no-optional

This codemod replaces typing.Optional[T] by typing.Union[T, None] in the codebase.

Why?

This tool was inspired by a tweet from Sebastián Ramírez (as you see below), and a conversation between us.

As the tweet says, we have two reasons for doing this:

It's more explicit to write Union[str, None] than Optional[str]. Mainly because Optional[str] doesn't mean that the attribute is optional. It only means that it accepts None as a possible value.
On Python 3.10+ you can type annotate as str | None instead of the above two. Which is more similar to Union[str, None] than Optional[str].

pip install no-optional

Run the following on the repository you want to format:

python -m no_optional <files>

You can also use the pre-commit. Add the following to your .pre-commit-config.yaml file:

  - repo: https://github.com/Kludex/no-optional
    rev: 0.4.0
    hooks:
      - id: no_optional

This project is licensed under the terms of the MIT license.

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Table of built distributions (wheels) for no-optional 0.4.0
File	Interpreter	ABI	Platform	Reset
no_optional-0.4.0-py3-none-any.whl 6.8 kB Jun 25, 2022	Python 3	none	any	Details

Download URL	no_optional-0.4.0-py3-none-any.whl
Size	6.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`d4a625f7abbbaeef3b77ed88f53a44134c6f2d5a365378bb4a0197d94b95c998`
BLAKE2b-256 checksum How to use checksums	`9a64b6d3d2e446c7c0b7d815359c2991724253be769a4e744ae4658a3caf8540`
Upload date	Jun 25, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.8.12`