Python命名规则与注释风格

名称不要缩写！！！

成都创新互联公司专业为企业提供洛隆网站建设、洛隆做网站、洛隆网站设计、洛隆网站制作等企业网站建设、网页设计与制作、洛隆企业网站模板建站服务，十多年洛隆做网站经验，不只是建网站，更提供有价值的思路和整体网络服务。

名称不要缩写！！！

名称不要缩写！！！

包命名：小写，下划线_连接单词

模块命名：小写，下划线_连接单词

类命名：双驼峰，MyClass

函数命名：小写，下划线_连接单词

全局变量：每个字母大写

注释很重要，要注明函数或类的功能，参数的数据类型、含义等。

注释模板：

注释的作用：

Python有句话是do not repeat yourself，即不要做重复的事，因此出现了类或函数的封装和继承，基于此可提高代码的重复利用性。

python怎样命名变量的

模块名：

小写字母，单词之间用_分割

ad_stats.py

包名：

和模块名一样

类名：

单词首字母大写

AdStats

ConfigUtil

全局变量名（类变量，在java中相当于static变量）：

大写字母，单词之间用_分割

NUMBER

COLOR_WRITE

普通变量：

小写字母，单词之间用_分割

this_is_a_var

实例变量：

以_开头，其他和普通变量一样

_price

_instance_var

私有实例变量（外部访问会报错）：

以__开头（2个下划线），其他和普通变量一样

__private_var

专有变量：

__开头，__结尾，一般为python的自有变量，不要以这种方式命名

__doc__

__class__

普通函数：

和普通变量一样：

get_name()

count_number()

ad_stat()

私有函数（外部访问会报错）：

以__开头（2个下划线），其他和普通函数一样

__get_name()

————————————————————————————————————————————————————————————————————

文件名

全小写,可使用下划线

包

应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如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__。绝对不要创造这样的名字，而只是使用它们。

*注意*：关于下划线的使用存在一些争议。

Python 用下划线作为变量前缀和后缀指定特殊变量。

_xxx 不能用'from module import *'导入

__xxx__ 系统定义名字

__xxx 类中的私有变量名

核心风格：避免用下划线作为变量名的开始。

因为下划线对解释器有特殊的意义，而且是内建标识符所使用的符号，我们建议程序员避免用下划线作为变量名的开始。一般来讲，变量名_xxx被看作是“私有的”，在模块或类外不可以使用。当变量是私有的时候，用_xxx 来表示变量是很好的习惯。因为变量名__xxx__对Python 来说刑厥夂澹杂谄胀ǖ谋淞坑Φ北苊庹庵置绺瘛?br

"单下划线" 开始的成员变量叫做保护变量，意思是只有类对象和子类对象自己能访问到这些变量；

"双下划线" 开始的是私有成员，意思是只有类对象自己能访问，连子类对象也不能访问到这个数据。

以单下划线开头（_foo）的代表不能直接访问的类属性，需通过类提供的接口进行访问，不能用“from xxx import *”而导入；以双下划线开头的（__foo）代表类的私有成员；以双下划线开头和结尾的（__foo__）代表python里特殊方法专用的标识，如 __init__（）代表类的构造函数。

特定命名方式

主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名，它的意义在于这种形式的变量是只读的，这种形式的类成员函数尽量不要重载。如

class Base(object):

def __init__(self, id, parent = None):

self.__id__ = id

self.__parent__ = parent

def __message__(self, msgid):

# …略

其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。

python中函数名的命名规则

Python 命名一般来说有一下不成文的规则 ：

模块名一般使用全部小写 如 myphone

类名第一个字母大写，如果有多个单词，每一个单词的第一个字母大写如 : MyPhone

函数名 ： 小写， 如果有多个单词用下划线隔开 如 my_phone

常量名字一般全大写 ： MYPHONE

python程序有哪些编码规范

编码格式声明

通常，编码格式声明是必需的。如果 python 源码文件没有声明编码格式，python 解释器会默认使用 ASCII 编码，一旦源码文件包含非ASCII编码的字符，python 解释器就会报错。以 UTF-8 为例，以下两种编码格式声明都是合乎规则的。

缩进

统一使用 4 个空格进行缩进。绝对不要用tab, 也不要tab和空格混用。对于行连接的情况，我一般使用4空格的悬挂式缩进。例如：

引号

自然语言使用双引号

机器标识使用单引号

正则表达式使用双引号

空行

编码格式声明、模块导入、常量和全局变量声明、顶级定义和执行代码之间空两行

顶级定义之间空两行，方法定义之间空一行

在函数或方法内部，可以在必要的地方空一行以增强节奏感，但应避免连续空行

导入模块

导入总应该放在文件顶部，位于模块注释和文档字符串之后，模块全局变量和常量之前。导入应该按照从最通用到最不通用的顺序分组，分组之间空一行

标准库导入

第三方库导入

应用程序指定导入

命名规范

模块尽量使用小写命名，首字母保持小写，尽量不要用下划线

类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头

函数名一律小写，如有多个单词，用下划线隔开

私有函数可用一个下划线开头

变量名尽量小写, 如有多个单词，用下划线隔开

常量采用全大写，如有多个单词，使用下划线隔开

新闻名称：python函数命名风格 Python中函数命名规则
网页地址：http://ybzwz.com/article/hggesg.html