Skip to main content

lint for ensuring quality software

Project description

https://img.shields.io/travis/flowroute/ebb-lint/master.svg?style=flat-square https://img.shields.io/coveralls/flowroute/ebb-lint/master.svg?style=flat-square https://img.shields.io/pypi/v/ebb-lint.svg?style=flat-square https://img.shields.io/pypi/format/ebb-lint.svg?style=flat-square https://img.shields.io/pypi/pyversions/ebb-lint.svg?style=flat-square https://img.shields.io/pypi/l/ebb-lint.svg?style=flat-square

ebb-lint

It’s a flake8 plugin! It lints for style problems! All you have to do to activate it is:

$ pip install ebb-lint

Configuration

Configuration does nothing but cause bugs or laxness, so ebb-lint has none.

If, however, one is writing a one-off script and wishes to use print against ebb-lint‘s wishes, a comment can be added to the top of the file to disable that warning:

# I sincerely swear that this is one-off code.

This comment must be above any statements in the code (including docstrings), on a line by itself.

Errors

All of the possible errors, organized by category:

L1: Docstrings

L101

The __init__ method of classes must not have a docstring, as it is standard sphinx style to put that information on the class docstring.

L102

A docstring was incorrectly formatted. Single-line docstrings must resemble this:

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

Multi-line docstrings must resemble this:

def func():
    """
    Spam eggs.

    Also, sausage.
    """
L103

A test docstring (i.e. the docstring on a function or method with a name starting with test_) must not start with any form of the words “test”, “verify”, or “ensure”.

L104

Docstrings must use Napoleon, not reStructuredText fields.

L2: Dubious syntax

Some features of python do more harm than good. These errors catch potential problems in situations where the programmer might have intended to do one thing, but accidentally did something else instead.

L201

Container literals must have a trailing comma following the last element. If the closing ), ], or } is on the same line as the last element, this error is not emitted.

L202

print is not allowed except for debugging. For production code, logging is much more flexible and predictable. This can be disabled in one-off scripts.

L203

pdb and compatible modules (i.e. modules exposing a set_trace function) are not allowed except for debugging. If a set_trace call was allowed into production, it would likely wedge the process.

L204

Implicit string literal concatenation (i.e. 'spam' 'eggs' being isomorphic to 'spameggs') is only allowed if every string being concatenated is parenthesized, and the parentheses contain nothing but string literals.

This is okay:

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

And this is not:

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

__init__.py is not allowed to contain function or class definitions.

L206

Implicit relative imports are not allowed.

L207

pass is only necessary in non-optional suites containing no other statements. If a suite contains another statement, adding pass is redundant. Docstrings count as a statement.

Non-optional suites are the suites of, for example, def, class, and if. else and finally suites are optional, and as such this is never necessary:

if predicate():
    do_something()
else:
    pass

try:
    do_something()
finally:
    pass
L208

Pokémon exception handling is always a mistake. If you really intend to catch and ignore exceptions, explicitly name which exception types you wish to silence.

L209

return, del, raise, assert, print (in python 2, without print_function) yield, and yield from are statements, not functions, and as such, do not require parentheses.

This is okay:

return (
  a
  + b)

And this is not:

return(a + b)
L210

Instead of intentionally relying on the side effects of map, filter, or a comprehension, write an explicit for loop.

This is okay:

for x in y:
    print(x)

And this is not:

map(print, y)

L3: Whitespace

L301

Files must end with a trailing newline.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ebb-lint-0.3.8.tar.gz (13.4 kB view hashes)

Uploaded Source

Built Distribution

ebb_lint-0.3.8-py2.py3-none-any.whl (18.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page