Skip to main content

Flake8 plugin to enforce the new Union and Optional annotation syntax defined in PEP 604

Project description

flake8-new-union-types

Build Status PyPI PyPI - Python Version PyPI - License

Flake8 plugin to enforce the new Union and Optional annotation syntax defined in PEP 604.

Union[X, Y] = X | Y

Optional[X] = X | None

Note that it's impossible to use forward references in the new syntax, like this:

"X" | int

such a case can be expressed as a string containing both union terms:

"X | int"

Installation

pip install flake8-new-union-types

or if you use poetry:

poetry add --dev flake8-new-union-types

Usage

Error list

  • NU001 Use Foo | Bar syntax instead of Union (PEP 604)
  • NU002 Use Foo | None syntax instead of Optional (PEP 604)
  • NU003 Present the whole expression as a string to annotate forward refs, e.g. "int | Foo" (PEP 604)

Configuration

There is no way to configure the plugin at the moment.

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-new-union-types-0.4.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

flake8_new_union_types-0.4.0-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file flake8-new-union-types-0.4.0.tar.gz.

File metadata

File hashes

Hashes for flake8-new-union-types-0.4.0.tar.gz
Algorithm Hash digest
SHA256 0d969f547f7d8d48bf5fc6e8339c4843f9f1e7950d98a92f28e45cf2faeebf84
MD5 85c4659888be4507d02514f48f1de4e6
BLAKE2b-256 109ec9d4c64404b1a44c3c8fde9a8c6bd0808d1761de1a7671eae4f257dcffb1

See more details on using hashes here.

File details

Details for the file flake8_new_union_types-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for flake8_new_union_types-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e751c212185ce4d0f32d79b041822157fe554a368329f6a058c8affe39d5b4ec
MD5 12673e48e65cdab34dbcb88733165c16
BLAKE2b-256 b275a0f64eb2ac4da3f5c3df05a186c59ea87a82d0db617d9d4784c9b4d492d3

See more details on using hashes here.

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