一文轻松掌握Python语言命名规范规则
在使用Python编写代码时,良好的命名规范不仅仅可以让代码更加易读易懂,还能减少错误发生的概率。Python社区提出了一些通用的命名规范,下面是一些基本规则。
1. 变量和函数名命名
- 命名要具备可读性,避免使用缩写和望文不知义的变量名。
- 变量名要小写。
- 函数名要小写,如果是多个单词组成,用下划线(
_
)分隔。 - 类名要使用驼峰命名法(CamelCase)。
- 常量名要使用全大写,用下划线(
_
)分隔。
示例:
# 不好的命名示例
b = 10
if d >= 2:
return 'yes'
# 好的命名示例
count = 10
if days_since_creation >= 2:
return 'Yes'
2. 程序文件命名
- 应该使用全部小写字母,用下划线(
_
)分隔各个单词。 - 程序文件名应该有有意义,让人能够很容易地看出文件的功能。
示例:
程序文件名为“hello_world.py
”,这个文件中主要实现了一个程序,可以向控制台输出“Hello, World!”这句话。文件名就明确地说明了它的功能和作用。
3. 包名命名
- 包名应该全部小写。
- 包名不应该有下划线(
_
)。
示例:
一个名为“example_package
”的包。
4. 类型命名
- 类型命名要使用驼峰命名法(CamelCase)。
- 类型包括:类、类型变量、异常等。
示例:
# 类型变量
class Person:
name: str
age: int
# 异常
class MyException(Exception):
pass
5. 模块级别的常量命名
- 模块级别的常量命名要使用全大写,用下划线(
_
)分隔。 - 常量用于任何不会被用户修改的数值或内部的标识符。
示例:
# 常量定义
MAXIMUM_CONNECTIONS = 100
以上是比较基础的Python语言命名规范规则,如果想要更加了解Python中的命名规范,可以查看官方的PEP 8文档。
本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:一文轻松掌握python语言命名规范规则 - Python技术站