CAS-61 Make the APIClient return model objects #81
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
nmalfroy
force-pushed
the
nm-explicit-models
branch
2 times, most recently
from
751307c to
1a0bc2b
Compare
KevinCLydon
approved these changes
Sep 5, 2024
| Represents the data object returned by the CAS API for nearest neighbor annotations. | ||
| """ | ||
|
|
||
| class DatasetStatistics(BaseModel): |
There was a problem hiding this comment.
Possibly a dumb question: Are these classes nested because they are only used for fields of CellTypeSummaryStatisticsResults?
There was a problem hiding this comment.
Yeah that's exactly right
cellarium/cas/models.py
Outdated
| Represents the data object returned by the CAS API for a ontology-aware annotations. | ||
| """ | ||
|
|
||
| class Matches(BaseModel): |
There was a problem hiding this comment.
Does this class represent multiple matches or just one match? If it's just one match, could it be Match?
There was a problem hiding this comment.
Gah, you're totally right
cellarium/cas/models.py
Outdated
| (e.g. a query of the cell database using a matrix). | ||
| """ | ||
|
|
||
| class Matches(BaseModel): |
There was a problem hiding this comment.
Same question as the other Matches class
nmalfroy
force-pushed
the
nm-explicit-models
branch
2 times, most recently
from
03a54ff to
2ab94eb
Compare
nmalfroy
force-pushed
the
nm-explicit-models
branch
from
2ab94eb to
6e66f2d
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.
This PR makes it so that rather than returning
lists ofdicts, the API client will now return typed objects. This should make it much easier for users to develop against and understand the CAS api.Note: this is a breaking change! Results are returned in objects (as opposed to lists of objects) and the list is now in a field named
data. This is true for all of the types of enumerations that are returned.For instance, if an endpoint returns:
and is returned as object
foo,foo[0]will fail butfoo.datawill return the list of objects. Furthermore, since these are typed objects, they can't be accessed with subtypes but must be accessed by the variable name.For instance, in the example above,
foo.data[0]["query_cell_id"]will fail butfoo.data[0].query_cell_idwill return"1".The docs and example notebook were updated to reflect this