ebb-lint 0.19.1.0

L1: 文档字符串

L101

类的方法 __init__ 不应包含文档字符串，因为按照 标准的 Sphinx 风格，应将此信息放在类的文档字符串中。

L102

文档字符串的格式错误。单行文档字符串应类似于这样

def func():
    """Spam eggs."""

多行文档字符串应类似于这样

def func():
    """
    Spam eggs.

    Also, sausage.
    """

L103

测试文档字符串（即名称以 test_ 开头的函数或方法的文档字符串）不得以任何形式的“test”、“verify”或“ensure”开头。

L104

文档字符串必须使用 Napoleon，而不是 reStructuredText 字段。

L2: 有疑义的语法

Python 的某些功能弊大于利。这些错误在程序员可能有意做某事但意外做错了的情况下捕获潜在问题。

L201

容器字面量必须跟在最后一个元素后面有一个逗号。如果关闭的 )、] 或 } 与最后一个元素在同一行上，则不会发出此错误。

L202

print 除了调试外不允许使用。对于生产代码，日志记录更加灵活和可预测。这可以在 一次性脚本 中禁用。

L203

pdb 和兼容的模块（即暴露 set_trace 函数的模块）除了调试外不允许使用。如果允许在生产代码中使用 set_trace 调用，可能会阻塞进程。

L204

隐式字符串字面量连接（即 'spam' 'eggs' 等价于 'spameggs'）仅允许在连接的每个字符串都被括号包围时使用，并且括号中只包含字符串字面量。

这没问题

some_string = ('spam {} '
               'eggs').format('spam')

但这不行

some_list = [
    'spam'
    'eggs',
    'sausage',
]

L205

__init__.py 不允许包含函数或类定义。

L206

隐式相对导入 不允许。

L207

pass 仅在包含没有其他语句的非可选块中是必要的。如果块中包含其他语句，添加 pass 是多余的。文档字符串算作一个语句。

非可选块是例如 def、class 和 if 的块。 else 和 finally 块是可选的，因此这种情况永远不会必要

if predicate():
    do_something()
else:
    pass

try:
    do_something()
finally:
    pass

L208

处理Pokémon异常总是错误的。如果真的想要捕获并忽略异常，应明确指定要静音的异常类型。

L209

return、del、raise、assert、print（在Python 2中，没有 print_function）yield 和 yield from 都是语句，而不是函数，因此不需要括号。

这没问题

return (
  a
  + b)

但这不行

return(a + b)

L210

而不是有意依赖map、filter或列表推导式的副作用，应该写一个明确的for循环。

这没问题

for x in y:
    print(x)

但这不行

map(print, y)

L211

使用map或filter与lambda作为第一个参数总是更好写成列表推导式或生成器表达式。表达式更易读、更易扩展，并且不太重要，不会产生太多的函数调用开销。

L212

使用@staticmethod总是错误的。最常见的情况有两种：

• 想要对类做些事情，但不需要实例，在这种情况下，@classmethod是正确的解决方案。

• 想要在类上‘命名空间’一个函数，但这不是Java，所以将其作为模块作用域的函数。

单独使用staticmethod没有问题；这对于测试目的完全是可以接受的。

from some_module import do_some_more_io, some_io


def do_io():
    return some_io()


class Spam(object):
    do_io = staticmethod(do_io)
    do_some_more_io = staticmethod(do_some_more_io)

L3: 格式化

L301

文件必须以换行符结尾。

L302

行太长了。

超过hard-max-line-length（这被认为是“硬限制”，默认为119列）的行是不允许的。如果行包含超过一定百分比的字符串字面量或注释，则允许超过max-line-length（这被认为是“软限制”，默认为79列）。这两个百分比不合并。允许的“一定百分比”是permissive-bulkiness-percentage，默认为67%。

对于以下所有示例，软限制为15列，硬限制为25列。

不允许，因为，在20个字符时，该行超过了软限制，整个行只占字符计数的15%字符串字面量。

ultradignified = 'y'

允许，因为整个行占字符计数的80%是字符串字面量。

t = 'electroplating'

允许，因为整个行占字符计数的75%是注释。

f()  # accreditation

不允许，因为整个行占字符计数的20%是注释和50%是字符串字面量，并且这两个都不是或超过67%。

d = 'smallpox'  # ok

不允许，因为整个行长为26个字符，超过了硬限制。

thyroparathyroidectomize()

hard-max-line-length 和 permissive-bulkiness-percentage 可以配置；请参阅配置部分。

L303

noqa 被忽略，因此应删除 # noqa 注释以减少无用的噪音。