justvanrossum / jundo Goto Github PK

• A set of functions to be exported by the jundo library:
  • makeUndoProxy(obj, changeMonitor) -> UndoProxy
  • recordChanges(proxy, **kwargs) context manager
  • undoChanges(proxy)
  • redoChanges(proxy)
  • undoInfo(proxy)
  • redoInfo(proxy)

The idea is that the UndoManager becomes invisible, and that everything is managed via the proxy object – you'd only ever need to keep a reference to the proxy object.

Usage example:

>>> from jundo import makeUndoProxy, recordChanges, undoChanges, redoChanges
>>> model = [1, 2, 3, {"a": 123}]
>>> proxy = makeUndoProxy(model)
>>> with recordChanges(proxy, title="replace list item"):
...     proxy[1] = 2000
...
>>> model[1]
2000
>>> undoChanges(proxy)
>>> model[1]
2
>>> redoChanges(proxy)
>>> model[1]
2000
>>> with recordChanges(proxy, title="replace nested dict item"):
...     proxy[3]["a"] = 456
...
>>> model[3]["a"]
456
>>> undoChanges(proxy)
>>> model[3]["a"]
123

Adding the functions can be done without changing anything about the rest of the code. Perhaps they should even be added to __init__.py and not undoManager.py.