《Python从小白到大牛》第5章 Python编码规范

俗话说:“没有规矩不成方圆”。编程工作往往都是一个团队协同进行,因而一致的编码规范非常有必要,这样写成的代码便于团队中的其他人员阅读,也便于编写者自己以后阅读。

提示
关于本书的Python编码规范借鉴了Python官方的PEP8编码规范^1和谷歌Python编码规范^2

命名规范

程序代码中到处都是标识符,因此取一个一致并且符合规范的名字非常重要。Python中命名规范采用多种不同。不同的代码元素命名不同,下面分类说明一下。

  • 包名。全部小写字母,中间可以由点分隔开,不推荐使用下划线。作为命名空间,包名应该具有唯一性,推荐采用公司或组织域名的倒置,如com.apple.quicktime.v2。

  • 模块名。全部小写字母,如果是多个单词构成,可以用下划线隔开,如dummy_threading。

  • 类名。采用大驼峰法命名法^3,如SplitViewController。

  • 异常名。异常属于类,命名同类命名,但应该使用Error作为后缀。如FileNotFoundError。

  • 变量名。全部小写字母,如果是多个单词构成,可以用下划线隔开。如果变量应用于模块或函数内部,则变量名可以单下划线开头;如果变量类内部私有使用变量名可以双下划线开头。不要命名双下划线开头和结尾的变量,这是Python保留的。另外,避免使用小写L、大写O和大写I作为变量名。

  • 函数名和方法名。命名同变量命名。如balance_account、_push_cm_exit。

  • 常量名。全部大写字母,如果是由多个单词构成,可以用下划线隔开,如YEAR和WEEK_OF_MONTH。

命名规范示例如下:

_saltchars = _string.ascii_letters + _string.digits + './'

def mksalt(method=None):

    if method is None:
        method = methods[0]
    s = '${}$'.format(method.ident) if method.ident else ''
    s += ''.join(_sr.choice(_saltchars) for char in range(method.salt_chars))
    return s

METHOD_SHA256 = _Method('SHA256', '5', 16, 63)
METHOD_SHA512 = _Method('SHA512', '6', 16, 106)

methods = []
for _method in (METHOD_SHA512, METHOD_SHA256, METHOD_MD5, METHOD_CRYPT):
    _result = crypt('', _method)
    if _result and len(_result) == _method.total_size:
        methods.append(_method)

注释规范

Python中注释的语法有三种:单行注释、多行注释和文档注释。本节介绍如何规范使用这些注释。

文件注释

文件注释就是在每一个文件开头添加注释,采用多行注释。文件注释通常包括如下信息:版权信息、文件名、所在模块、作者信息、历史版本信息、文件内容和作用等。

下面看一个文件注释的示例:

# 
# 版权所有 2015 北京智捷东方科技有限公司
# 许可信息查看LICENSE.txt文件
# 描述:
#   实现日期基本功能
# 历史版本:
#   2015-7-22: 创建 关东升
#   2015-8-20: 添加socket库
#   2015-8-22: 添加math库
#

上述注释只是提供了版权信息、文件内容和历史版本信息等,文件注释要根据本身的实际情况包括内容。

文档注释

文档注释就是文档字符串,注释内容能够生成API帮助文档,可以使用Python官方提供的pydoc工具从Python源代码文件中提取信息这些信息,也可以生成HTML文件。所有公有的模块、函数、类和方法都应该进行文档注释。

文档注释规范有些“苛刻”。文档注释推荐使用一对三重双引号(""")包裹起来,注意不推荐使用三重单引号(''')。文档注释应该位于被注释的模块、函数、类和方法内部的第一条语句。如果文档注释一行能够注释完成,结束的三重双引号也在同一行。如果文档注释很长,第一行注释之后要留一个空行,然后剩下的注释内容,注释内容换行是要于开始三重双引号对齐,最后结束的三重双引号要独占一行,并与开始三重双引号对齐。

下面代码是Python官方提供的base64.py文件一部分。

#! /usr/bin/env python3

"""Base16, Base32, Base64 (RFC 3548), Base85 and Ascii85 data encodings"""  ①

# Modified 04-Oct-1995 by Jack Jansen to use binascii module
# Modified 30-Dec-2003 by Barry Warsaw to add full RFC 3548 support
# Modified 22-May-2007 by Guido van Rossum to use bytes everywhere

import re
import struct
import binascii

bytes_types = (bytes, bytearray)  # Types acceptable as binary data

def _bytes_from_decode_data(s): ②
    if isinstance(s, str):
        try:
            return s.encode('ascii')
        except UnicodeEncodeError:
            raise ValueError('string argument should contain only ASCII characters')
    if isinstance(s, bytes_types):
        return s
    try:
        return memoryview(s).tobytes()
    except TypeError:
        raise TypeError("argument should be a bytes-like object or ASCII "
                        "string, not %r" % s.__class__.__name__) from None

# Base64 encoding/decoding uses binascii

def b64encode(s, altchars=None):
    """Encode the bytes-like object s using Base64 and return a bytes object.   ③

    Optional altchars should be a byte string of length 2 which specifies an    ④
    alternative alphabet for the '+' and '/' characters.  This allows an
    application to e.g. generate url or filesystem safe Base64 strings.
    """ ⑤
    encoded = binascii.b2a_base64(s, newline=False)
    if altchars is not None:
        assert len(altchars) == 2, repr(altchars)
        return encoded.translate(bytes.maketrans(b'+/', altchars))
return encoded

上述代码第①行是只有一行的文档注释,代码第③行\~第⑤行是多行的文档注释,注意它的第一行后面是一个空行,代码第④行接着进行注释,它要与开始三重双引号对齐。代码第⑤行是结束三重双引号,它独占一行的,而且与对齐开始三重双引号对齐。另外,代码第②行定义的函数没有文档注释,这是因为该函数是模块私有的,通过它的命名_bytes_from_decode_data可知它是私有的,下划线开头函数是模块私有的。

代码注释

程序代码中处理文档注释还需要在一些关键的地方添加代码注释,文档注释一般是给一些看不到源代码的人看的帮助文档,而代码注释是给阅读源代码的人参考的。代码注释一般是采用单行注释和多行注释。

示例代码如下:

# Base32 encoding/decoding must be done in Python     ①
_b32alphabet = b'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'
_b32tab2 = None
_b32rev = None

def b32encode(s):
    """Encode the bytes-like object s using Base32 and return a bytes object.
    """
    global _b32tab2
    # Delay the initialization of the table to not waste memory     ②
    # if the function is never called     ③
    if _b32tab2 is None:
        b32tab = [bytes((i,)) for i in _b32alphabet]
        _b32tab2 = [a + b for a in b32tab for b in b32tab]
        b32tab = None

    if not isinstance(s, bytes_types):
        s = memoryview(s).tobytes()
    leftover = len(s) % 5
    # Pad the last quantum with zero bits if necessary     ④
    if leftover:
        s = s + b'\0' * (5 - leftover)  # Don't use += !
    encoded = bytearray()
    from_bytes = int.from_bytes
    b32tab2 = _b32tab2
    for i in range(0, len(s), 5):
        c = from_bytes(s[i: i + 5], 'big')
        encoded += (b32tab2[c >> 30] +           # bits 1 – 10     ⑤
                    b32tab2[(c >> 20) & 0x3ff] + # bits 11 - 20
                    b32tab2[(c >> 10) & 0x3ff] + # bits 21 - 30
                    b32tab2[c & 0x3ff]           # bits 31 - 40
                   )
    # Adjust for any leftover partial quanta
    if leftover == 1:
        encoded[-6:] = b'======'
    elif leftover == 2:
        encoded[-4:] = b'===='
    elif leftover == 3:
        encoded[-3:] = b'==='
    elif leftover == 4:
        encoded[-1:] = b'='
    return bytes(encoded)

上述代码第②行\~第④行都是单行注释,要求与其后的代码具有一样的缩进级别。代码第①行\~第③行是多行注释,注释时要求与其后的代码具有一样的缩进级别。代码第⑤行是尾端进行注释,这要求注释内容极短,应该再有足够的空白(至少两个空格)来分开代码和注释。

使用TODO注释

PyCharm等IDE工具都为源代码提供了一些特殊的注释,就是在代码中加一些标识,便于IDE工具快速定位代码,TODO注释就是其中的一种。TODO注释虽然不是Python官方所提供的,但是主流的IDE工具也都支持TODO注释。TODO注释说明此处有待处理的任务,或代码没有编写完成。

示例代码如下:

import com.pkg2.hello as module1
from com.pkg2.hello import z

y = 20

# TODO 声明函数 

print(y)  # 访问当前模块变量y
print(module1.y)  # 访问com.pkg2.hello模块变量y
print(z)  # 访问com.pkg2.hello模块变量z

这些注释在PyCharm工具的TODO视图查看,如果没有打开TODO视图,可以将鼠标放到PyCharm左下角

《Python从小白到大牛》第5章 Python编码规范

按钮上,如图5-1所示弹出的菜单,选择TODO,打开如图5-2所示的TODO视图,单击其中的TODO可跳转到注释处。

图5-1 打开TODO视图

图5-2 查看TODO视图

导入规范

导入语句总是放在文件顶部,位于模块注释和文档注释之后,模块全局变量和常量之前。每一个导入语句只能导入一个模块,示例代码如下。

推荐:

import re
import struct
import binascii

不推荐:

import re, struct, binascii

但是如何from import后面可以多个代码元素。

from codeop import CommandCompiler, compile_command

导入语句应该按照从通用到特殊的顺序分组,顺序是:标准库→第三方库→自己模块,每一组之间有一个空行,而且组中模块是按照英文字典顺序排序的。

import io       ①
import os
import pkgutil
import platform
import re
import sys
import time ②

from html import unescape       ③

from com.pkg1 import example    ④

上述代码中导入语句分为三组,代码第①行\~第②行是标准库中的模块,注意它的导入顺序是有序的。代码第③行是导入第三方库中的模块,代码第④行是导入自己的模块。

代码排版

代码排版包括空行、空格、断行和缩进等内容。代码排版内容比较多,工作量很大,也非常重要。

空行

空行用以将逻辑相关的代码段分隔开,以提高可读性。下面是使用空行的规范。

  1. import语句块前后保留两个空行,示例代码如下,其中①②处和③④处是两个空行。
    # Copyright 2007 Google, Inc. All Rights Reserved.
    # Licensed to PSF under a Contributor Agreement.

"""Abstract Base Classes (ABCs) according to PEP 3119."""


from _weakrefset import WeakSet

2. 函数声明之前保留两个空行,示例代码如下,其中①②处处是两个空行。
```python
from _weakrefset import WeakSet 
①
②
def abstractmethod(funcobj):
    funcobj.__isabstractmethod__ = True
    return funcobj
  1. 类声明之前保留两个空行,示例代码如下,其中①②处是两个空行。

    ①
    ②
    class abstractclassmethod(classmethod):
    __isabstractmethod__ = True
    
    def __init__(self, callable):
        callable.__isabstractmethod__ = True
        super().__init__(callable)
    1. 方法声明之前保留一个空行,示例代码如下,其中①处是一个空行。
      class abstractclassmethod(classmethod):
      __isabstractmethod__ = True
      ①
      def __init__(self, callable):
      callable.__isabstractmethod__ = True
      super().__init__(callable)
    2. 两个逻辑代码块之间应该保留一个空行,示例代码如下,其中①处是一个空行。
      def convert_timestamp(val):
      datepart, timepart = val.split(b" ")
      year, month, day = map(int, datepart.split(b"-"))
      timepart_full = timepart.split(b".")
      hours, minutes, seconds = map(int, timepart_full[0].split(b":"))
      if len(timepart_full) == 2:
          microseconds = int('{:0<6.6}'.format(timepart_full[1].decode()))
      else:
          microseconds = 0
      ①
      val = datetime.datetime(year, month, day, hours, minutes, seconds, microseconds)
      return val

      空格

代码中的有些位置是需要有空格的,这个工作量也很大。下面是使用空格的规范。

  1. 赋值符号“=”前后各有一个空格。
    a = 10
    c = 10
  2. 所有的二元运算符都应该使用空格与操作数分开。
    a += c + d
  3. 一元运算符:算法运算符取反“-”和运算符取反“\~”。
    b = 10
    a = -b
    y = \~b
  4. 括号内不要有空格,Python中括号包括:小括号“()”、中括号“[]”和大括号“{}”。

推荐:

doque(cat[1], {dogs: 2}, [])

不推荐:

doque(cat[ 1 ], { dogs: 2 }, [ ])

5.
不要在逗号、分号、冒号前面有空格,而是要在他们后面有一个空格,除非该符号已经是行尾了。

推荐:

if x == 88:
  print x, y
x, y = y, x

不推荐:

if x == 88 :
  print x , y
x , y = y , x
  1. 参数列表、索引或切片的左括号前不应有空格。

推荐:

doque(1)
dogs['key'] = list[index]

不推荐:

doque (1)
dict ['key'] = list [index]

缩进

4个空格常被作为缩进排版的一个级别。虽然在开发时程序员可以使用制表符进行缩进,而默认情况下一个制表符等于8个空格,但是不同的IDE工具中一个制表符与空格对应个数会有不同,所以不要使用制表符缩进。

代码块的内容相对于首行缩进一个级别(4个空格),示例如下:

class abstractclassmethod(classmethod):
    __isabstractmethod__ = True

    def __init__(self, callable):
        callable.__isabstractmethod__ = True
        super().__init__(callable)

def __new__(mcls, name, bases, namespace, **kwargs):
    cls = super().__new__(mcls, name, bases, namespace, **kwargs)
    for base in bases:
        for name in getattr(base, "__abstractmethods__", set()):
            value = getattr(cls, name, None)
            if getattr(value, "__isabstractmethod__", False):
                abstracts.add(name)
    cls.__abstractmethods__ = frozenset(abstracts)

    return cls

断行

一行代码中最多79个字符。对于文档注释和多行注释时一行最多72个字符,但是如何注释中包含URL地址可以不受这个限制。否则,如果超过则需断行,可以依据下面的一般规范断开:

  1. 在逗号后面断开。
    bar = long_function_name(name1, name2,
                         name3, name4)
    def long_function_name(var_one, var_two,
                       var_three, var_four):
  2. 在运算符前面断开。
    name1 = name2 * (name3 + name4
                         - name5) + 4 * name6
  3. 尽量不要使用续行符(\),当有括号(包括:大括号、中括号和小括号)则在括号中断开,这样可以不使用续行符。

    def long_function_name(var_one, var_two,
                       var_three, var_four):
    return var_one + var_two + var_three \  ①
           + var_four

name1 = name2 * (name3 + name4

  • name5) + 4 * name6

bar = long_function_name(name1, name2,
name3, name4)

foo = {
long_dictionary_key: name1 + name2

  • name3 + name4 - name5
    }

c = list[name2 * name3

  • name4 - name5 + 4 * name6]
    上述代码第①行使用了续航符进行断行,其他的断行都是在括号中实现的,所以省略了续行符。有时为了省略续行符,会将表达式用小括号包裹起来,如下代码所示:
    ```python
    def long_function_name(var_one, var_two,
                       var_three, var_four):
    return (var_one + var_two + var_three 
           + var_four)

    提示
    在Python中反斜杠(\)可以作为续行符使用,告诉解释器当前行和下一行是连接在一起的。但如果在大括号、中括号和小括号中续行是隐式的。

本章小结

通过对本章内容的学习,读者可以了解到Python编码规范,包括命名规范、注释规范、导入规范和代码排版等内容。

配套视频

http://edu.51cto.com/topic/1507.html

配套源代码

http://www.zhijieketang.com/group/8

电子书

https://yuedu.baidu.com/ebook/5823871e59fafab069dc5022aaea998fcc2240fc

作者微博:@tony_关东升br/>邮箱:eorient@sina.com智捷课堂微信公共号:zhijieketangPython读者服务QQ群:628808216

相关文章
相关标签/搜索