feat(nodes): improve types in graph.py #5656
Merged
Conversation
This file contains 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
psychedelicious
requested review from
Kyle0654,
blessedcoolant,
brandonrising and
hipsterusername
as code owners
github-actions
bot
added
python
psychedelicious
force-pushed
the
feat/nodes/graph-method-types
branch
from
ac82b28
to
d7ead66
Compare
maryhipp
approved these changes
Feb 9, 2024
hipsterusername
approved these changes
Feb 13, 2024
Methods `get_node` and `complete` were typed as returning a dynamically created unions `InvocationsUnion` and `InvocationOutputsUnion`, respectively. Static type analysers cannot work with dynamic objects, so these methods end up as effectively un-annotated, returning `Unknown`. They now return `BaseInvocation` and `BaseInvocationOutput`, respectively, which are the superclasses of all members of each union. This gives us the best type annotation that is possible. Note: the return types of these methods are never introspected, so it doesn't really matter what they are at runtime.
hipsterusername
force-pushed
the
feat/nodes/graph-method-types
branch
from
d7ead66
to
db924b9
Compare
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.
What type of PR is this? (check all applicable)
Description
Methods
get_nodeandcompletewere typed as returning a dynamically created unionsInvocationsUnionandInvocationOutputsUnion, respectively.Static type analysers cannot work with dynamic objects, so these methods end up as effectively un-annotated, returning
Unknown.They now return
BaseInvocationandBaseInvocationOutput, respectively, which are the superclasses of all members of each union. This gives us the best type annotation that is possible.Note: the return types of these methods are never introspected, so it doesn't really matter what they are at runtime.
Merge Plan
This PR can be merged when approved