Add type annotation for on_space parameter #605
Merged
Conversation
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
nkoskelo
requested review from
adhumu,
tjproct and
coreyostrove
and removed request for
a team
nkoskelo
changed the title
nkoskelo
changed the title
rileyjmurray
requested changes
Aug 1, 2025
There was a problem hiding this comment.
The current changes have __init__.py do a relative import, from .typing import SpaceT, from the new file pygsti/typing.py The fact that this is a relative import is easy to miss and led me to think that SpaceT was a built-in type of some kind. I'd prefer that __init__.py just define SpaceT directly, and that we remove pygsti/typing.py.
@nkoskelo, if you're strongly opposed to that approach, then let's change the name of pygsti/typing.py to pgsti/pgtypes.py or pygsti/pygtypes.
rileyjmurray
approved these changes
Aug 4, 2025
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.
When one asks for a dense representation of a
modelmemberviato_dense(on_space=?), there are 3 options that theon_spaceparameter accepts,Hilbert,HilbertSchmidtandminimal. However, when one is coding, editors will not populate these options unless there is a type annotation on the parameteron_space. This could lead to unintended behavior, if there is a misspelling for instance. The methodto_sparse(on_space=?)also has this problem.