djblets.util.symbols¶

Common symbols useful for function signatures.

New in version 3.3.

class UnsetSymbol(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: Enum

A type indicating an unsettable value.

This can be useful in functions that take default values to distinguish between a value not provided and a false/None value.

Changed in version 4.0: This is now an Enum, allowing values to be used in typing.Literal.

New in version 3.3.

UNSET: UNSET: '<UNSET>'>]] = UnsetSymbol.UNSET¶: An instance of a symbol indicating an unset value.

New in version 3.3.

Unsettable¶

A generic type alias for marking a type as unsettable.

This allows for usage like:

def __init__(
    self,
    value: Unsettable[str],
) -> None:
    ...

New in version 4.0.

alias of Union[Literal[<UnsetSymbol.UNSET: ‘<UNSET>’>], _T]