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.1.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for flake8-new-union-types-0.4.1.tar.gz
Algorithm Hash digest
SHA256 0a9dd421099f2525f8be525977ff6632b13b68719a7b0807cf49028d4287b0aa
MD5 46178a22294741328aaab3847643e075
BLAKE2b-256 0bf0b07ec2ded79aec3f95e676d5fbffc5c7e7ce6fe7640cd69d2ce109daca41

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flake8_new_union_types-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 92737a2f598772d5aedd05b5450c5dd200e0f1acd42b3c1f95dbbe3211af2009
MD5 8998712042619085f46be000278d683b
BLAKE2b-256 c32f487aeffaab826bb3d23b51c20059c5b9519bca456748652f536df274ac6f

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