Skip to main content

A flake8 plugin that helps you wrap code with visual balance.

Project description

flake8-balanced-wrapping

CircleCI

A flake8 plugin that helps you wrap code with visual balance.

The aim of this linter is to complement the use of developer-assistance python formatting tools, i.e: those where the developer remains in control of when to format code a particular way, while still enforcing a consistent style of how the code is formatted.

Style

The style which this linter checks for is one which aims for clarity and visual balance while reducing diff noise, without concern for vertical space. This is similar to the tuck wrapping tool.

As much as possible this linter will not duplicate checks provided by other plugins where they are are in agreement.

Example: Function definitions

# Unwrapped
def foo(bar: str, quox: int = 0) -> float:
    return 4.2

# Wrapped
def foo(
    bar: str,
    quox: int = 0,
) -> float:
    return 4.2

Example: List comprehension

# Unwrapped
[x for x in 'aBcD' if x.isupper()]

# Wrapped
[
    x
    for x in 'aBcD'
    if x.isupper()
]

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

flake8-balanced-wrapping-0.1.5.tar.gz (10.1 kB view hashes)

Uploaded Source

Built Distribution

flake8_balanced_wrapping-0.1.5-py2.py3-none-any.whl (10.1 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