👌 Add warning log for config values that cannot be cached #12203
Conversation
This file contains 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
picnixz
requested changes
Mar 26, 2024
Co-authored-by: Bénédikt Tran <[email protected]>
chrisjsewell
commented
Mar 26, 2024
picnixz
reviewed
Mar 26, 2024
chrisjsewell
commented
Mar 27, 2024
|
The test failures appear to be unrelated to this PR, or perhaps a result of poor test isolation? edit: commented out the test and it is still failing, so seems some side-effect of the latest python release: |
This reverts commit 3ac2e15.
picnixz
reviewed
Mar 27, 2024
For posterity: python/cpython#115913 |
picnixz
approved these changes
Mar 27, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
As a user and/or extension developer, it can be a source of confusion when, on performing a
sphinx-buildon a cached project, an unchanged configuration variable is always marked as changed (which then triggers a full rebuild).This is often due to the variable being an unpicklable value, like a function, which is silently omitted from the cache (i.e. the
environment.pickle).This PR introduces a specific warning for when a configuration variable is omitted from the cache, allowing users to understand the root of the problem.