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.4.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.4-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: auto-optional-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 cc88f0dde2838f1c501be65229b0a75dc96e5fce3acbbe558f76c67962cba361
MD5 b73b7c82ecf2b20cbb2e37b1de1b3529
BLAKE2b-256 16c908266e789af6c9c47aa617fab3cf6c2eec058f2a083274f9ab7dd5bd55d0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: auto_optional-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 37a91efc8d6aa0671e2ae32884240dd39a40a79afda384fd9bb24cf0dd7dbe23
MD5 b7bf6966b9b3ad9f4ab56ca6a64ab12f
BLAKE2b-256 def6339446e151ad7620e6ab7775b508f20f842dcbe7b78b381a59d7419fdc22

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