Replace assert False with KeyError in DAGCircuit methods#133
Merged
gecrooks merged 1 commit intogecrooks:mainfrom Dec 19, 2025
Merged
Replace assert False with KeyError in DAGCircuit methods#133gecrooks merged 1 commit intogecrooks:mainfrom
gecrooks merged 1 commit intogecrooks:mainfrom
Conversation
The next_element() and prev_element() methods used `assert False` to handle the case when no element is found. This is problematic because: 1. Assertions are disabled with `python -O` 2. AssertionError provides no diagnostic information Now raises KeyError with a descriptive message including the element and qubit being searched for. Also added docstrings for these methods. Fixes gecrooks#130
This was referenced Dec 29, 2025
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
assert Falsewith properKeyErrorexceptions innext_element()andprev_element()# DOCME TESTME)Problem
The methods used
assert Falseas error handling:This is problematic because:
-Odisables assertions, causing the function to returnNoneAssertionErrorwith no message provides no diagnostic informationFix
Now raises
KeyErrorwith descriptive message:Test plan
dagcircuit_test.pytests pass (includingtest_next_prev)Fixes #130