Metadata-Version: 2.1
Name: flake8-pep604
Version: 0.1.0
Summary: flake8 plugin to enforce use of `|` over `typing.Union`
Home-page: https://gitlab.com/matthewhughes/flake-pep604
Author: Matthew Hughes
Author-email: matthewhughes934@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: flake8 (>=3.8)
Requires-Dist: importlib-metadata ; python_version < "3.8"

# flake8-pep604

flake8 plugin which forbids use of `typing.Union` (in favour of `|`), per [PEP
604](https://www.python.org/dev/peps/pep-0604/).

Note the `|` notation is a syntax error for Python \< 3.10. In this case you can
use the `annotations` feature (see [PEP 563](https://peps.python.org/pep-0563/)).

## flake8 Codes

| Code   | Description                                      |
|--------|--------------------------------------------------|
| UNT001 | Use `\|` in place of `typing.Union`. See PEP-604 |

## Motivation

Motivated by just wanting to make a codebase consistent in usage between
`typing.Union` and union types.

## Development

Get started by installing everything in a virtualenv

```
$ python -m .venv venv
$ pip install --requirement requirements-dev.txt
$ pre-commit install
```

Then testing:

```
$ pytest
```

And linting:

```
$ pre-commit run --all-files
```


