Add type annotations for most of camera and mobject.graphing
#4125
Conversation
updates: - [github.com/astral-sh/ruff-pre-commit: v0.9.1 → v0.9.2](astral-sh/ruff-pre-commit@v0.9.1...v0.9.2)
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
henrikmidtiby
force-pushed
the
Typing_graphing_and_camera
branch
from
6b8f27d to
f767e8a
Compare
| return self.point_to_coords(point) | ||
|
|
||
| @staticmethod | ||
| def _origin_shift(axis_range: Sequence[float]) -> float: ... |
Check notice
Code scanning / CodeQL
Statement has no effect Note
| self.display_funcs: dict[ | ||
| type[Mobject], Callable[[list[Mobject], PixelArray], Any] | ||
| ] = { | ||
| VMobject: self.display_multiple_vectorized_mobjects, # type: ignore[dict-item] |
There was a problem hiding this comment.
I ended up using a type ignore statement here.
| assert isinstance(label_mob, VMobject) | ||
| label_mobs.add(label_mob) | ||
| parts.braces = braces | ||
| parts.labels = label_mobs | ||
| parts.label_kwargs = { | ||
| parts.braces = braces # type: ignore[attr-defined] | ||
| parts.labels = label_mobs # type: ignore[attr-defined] | ||
| parts.label_kwargs = { # type: ignore[attr-defined] |
There was a problem hiding this comment.
Here I chose to use an assert statement and a few type ignores.
| def __init__(self, function, x_range=None, color=YELLOW, **kwargs): | ||
| def __init__( | ||
| self, | ||
| function: Callable[[float], Any], |
There was a problem hiding this comment.
It's probably fine for now that function returns Any instead of float for compatibility with the parent class' function attribute. In a subsequent PR, there should be a rewrite such that FunctionGraph.function is different from ParametricFunction.function.
| tick_range, | ||
| unit_decimal_places=decimal_number_config["num_decimal_places"], | ||
| ) | ||
|
|
||
| self.add_labels( |
There was a problem hiding this comment.
It's strange that this wasn't autocollapsed by pre-commit into a single line like this:
self.add_labels(dict(zip(tick_range, custom_labels)))Co-authored-by: Francisco Manríquez Novoa <[email protected]>
Co-authored-by: Francisco Manríquez Novoa <[email protected]>
Co-authored-by: Francisco Manríquez Novoa <[email protected]>
Co-authored-by: Francisco Manríquez Novoa <[email protected]>
Co-authored-by: Francisco Manríquez Novoa <[email protected]>
Co-authored-by: Francisco Manríquez Novoa <[email protected]>
| # TODO: I think the method should be able to return more than just a single point. | ||
| # E.g. see the implementation of it on line 2065. |
There was a problem hiding this comment.
I think that this function (or rather its descendants) should be able to return more than a single point.
There was a problem hiding this comment.
That's actually correct. The Axes.coords_to_points() method I optimized in #3286 also uses that behavior. Thanks for reminding me of it.
This behavior is probably too complex to type for now, so let's leave the TODO there.
|
I took another look at the code and found a number of things that I wanted to change. See the last four commits. |
chopan050
changed the title
camera and mobject.graphing
| @@ -26,6 +28,12 @@ | |||
| def __init__(self, custom_labels: bool = False): | |||
| self.custom_labels = custom_labels | |||
|
|
|||
| @overload | |||
| def function(self, value: float) -> float: ... | |||
Check notice
Code scanning / CodeQL
Statement has no effect Note
| def function(self, value: float) -> float: ... | ||
|
|
||
| @overload | ||
| def function(self, value: np.ndarray) -> np.ndarray: ... |
Check notice
Code scanning / CodeQL
Statement has no effect Note
Overview: What does this pull request change?
Adding type annotations for files in mobject/graphing/.* and camera/.*