constantly._constants._ConstantsContainer : API documentation

_ConstantsContainer is a class with attributes used as symbolic constants. It is up to subclasses to specify what kind of constants are allowed.

Method	__new__	Classes representing constants containers are not intended to be instantiated.
Class Method	lookupByName	Retrieve a constant by its name or raise a `ValueError` if there is no constant associated with that name.
Class Method	iterconstants	Iteration over a `Names` subclass results in all of the constants it contains.
Class Variable	_constantType	Specified by a `_ConstantsContainer` subclass to specify the type of constants allowed by that subclass.
Class Variable	_enumerants	A `dict` mapping the names of constants (eg `NamedConstant` instances) found in the class definition to those instances.
Class Method	_constantFactory	Construct the value for a new constant to add to this container.

_constantType =

Specified by a _ConstantsContainer subclass to specify the type of constants allowed by that subclass.

_enumerants =

A dict mapping the names of constants (eg NamedConstant instances) found in the class definition to those instances.

def __new__(cls):

Classes representing constants containers are not intended to be instantiated.

The class object itself is used directly.

@classmethod
def _constantFactory(cls, name, descriptor):

Construct the value for a new constant to add to this container.

Parameters	name	The name of the constant to create.
	descriptor	An instance of a `_Constant` subclass (eg `NamedConstant`) which is assigned to `name`.
Returns	`NamedConstant` instances have no value apart from identity, so return a meaningless dummy value.

@classmethod
def lookupByName(cls, name):

Retrieve a constant by its name or raise a ValueError if there is no constant associated with that name.

Parameters	name	A `str` giving the name of one of the constants defined by `cls`.
Returns	The `NamedConstant` associated with `name`.
Raises	ValueError	If `name` is not the name of one of the constants defined by `cls`.

@classmethod
def iterconstants(cls):

Iteration over a Names subclass results in all of the constants it contains.

Returns an iterator the elements of which are the NamedConstant instances defined in the body of this Names subclass.

API Documentation for constantly, generated by pydoctor at 2016-05-30 18:36:47.

constantly._constants._ConstantsContainer(_ConstantsContainerType('', (object,), {})) class documentation