Add type hints to `manim.cli` module #3988

chopan050 · 2024-10-28T20:35:20Z

As required by the issue #3375, I added typings for the manim.cli module.

I also added an entry in the docs for the cli module, although it's a work in progress.

Links to added or changed documentation pages

Reviewer Checklist

The PR title is descriptive enough for the changelog, and the PR is labeled correctly
If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
If applicable: newly added functions and classes are tested

manim/cli/checkhealth/checks.py

manim/cli/render/global_options.py

manim/cli/render/render_options.py

JasonGrace2282 · 2024-10-28T20:48:00Z

Could you remove this module from mypy's ignore list?

https://github.com/ManimCommunity/manim/blob/main/mypy.ini#L61-L63

…to cli-typehints

chopan050 · 2024-10-28T20:51:30Z

Done!

chopan050 · 2024-10-28T20:54:18Z

I'll have to fix the MyPy errors later.

manim/cli/default_group.py

manim/cli/render/render_options.py

chopan050 · 2024-10-29T20:53:04Z

I fixed all the errors reported by mypy.
In order to do that, I had to modify files outside of manim.cli:

manim._config.cli_colors.parse_cli_ctx()'s return value was typed as a cloup.Context, but it was actually a dict[str, Any], so I had to modify it.
I had to type OpenGLRenderer.__init__() and Scene.__init__() in order to use them in typed contexts.
The manim.utils.file_ops.open_file() function was missing type annotations and I had to use it in a typed context, so I also typed it.

JasonGrace2282

Thanks for putting in this effort, this is amazing progress towards typing Manim fully :)

I did leave some minor comments, so I would appreciate if you could take a look at those.

JasonGrace2282 · 2024-10-29T22:40:34Z

manim/cli/cfg/group.py

+if TYPE_CHECKING:
+    pass


Suggested change

if TYPE_CHECKING:

pass

Hold on, how did that even get there-

JasonGrace2282 · 2024-10-29T22:43:29Z

manim/cli/cfg/group.py


-    return isinstance(value, expected) and (is_valid_style(value) if style else True)
+    return isinstance(value_literal, ExpectedLiteralType) and (
+        (type(value_literal) is str and is_valid_style(value_literal))


I don't see a strict reason to allow only str and not any subclasses?

Suggested change

(type(value_literal) is str and is_valid_style(value_literal))

(isinstance(value_literal, str) and is_valid_style(value_literal))

I didn't think of that case. Thanks for mentioning it!

JasonGrace2282 · 2024-10-29T22:44:36Z

manim/cli/cfg/group.py

@@ -245,11 +266,11 @@ def write(level: str = None, openfile: bool = False) -> None:
    with cfg_file_path.open("w") as fp:
        parser.write(fp)
    if openfile:
-        open_file(cfg_file_path)
+        open_file(str(cfg_file_path))


This seems to me that open_file should be typehinted to allow manim.typing.StrPath? Or is there a reason why it has to be a string?

I just realized that it has to be a pathlib.Path currently, maybe a better approach would be to allow any StrPath and then convert it to a Path manually?

https://github.com/chopan050/manim/blob/8f0af8d4db631a46417d99722e2ad12358b8807b/manim/utils/file_ops.py#L194

You're right, I put str on accident. It should've been pathlib.Path.

Regarding the StrPath, I don't know. There are some inconsistencies in file_ops.py which I think should be handled in a different PR, and I'd prefer to make that change in that PR. There are parameters called file_path, but some of them are of type pathlib.Path and others are str. There are also parameters called file_name whose type is pathlib.Path, as well as a parameter which is simply called file, also of type pathlib.Path.

JasonGrace2282 · 2024-10-29T22:45:24Z

manim/cli/cfg/group.py

@@ -269,7 +290,7 @@ def show():
 @cfg.command(context_settings=cli_ctx_settings)
 @cloup.option("-d", "--directory", default=Path.cwd())
 @cloup.pass_context
-def export(ctx, directory):
+def export(ctx: cloup.Context, directory: str) -> None:


Suggested change

def export(ctx: cloup.Context, directory: str) -> None:

def export(ctx: cloup.Context, directory: manim.typing.StrPath) -> None:

Just allowing it to be less restrictive is a helpful habit :)

Unless we pass type=cloup.Path(path_type=pathlib.Path) to @cloup.option, it doesn't seem that directory can be a pathlib.Path.

JasonGrace2282 · 2024-10-29T22:46:06Z

manim/cli/checkhealth/checks.py

+    description: str
+    recommendation: str
+    skip_on_failed: list[str]
+    post_fail_fix_hook: Callable | None


Do you mind annotating the Callables here and later? If you don't care about the arguments you can do e.g. Callable[..., object]

JasonGrace2282 · 2024-10-29T22:47:08Z

manim/cli/checkhealth/checks.py

-        func.post_fail_fix_hook = post_fail_fix_hook
-        HEALTH_CHECKS.append(func)
-        return func
+    def wrapper(func: Callable) -> HealthCheckFunction:


Suggested change

def wrapper(func: Callable) -> HealthCheckFunction:

def wrapper(func: Callable[[], bool]) -> HealthCheckFunction:

If I understood correctly?

You're right. I forgot that it's only intended to wrap functions like that.

JasonGrace2282 · 2024-10-29T22:48:02Z

manim/cli/checkhealth/checks.py

+    :class:`bool`
+        Whether ``dvisvgm`` is in ``PATH`` and can be executed or not.
+    """
+    path_to_dvisvgm: str | None = shutil.which("dvisvgm")


Do we need this str | None annotation? shutil.which should take care of it for us.

I also had it for the is_manim...() functions. I removed those, but I missed these for latex and dvisvgm. I'll also remove them.

JasonGrace2282 · 2024-10-29T22:52:53Z

manim/cli/default_group.py

            # No command name matched.
-            ctx.arg0 = cmd_name
+            ctx.meta["arg0"] = cmd_name


Didn't know about this, nice change :)

Thanks! I was struggling to do this assignment without having mypy complain about it, so I ended up looking at click.Context in the hope of finding some dictionary, which I fortunately found!

JasonGrace2282 · 2024-10-29T22:56:58Z

manim/cli/init/commands.py

@@ -94,11 +98,12 @@ def update_cfg(cfg_dict: dict, project_cfg_path: Path):
    help="Default settings for project creation.",
    nargs=1,
 )
-def project(default_settings, **args):
+def project(default_settings: bool, **args: Any) -> None:


Suggested change

def project(default_settings: bool, **args: Any) -> None:

def project(default_settings: bool, **kwargs: Any) -> None:

I know I know, not related to the PR per say, but it would be nice if you could do this here and below :)

JasonGrace2282 · 2024-10-29T23:00:05Z

manim/cli/init/commands.py

    """Creates a new project.

    PROJECT_NAME is the name of the folder in which the new project will be initialized.
    """
+    project_name: Path


(nitpick?) Maybe instead of this, it could be something like

project_name = cast(Path, args["project_name"]) or click.prompt("Project Name", type=Path)

Hmm, I don't know about this. I could add the cast, although mypy didn't complain about this. However, the proposal with or seems a bit more difficult to visually digest, at least for me.

chopan050 added 2 commits October 28, 2024 17:12

Add type hints to cli

1d3f4c7

Import click.Parameter instead of non existing cloup.Parameter

81bb66f

chopan050 mentioned this pull request Oct 28, 2024

Typing progress tracker #3375

Open

22 tasks

Merge branch 'main' into cli-typehints

94eb489

github-advanced-security bot found potential problems Oct 28, 2024

View reviewed changes

manim/cli/checkhealth/checks.py Dismissed Show dismissed Hide dismissed

manim/cli/render/global_options.py Fixed Show fixed Hide fixed

manim/cli/render/render_options.py Fixed Show fixed Hide fixed

manim/cli/render/render_options.py Fixed Show fixed Hide fixed

chopan050 added 2 commits October 28, 2024 17:50

Stop ignoring manim.cli errors in mypy.ini

0d21fbf

Merge branch 'cli-typehints' of https://github.com/chopan050/manim in…

135ea70

…to cli-typehints

Fix mypy errors

af42bd5

github-advanced-security bot found potential problems Oct 29, 2024

View reviewed changes

manim/cli/default_group.py Fixed Show fixed Hide fixed

manim/cli/render/render_options.py Dismissed Show dismissed Hide dismissed

chopan050 added 2 commits October 29, 2024 17:57

Remove unused TypeVar C

47044b1

click.Command.command -> cloup.Group.command

8f0af8d

JasonGrace2282 requested changes Oct 29, 2024

View reviewed changes

JasonGrace2282 changed the title ~~Add type hints to cli~~ Add type hints to manim.cli module Oct 29, 2024

chopan050 and others added 2 commits October 29, 2024 22:02

Address Jason's requested changes

3c21e93

Merge branch 'main' into cli-typehints

756aa2b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add type hints to `manim.cli` module #3988

Add type hints to `manim.cli` module #3988

chopan050 commented Oct 28, 2024 •

edited

Loading

JasonGrace2282 commented Oct 28, 2024

chopan050 commented Oct 28, 2024

chopan050 commented Oct 28, 2024

chopan050 commented Oct 29, 2024

JasonGrace2282 left a comment

JasonGrace2282 Oct 29, 2024

chopan050 Oct 29, 2024

JasonGrace2282 Oct 29, 2024

chopan050 Oct 29, 2024

JasonGrace2282 Oct 29, 2024

JasonGrace2282 Oct 29, 2024 •

edited

Loading

chopan050 Oct 30, 2024

JasonGrace2282 Oct 29, 2024

chopan050 Oct 30, 2024

JasonGrace2282 Oct 29, 2024

chopan050 Oct 30, 2024

JasonGrace2282 Oct 29, 2024

chopan050 Oct 30, 2024

JasonGrace2282 Oct 29, 2024

chopan050 Oct 30, 2024

JasonGrace2282 Oct 29, 2024

chopan050 Oct 30, 2024

JasonGrace2282 Oct 29, 2024

chopan050 Oct 30, 2024

JasonGrace2282 Oct 29, 2024

chopan050 Oct 30, 2024

	(type(value_literal) is str and is_valid_style(value_literal))
	(isinstance(value_literal, str) and is_valid_style(value_literal))

	def export(ctx: cloup.Context, directory: str) -> None:
	def export(ctx: cloup.Context, directory: manim.typing.StrPath) -> None:

	def wrapper(func: Callable) -> HealthCheckFunction:
	def wrapper(func: Callable[[], bool]) -> HealthCheckFunction:

	def project(default_settings: bool, **args: Any) -> None:
	def project(default_settings: bool, **kwargs: Any) -> None:

Add type hints to manim.cli module #3988

Are you sure you want to change the base?

Add type hints to manim.cli module #3988

Conversation

chopan050 commented Oct 28, 2024 • edited Loading

Links to added or changed documentation pages

Reviewer Checklist

JasonGrace2282 commented Oct 28, 2024

chopan050 commented Oct 28, 2024

chopan050 commented Oct 28, 2024

chopan050 commented Oct 29, 2024

JasonGrace2282 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JasonGrace2282 Oct 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add type hints to `manim.cli` module #3988

Add type hints to `manim.cli` module #3988

chopan050 commented Oct 28, 2024 •

edited

Loading

JasonGrace2282 Oct 29, 2024 •

edited

Loading