Make components dicts public attributes of Components class#634
Merged
Conversation
Bangertm
approved these changes
Feb 5, 2021
Collaborator
Bangertm
left a comment
Bangertm
left a comment
There was a problem hiding this comment.
Looks good to me. No issue making these public that I can see.
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 allows the caller to check a component is already registered. For instance to avoid registering it several times.
I could try/except but I think exceptions are more suited for... exceptions. If testing is the normal flow (because the code is expected to run several time and only register once) I think the try/except method does not express the intent.
Another reason is that even in apispec itself,
_schemasis accessed from another class.flask-smorest auto registers default responses when a response contains a name from
http.HTTPStatus. I'd like to allow the user to register his own response and only register a default response if he didn't. There my code needs to register the response only if it is not in components.schemas and it is a pity to keep track of which is registered in another list. More on this in marshmallow-code/flask-smorest#208. This use case is not that important. I just don't see why those should be private.