Internal Development Interface

Package frigid.__

Common constants, imports, and utilities.

Module frigid.__.imports

Common imports used throughout the package.

Module frigid.__.nomina

Common names and type aliases.

type frigid.__.nomina.ComparisonResult = bool | builtins.NotImplementedType
type frigid.__.nomina.NominativeArguments = collections.abc.Mapping[str, typing_extensions.Any]
type frigid.__.nomina.PositionalArguments = collections.abc.Sequence[typing_extensions.Any]
type frigid.__.nomina.ClassDecorator = collections.abc.Callable[[type[frigid.__.nomina.U]], type[frigid.__.nomina.U]]
type frigid.__.nomina.ClassDecorators = collections.abc.Sequence[collections.abc.Callable[[type[frigid.__.nomina.U]], type[frigid.__.nomina.U]]]
type frigid.__.nomina.ClassDecoratorFactory = collections.abc.Callable[..., collections.abc.Callable[[type[frigid.__.nomina.U]], type[frigid.__.nomina.U]]]
type frigid.__.nomina.ModuleReclassifier = collections.abc.Callable[[collections.abc.Mapping[str, typing_extensions.Any]], None]
type frigid.__.nomina.DictionaryNominativeArgument = frigid.__.nomina.V
type frigid.__.nomina.DictionaryPositionalArgument = collections.abc.Mapping[frigid.__.nomina.H, frigid.__.nomina.V] | collections.abc.Iterable[tuple[frigid.__.nomina.H, frigid.__.nomina.V]]
type frigid.__.nomina.DictionaryValidator = collections.abc.Callable[[frigid.__.nomina.H, frigid.__.nomina.V], bool]
frigid.__.nomina.calculate_attrname(level, core)
Parameters:
Return type:

str

frigid.__.nomina.is_public_identifier(name)

Is Python identifier public?

Parameters:

name (str)

Return type:

bool

Module frigid.__.exceptions

Family of exceptions for package internals.

exception frigid.__.exceptions.EntryImmutability(indicator)

Bases: Omnierror, TypeError

Attempt to update or remove immutable dictionary entry.

exception frigid.__.exceptions.Omnierror(*posargs, **nomargs)

Bases: Omniexception, Exception

Base for error exceptions raised internally.

exception frigid.__.exceptions.Omniexception(*posargs, **nomargs)

Bases: Object, BaseException

Base for all exceptions raised internally.

exception frigid.__.exceptions.OperationInvalidity(name)

Bases: Omnierror, RuntimeError, TypeError

Attempt to perform invalid operation.

Module frigid.__.dictionaries

Internal dictionary.

class frigid.__.dictionaries.ImmutableDictionary(*iterables, **entries)

Bases: dict[_H, _V], Object, Generic[_H, _V]

Immutable subclass of dict.

Can be used as an instance dictionary.

Prevents attempts to mutate dictionary via inherited interface.

clear()

Raises exception. Cannot clear immutable entries.

Parameters:

self

Return type:

typing_extensions.Never

copy()

Provides fresh copy of dictionary.

Parameters:

self

Return type:

typing_extensions.Self

pop(key, default=absence.absent)

Raises exception. Cannot pop immutable entry.

Parameters:

  • self

  • key (frigid.__.dictionaries._H)

  • default (frigid.__.dictionaries._V | absence.objects.AbsentSingleton)

Return type:

typing_extensions.Never

popitem()

Raises exception. Cannot pop immutable entry.

Parameters:

self

Return type:

typing_extensions.Never

update(*iterables, **entries)

Raises exception. Cannot perform mass update.

Parameters:

  • self

  • iterables (collections.abc.Mapping[ frigid.__.dictionaries._H, frigid.__.dictionaries._V ] | collections.abc.Iterable[ tuple[ frigid.__.dictionaries._H, frigid.__.dictionaries._V ] ]) – Zero or more iterables from which to initialize dictionary data. Each iterable must be dictionary or sequence of key-value pairs. Duplicate keys will result in an error.

  • entries (frigid.__.dictionaries._V) – Zero or more keyword arguments from which to initialize dictionary data.

Module frigid.__.doctab

Docstrings table for reuse across entities.

frigid.__.doctab.fragments: collections.abc.Mapping[str, str] = mappingproxy({'cfc class conceal': ' By default, conceals non-public class attributes. ', 'cfc class protect': ' By default, protects class attributes. ', 'cfc dynadoc': ' Applies Dynadoc decoration to classes. ', 'cfc instance conceal': ' Produces classes which can conceal instance attributes. ', 'cfc instance protect': ' Produces classes which can protect instance attributes. ', 'cfc produce abstract base class': ' Produces abstract base classes compatible with :py:class:`abc.ABCMeta`.\n    ', 'cfc produce dataclass': ' Produces inheritable dataclasses with keyword-only instantiation. ', 'cfc produce protocol class': ' Produces :pep:`544` protocol classes. ', 'class concealment': ' By default, non-public class attributes are invisible. ', 'class protection': ' By default, class attributes are immutable. ', 'class instance conceal': ' By default, conceals non-public instance attributes. ', 'class instance protect': ' By default, protects instance attributes. ', 'dataclass': ' Inheritable dataclass with keyword-only instantiation. ', 'protocol class': ' Protocol class (:pep:`544`). Nominal and structural subtyping. ', 'class dynadoc': ' Is decorated by Dynadoc. ', 'dictionary entries protect': ' Protects dictionary entries on initialization. ', 'dictionary entries validate': ' Validates dictionary entries on initialization. ', 'module': ' Python module class, derived from :py:class:`types.ModuleType`. ', 'module conceal': ' By default, conceals non-public module attributes. ', 'module protect': ' By default, protects module attributes. ', 'namespace': ' Namespace object, modeled after :py:class:`types.SimpleNamespace. '})