Skip to main content

flake8 plugin which makes sure that __init__ functions have a return type

Project description

PyPi pre-commit.ci status Build and Test codecov

flake8-init-return

flake8 plugin which forbids not having a return type on a class' __init__ function

installation

pip install flake8-init-return

flake8 codes

Code Description
FIR100 missing return value for initializer

rationale

As PEP-484 says, a class' __init__ functions ought to be annotated with -> None. This plugin makes sure that they are annotated, but it leaves up the type checking for another tool.

This might be useful when a type checker is not yet integrated into a project's development flow.

as a pre-commit hook

See pre-commit for instructions

Sample .pre-commit-config.yaml:

-   repo: https://github.com/pycqa/flake8
    rev: 3.8.1
    hooks:
    -   id: flake8
        additional_dependencies: [flake8-init-return==1.0.1]

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_init_return-1.0.1.tar.gz (3.2 kB view hashes)

Uploaded Source

Built Distribution

flake8_init_return-1.0.1-py2.py3-none-any.whl (3.7 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