https://github.com/shaharazulay/traceable-dict

Traceable Python dictionary, that stores change history in an efficient way inside the object.
https://github.com/shaharazulay/traceable-dict

diff-algorithm metaprogramming python-dic tree-structure

Last synced: 14 days ago
JSON representation

Traceable Python dictionary, that stores change history in an efficient way inside the object.

• Host: GitHub
• URL: https://github.com/shaharazulay/traceable-dict
• Owner: shaharazulay
• License: bsd-3-clause
• Created: 2018-08-08T08:06:54.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-17T14:09:45.000Z (over 6 years ago)
• Last Synced: 2024-11-10T13:49:25.246Z (2 months ago)
• Topics: diff-algorithm, metaprogramming, python-dic, tree-structure
• Language: Python
• Size: 440 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: docs/README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
TraceableDict

============

**Traceable Python dictionary, that stores change history in an efficient way inside the object.**

.. image:: _static/logo.jpg

Shahar Azulay, Rinat Ishak

|Travis|_ |Codecov|_ |Python27|_ |Python35|_ |License|_

.. |License| image:: https://img.shields.io/badge/license-BSD--3--Clause-brightgreen.svg

.. _License: https://github.com/shaharazulay/traceable-dict/blob/master/LICENSE

   

.. |Travis| image:: https://travis-ci.org/shaharazulay/traceable-dict.svg?branch=master

.. _Travis: https://travis-ci.org/shaharazulay/traceable-dict

.. |Codecov| image:: https://codecov.io/gh/shaharazulay/traceable-dict/branch/master/graph/badge.svg

.. _Codecov: https://codecov.io/gh/shaharazulay/traceable-dict

    

.. |Python27| image:: https://img.shields.io/badge/python-2.7-blue.svg

.. _Python27:

.. |Python35| image:: https://img.shields.io/badge/python-3.5-blue.svg

.. _Python35:

    

.. |Documentation| image:: _static/readthedocs_logo.jpg

.. _Documentation: https://traceable-dict.readthedocs.io/en/latest/

|Documentation|_

**Usage Examples:**

  Create a traceable dictionary 

   

        >>> from traceable_dict import TraceableDict

        >>> d1 = {'old_key': 'old_value'}

        >>> D1 = TraceableDict(d1)

        >>> D1

        {'old_key': 'old_value', '__trace__': {}, '__revisions__': []}

        >>> D1.revisions

        []

        

  Commit the dictionary for the first time

        

        >>> D1.has_uncommitted_changes

        True

        >>>

        >>> D1.commit(revision=1)

        >>> D1

        {'old_key': 'old_value', '__trace__': {}, '__revisions__': [1]}

        >>> D1.revisions

        [1]

        >>> D1.has_uncommitted_changes

        False

        

  Update the dictionary while tracing the changes

  

        >>> D1['new_key'] = 'new_value'

        >>> D1.trace

        {'_uncommitted_': [(('_root_', 'new_key'), None, '__a__')]}

        >>> D1.has_uncommitted_changes

        True

        >>> D1.commit(revision=2)

        >>> D1.trace

        {'2': [(('_root_', 'new_key'), None, '__a__')]}

        >>> D1.has_uncommitted_changes

        False

        >>> D1.revisions

        [1, 2]

  Checkout previous revisions

        >>> D1.as_dict()

        {'old_key': 'old_value', 'new_key': 'new_value'}

        >>>

        >>> D_original = D1.checkout(revision=1)

        >>> D_original.as_dict()

        {'old_key': 'old_value'}