[v4.0] Update use of type annotations#1017
Merged
anoto-moniz merged 6 commits intorelease/v4.0from Feb 19, 2026
Merged
Conversation
As of python 3.9, the builtin classes can be used as type annotations, so there's no need to use the separate "typing" versions (which are also deprecated). Note that data_objects and predictor_evaluation retain List for now, as it conflicts with their definition of a method called "list".
As of python 3.10, unions can be expressed with the pipe (|) operator.
Clean up all the unused imports created by the previous two changes. It was easier to handle them all at once rather than as I went.
Many types introduced as type annotations in typing are now available for use from collections.abc. The typing versions are deprecated, so we switch to these newer versions. For us, this impacts Sequence, Iterator, Iterable, Callable, and (in one place) Collection.
kroenlein
reviewed
Feb 17, 2026
Collaborator
kroenlein
left a comment
kroenlein
left a comment
There was a problem hiding this comment.
I transformed a lot of Optional[x] to x | None, and there are a lot more left. Seems like it's the better pattern.
src/citrine/informatics/predictors/chemical_formula_featurizer.py
Outdated
Show resolved
Hide resolved
src/citrine/informatics/constraints/ingredient_ratio_constraint.py
Outdated
Show resolved
Hide resolved
src/citrine/informatics/constraints/ingredient_ratio_constraint.py
Outdated
Show resolved
Hide resolved
kroenlein
reviewed
Feb 17, 2026
Collaborator
kroenlein
left a comment
kroenlein
left a comment
There was a problem hiding this comment.
I transformed a lot of Optional[x] to x | None, and there are a lot more left. Seems like it's the better pattern.
kroenlein
approved these changes
Feb 19, 2026
Collaborator
kroenlein
left a comment
kroenlein
left a comment
There was a problem hiding this comment.
Additional minor clerical fixes.
| if not isinstance(element_types, Iterable): | ||
| raise ValueError("element types must be iterable: {}".format(element_types)) | ||
| self.element_types: typing.List[Property, ...] = \ | ||
| self.element_types: list[Property, ...] = \ |
Collaborator
There was a problem hiding this comment.
Suggested change
| self.element_types: list[Property, ...] = \ | |
| self.element_types: list[Property] = \ |
| if not isinstance(element_types, list): | ||
| raise ValueError("element types must be a list: {}".format(element_types)) | ||
| self.element_types: typing.List[Property, ...] = \ | ||
| self.element_types: list[Property, ...] = \ |
Collaborator
There was a problem hiding this comment.
Suggested change
| self.element_types: list[Property, ...] = \ | |
| self.element_types: list[Property] = \ |
Collaborator
Author
From the description of the PR above:
|
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
2 participants
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.
A handful of updates and improvements came into type annotations in Python 3.9 and 3.10. The ones most relevant to us are the introduction of
|for union types, the ability to use builtin classes as annotations (i.e.list), and the deprecation of a handful of types intypingin favor of referencing them incollections.abc.We could also replace our usages of
Optional[T]withT | None, but the latter syntax doesn't seem as clear to me.We're also clear to start using match statements and the dictionary update operator, it's just harder to identify opportunities for them without knowing where to look.
Note: a couple classes (namely
DataConceptsCollectionandPredictorEvaluationCollection) still have methods that returnList. It seems thelistmethod defined inCollectionis conflicting with the built-in in those cases. I'm not sure why, but will be investigating in a follow-up.PR Type:
Adherence to team decisions