:mod:`memote.suite.results.history_manager`
===========================================

.. py:module:: memote.suite.results.history_manager

.. autoapi-nested-parse::

   Provide a history manager that integrates with a git repository.

   ..
       !! processed by numpydoc !!



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

Classes
~~~~~~~

.. autoapisummary::

   memote.suite.results.history_manager.HistoryManager



.. py:class:: HistoryManager(repository, manager, **kwargs)

   Bases: :class:`object`

   Manage access to results in the commit history of a git repository.














   :Attributes:

       **manager** : memote.RepoResultManager
           The manager for accessing individual results.

       **current** : str
           The name of the currently active branch.


   ..
       !! processed by numpydoc !!

   .. method:: build_branch_structure(self, model, skip)

      Inspect and record the repo's branches and their history.
















      ..
          !! processed by numpydoc !!


   .. method:: iter_branches(self)

      Iterate over branch names and their commit histories.
















      ..
          !! processed by numpydoc !!


   .. method:: iter_commits(self)

      Iterate over all commit hashes in the repository.
















      ..
          !! processed by numpydoc !!


   .. method:: load_history(self, model, skip=('gh-pages', ))

      Load the entire results history into memory.

      Could be a bad idea in a far future.















      ..
          !! processed by numpydoc !!


   .. method:: get_result(self, commit, default=None)

      Return an individual result from the history if it exists.
















      ..
          !! processed by numpydoc !!


   .. method:: __contains__(self, commit)

      Test for the existence of a result for a commit.
















      ..
          !! processed by numpydoc !!