Start adding some typing and documentation #751
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
jorgensd
commented
Feb 23, 2025
| for i in all_tensor_factors: | ||
| if i.values.shape == sub_tbl.shape and np.allclose(i.values, sub_tbl): | ||
| tensor_factors.append(i) | ||
| for tensor_factor in all_tensor_factors: |
There was a problem hiding this comment.
@IgorBaratta Here i was redeclared (from line 5.18 enumerate), I assume that was a bug.
Do you agree?
mscroggs
reviewed
Mar 19, 2025
mscroggs
reviewed
Mar 19, 2025
mscroggs
reviewed
Mar 19, 2025
| @@ -246,7 +248,7 @@ def _analyze_form( | |||
|
|
|||
|
|
|||
| def _has_custom_integrals( | |||
| o: ufl.integral.Integral | ufl.classes.Form | list | tuple, | |||
| o: typing.Union[ufl.integral.Integral, ufl.classes.Form, list, tuple], | |||
There was a problem hiding this comment.
How was this not causing an error previously? Or is 3.9 not running on CI so we just weren't seeing the error?
Is it worth considering bumping the minimun version to 3.10 six months early so we can use |?
There was a problem hiding this comment.
I think it depends on what functions are typed. Mypy ignores that are typed (if they are within an untyped function signature).
mscroggs
approved these changes
Mar 19, 2025
Co-authored-by: Matthew Scroggs <matthew.w.scroggs@gmail.com>
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.
Start using
typing.Literalfor string-types, as there is so much implicit logic on the expected type.Also add some doc-strings when needed.