https://blog.csdn.net/warm77/article/details/78353632 前言

Python 学习之旅，先来看看 Python 的代码规范，让自己先有个意识，而且在往后的学习中慢慢养成习惯

目录

Python代码规范和命名规范 随笔 第1张

SRE实战 互联网时代守护先锋，助力企业售后服务体系运筹帷幄！一键直达领取阿里云限量特价优惠。 一、简明概述 1、编码
  • 如无特殊情况, 文件一律使用 UTF-8 编码
  • 如无特殊情况, 文件头部必须加入#-*-coding:utf-8-*-标识
2、代码格式

2.1、缩进

  • 统一使用 4 个空格进行缩进

2.2、行宽

每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ，但最长不得超过 120)

理由：

  • 这在查看 side-by-side 的 diff 时很有帮助
  • 方便在控制台下查看代码
  • 太长可能是设计有缺陷

2.3、引号

简单说，自然语言使用双引号，机器标示使用单引号，因此 代码里 多数应该使用 单引号

  • 自然语言 使用双引号 "..."
    例如错误信息；很多情况还是 unicode，使用u"你好世界"
  • 机器标识 使用单引号 '...'
    例如 dict 里的 key
  • 正则表达式 使用原生的双引号 r"..."
  • 文档字符串 (docstring) 使用三个双引号 """......"""

2.4、空行

  • 模块级函数和类定义之间空两行；
  • 类成员函数之间空一行；
  1.   class A:
  2.    
  3.   def __init__(self):
  4.   pass
  5.    
  6.   def hello(self):
  7.   pass
  8.    
  9.   def main():
  10.   pass
  • 可以使用多个空行分隔多组相关的函数
  • 函数中可以使用空行分隔出逻辑相关的代码

2.5、编码

  • 文件使用 UTF-8 编码
  • 文件头部加入#-*-conding:utf-8-*-标识
3、import 语句
  • import 语句应该分行书写
  1.   # 正确的写法
  2.   import os
  3.   import sys
  4.    
  5.   # 不推荐的写法
  6.   import sys,os
  7.    
  8.   # 正确的写法
  9.   from subprocess import Popen, PIPE
  • import语句应该使用 absolute import
  1.   # 正确的写法
  2.   from foo.bar import Bar
  3.    
  4.   # 不推荐的写法
  5.   from ..bar import Bar
  • import语句应该放在文件头部，置于模块说明及docstring之后，于全局变量之前；
  • import语句应该按照顺序排列，每组之间用一个空行分隔
  1.   import os
  2.   import sys
  3.    
  4.   import msgpack
  5.   import zmq
  6.    
  7.   import foo
  • 导入其他模块的类定义时，可以使用相对导入
from myclass import MyClass
  • 如果发生命名冲突，则可使用命名空间
  1.   import bar
  2.   import foo.bar
  3.    
  4.   bar .Bar()
  5.   foo .bar.Bar()
4、空格
  • 在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]:
  1.   # 正确的写法
  2.   i = i + 1
  3.   submitted += 1
  4.   x = x * 2 - 1
  5.   hypot2 = x * x + y * y
  6.   c = (a + b) * (a - b)
  7.    
  8.   # 不推荐的写法
  9.   i =i+1
  10.   submitted +=1
  11.   x = x*2 - 1
  12.   hypot2 = x*x + y*y
  13.   c = (a+b) * (a-b)
  • 函数的参数列表中，,之后要有空格
  1.   # 正确的写法
  2.   def complex(real, imag):
  3.   pass
  4.    
  5.   # 不推荐的写法
  6.   def complex(real,imag):
  7.   pass
  • 函数的参数列表中，默认值等号两边不要添加空格
  1.   # 正确的写法
  2.   def complex(real, imag=0.0):
  3.   pass
  4.    
  5.   # 不推荐的写法
  6.   def complex(real, imag = 0.0):
  7.   pass
  • 左括号之后，右括号之前不要加多余的空格
  1.   # 正确的写法
  2.   spam (ham[1], {eggs: 2})
  3.    
  4.   # 不推荐的写法
  5.   spam ( ham[1], { eggs : 2 } )
  • 字典对象的左括号之前不要多余的空格
  1.   # 正确的写法
  2.   dict ['key'] = list[index]
  3.    
  4.   # 不推荐的写法
  5.   dict ['key'] = list [index]
  • 不要为对齐赋值语句而使用的额外空格
  1.   # 正确的写法
  2.   x = 1
  3.   y = 2
  4.   long_variable = 3
  5.    
  6.   # 不推荐的写法
  7.   x = 1
  8.   y = 2
  9.   long_variable = 3
5、换行

Python 支持括号内的换行。这时有两种情况。

1) 第二行缩进到括号的起始处

  1.   foo = long_function_name(var_one, var_two,
  2.   var_three , var_four)

2) 第二行缩进 4 个空格，适用于起始括号就换行的情形

  1.   def long_function_name(
  2.   var_one , var_two, var_three,
  3.   var_four ):
  4.   print(var_one)

使用反斜杠\换行，二元运算符+ .等应出现在行末；长字符串也可以用此法换行

  1.   session.query(MyTable).\
  2.   filter_by (id=1).\
  3.   one ()
  4.    
  5.   print 'Hello, '\
  6.   '%s %s!' %\
  7.   ('Harry', 'Potter')

禁止复合语句，即一行中包含多个语句：

  1.   # 正确的写法
  2.   do_first ()
  3.   do_second ()
  4.   do_third ()
  5.    
  6.   # 不推荐的写法
  7.   do_first ();do_second();do_third();

if/for/while一定要换行：

  1.   # 正确的写法
  2.   if foo == 'blah':
  3.   do_blah_thing ()
  4.    
  5.   # 不推荐的写法
  6.   if foo == 'blah': do_blash_thing()
6、docstring

docstring 的规范中最其本的两点：

  1. 所有的公共模块、函数、类、方法，都应该写 docstring 。私有方法不一定需要，但应该在 def 后提供一个块注释来说明。
  2. docstring 的结束"""应该独占一行，除非此 docstring 只有一行。
  1.   """Return a foobar
  2.   Optional plotz says to frobnicate the bizbaz first.
  3.   """
  4.    
  5.   """Oneline docstring"""
二、注释 1、注释

1.1、块注释

“#”号后空一格，段落件用空行分开（同样需要“#”号）

  1.   # 块注释
  2.   # 块注释
  3.   #
  4.   # 块注释
  5.   # 块注释

1.2、行注释

至少使用两个空格和语句分开，注意不要使用无意义的注释

  1.   # 正确的写法
  2.   x = x + 1 # 边框加粗一个像素
  3.    
  4.   # 不推荐的写法(无意义的注释)
  5.   x = x + 1 # x加1

1.3、建议

  • 在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释

  • 比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性
  1.   app = create_app(name, options)
  2.    
  3.   # =====================================
  4.   # 请勿在此处添加 get post等app路由行为 !!!
  5.   # =====================================
  6.    
  7.   if __name__ == '__main__':
  8.   app .run()
2、文档注释（Docstring）

作为文档的Docstring一般出现在模块头部、函数和类的头部，这样在python中可以通过对象的__doc__对象获取文档.
编辑器和IDE也可以根据Docstring给出自动提示.

  • 文档注释以 """ 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例
  1.   # -*- coding: utf-8 -*-
  2.   """Example docstrings.
  3.    
  4.   This module demonstrates documentation as specified by the `Google Python
  5.   Style Guide`_. Docstrings may extend over multiple lines. Sections are created
  6.   with a section header and a colon followed by a block of indented text.
  7.    
  8.   Example:
  9.   Examples can be given using either the ``Example`` or ``Examples``
  10.   sections. Sections support any reStructuredText formatting, including
  11.   literal blocks::
  12.    
  13.   $ python example_google.py
  14.    
  15.   Section breaks are created by resuming unindented text. Section breaks
  16.   are also implicitly created anytime a new section starts.
  17.   """
  • 不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等
  1.   # 不推荐的写法(不要写函数原型等废话)
  2.   def function(a, b):
  3.   """function(a, b) -> list"""
  4.   ... ...
  5.    
  6.   # 正确的写法
  7.   def function(a, b):
  8.   """计算并返回a到b范围内数据的平均值"""
  9.   ... ...
  • 对函数参数、返回值等的说明采用numpy标准, 如下所示
  1.   def func(arg1, arg2):
  2.   """在这里写函数的一句话总结(如: 计算平均值).
  3.    
  4.   这里是具体描述.
  5.    
  6.   参数
  7.   ----------
  8.   arg1 : int
  9.   arg1的具体描述
  10.   arg2 : int
  11.   arg2的具体描述
  12.    
  13.   返回值
  14.   -------
  15.   int
  16.   返回值的具体描述
  17.    
  18.   参看
  19.   --------
  20.   otherfunc : 其它关联函数等...
  21.    
  22.   示例
  23.   --------
  24.   示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行
  25.    
  26.   >>> a=[1,2,3]
  27.   >>> print [x + 3 for x in a]
  28.   [4, 5, 6]
  29.   """

  • 文档注释不限于中英文, 但不要中英文混用

  • 文档注释不是越长越好, 通常一两句话能把情况说清楚即可

  • 模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释
三、命名规范 1、模块
  • 模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)
  1.   # 正确的模块名
  2.   import decoder
  3.   import html_parser
  4.    
  5.   # 不推荐的模块名
  6.   import Decoder
2、类名
  • 类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头
  1.   class Farm():
  2.   pass
  3.    
  4.   class AnimalFarm(Farm):
  5.   pass
  6.    
  7.   class _PrivateFarm(Farm):
  8.   pass
  • 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.
3、函数
  • 函数名一律小写，如有多个单词，用下划线隔开
  1.   def run():
  2.   pass
  3.    
  4.   def run_with_env():
  5.   pass
  • 私有函数在函数前加一个下划线_
  1.   class Person():
  2.    
  3.   def _private_func():
  4.   pass
4、变量名
  • 变量名尽量小写, 如有多个单词，用下划线隔开
  1.   if __name__ == '__main__':
  2.   count = 0
  3.   school_name = ''
  • 常量采用全大写，如有多个单词，使用下划线隔开
  1.   MAX_CLIENT = 100
  2.   MAX_CONNECTION = 1000
  3.   CONNECTION_TIMEOUT = 600
5、常量
  • 常量使用以下划线分隔的大写命名
  1.   MAX_OVERFLOW = 100
  2.    
  3.   Class FooBar:
  4.    
  5.   def foo_bar(self, print_):
  6.   print(print_)
农村有一宝，可祛灰指甲，可惜很少人知道梦悦 · 猎媒 Python代码规范和命名规范 随笔 第2张
扫码关注我们
微信号：SRE实战
拒绝背锅 运筹帷幄