refactor: cobra.io.yaml #1152
Merged
refactor: cobra.io.yaml #1152
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
Midnighter
reviewed
Feb 17, 2022
src/cobra/io/yaml.py
Outdated
| class CobraYAML(YAML): | ||
| """Define custom subclass for YAML I/O.""" | ||
|
|
||
| def dump(self, data: Dict, stream: Optional[Any] = None, **kwargs: Any) -> str: |
There was a problem hiding this comment.
I think the type of stream can be https://docs.python.org/3/library/io.html#io.TextIOBase rather than Any.
There was a problem hiding this comment.
What about we use something more specific: https://docs.python.org/3/library/io.html#io.StringIO ?
There was a problem hiding this comment.
My thinking was that if someone passes a stream, it will not be StringIO but some other text stream. So it's a bit more broad to go with TextIOBase.
There was a problem hiding this comment.
Okay sounds fair. I'll change it.
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.
This PR adds typing annotations for cobra.io.yaml and its unit tests. It also upgrades the code style for them to maintain Python 3.6+ compatibility.