Auto generate code for resource objects #42
Merged
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
github-actions
bot
added
dependencies
ojkoenig
approved these changes
Sep 6, 2022
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.
With this approach, we get a more accessible (in-code) and PyAnsys-compliant doc
and code completion
Not to mention that the tedious code for the resource objects is automatically generated. In the future, we could consider extracting the schema from the openapi spec.
As an alternative (or next-step) approach, we could consider replacing
marshmallowwithpydantic, which has a nice command-line utility to generate pydantic models from an openapi spec. Moving to pydantic would allow to merge schema and resource objects (example for JMS here). However, it requires some more work to fit some of our cases (ParameterDefinition objects, load_only attributes, equivalent of marshmallow missing).