refactor: use typed namedtuples for the get_list page result #251
Merged
jooola merged 7 commits intohetznercloud:mainfrom Jul 21, 2023
Merged
refactor: use typed namedtuples for the get_list page result #251jooola merged 7 commits intohetznercloud:mainfrom
get_list page result #251jooola merged 7 commits intohetznercloud:mainfrom
Conversation
The `get_list` function returns a named tuple that always has the following structure `(result, meta)`. Since this is a tuple, we can unpack it without using the named attributes. This allows us to remove the `results_list_attribute_name` used to access the data in the tuple.
Unpack the page result tuple instead of accessing the data by attr name.
jooola
force-pushed
the
typed_page_result
branch
from
c00c6f1 to
7c5485b
Compare
jooola
commented
Jul 20, 2023
apricote
reviewed
Jul 21, 2023
apricote
approved these changes
Jul 21, 2023
This was referenced Jul 21, 2023
jooola
added a commit
that referenced
this pull request
May 7, 2025
The API specification now describe all meta/pagination fields as required, this PR updates the library to reflect that. Related #251
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.
This is a nice refactor that remove some magic from the
get_listmethods.The
get_listfunction returns a named tuple that always has the following structure(result, meta). Since this is a tuple, we can unpack it without using the named attributes, and remove theresults_list_attribute_nameattributes used to access the data inside the tuple.NamedTuplesclasses instead of dynamic (magic)namedtuplesfor theget_listPageResult. This will greatly improve the library typing definition.