Skip to main content

Utility functions to unwrap Optional values

Project description

unopt: Utility functions to unwrap Optional[T]

Overview

unopt provides several utility functions to "unwrap" the Optional[T] (or T | None) objects: removes the Optional type hint and obtains the underlying object.

unopt functions are inspired by the Rust's Option<T> functionality, but the behavior is tuned to Python's convention. E.g., unwrap() raises an exception instead of aborting.

Install

pip install unopt

Examples

from unopt import *

foo: Optional[int] = 123
bar: Optional[int] = None

# unwrap() returns the given object if it is not None.
assert unwrap(foo) == 123
unwrap(bar)  # Raises UnwrapError

# unwrap_or() returns the default value if the given object is None.
assert unwrap_or(foo, 456) == 123
assert unwrap_or(bar, 456) == 456

# unwrap_or_else() returns the default value obtained by invoking the given function.
assert unwrap_or_else(foo, lambda: 456) == 123
assert unwrap_or_else(bar, lambda: 456) == 456

# unwrap_unchecked() just casts the given object without value checking.
assert unwrap_unchecked(foo) == 123
assert unwrap_unchecked(bar) is None  # Unsafe

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

unopt-0.2.0.tar.gz (3.8 kB view hashes)

Uploaded Source

Built Distribution

unopt-0.2.0-py3-none-any.whl (3.8 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