美文网首页
python命名规则

python命名规则

作者: bonnie_xing | 来源:发表于2018-12-27 11:21 被阅读0次

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

应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如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.

相关文章

  • Python的注释和变量的命名规则

    python 注释 python 变量命名规则

  • python命名规则

    命名规范:根据(https://www.cnblogs.com/Maker-Liu/p/5528213.html)...

  • Python命名规则

    Python 命名一般来说有一下不成文的规则 : 模块名一般使用全部小写 如 myname 类名第一个字母大写,如...

  • Python命名规则

    类型命名规则举例模块名/包名全小写字母,简单有意义,如果需要可以使用下划线math、sys函数名全小写字母,可以使...

  • python命名规则

    1、模块 模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况) -特殊的如in...

  • python命名规则

    文件名全小写,可使用下划线 包应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如mypackage。 ...

  • Python备忘录-基础

    Python 基础知识 Python命名规则 使用 future 的特性 导入__future__ 可以在pyth...

  • Python编码规范

    写在前面 本章的Python的编码规范和命名规则来自于: PEP8官网 CSDN博客 命名规则 (Naming C...

  • python变量命名规则

    标识符 标识符(identifier)是指用来标识某个实体的一个符号,在不同的应用环境下有不同的含义。在计算机编程...

  • python 函数

    函数的基本结构 Python中的函数基本结构: 几点说明: 函数名的命名规则要符合python中的命名要求。一般用...

网友评论

      本文标题:python命名规则

      本文链接:https://www.haomeiwen.com/subject/fmhrlqtx.html