Add type annotations on input and return values#73
Open
einarwar wants to merge 1 commit into
Open
Conversation
einarwar
commented
Nov 7, 2025
| dev = [ | ||
| "ruff", | ||
| "pytest", | ||
| "typing-extensions>=4.15.0", |
Author
There was a problem hiding this comment.
typing.Self was not added until python 3.11, so to be able to support 3.10 this dependency is needed
einarwar
commented
Nov 7, 2025
| CorrelationType = Literal["pearson", "spearman"] | ||
| CorrelatorType = Literal["cholesky", "imanconover", "permutation", "composite"] | ||
| SamplingMethodType = Literal["lhs", "halton", "sobol"] | ||
| DistributionType = Literal[ |
Author
There was a problem hiding this comment.
This list is probably longer, i just added the types i found being used in the repo
einarwar
commented
Nov 7, 2025
Comment on lines
-33
to
+45
| import numpy as np | ||
| import scipy as sp | ||
| import abc | ||
| import dataclasses | ||
|
|
||
| import contextlib | ||
| import os | ||
| import dataclasses | ||
| import itertools | ||
| import os | ||
| from collections.abc import Iterable, Iterator | ||
| from typing import Any | ||
|
|
||
| import numpy as np | ||
| import scipy as sp | ||
| from typing_extensions import Self | ||
|
|
||
| from probabilit.types import Array1D, Array2D, CorrelationType |
Author
There was a problem hiding this comment.
I see that my IDE automatically sorted the imports. I see you already are using ruff, so it might be a good idea to enable the I (isort) rule as well
einarwar
force-pushed
the
add-type-annotations
branch
from
772ada5 to
d29cff8
Compare
einarwar
force-pushed
the
add-type-annotations
branch
2 times, most recently
from
efe976f to
280c90d
Compare
Author
|
@tommyod i updated this recently. Please let me know if you want to reduce the amount of type annotations to just public functions |
einarwar
force-pushed
the
add-type-annotations
branch
from
280c90d to
fd0d0b3
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #72
This PR adds type annotations for all input arguments and return values for all functions and methods.
I might not have gotten the correct types in all functions, so please correct me if there is anything wrong. There is currently limited typing capabilities in numpy out of the box, but saying if it is a 1d array (
np.ndarray[tuple[int], np.float64]) or 2D-array (np.ndarray[tuple[int, int], np.float64]) is pretty valuable, so i added a new file calledtypes.pyto contain typing constructs. I also added some string literals for various functions/methods that accept only certian string values.