🔧 Centralise sphinx env data access (and add schemas)
#987
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
chrisjsewell
changed the title
env data access (and add schemas)
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.
The sphinx-needs data stored on the Sphinx
BuildEnvironmentis currently difficult to interpret and work with,since the dynamic nature of
BuildEnvironmentprovides no type safety or static introspection.This PR intends to centralise access to sphinx-needs data, via
sphinx_needs.data.SphinxNeedsData, which is a thin wrapper around the sphinxBuildEnvironment, to define and provide type safe access to the sphinx-need specific data.TypedDict are used to type annotate the dictionary keys for the different data types,
and thus
sphinx_needs.dataessentially provides a schema for the data that sphinx-needs stores.This is a non-breaking change, since all data can still be accessed via the sphinx
BuildEnvironment, (although this is now discouraged).Note, this is intended as a step toward making the package type checked, since at present, although mypy is used, almost every module is set to be ignored (see
pyproject.toml)