• python命名规范


    1. 模块名:   

      通常是小写字母,单词之间用_分割:

       ad_stats.py 

    2. 包名: 

      和模块名一样 

    3. 类名: 

      类名都使用单词首字母大写开头(Pascal命名风格)的规范。举例:AdStats , ConfigUtil 

    • 使用_单下划线开头的类名为内部使用,from M import *默认不被导入的情况。 

    4. 变量:

      1)全局变量名(类变量,在java中相当于static变量):

    • 大写字母,单词之间用_分割 NUMBER , COLOR_WRITE 
    • 对于from M import *导入语句,如果想阻止导入模块内的全局变量可以使用旧有的规范,在全局变量上加一个前导的下划线。
    • 注意:应避免使用全局变量

      2)普通变量:

    • 小写字母,单词之间用_分割 this_is_a_var 
    • 注意:
      • 不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。
      • 私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。 
      • 变量名不应带有类型信息,因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。 

      3)实例变量: 

    • 以_开头,其他和普通变量一样 _price , _instance_var 

      4)私有实例变量(外部访问会报错):   

    • 以__开头(2个下划线),其他和普通变量一样 __private_var 专有变量:  
    • 注意:__开头,__结尾,一般为python的自有变量,不要以这种方式命名 __doc__ 、__class__ 

    5. 函数

      1)普通函数:

       和普通变量一样: get_name() count_number() ad_stat() 


      2)私有函数(外部访问会报错): 

    • 以__开头(2个下划线),其他和普通函数一样 __get_name()

      3)文件名: 

    • 全小写,可使用下划线 

      4)函数和方法的参数:

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

      5)常量: 

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

      6)异常 

    • 因为异常也是一个类,所以遵守类的命名规则。
    • 此外,如果异常实际上指代一个错误的话,应该使用“Error”做后缀。

    6. 缩写 

      命名应当尽量使用全拼写的单词,缩写的情况有如下两种: 
      1.常用的缩写,如XML、ID等,在命名时也应只大写首字母,如XmlParser。 

      2.命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式。

    例如: function 缩写为 fn,text 缩写为 txt,object 缩写为 obj,count 缩写为 cnt,number 缩写为 num等。

    7.  前导后缀下划线总结 

    • 一个前导下划线(_xxx):表示非公有:代表不能直接访问的类属性,需通过类对象和子类对象通过提供的接口进行访问,不能用'from module import *'导入(相当于 private)
    •  __xxx__ 系统定义名字 
    • 一个后缀下划线(__xxx):是私有成员,意思是只有类对象自己能访问,连子类对象也不能访问到这个数据。
    • 两个前导下划线:当命名一个类属性引起名称冲突时使用。 
    • 两个前导和后缀下划线(__xxx__):系统保留字命名法,例如__init__或者__file__绝对不要创造这样的名字,而只是使用它们。 
  • 相关阅读:
    仿函数(functor)
    七周七语言
    面向签名编程
    git checkout简介
    .gitkeep常用写法
    PhpStorm terminal无法输入命令的解决方法
    原 在windows上创建文件名以“.”开头的文件
    cmd 里面运行git提示“不是内部或外部命令,也不是可运行的程序”的解决办法
    .gitkeep
    git/github运用
  • 原文地址:https://www.cnblogs.com/lesleysbw/p/5894436.html
Copyright © 2020-2023  润新知