semvec/pypi-packages huggingface dataset:
flake8-init-return 1.0.1
flake8 plugin which makes sure that __init__ functions have a return type
License: MIT
Requires Python: >=3.8

[![PyPi](https://img.shields.io/pypi/v/flake8-init-return.svg)](https://pypi.python.org/pypi/flake8-init-return/)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/keller00/flake8-init-return/main.svg)](https://results.pre-commit.ci/latest/github/keller00/flake8-init-return/main)
[![Build and Test](https://github.com/keller00/flake8-init-return/actions/workflows/test.yml/badge.svg)](https://github.com/keller00/flake8-init-return/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/keller00/flake8-init-return/branch/main/graph/badge.svg)](https://codecov.io/gh/keller00/flake8-init-return)

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](https://peps.python.org/pep-0484/) 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](https://github.com/pre-commit/pre-commit) for instructions

Sample `.pre-commit-config.yaml`:

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