MAINT: Add _exception_on_warning to MockApp #586
Merged
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
MockApp in test suite is now breaking due to the absence of a private _exception_on_warning attribute. Fix by explicitly adding to the MockApp.
|
I believe this fix is the right and pragmatic approach. Sphinx is not designed with the possibility in mind that you replace the centrall components. Therefore, the inner APIs are a bit lax, which makes mocking difficult. As long as such a change is a rare event, updating the mock is the simplest way forward. If this happens more often, we'd need to go into the discussion with Sphinx how to handle the case. |
larsoner
approved these changes
Oct 17, 2024
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.
The test suite has started failing with:
This started happening with the release of sphinx 8.1, and from a quick look at the changelog is likely related to sphinx-doc/sphinx#12743.
Since the failures are only related to the existence of attributes on a
MockAppobject used to simulate a sphinx-app instance in the numpydoc test suite, it should be okay to just patch the mocked object with the missing attr.