Adds the Optional type-hint to arguments where the default value is None
Project description
Auto-optional
auto-optional: adds the Optional type-hint to arguments where the default value 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.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f14de6cfe8eb870c912464419a366ab28c4136888a7bdac2c2d7bea9dc46223 |
|
MD5 | 4e6bb68ed34049312891c8d7e3d65a92 |
|
BLAKE2b-256 | a91a829a592c693dbf564c0e9332600c1096df7ba277301e15b5b0b30a336779 |