Coala的CodeStyle¶

科拉跟随着 PEP8 codestyle 最大行长为80个字符(包括换行符)。调用 coala 让它自动更正您的代码。

其他样式指南¶

文档注释¶

文档注释由换行符分隔的两部分组成：

对其功能的描述
它接受的参数及其描述、它提供的返回值以及可能引发的异常的列表

文档字符串开始和结束的第一行和最后一行不应写入任何内容，文档注释中的每条消息都必须以句号结尾。另外，所有参数、返回值和引发的错误的描述都应该在换行符上，缩进4个空格。

例子：

def area(length, breadth):
    """
    Finds the area of a rectangle of the given length and breadth.

    :param length:
        The length of the rectangle.
    :param breadth:
        The breadth of the rectangle.
    :return:
        The area of the rectangle.
    :raises ValueError:
        Raises ValueError if the arguments are not of type
        ``float`` or ``int``.
    """

如果参数或其他关键字的描述超过1行，请在下一行中继续。确保第二行在第一行以下对齐。

类型检查¶

如果要确保参数具有特定类型，可以使用 enforce_signature 装饰符，并简单地用允许的类型注释您的函数：

@enforce_signature
def concatenate_strings(a: str, b: str, c: (str, None)=None):
    if c is None:
        c = ""
    return a + b + c

这将提高 TypeError 如果 a 或 b 不是字符串或 c 不是字符串，也不是 None .

行延续¶

由于PEP8编码风格指南不包括行延续，因此您应该保留多行列表、字典、元组、函数定义、函数调用以及任何此类结构：

保持在线状态
跨多行，每行列出一个参数/项

Fork me on GitHub