Fix Drawing.undo() crash on empty or single-element drawings#99
Closed
leofernandezg wants to merge 1 commit intocdelker:masterfrom
Closed
Fix Drawing.undo() crash on empty or single-element drawings#99leofernandezg wants to merge 1 commit intocdelker:masterfrom
leofernandezg wants to merge 1 commit intocdelker:masterfrom
Conversation
undo() crashed with IndexError when the drawing had only one element (self.elements[-1] on empty list after pop), and with pop() error on empty drawings. Also crashed with AttributeError when fig was None (non-interactive mode). Guard against empty element list and None figure. Reset position to origin when all elements are removed. Added test/test_undo.py. Fixes cdelker#94
Author
Test suite resultsFull test suite (
The 38 pre-existing failures are in |
Author
|
Update: Re-ran the full test suite with all optional dependencies installed (matplotlib, ziamath, pyparsing).
No regressions introduced. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Drawing.undo()when the drawing has zero or one elementProblem
undo()had three failure modes:self.elements.pop(-1)raisesIndexErrorself.elements[-1].absdropraisesIndexErroron empty listself.fig.clear()raisesAttributeErrorbecausefigisNoneChanges
schemdraw/schemdraw.py: Guard against empty element list (early return), reset position to origin when all elements are removed, skip figure operations whenfigisNonetest/test_undo.py: New test file covering empty drawing, single element, and undo-then-add scenariosTest results
Without fix: 3 of 3 tests fail
With fix: 3 of 3 tests pass
Fixes #94