Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃攢馃敡 MERGE: Add strict typing for most sphinx_needs modules #1002

Merged
merged 29 commits into from Aug 29, 2023

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Aug 28, 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)

@chrisjsewell chrisjsewell changed the title 馃敡 Add strict typing for sphinx_needs.diagrams_common 馃敡 Add strict typing for more sphinx_needs modules Aug 28, 2023
@chrisjsewell
Copy link
Member Author

Will be fixed by #1003

@chrisjsewell chrisjsewell marked this pull request as draft August 28, 2023 10:07
@chrisjsewell chrisjsewell force-pushed the typing-2 branch 3 times, most recently from de0767a to e369be1 Compare August 28, 2023 13:26
@chrisjsewell chrisjsewell force-pushed the typing-2 branch 2 times, most recently from e1ce09d to b1dfc11 Compare August 28, 2023 22:48
@chrisjsewell chrisjsewell changed the title 馃敡 Add strict typing for more sphinx_needs modules 馃敡 Add strict typing for most sphinx_needs modules Aug 29, 2023
@chrisjsewell chrisjsewell marked this pull request as ready for review August 29, 2023 08:53
@chrisjsewell chrisjsewell changed the title 馃敡 Add strict typing for most sphinx_needs modules 馃攢馃敡 MERGE: Add strict typing for most sphinx_needs modules Aug 29, 2023
@chrisjsewell chrisjsewell merged commit 00e6afb into master Aug 29, 2023
10 checks passed
@chrisjsewell chrisjsewell deleted the typing-2 branch August 29, 2023 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants