cobramod.visualization.pair
===========================

.. py:module:: cobramod.visualization.pair


Exceptions
----------

.. autoapisummary::

   cobramod.visualization.pair.FoundInPairError


Classes
-------

.. autoapisummary::

   cobramod.visualization.pair.PairDictionary


Module Contents
---------------

.. py:exception:: FoundInPairError

   Bases: :py:obj:`Exception`


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


.. py:class:: PairDictionary(pair = None, **kwargs)

   Bases: :py:obj:`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.


   .. py:method:: set_pair(pair)

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