manim 0.18.1__py3-none-any.whl → 0.19.0__py3-none-any.whl

manim/utils/testing/_test_class_makers.py

@@ -1,9 +1,12 @@
 from __future__ import annotations
 
-from typing import Callable
+from typing import Any, Callable
 
+from manim.renderer.cairo_renderer import CairoRenderer
+from manim.renderer.opengl_renderer import OpenGLRenderer
 from manim.scene.scene import Scene
 from manim.scene.scene_file_writer import SceneFileWriter
+from manim.typing import PixelArray, StrPath
 
 from ._frames_testers import _FramesTester
 
@@ -11,13 +14,14 @@ from ._frames_testers import _FramesTester
 def _make_test_scene_class(
     base_scene: type[Scene],
     construct_test: Callable[[Scene], None],
-    test_renderer,
+    test_renderer: CairoRenderer | OpenGLRenderer | None,
 ) -> type[Scene]:
-    class _TestedScene(base_scene):
-        def __init__(self, *args, **kwargs):
-            super().__init__(renderer=test_renderer, *args, **kwargs)
+    # TODO: Get the type annotation right for the base_scene argument.
+    class _TestedScene(base_scene):  # type: ignore[valid-type, misc]
+        def __init__(self, *args: Any, **kwargs: Any) -> None:
+            super().__init__(*args, renderer=test_renderer, **kwargs)
 
-        def construct(self):
+        def construct(self) -> None:
             construct_test(self)
 
             # Manim hack to render the very last frame (normally the last frame is not the very end of the animation)
@@ -28,7 +32,7 @@ def _make_test_scene_class(
     return _TestedScene
 
 
-def _make_test_renderer_class(from_renderer):
+def _make_test_renderer_class(from_renderer: type) -> Any:
     # Just for inheritance.
     class _TestRenderer(from_renderer):
         pass
@@ -39,39 +43,50 @@ def _make_test_renderer_class(from_renderer):
 class DummySceneFileWriter(SceneFileWriter):
     """Delegate of SceneFileWriter used to test the frames."""
 
-    def __init__(self, renderer, scene_name, **kwargs):
+    def __init__(
+        self,
+        renderer: CairoRenderer | OpenGLRenderer,
+        scene_name: StrPath,
+        **kwargs: Any,
+    ) -> None:
         super().__init__(renderer, scene_name, **kwargs)
         self.i = 0
 
-    def init_output_directories(self, scene_name):
+    def init_output_directories(self, scene_name: StrPath) -> None:
         pass
 
-    def add_partial_movie_file(self, hash_animation):
+    def add_partial_movie_file(self, hash_animation: str) -> None:
         pass
 
-    def begin_animation(self, allow_write=True):
+    def begin_animation(
+        self, allow_write: bool = True, file_path: StrPath | None = None
+    ) -> Any:
         pass
 
-    def end_animation(self, allow_write):
+    def end_animation(self, allow_write: bool = False) -> None:
         pass
 
-    def combine_to_movie(self):
+    def combine_to_movie(self) -> None:
         pass
 
-    def combine_to_section_videos(self):
+    def combine_to_section_videos(self) -> None:
         pass
 
-    def clean_cache(self):
+    def clean_cache(self) -> None:
         pass
 
-    def write_frame(self, frame_or_renderer):
+    def write_frame(
+        self, frame_or_renderer: PixelArray | OpenGLRenderer, num_frames: int = 1
+    ) -> None:
         self.i += 1
 
 
 def _make_scene_file_writer_class(tester: _FramesTester) -> type[SceneFileWriter]:
     class TestSceneFileWriter(DummySceneFileWriter):
-        def write_frame(self, frame_or_renderer):
+        def write_frame(
+            self, frame_or_renderer: PixelArray | OpenGLRenderer, num_frames: int = 1
+        ) -> None:
             tester.check_frame(self.i, frame_or_renderer)
-            super().write_frame(frame_or_renderer)
+            super().write_frame(frame_or_renderer, num_frames=num_frames)
 
     return TestSceneFileWriter

manim/utils/testing/frames_comparison.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import functools
 import inspect
 from pathlib import Path
-from typing import Callable
+from typing import Any, Callable
 
 import cairo
 import pytest
@@ -14,7 +14,9 @@ from manim._config import tempconfig
 from manim._config.utils import ManimConfig
 from manim.camera.three_d_camera import ThreeDCamera
 from manim.renderer.cairo_renderer import CairoRenderer
+from manim.renderer.opengl_renderer import OpenGLRenderer
 from manim.scene.three_d_scene import ThreeDScene
+from manim.typing import StrPath
 
 from ._frames_testers import _ControlDataWriter, _FramesTester
 from ._test_class_makers import (
@@ -31,13 +33,13 @@ MIN_CAIRO_VERSION = 11800
 
 
 def frames_comparison(
-    func=None,
+    func: Callable | None = None,
     *,
     last_frame: bool = True,
-    renderer_class=CairoRenderer,
-    base_scene=Scene,
-    **custom_config,
-):
+    renderer_class: type[CairoRenderer | OpenGLRenderer] = CairoRenderer,
+    base_scene: type[Scene] = Scene,
+    **custom_config: Any,
+) -> Callable:
     """Compares the frames generated by the test with control frames previously registered.
 
     If there is no control frames for this test, the test will fail. To generate
@@ -60,7 +62,7 @@ def frames_comparison(
         If the scene has a moving animation, then the test must set last_frame to False.
     """
 
-    def decorator_maker(tested_scene_construct):
+    def decorator_maker(tested_scene_construct: Callable) -> Callable:
         if (
             SCENE_PARAMETER_NAME
             not in inspect.getfullargspec(tested_scene_construct).args
@@ -79,11 +81,14 @@ def frames_comparison(
                 "There is no module test name indicated for the graphical unit test. You have to declare __module_test__ in the test file.",
             )
         module_name = tested_scene_construct.__globals__.get("__module_test__")
+        assert isinstance(module_name, str)
         test_name = tested_scene_construct.__name__[len("test_") :]
 
         @functools.wraps(tested_scene_construct)
         # The "request" parameter is meant to be used as a fixture by pytest. See below.
-        def wrapper(*args, request: FixtureRequest, tmp_path, **kwargs):
+        def wrapper(
+            *args: Any, request: FixtureRequest, tmp_path: StrPath, **kwargs: Any
+        ) -> None:
             # check for cairo version
             if (
                 renderer_class is CairoRenderer
@@ -146,13 +151,13 @@ def frames_comparison(
                 inspect.Parameter("tmp_path", inspect.Parameter.KEYWORD_ONLY),
             ]
         new_sig = old_sig.replace(parameters=parameters)
-        wrapper.__signature__ = new_sig
+        wrapper.__signature__ = new_sig  # type: ignore[attr-defined]
 
         # Reach a bit into pytest internals to hoist the marks from our wrapped
         # function.
-        setattr(wrapper, "pytestmark", [])
+        wrapper.pytestmark = []  # type: ignore[attr-defined]
         new_marks = getattr(tested_scene_construct, "pytestmark", [])
-        wrapper.pytestmark = new_marks
+        wrapper.pytestmark = new_marks  # type: ignore[attr-defined]
         return wrapper
 
     # Case where the decorator is called with and without parentheses.
@@ -192,9 +197,10 @@ def _make_test_comparing_frames(
     Callable[[], None]
         The pytest test.
     """
-
     if is_set_test_data_test:
-        frames_tester = _ControlDataWriter(file_path, size_frame=size_frame)
+        frames_tester: _FramesTester = _ControlDataWriter(
+            file_path, size_frame=size_frame
+        )
     else:
         frames_tester = _FramesTester(file_path, show_diff=show_diff)
 
@@ -205,7 +211,7 @@ def _make_test_comparing_frames(
     )
     testRenderer = _make_test_renderer_class(renderer_class)
 
-    def real_test():
+    def real_test() -> None:
         with frames_tester.testing():
             sceneTested = _make_test_scene_class(
                 base_scene=base_scene,

manim/utils/tex.py

@@ -36,6 +36,9 @@ class TexTemplate:
     tex_compiler: str = "latex"
     """The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``."""
 
+    description: str = ""
+    """A description of the template"""
+
     output_format: str = ".dvi"
     """The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``."""
 
@@ -181,7 +184,6 @@ def _texcode_for_environment(environment: str) -> tuple[str, str]:
         A pair of strings representing the opening and closing of the tex environment, e.g.
         ``\begin{tabular}{cccl}`` and ``\end{tabular}``
     """
-
     environment.removeprefix(r"\begin").removeprefix("{")
 
     # The \begin command takes everything and closes with a brace
@@ -191,7 +193,7 @@ def _texcode_for_environment(environment: str) -> tuple[str, str]:
         begin += "}"
 
     # While the \end command terminates at the first closing brace
-    split_at_brace = re.split("}", environment, 1)
+    split_at_brace = re.split("}", environment, maxsplit=1)
     end = r"\end{" + split_at_brace[0] + "}"
 
     return begin, end

manim/utils/tex_file_writing.py

@@ -9,11 +9,13 @@
 from __future__ import annotations
 
 import hashlib
-import os
 import re
+import subprocess
 import unicodedata
+from collections.abc import Generator, Iterable, Sequence
 from pathlib import Path
-from typing import Iterable
+from re import Match
+from typing import Any
 
 from manim.utils.tex import TexTemplate
 
@@ -22,7 +24,7 @@ from .. import config, logger
 __all__ = ["tex_to_svg_file"]
 
 
-def tex_hash(expression):
+def tex_hash(expression: Any) -> str:
     id_str = str(expression)
     hasher = hashlib.sha256()
     hasher.update(id_str.encode())
@@ -34,8 +36,8 @@ def tex_to_svg_file(
     expression: str,
     environment: str | None = None,
     tex_template: TexTemplate | None = None,
-):
-    """Takes a tex expression and returns the svg version of the compiled tex
+) -> Path:
+    r"""Takes a tex expression and returns the svg version of the compiled tex
 
     Parameters
     ----------
@@ -76,7 +78,7 @@ def generate_tex_file(
     environment: str | None = None,
     tex_template: TexTemplate | None = None,
 ) -> Path:
-    """Takes a tex expression (and an optional tex environment),
+    r"""Takes a tex expression (and an optional tex environment),
     and returns a fully formed tex file ready for compilation.
 
     Parameters
@@ -114,10 +116,11 @@ def generate_tex_file(
     return result
 
 
-def tex_compilation_command(
+def make_tex_compilation_command(
     tex_compiler: str, output_format: str, tex_file: Path, tex_dir: Path
-) -> str:
-    """Prepares the tex compilation command with all necessary cli flags
+) -> list[str]:
+    """Prepares the TeX compilation command, i.e. the TeX compiler name
+    and all necessary CLI flags.
 
     Parameters
     ----------
@@ -132,50 +135,46 @@ def tex_compilation_command(
 
     Returns
     -------
-    :class:`str`
+    :class:`list[str]`
         Compilation command according to given parameters
     """
     if tex_compiler in {"latex", "pdflatex", "luatex", "lualatex"}:
-        commands = [
+        command = [
             tex_compiler,
             "-interaction=batchmode",
-            f'-output-format="{output_format[1:]}"',
+            f"-output-format={output_format[1:]}",
             "-halt-on-error",
-            f'-output-directory="{tex_dir.as_posix()}"',
-            f'"{tex_file.as_posix()}"',
-            ">",
-            os.devnull,
+            f"-output-directory={tex_dir.as_posix()}",
+            f"{tex_file.as_posix()}",
         ]
     elif tex_compiler == "xelatex":
         if output_format == ".xdv":
-            outflag = "-no-pdf"
+            outflag = ["-no-pdf"]
         elif output_format == ".pdf":
-            outflag = ""
+            outflag = []
         else:
             raise ValueError("xelatex output is either pdf or xdv")
-        commands = [
+        command = [
             "xelatex",
-            outflag,
+            *outflag,
             "-interaction=batchmode",
             "-halt-on-error",
-            f'-output-directory="{tex_dir.as_posix()}"',
-            f'"{tex_file.as_posix()}"',
-            ">",
-            os.devnull,
+            f"-output-directory={tex_dir.as_posix()}",
+            f"{tex_file.as_posix()}",
         ]
     else:
         raise ValueError(f"Tex compiler {tex_compiler} unknown.")
-    return " ".join(commands)
+    return command
 
 
-def insight_inputenc_error(matching):
+def insight_inputenc_error(matching: Match[str]) -> Generator[str]:
     code_point = chr(int(matching[1], 16))
     name = unicodedata.name(code_point)
     yield f"TexTemplate does not support character '{name}' (U+{matching[1]})."
     yield "See the documentation for manim.mobject.svg.tex_mobject for details on using a custom TexTemplate."
 
 
-def insight_package_not_found_error(matching):
+def insight_package_not_found_error(matching: Match[str]) -> Generator[str]:
     yield f"You do not have package {matching[1]} installed."
     yield f"Install {matching[1]} it using your LaTeX package manager, or check for typos."
 
@@ -200,14 +199,14 @@ def compile_tex(tex_file: Path, tex_compiler: str, output_format: str) -> Path:
     result = tex_file.with_suffix(output_format)
     tex_dir = config.get_dir("tex_dir")
     if not result.exists():
-        command = tex_compilation_command(
+        command = make_tex_compilation_command(
             tex_compiler,
             output_format,
             tex_file,
             tex_dir,
         )
-        exit_code = os.system(command)
-        if exit_code != 0:
+        cp = subprocess.run(command, stdout=subprocess.DEVNULL)
+        if cp.returncode != 0:
             log_file = tex_file.with_suffix(".log")
             print_all_tex_errors(log_file, tex_compiler, tex_file)
             raise ValueError(
@@ -218,7 +217,7 @@ def compile_tex(tex_file: Path, tex_compiler: str, output_format: str) -> Path:
     return result
 
 
-def convert_to_svg(dvi_file: Path, extension: str, page: int = 1):
+def convert_to_svg(dvi_file: Path, extension: str, page: int = 1) -> Path:
     """Converts a .dvi, .xdv, or .pdf file into an svg using dvisvgm.
 
     Parameters
@@ -237,18 +236,16 @@ def convert_to_svg(dvi_file: Path, extension: str, page: int = 1):
     """
     result = dvi_file.with_suffix(".svg")
     if not result.exists():
-        commands = [
+        command = [
             "dvisvgm",
-            "--pdf" if extension == ".pdf" else "",
-            "-p " + str(page),
-            f'"{dvi_file.as_posix()}"',
-            "-n",
-            "-v 0",
-            "-o " + f'"{result.as_posix()}"',
-            ">",
-            os.devnull,
+            *(["--pdf"] if extension == ".pdf" else []),
+            f"--page={page}",
+            "--no-fonts",
+            "--verbosity=0",
+            f"--output={result.as_posix()}",
+            f"{dvi_file.as_posix()}",
         ]
-        os.system(" ".join(commands))
+        subprocess.run(command, stdout=subprocess.DEVNULL)
 
     # if the file does not exist now, this means conversion failed
     if not result.exists():
@@ -271,7 +268,6 @@ def delete_nonsvg_files(additional_endings: Iterable[str] = ()) -> None:
     additional_endings
         Additional endings to whitelist
     """
-
     tex_dir = config.get_dir("tex_dir")
     file_suffix_whitelist = {".svg", ".tex", *additional_endings}
 
@@ -310,7 +306,11 @@ LATEX_ERROR_INSIGHTS = [
 ]
 
 
-def print_tex_error(tex_compilation_log, error_start_index, tex_source):
+def print_tex_error(
+    tex_compilation_log: Sequence[str],
+    error_start_index: int,
+    tex_source: Sequence[str],
+) -> None:
     logger.error(
         f"LaTeX compilation error: {tex_compilation_log[error_start_index][2:]}",
     )
@@ -344,8 +344,8 @@ def print_tex_error(tex_compilation_log, error_start_index, tex_source):
         context += tex_source[line_of_tex_error - 3 : line_of_tex_error + 3]
         context[-4] = "-> " + context[-4]
 
-    context = "".join(context)
-    logger.error(context)
+    context_joined = "".join(context)
+    logger.error(context_joined)
 
     for insights in LATEX_ERROR_INSIGHTS:
         prob, get_insight = insights

manim/utils/tex_templates.py

@@ -12,7 +12,7 @@ from .tex import *
 # This file makes TexTemplateLibrary and TexFontTemplates available for use in manim Tex and MathTex objects.
 
 
-def _new_ams_template():
+def _new_ams_template() -> TexTemplate:
     """Returns a simple Tex Template with only basic AMS packages"""
     preamble = r"""
 \usepackage[english]{babel}

manim/utils/unit.py

@@ -5,20 +5,21 @@ from __future__ import annotations
 import numpy as np
 
 from .. import config, constants
+from ..typing import Vector3D
 
 __all__ = ["Pixels", "Degrees", "Munits", "Percent"]
 
 
 class _PixelUnits:
-    def __mul__(self, val):
+    def __mul__(self, val: float) -> float:
         return val * config.frame_width / config.pixel_width
 
-    def __rmul__(self, val):
+    def __rmul__(self, val: float) -> float:
         return val * config.frame_width / config.pixel_width
 
 
 class Percent:
-    def __init__(self, axis):
+    def __init__(self, axis: Vector3D) -> None:
         if np.array_equal(axis, constants.X_AXIS):
             self.length = config.frame_width
         if np.array_equal(axis, constants.Y_AXIS):
@@ -26,10 +27,10 @@ class Percent:
         if np.array_equal(axis, constants.Z_AXIS):
             raise NotImplementedError("length of Z axis is undefined")
 
-    def __mul__(self, val):
+    def __mul__(self, val: float) -> float:
         return val / 100 * self.length
 
-    def __rmul__(self, val):
+    def __rmul__(self, val: float) -> float:
         return val / 100 * self.length
 
 

{manim-0.18.1.dist-info → manim-0.19.0.dist-info}/METADATA

@@ -1,12 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: manim
-Version: 0.18.1
+Version: 0.19.0
 Summary: Animation engine for explanatory math videos.
-Home-page: https://www.manim.community/
 License: MIT
 Author: The Manim Community Developers
 Author-email: contact@manim.community
-Requires-Python: >=3.9,<3.13
+Requires-Python: >=3.9
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
@@ -15,7 +14,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Multimedia :: Graphics
 Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Scientific/Engineering
@@ -23,6 +22,9 @@ Provides-Extra: gui
 Provides-Extra: jupyterlab
 Requires-Dist: Pillow (>=9.1)
 Requires-Dist: Pygments (>=2.0.0)
+Requires-Dist: audioop-lts (>=0.2.0) ; python_version >= "3.13"
+Requires-Dist: av (>=9.0.0,<14.0.0)
+Requires-Dist: beautifulsoup4 (>=4.12)
 Requires-Dist: click (>=8.0)
 Requires-Dist: cloup (>=2.0.0)
 Requires-Dist: dearpygui (>=1.0.0) ; extra == "gui"
@@ -36,11 +38,13 @@ Requires-Dist: moderngl (>=5.0.0,<6.0.0)
 Requires-Dist: moderngl-window (>=2.0.0)
 Requires-Dist: networkx (>=2.6)
 Requires-Dist: notebook (>=6.0.0) ; extra == "jupyterlab"
-Requires-Dist: numpy (>=1.26)
+Requires-Dist: numpy (>=2.0) ; python_version < "3.10"
+Requires-Dist: numpy (>=2.1) ; python_version >= "3.10"
 Requires-Dist: pycairo (>=1.13,<2.0.0)
 Requires-Dist: pydub (>=0.20.0)
 Requires-Dist: rich (>=12.0.0)
-Requires-Dist: scipy (>=1.6.0)
+Requires-Dist: scipy (>=1.13.0) ; python_version < "3.13"
+Requires-Dist: scipy (>=1.14.0) ; python_version >= "3.13"
 Requires-Dist: screeninfo (>=0.7)
 Requires-Dist: skia-pathops (>=0.7.0)
 Requires-Dist: srt (>=3.0.0)
@@ -52,6 +56,7 @@ Project-URL: Bug Tracker, https://github.com/ManimCommunity/manim/issues
 Project-URL: Changelog, https://docs.manim.community/en/stable/changelog.html
 Project-URL: Documentation, https://docs.manim.community/
 Project-URL: Discord, https://www.manim.community/discord/
+Project-URL: Homepage, https://www.manim.community/
 Project-URL: Repository, https://github.com/manimcommunity/manim
 Project-URL: Twitter, https://twitter.com/manim_community
 Description-Content-Type: text/markdown
@@ -79,7 +84,8 @@ Description-Content-Type: text/markdown
 
 Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as demonstrated in the videos of [3Blue1Brown](https://www.3blue1brown.com/).
 
-> NOTE: This repository is maintained by the Manim Community and is not associated with Grant Sanderson or 3Blue1Brown in any way (although we are definitely indebted to him for providing his work to the world). If you would like to study how Grant makes his videos, head over to his repository ([3b1b/manim](https://github.com/3b1b/manim)). This fork is updated more frequently than his, and it's recommended to use this fork if you'd like to use Manim for your own projects.
+> [!NOTE]
+> The community edition of Manim has been forked from 3b1b/manim, a tool originally created and open-sourced by Grant Sanderson, also creator of the 3Blue1Brown educational math videos. While Grant Sanderson’s repository continues to be maintained separately by him, he is not among the maintainers of the community edition. We recommend this version for its continued development, improved features, enhanced documentation, and more active community-driven maintenance. If you would like to study how Grant makes his videos, head over to his repository ([3b1b/manim](https://github.com/3b1b/manim)).
 
 ## Table of Contents:
 
@@ -93,7 +99,8 @@ Manim is an animation engine for explanatory math videos. It's used to create pr
 
 ## Installation
 
-> **WARNING:** These instructions are for the community version _only_. Trying to use these instructions to install [3b1b/manim](https://github.com/3b1b/manim) or instructions there to install this version will cause problems. Read [this](https://docs.manim.community/en/stable/faq/installation.html#why-are-there-different-versions-of-manim) and decide which version you wish to install, then only follow the instructions for your desired version.
+> [!CAUTION]
+> These instructions are for the community version _only_. Trying to use these instructions to install [3b1b/manim](https://github.com/3b1b/manim) or instructions there to install this version will cause problems. Read [this](https://docs.manim.community/en/stable/faq/installation.html#why-are-there-different-versions-of-manim) and decide which version you wish to install, then only follow the instructions for your desired version.
 
 Manim requires a few dependencies that must be installed prior to using it. If you
 want to try it out first before installing it locally, you can do so