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 hashes)

Uploaded Source

Built Distribution

auto_optional-0.1.2-py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 3

Supported by

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