pak.util.misc¶

Miscellaneous utilities.

class UniqueSentinel(name=None)[source]¶

Bases: object

An object with a unique identity.

This is useful for e.g. default parameters that may have None as a valid value.

Parameters:

name (str or None) –

The name of the UniqueSentinel.

If None, then a default name is chosen.

Returned when repr() is used on the object, mainly for the purpose of better docs.

Examples

>>> import pak
>>> sentinel = pak.util.UniqueSentinel("SENTINEL")
>>> sentinel
SENTINEL
>>> unnamed = pak.util.UniqueSentinel()
>>> unnamed
UniqueSentinel