Allow docutils.readers.standalone.Reader.document to be a docutils.no… #14447
+2
−2
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
…des.document The use of this in docutils is not trivial but in testing I changed `document` to a property and created a setter and found that https://github.com/docutils/docutils/blob/9f04802532e77542c8edf6b7f4bf78bab141cf6e/docutils/docutils/readers/__init__.py#L103 was setting this as a `nodes.document`. Intuitively it likely is not always None, as well :) I am making this change because Sphinx sets this to a `nodes.document`.
This comment has been minimized.
This comment has been minimized.
|
The primer shows what I care about and I guess in Sphinx we can do an |
|
cc @donBarbos |
donBarbos
reviewed
Jul 24, 2025
There was a problem hiding this comment.
Indeed, you're right. Thank you.
But to be honest, I don't like any of the approaches, because the problem is in Sphinx itself, it often redefines attributes :-)
I've never contributed there, but I hope more warnings will encourage them to be more careful with attributes
donBarbos
approved these changes
Jul 24, 2025
|
Diff from mypy_primer, showing the effect of this PR on open source code: sphinx (https://github.com/sphinx-doc/sphinx)
- sphinx/io.py:100:16: error: Incompatible return value type (got "None", expected "document") [return-value]
+ sphinx/io.py:100:16: error: Incompatible return value type (got "document | None", expected "document") [return-value]
|
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.
…des.document
The use of this in docutils is not trivial but in testing I changed
documentto a property and created a setter and found that https://github.com/docutils/docutils/blob/9f04802532e77542c8edf6b7f4bf78bab141cf6e/docutils/docutils/readers/__init__.py#L103 was setting this as anodes.document.Intuitively it likely is not always None, as well :)
I am making this change because Sphinx sets this to a
nodes.document- see sphinx-doc/sphinx#13634.