Access and modify Maya undo queues

Question

are there any ways in which I could access/ edit the undo queue?

The reason I asked is because, in my current tooling, I created the following in one of my renaming function (where you double click on the QListWidgetItem, input in a new name and cmds.rename will be using the new input name):

cmds.undoInfo(chunkName='renameChunk', openChunk=True)
# do cmds.rename operations
cmds.undoInfo(chunkName='renameChunk', closeChunk=True)

However, if I am trying to do an undo function (ctrl+z) to revert back the naming, I need to hit the key combination a couple of times instead of the expected 1 time. And while printing out the undo queue, I noticed that there are a lot of 'blank' entries which could be the cause of the multiple undos.

...
# 39:  # 
# 40:  # 
# 41:  # 
# 42:  # 
# 43: renameChunk # 
# 44:  # 
# 45:  # 
# 46:  # 
# 47:  # 
# 48:  # 
# 49:  #

I had the same issue, I just did bare with the multiple undo blank entry..... — DrWeeny, Jul 10 '19 at 03:48
Can you replicate this with a simple example? It works as expected here. Is it doing something else other than `rename` in-between `undoInfo`? — Green Cell, Jul 10 '19 at 06:26
@GreenCell I think I may have got it. It seems that in my tool where I am creating groups, constraints, parenting etc. these actions are not collated as one and right now, I am commenting out as I go through my code, to see what could have been causing these 'blank' entries — Teh Ki, Jul 12 '19 at 01:27

Green Cell · Accepted Answer · 2019-07-12T05:57:44.607

I'm going to supply an answer since what you're doing is a bit risky. Right now you're assuming cmds.undoInfo(chunkName='renameChunk', closeChunk=True) WILL run, though if an error occurs in-between the line will never be executed and you will be left with an open undo chunk.

A safer approach would be to open an undo chunk, then wrap your code in a try finally. This way no matter what happens you can be assured that the chunk will close in the finally block:

cmds.undoInfo(chunkName='renameChunk', openChunk=True)
try:
    raise RuntimeError("Oops!")
finally:
    cmds.undoInfo(closeChunk=True)  # This will still execute.

Alternatively you can be a bit more fancier and create your own undo class and utilize its __enter__ and __exit__ special methods:

class UndoStack(object):

    def __init__(self, name="actionName"):
        self.name = name

    def __enter__(self):
        cmds.undoInfo(openChunk=True, chunkName=self.name, infinity=True)

    def __exit__(self, typ, val, tb):
        cmds.undoInfo(closeChunk=True)

with UndoStack("renameChunk"):  # Opens undo chunk.
    raise RunTimeError("Oops!")  # Fails
# At this point 'with' ends and will auto-close the undo chunk.

As long as you do it this way you shouldn't have all these blank undo calls (at least I don't!). Though do try to keep it compact, so open up an undo chunk, do the work, then immediately close it. Avoid straying off to do other stuff like managing your gui or something.

Thanks for the info. I saw the latter one that you have did - `contextmanager`. While that does seems to work for me too, there are still 1 or 2 which are seemingly 'blank' entries.. Currently working out line by line to try and narrow down which methods in my code are causing them — Teh Ki, Jul 15 '19 at 23:54

Access and modify Maya undo queues

1 Answers1