Fix a test failure caused by an internal docutils open() call
#332
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
docutils 0.22 introduced an RST stylesheet feature that must be able to open files during RST-to-HTML rendering. The original design of the `test_cli_explicit_format` test patched `pathlib.Path.open()` so it would always return the same open file instance...which was always closed on first use. This caused a failure when docutils tried to open `minimal.css`: ``` ValueError: I/O operation on closed file. ``` This change introduces a more complex mocking strategy that documents and meets the current technical requirements.
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.
docutils 0.22 introduced an RST stylesheet feature that must be able to open files during RST-to-HTML rendering.
The original design of the
test_cli_explicit_formattest patchedpathlib.Path.open()so it would always return the same open file instance...which was always closed on first use. This caused a failure when docutils tried to openminimal.css:This change introduces a more complex mocking strategy that documents and meets the current technical requirements.
When combined with #328, the full test suite will now pass.
Note
It may be worthwhile to consider using the pyfakefs plugin, and pytest's capsys, to simplify some of the mocking and patching used in the test suite.