详解python里的命名规范

作者:Williamwhc 时间:2023-02-11 20:07:02 

文件名

全小写,可使用下划线

应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如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里的命名规范网站的支持!

来源:https://blog.csdn.net/qq_40285302/article/details/81064536

标签:python,命名,规范
0
投稿

猜你喜欢

  • python中必要的名词解释

    2023-10-17 23:30:32
  • Django页面数据的缓存与使用的具体方法

    2023-03-29 11:42:44
  • Pytorch 神经网络—自定义数据集上实现教程

    2022-11-30 20:05:04
  • 详解pyqt中解决国际化tr()函数不起作用的问题

    2021-03-31 05:15:56
  • codeigniter发送邮件并打印调试信息的方法

    2024-05-13 09:57:03
  • Python数据可视化实现漏斗图过程图解

    2022-07-29 19:02:43
  • Python3简单实例计算同花的概率代码

    2023-07-20 16:23:03
  • python3+requests接口自动化session操作方法

    2022-09-22 19:30:40
  • Python 多个图同时在不同窗口显示的实现方法

    2022-07-02 01:20:35
  • Python必备技巧之函数的使用详解

    2021-03-02 11:19:59
  • Django项目在pycharm新建的步骤方法

    2021-01-19 11:46:32
  • Pandas.DataFrame删除指定行和列(drop)的实现

    2022-05-27 16:15:55
  • W3C优质网页小贴士(一)

    2008-04-06 16:35:00
  • python 多个参数不为空校验方法

    2022-12-15 10:48:56
  • python生成不重复随机数和对list乱序的解决方法

    2023-09-24 01:17:59
  • Tornado实现多进程/多线程的HTTP服务详解

    2023-11-19 23:40:20
  • 在登录触发器错误情况下连接SQL Server的方法

    2024-01-25 19:37:51
  • jupyter notebook 调用环境中的Keras或者pytorch教程

    2022-10-07 23:23:09
  • 详解python中@classmethod和@staticmethod方法

    2022-10-24 11:47:16
  • Python字典 dict几种遍历方式

    2023-01-14 19:48:28
  • asp之家 网络编程 m.aspxhome.com