♻️ Improve access to dynamic configs: extra_options, functions, warnings #1332
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
These three configurations are complicated by the fact that they can be set both in the `conf.py` configuration, but also via functions from `sphinx_needs.api`. This has lead to confusion, when to use `NEEDS_CONFIG` and when to use `NeedsSphinxConfig` (which I have already had to fix numerous bugs for) In this PR we make split access to these configs into: - `NeedsSphinxConfig._extra_options`, `NeedsSphinxConfig._functions`, `NeedsSphinxConfig._warnings`, which access the "raw" sphinx configuration - `NeedsSphinxConfig.extra_options`, `NeedsSphinxConfig.functions`, `NeedsSphinxConfig.warnings`, which access the "combined" sphinx config + API added values
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1332 +/- ##
==========================================
+ Coverage 86.87% 88.02% +1.14%
==========================================
Files 56 60 +4
Lines 6532 7034 +502
==========================================
+ Hits 5675 6192 +517
+ Misses 857 842 -15
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
These three configurations are complicated by the fact that they can be set both in the
conf.pyconfiguration, but also via functions fromsphinx_needs.api.This has lead to confusion, when to use
NEEDS_CONFIGand when to useNeedsSphinxConfig, and indeed I have already had to fix numerous bugs whenNeedsSphinxConfigwas incorrectly usedIn this PR we split access to these configs into:
NeedsSphinxConfig._extra_options,NeedsSphinxConfig._functions,NeedsSphinxConfig._warnings, which access the "raw" sphinx configurationNeedsSphinxConfig.extra_options,NeedsSphinxConfig.functions,NeedsSphinxConfig.warnings, which access the "combined" sphinx config + API added valuesWe also make
NEEDS_CONFIGprivate and merge in the use ofNEEDS_FUNCTIONS.This makes the code less prone to mistakes in the use of the wrong variable