Python 文件命名风格
Vaibhhav Khetarpal
2022年5月17日
本文中讨论的所有命名风格均基于 Python 代码的 PEP 8
样式指南。
Python 库的命名风格提供了一些可供选择的空间,因此没有太多的一致性。
Python 是一门庞大的语言,它有两部分:现有的库和函数。而另一个是第三方框架和包。
前者遵循一致性,而在后者的情况下命名可能会有所不同。
Python 中的命名风格
Python 中命名风格的一般注意事项:
- 不要使用可能类似于预定义函数的通用名称。
- 不要使用过于冗长的名称,因为它们会在多次使用该功能时增加出错的空间。
- 字符
l
、O
或I
不应单独用于命名。在某些字体中,这些字符有时会被误解为0
或1
。 - 当使用
CamelCase
约定时,所有缩写的字母都大写。
模块:
- 所有模块应仅以小写字符命名。
- 当需要使用多个单词来命名模块时,下划线适合空白。
- 建议使用单个词来命名模块。
库:
- 与模块类似,包只能在小写字母的帮助下命名。
- 当需要使用多个单词来命名模块时,下划线适合空白。
- 建议使用单个词来命名包。
类:
- 通常建议使用
CapWords
约定来命名类。 - 但是,Python 中的内置类通常是小写的。
- 建议所有异常类的名称末尾都包含单词
Error
。
全局变量:
- 建议这些变量全部使用小写字母。
- 如果需要,可以用下划线分隔单词。
变量:
- 与全局变量类似,实例变量也应该使用小写字母。
- 如果需要,可以用下划线分隔单词。
- 在极少数情况下,实例变量的开头可能带有双下划线。
函数/方法:
- 函数或方法应始终使用小写字母进行命名。
- 如果需要,可以用下划线分隔单词。
- 以单个下划线开头的函数通常标记非公共函数的命名。
- 在极少数情况下,方法的开头可能带有双下划线。
函数参数:
- 实例方法的第一个参数需要是
self
。 - 类方法的第一个参数必须是
cls
。
常量:
- 常量使用全部大写字母。
- 如果有多个单词,可以用下划线分隔它们。
Author: Vaibhhav Khetarpal
Vaibhhav is an IT professional who has a strong-hold in Python programming and various projects under his belt. He has an eagerness to discover new things and is a quick learner.
LinkedIn