7.1.1.4.1.7. cobramod.visualization.pair

7.1.1.4.1.7.1. Exceptions

FoundInPairError

Simple Error that is raised when the pair of a PairDictionary has already

7.1.1.4.1.7.2. Classes

PairDictionary

Dictionary that can include a pair (linked) dictionary. Both dictionaries

7.1.1.4.1.7.3. Module Contents

exception cobramod.visualization.pair.FoundInPairError

Bases: Exception

Simple Error that is raised when the pair of a PairDictionary has already given key name.

class cobramod.visualization.pair.PairDictionary(pair=None, **kwargs)

Bases: collections.UserDict

Dictionary that can include a pair (linked) dictionary. Both dictionaries cannot have the same keys. It is posible that only a dictionary is a PairDictionary, while the other a regular dictionary. The method :func:`cobramod.visualization.PairDictionary.set_pair’ sets the pair for the dictionary.

Parameters:

pair (Optional[collections.UserDict])

set_pair(pair)

Set new pair for the dictionary. If will search for conflicts and raise a FoundInPairError if both PairDictionary have common keys.

Parameters:

pair (collections.UserDict)