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.

Documentation: auto-optional.daanluttik.nl

Source Code: https://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.2.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.2-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: auto-optional-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 4a11afd3c0a6c8b8033fe8901b27dd16b7972db027e100560f6ba4bd9a369e48
MD5 066042007955876b5992797e44516e9c
BLAKE2b-256 6e78e579f9262a71728cba8ed86eddf1a94c611f340c63163c860c8ae2c81e20

See more details on using hashes here.

File details

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

File metadata

  • Download URL: auto_optional-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8b150eefec27973f8031a69dec8f2cce29257ea1fdb2c05dbe0bff75dd7a9033
MD5 8579c06b3197eacd88583807ca9905a0
BLAKE2b-256 994bff77af98d6dac0e4b4fc375ca59b8ef73432f14dec9c85d8957b77f1738f

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