Python命名规范

摘要:
模块和包装的规格相同。函数和方法的参数始终使用“self”作为实例方法的第一个参数。例如,iValue、names_list、dict_Obj和其他都是坏名字。两个前导下划线:用于命名类属性时会导致名称冲突。具体命名主要指__xxx__的系统保留字命名法。省略的id__、__父__和__消息__均采用系统保留字命名方法。

文件名
全小写,可使用下划线



应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如mypackage。


模块
与包的规范同。如mymodule。



总是使用首字母大写单词串。如MyClass。内部类可以使用额外的前导下划线。

 

函数&方法
函数名应该为小写,可以用下划线风格单词以增加可读性。如:myfunction,my_example_function。
*注意*:混合大小写仅被允许用于这种风格已经占据优势的时候,以便保持向后兼容。


函数和方法的参数
总使用“self”作为实例方法的第一个参数。总使用“cls”作为类方法的第一个参数。
如果一个函数的参数名称和保留的关键字冲突,通常使用一个后缀下划线好于使用缩写或奇怪的拼写。


全局变量
对于from M import *导入语句,如果想阻止导入模块内的全局变量可以使用旧有的规范,在全局变量上加一个前导的下划线。
*注意*:应避免使用全局变量


变量
变量名全部小写,由下划线连接各个单词。如color = WHITE,this_is_a_variable = 1
*注意*:
1.不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
3.变量名不应带有类型信息,因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。


常量
常量名所有字母大写,由下划线连接各个单词如MAX_OVERFLOW,TOTAL。


异常
以“Error”作为后缀。


缩写
命名应当尽量使用全拼写的单词,缩写的情况有如下两种:
1.常用的缩写,如XML、ID等,在命名时也应只大写首字母,如XmlParser。
2.命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式。
例如:
function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num,等。
前导后缀下划线
一个前导下划线:表示非公有。
一个后缀下划线:避免关键字冲突。
两个前导下划线:当命名一个类属性引起名称冲突时使用。
两个前导和后缀下划线:“魔”(有特殊用图)对象或者属性,例如__init__或者__file__。绝对不要创造这样的名字,而只是使用它们。
*注意*:关于下划线的使用存在一些争议。


特定命名方式
主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名,它的意义在于这种形式的变量是只读的,这种形式的类成员函数尽量不要重载。如
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略
其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。


附:Google Python命名规范
module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.

--------------------- 本文来自 zhangzeyuaaa 的CSDN 博客 ,全文地址请点击:https://blog.csdn.net/zhangzeyuaaa/article/details/78574919?utm_source=copy 

免责声明:文章转载自《Python命名规范》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇P1983 车站分级fastjson SerializerFeature详解下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

老王Python-进阶篇4-面向对象第三节

一: 写一个网页数据操作类。完成下面的功能: 提示:需要用到urllib模块 get_httpcode()获取网页的状态码,返回结果例如:200,301,404等 类型为int get_htmlcontent() 获取网页的内容。返回类型:str get_linknum()计算网页的链接数目。 1 class get_web_data(): 2...

【Python】爬取百度图片

所需要导入的包:BeautifulSoup:该模块用于接收一个HTML或XML字符串,然后将其进行格式化,之后遍可以使用他提供的方法进行快速查找指定元素,从而使得在HTML或XML中查找指定元素变得简单。这里是用来获取一个页面里面的各个标签及里面的内容,我们主要用到它里面的find(),find_All()函数requests:是用来获取网页信息的,也就是...

python之路

引子 学如逆水行舟,不进则退. Python Python开发【第一篇】:初识 Python开发【第二篇】:基本数据类型 Python开发【第三篇】:函数 Python开发【第四篇】:文件处理 Python开发【第五篇】:python常用模块 Python开发【第六篇】:面向对象 Python开发【第七篇】:网络编程 Python开发【第八篇】:进程、...

Python 用SMTP发送邮件

一、简介  上面介绍了传统邮件的生成和解析,这些都是non-internet,也就是不需要网络就可一完成的。那么当生成了邮件,下一步就是发送了,本文就讲解利用SMTP协议发送邮件。  正如SMTP(Simple Mail Transfer Protocal)名字一样,只能发送简单邮件。上面讲解就是生成的简单邮件,完全可以通过SMTP协议来发送。 二、SMT...

宝塔Python项目设置及启动文件编辑

在宝塔面板中,通过软件商店的Python项目管理器,即可完成设置,一般有以下两个步骤: 1、添加项目 设置完成后,点击确认。 2、设置绑定 点击列表中的映射 设置映射 设置完映射后,会在网站列表中出现一个以你映射域名作为名称的站点。 在网站的反向代理中,能看见对python的支持 3、注意事项 1、由于目录没有判断的原因,在创建后,需要将网站列...

python psycopg2 连接pg 建立连接池

# -*- coding: utf-8 -*-from psycopg2.pool import ThreadedConnectionPool,SimpleConnectionPool,PersistentConnectionPool from constant import pg_name, pg_user, pg_pw, pg_host, pg_por...