fix: fix argument and return value handling for get_by_id #1380
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
jgadling
changed the title
andy-sweet
approved these changes
Dec 6, 2024
There was a problem hiding this comment.
This fixes the issue for me and is probably the smallest possible change to fix, so approved. I would personally prefer that the template uses the exact same signature as the base class (i.e. def get_by_id(cls, client, id)), but maybe I'm not following the doc generation code carefully enough.
uermel
approved these changes
Dec 6, 2024
client/python/cryoet_data_portal/src/cryoet_data_portal/templates/Model.jinja2
Outdated
Show resolved
Hide resolved
| @@ -43,14 +43,14 @@ class {{ model.name }}(Model): | |||
| find.__func__.__doc__ = Model.find.__func__.__doc__ + find.__func__.__doc__ | |||
|
|
|||
| @classmethod | |||
| def get_by_id(cls, **kwargs): | |||
| def get_by_id(cls, *args, **kwargs): | |||
| """ | |||
| Examples: | |||
| Get an {{ model.name }} by ID: | |||
| >>> {{ model.model_name_underscores }} = {{ model.name }}.get_by_id(client, 1) | |||
There was a problem hiding this comment.
Also not a blocker, but we should find a way to insert class-specific IDs here. The id=1 will return None for almost every important model in the client, so these are not necessarily intuitive examples. I will create a ticket.
jgadling
pushed a commit
that referenced
this pull request
Dec 6, 2024
🤖 I have created a release *beep* *boop* --- ## [4.2.1](cryoet-data-portal-python-client-v4.2.0...cryoet-data-portal-python-client-v4.2.1) (2024-12-06) ### 🐞 Bug Fixes * fix argument and return value handling for get_by_id ([#1380](#1380)) ([2504e4d](2504e4d)) * Fix generated examples formatting ([#1369](#1369)) ([6cf8473](6cf8473)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.
Fix: #1379
We broke the interface for
get_by_idwhen improving the generated documentation for the client. This fixes the interface and adds a test.