########################
wardrobe's documentation
########################

wardrobe is a Python project that provides a stack-based datastructure:
:py:class:`StackedDict`.

:py:class:`StackedDict` is a dictionary-like object with additional methods to
save the current state (commit) and restore it (reset).

.. doctest::

  >>> from wardrobe import StackedDict
  >>> clark = StackedDict(top='blue bodysuit', bottom='red underpants',
  ...                     sex_appeal=True)
  >>> clark['bottom']
  'red underpants'
  >>> clark['friend'] = 'Lois'
  >>> dict(clark) == {'top': 'blue bodysuit',
  ...                 'bottom': 'red underpants',
  ...                 'friend': 'Lois',
  ...                 'sex_appeal': True}
  True
  >>> clark.commit()  # doctest: +ELLIPSIS
  <wardrobe.stackeddict.StackedDict object at 0x...>
  >>> clark.update({'top': 'shirt', 'bottom': 'jeans', 'head': 'glasses'})
  >>> del clark['sex_appeal']
  >>> dict(clark) == {'top': 'shirt',
  ...                 'bottom': 'jeans',
  ...                 'head': 'glasses',
  ...                 'friend': 'Lois'}
  True
  >>> clark.reset()  # doctest: +ELLIPSIS
  <wardrobe.stackeddict.StackedDict object at 0x...>
  >>> dict(clark) == {'top': 'blue bodysuit',
  ...                 'bottom': 'red underpants',
  ...                 'friend': 'Lois',
  ...                 'sex_appeal': True}
  True


********
Contents
********

.. toctree::
   :maxdepth: 2

   INSTALL
   api/index
   about/index
   dev


**********
Ressources
**********

* `online documentation <http://wardrobe.readthedocs.org>`_
* `PyPI page <http://pypi.python.org/pypi/wardrobe>`_
* `code repository <https://github.com/benoitbryon/wardrobe>`_
* `bugtracker <https://github.com/benoitbryon/wardrobe/issues>`_


******************
Indices and tables
******************

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`