馃敡 Centralise access to sphinx-needs config #998
Merged
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
danwos
approved these changes
Aug 28, 2023
chrisjsewell
added a commit
that referenced
this pull request
Aug 29, 2023
This PR adds strict typing to most of the package, building on #987 and #998 to try to confine use of dynamic types to a small surface area. This hopefully makes it easier for developers to navigate the code base, and lessens the potential for bugs arising from type mismatches. --- There are still some open questions, particularly around `NeedsInfoType`, which 1. has some dynamic fields (such as user defined links/options) and, 2. has some fields which are only set after post-transforms (such `process_need_nodes`)
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.
similar to #987, accessing sphinx-needs configuration via the sphinx
Configobject is difficult to work with and ensure type safety, due to its dynamic nature.This PR moves all configuration specification to the
NeedsSphinxConfigclass, which is a thin wrapper around the sphinxConfig, to define and provide type safe access to the sphinx-need specific configuration.This is non-breaking change, since all configuration can still be accessed via the sphinx
Config, (although this is discouraged).