Description of proposed feature
There should be a clear type guide for which types to prefer in manim. There are a lot of ways to type things for example Optional[int] and int | None are the same thing when considering a linter like mypy, but they convey a different story when reading. For parameters if something has the type Optional it's very clear that this parameter can be left out safely and the rest is handled by the function itself.
This also reflects itself inside the function when reading the typehints, where the error messages state that the type is Optional and thus things like x.something don't work. This is also the case with int | None (it translates to Union[int, None] but it suggests that this variable can be in general a None value and also might just be changed back to one during the lifetime of the Object.
That's why i think we need to discuss a clear typeguide for manim and also have some kind of suggestions and help regarding typing.
I also would suggest the addition of a type module for Custom types needed in the future like the Color type which currently is str | Color, but this might be an addition for another day. But could also be discussed here if we need some standard types.
| V1 |
V2 |
We use! |
Optional[T] |
T | None |
- |
ndarray |
NDArray[dtype] |
- |
List[T] |
list[T] |
- |
Type[cls] |
type[cls] |
- |
Union[T,K] |
T | K |
- |
New Types in question
TimeBasedUpdater = Callable[["Mobject", float], None]NonTimeUpdater = Callable[["Mobject"], None]Updater = Union[TimeBasedUpdater, NonTimeUpdater]ManimColor = Union[str, Color]
Related to
Description of proposed feature
There should be a clear type guide for which types to prefer in manim. There are a lot of ways to type things for example
Optional[int]andint | Noneare the same thing when considering a linter like mypy, but they convey a different story when reading. For parameters if something has the typeOptionalit's very clear that this parameter can be left out safely and the rest is handled by the function itself.This also reflects itself inside the function when reading the typehints, where the error messages state that the type is
Optionaland thus things likex.somethingdon't work. This is also the case withint | None(it translates toUnion[int, None]but it suggests that this variable can be in general a None value and also might just be changed back to one during the lifetime of the Object.That's why i think we need to discuss a clear typeguide for manim and also have some kind of suggestions and help regarding typing.
I also would suggest the addition of a type module for Custom types needed in the future like the Color type which currently is
str | Color, but this might be an addition for another day. But could also be discussed here if we need some standard types.Optional[T]T | NonendarrayNDArray[dtype]List[T]list[T]Type[cls]type[cls]Union[T,K]T | KNew Types in question
TimeBasedUpdater = Callable[["Mobject", float], None]NonTimeUpdater = Callable[["Mobject"], None]Updater = Union[TimeBasedUpdater, NonTimeUpdater]ManimColor = Union[str, Color]Related to