Define a LineWriter type for use in OutputWriter#2335
Open
sirosen wants to merge 1 commit intojazzband:mainfrom
Open
Define a LineWriter type for use in OutputWriter#2335sirosen wants to merge 1 commit intojazzband:mainfrom
sirosen wants to merge 1 commit intojazzband:mainfrom
Conversation
To abstract away the distinction between writing lines in dry-run mode and non-dry-run mode, define a small protocol for a "line writer" which takes and emits lines of text as `str`s. This idea originates in jazzband#1696 , but was not completed at the time. On review, the change is perfectly sound and can be implemented with some slightly clearer types using a protocol to define the interface common to the two codepaths. The abstraction improves readability, especially by moving a `finally` block into a contextmanager `__exit__` function. Co-authored-by: Thomas Grainger <413772+graingert@users.noreply.github.com>
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
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.
closes #1696
Hat tip to @graingert for the original! I'm just carrying it over the finish line.
Because this is primarily a readability edit of existing logic, I have not included a changelog or new tests. (Open to changing upon request/feedback.)
To abstract away the distinction between writing lines in dry-run mode
and non-dry-run mode, define a small protocol for a "line writer" which
takes and emits lines of text as
strs.This idea originates in #1696 , but was not completed at the time. On
review, the change is perfectly sound and can be implemented with some
slightly clearer types using a protocol to define the interface common to
the two codepaths.
The abstraction improves readability, especially by moving a
finallyblock into a context manager
__exit__function.Contributor checklist
changelog.d/(seechangelog.d/README.mdfor instructions) or the PR text says "no changelog needed".
Maintainer checklist
bot:chronographer:skiplabel.(following Semantic Versioning).