sphinx.util.logging: Make write() methods return int #13595
Closed
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
AA-Turner
reviewed
Jun 3, 2025
Comment on lines
+586
to
594
| def write(self, data: str) -> int: | ||
| try: | ||
| self.stream.write(data) | ||
| return self.stream.write(data) | ||
| except UnicodeEncodeError: | ||
| # stream accept only str, not bytes. So, we encode and replace | ||
| # non-encodable characters, then decode them. | ||
| self.stream.write( | ||
| return self.stream.write( | ||
| data.encode(self.encoding, 'replace').decode(self.encoding) | ||
| ) |
There was a problem hiding this comment.
@srittau what is the return value here meant to mean? In one branch it is the number of characters written, in the other it is the number of bytes. This doesn't make sense. Please can we keep None as a valid return value for the (small-p) protocol?
A
There was a problem hiding this comment.
The typing.Writer protocol (as well as the legacy typing.IO pseudo-protocol) require an int return type. If you keep the None type here, you will need to # type: ignore this.
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.
Purpose
In typeshed, we're currently switching from our old custom protocol
_typeshed.SupportsWriteto the newWriterprotocol (in Python 3.14'siomodule and backported totyping_extensionsstarting with 4.14.0). One incompatibility is thatWriter.write()expects anintreturn type, whileSupportsWrite.write()was usingobject. This leads to a few new type errors in Sphinx (as pointed out by mypy_primer).This PR fixes upcoming type check errors in Sphinx, but also makes the two logging writer classes more compatible by returning the number of written bytes from
write().Does this require an entry in
CHANGES.rstor are the classes in util internal-facing?References
See python/typeshed#14149 for background.