Typed nodes and edges #1820
Merged
Typed nodes and edges #1820
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
doctrino
force-pushed
the
writable-typed-node-edges
branch
from
a148128
to
6626e78
Compare
erlendvollset
approved these changes
Jun 19, 2024
|
Would be great with an example in the docs aswell! |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1820 +/- ##
==========================================
+ Coverage 92.68% 92.75% +0.06%
==========================================
Files 121 122 +1
Lines 17950 18188 +238
==========================================
+ Hits 16637 16870 +233
- Misses 1313 1318 +5
|
doctrino
commented
Jul 1, 2024
| @@ -389,7 +401,16 @@ def __contains__(self, attr: str) -> bool: | |||
| self.__raise_if_non_singular_source(attr) | |||
|
|
|||
| def dump(self, camel_case: bool = True) -> dict[str, Any]: | |||
| dumped = super().dump(camel_case) | |||
There was a problem hiding this comment.
We cannot call the default dump method, as the TypedNode/Edge, will have properties directly on the class, which the default method just serialize in place.
The contained type was being inferred as Any
They only make sense if doing retrieving raw Nodes and Edges
Generic parameters and defaults don't mix well (see python/mypy#3737) so we need to use overloads instead, or InstancesResult is always InstancesResult[Any, Any]. Overloads don't work on retrieve() due to defaults and ordering of params, so we create two new methods that can be safely typed.
Then we can at least stay consistent within the DM client
doctrino
commented
Jul 2, 2024
| @@ -77,54 +70,6 @@ def __init__( | |||
| self.description = description | |||
|
|
|||
|
|
|||
| class DataModelingInstancesList(WriteableCogniteResourceList, Generic[T_WriteClass, T_WritableCogniteResource], ABC): | |||
There was a problem hiding this comment.
Probably need to add an alias here.
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.
Description
Please describe the change you have made.
Checklist:
If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.