Skip to main content

Makes typed arguments Optional when the default argument is None

Project description

Logo

auto-optional: Makes typed arguments Optional when the default argument is None.

actions batch pypi python versions codecov License: MIT Code style: black


Documentation: auto-optional.daanluttik.nl

Source Code: github.com/luttik/auto-optional


Purpose

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):
    ...

Install

Install with pip install auto-optional.

Run

After installing you can run auto-optional using auto-optional [path] (path is an optional argument).

Properties

  • Existing imports are reused.
  • import as statements are properly handled.

Things of note

For all these points I welcome pull-requests.

  • There is no exclude (for file patterns) option yet
  • There is no ignore (for code lines) option yet
  • Code is aways read and written as UTF-8 (which is accurate most of the time).
  • There is no diff or check command yet for a dry-run or linting.

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

auto-optional-0.1.5.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

auto_optional-0.1.5-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file auto-optional-0.1.5.tar.gz.

File metadata

  • Download URL: auto-optional-0.1.5.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.8.11 Linux/5.8.0-1040-azure

File hashes

Hashes for auto-optional-0.1.5.tar.gz
Algorithm Hash digest
SHA256 fea308a12f02b56058eef95542908df34e3d138e447c7536e72a97e27012798d
MD5 2f82fe553b802d286a8cb52bc40dca7d
BLAKE2b-256 51c8655d55ea6570d6a5d93d2a96a274c2a01dbc681005c832e1604fa2d2639b

See more details on using hashes here.

File details

Details for the file auto_optional-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: auto_optional-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.8.11 Linux/5.8.0-1040-azure

File hashes

Hashes for auto_optional-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e406f433f1dde352ec20627aac8f4ac97d078dbcbbdc07ce0768c2c914f6b618
MD5 2587dc3ebcecd5d8d856d2485bc17e2f
BLAKE2b-256 07a9be11790e3996bfc5ee89cbb91151faf99ac07b356f90178fc3d034cdf44f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page