Python 编程风格指南

python

Python 编程风格指南

该指南参考自 PEP 8

  • Python 区分大小写
  • 当调用像 print 这样的函数时,将左括号直接放在函数名称之后,不要在括号内添加多余空格,如 print(3*7)
  • 将不同优先级的运算符(如乘法和减法)混合,为了易于阅读可能需要在较低优先级运算符周围添加空格,如 1 + 2*3
  • 不要使代码行过长,否则会很难理解。人们通常将一行代码的长度限制在 79 或 99 个字符以内。需要编写更长的代码行,请考虑重写并简化代码
  • Python 根据代码的缩进判断代码结构,请谨慎缩进!
Tip

命名规范

Warning

不要使用小写字母 l(el),大写字母 O(oh),或者小写 i 作为单独变量名称。因为一些字体中,上诉字母和数字很难区分(比如:O0l1)。

  • 变量函数:尽量小写,如有多个单词,用下划线隔开
  • 常量:常量采用全大写,如有多个单词,使用下划线隔开
  • 类名:使用驼峰 CamelCase 命名风格,首字母大写
  • 模块:尽量使用小写命名,首字母保持小写。尽量不要用下划线,除非多个单词,且数量不多的情况
  • 参数名:小写单词

检查工具

pycodestyle 工具可以帮助你编写使其他 Python 程序员(包括项目审阅专家)更容易读懂的 Python 代码。它会使用 Python 样式指南中的很多规则检查你的代码。

请在 shell/终端 里使用 pippip3 命令安装 pycodestyle

shell
# 如果你的 Python 叫做 "python"
$ pip install pycodestyle

# 如果你的 Python 叫做 "python3"
$ pip3 install pycodestyle

检查目标脚本 styllish.py 的编程规范

shell
pycodestyle stylish.py

Copyright © 2025 Ben

Theme BlogiNote

Icons from Icônes