Makes typed arguments Optional when the default argument is None
Project description
Auto-optional
auto-optional: Makes typed arguments Optional when the default argument is None.
Documentation: auto-optional.daanluttik.nl
Source Code: github.com/luttik/auto-optional
What does auto-optional do
The basic purpose of auto-optional is ensuring that whenever a default argument is None
the type annotation is Optional.
For example:
def foo(bar: str = None):
...
Would turn into
from typing import Optional
def foo(bar: Optional[str] = None):
...
Why would you want this
- Easily modify external libraries that didn't pay attention to proper use of optional to improve mypy linting.
- Force consistency in your own code-base:
Enforcing that
None
parameter implies anOptional
type.
Install
Install with pip install auto-optional
.
Run
After installing you can run auto-optional using auto-optional [path]
(path is an optional argument).
Things of note
Things that are handled well
- Existing imports are reused.
import as
statements are properly handled.
Things that need improvement
For all these points you can leave a thumbs-up if you want it. Also, I welcome pull-requests for these issues.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for auto_optional-0.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4a1dd563fd80143a911ddda881987d7a14acaea10eaab28316ec47660792bde |
|
MD5 | 7bdd27df42717e145c4da09909f06677 |
|
BLAKE2b-256 | f7b8e25427fab8959504b848b525fd39360564992936be27cecd4f4bb2c5782a |