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

Uploaded Python 3

File details

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

File metadata

  • Download URL: auto-optional-0.1.5a1.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.5a1.tar.gz
Algorithm Hash digest
SHA256 141bd1a20ea91955d6ff1c00e18e46d713be12e4560d1d95c84ac49cca9ab345
MD5 4469e1b943469911d926e555a27bfee2
BLAKE2b-256 6482f9d0fbda30bcf64dc0288d183d3189dd5a00603369fda72e9b2d9ea1856e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: auto_optional-0.1.5a1-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.5a1-py3-none-any.whl
Algorithm Hash digest
SHA256 e00a316fd53e6040c446df9e12ff5f3846d2b7c1fd48ad44eadfa4a9f2fec121
MD5 cad003d2cf6c9f468d04e11c0918db97
BLAKE2b-256 07cc4e2231912e5d094f6924909d00399edbd148e1a4bbcde27a9d6812014d65

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