👌 Add type warnings of extra options in external/import reads #1389
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
Currently, the value of all extra options is expected to be a string; other types are not supported in other aspects of sphinx-needs, such as `needextend` and dynamic functions. This PR adds the `needs. mistyped_external_values ` and `needs.mistyped_import_values` warnings for non-string values, for `needs_external_needs` and `needimport` sources respectively. The warning is only emitted once per source, to avoid creating too many warnings. Note, in the future it is likely that more types will be supported via configuration in `needs_extra_options` (see #1338)
chrisjsewell
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1389 +/- ##
==========================================
+ Coverage 86.87% 88.00% +1.12%
==========================================
Files 56 60 +4
Lines 6532 7142 +610
==========================================
+ Hits 5675 6285 +610
Misses 857 857
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
chrisjsewell
changed the title
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.
Currently, the value of all extra options is expected to be a string; other types are not supported in various aspects of sphinx-needs (such as
needextend, dynamic functions and filtering), and in-fact are already silently converted to strings during processing,see:
sphinx-needs/sphinx_needs/api/need.py
Line 791 in 92b47b1
This PR adds the
needs.mistyped_external_valuesandneeds.mistyped_import_valueswarnings for non-string values, forneeds_external_needsandneedimportsources respectively. The warning is only emitted once per source, to avoid creating too many warnings.Note, in the future it is hoped that more types will be supported via configuration in
needs_extra_options(see #1338)