Use StrEnums instead of str for generated constant classes in the ASF APIs
#11176
Conversation
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
dfangl
commented
Jul 10, 2024
| @@ -315,10 +315,11 @@ def get_order(self): | |||
|
|
|||
|
|
|||
| def generate_service_types(output, service: ServiceModel, doc=True): | |||
| output.write("from datetime import datetime\n") | |||
There was a problem hiding this comment.
I moved this line so it has the right order from the beginning. I know our formatting will reorder it anyway, but why should it need to :P
dfangl
commented
Jul 11, 2024
Comment on lines
+520
to
+521
| def get_class_attrs_from_spec_class(spec_class: type[StrEnum]) -> set[str]: | ||
| return {str(spec) for spec in spec_class} |
There was a problem hiding this comment.
This is the only actual code change necessary, which iterates over the classes, now an enum.
alexrashed
approved these changes
Jul 11, 2024
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.
Motivation
Currently, the scaffolding currently translates the
StringShapes from the botocore specs to enum string classes, for example:The issue here, from a type checking perspective, is that the values, for example Architecture.x86_64, are not of type Architecture, they are simple strings:
for example, returns:
This is not really an issue for production - they are strings, and the exact type does not really matter after it is serialized anyway. However, when developing, we are hit with fun IDE warnings and mypy also reports it as an error:
Mypy error:
My proposed solution would be to switch those types to StrEnum, a new type of enum introduced with python3.11 (https://docs.python.org/3/library/enum.html#enum.StrEnum). It is only applicable for code not used by the CLI, but our API scaffolds should not be imported from the CLI.
A StrEnum is both an instance of str and enum, and more importantly, the members are also a type of the respective class.
Also, the dunder str and repr methods are those of string, therefore it should be interchangable (we will see how the testing of this PR works out).
Changes
StrEnuminstead ofstrfor generated APIStringShapes, which will lead to correct types for the enum members.