manim 0.17.0__py3-none-any.whl → 0.19.1__py3-none-any.whl

manim/utils/tex_file_writing.py

@@ -9,17 +9,22 @@
 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 re import Match
+from typing import Any
 
 from manim.utils.tex import TexTemplate
 
 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())
@@ -31,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
     ----------
@@ -51,20 +56,29 @@ def tex_to_svg_file(
     if tex_template is None:
         tex_template = config["tex_template"]
     tex_file = generate_tex_file(expression, environment, tex_template)
+
+    # check if svg already exists
+    svg_file = tex_file.with_suffix(".svg")
+    if svg_file.exists():
+        return svg_file
+
     dvi_file = compile_tex(
         tex_file,
         tex_template.tex_compiler,
         tex_template.output_format,
     )
-    return convert_to_svg(dvi_file, tex_template.output_format)
+    svg_file = convert_to_svg(dvi_file, tex_template.output_format)
+    if not config["no_latex_cleanup"]:
+        delete_nonsvg_files()
+    return svg_file
 
 
 def generate_tex_file(
     expression: str,
     environment: str | None = None,
     tex_template: TexTemplate | None = None,
-):
-    """Takes a tex expression (and an optional tex environment),
+) -> Path:
+    r"""Takes a tex expression (and an optional tex environment),
     and returns a fully formed tex file ready for compilation.
 
     Parameters
@@ -102,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
     ----------
@@ -120,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}"',
-            f'"{tex_file}"',
-            ">",
-            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}"',
-            f'"{tex_file}"',
-            ">",
-            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."
 
@@ -188,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(
@@ -206,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
@@ -225,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}"',
-            "-n",
-            "-v 0",
-            "-o " + f'"{result}"',
-            ">",
-            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():
@@ -244,12 +253,29 @@ def convert_to_svg(dvi_file: Path, extension: str, page: int = 1):
             f"Your installation does not support converting {dvi_file.suffix} files to SVG."
             f" Consider updating dvisvgm to at least version 2.4."
             f" If this does not solve the problem, please refer to our troubleshooting guide at:"
-            f" https://docs.manim.community/en/stable/installation/troubleshooting.html",
+            f" https://docs.manim.community/en/stable/faq/general.html#my-installation-"
+            f"does-not-support-converting-pdf-to-svg-help",
         )
 
     return result
 
 
+def delete_nonsvg_files(additional_endings: Iterable[str] = ()) -> None:
+    """Deletes every file that does not have a suffix in ``(".svg", ".tex", *additional_endings)``
+
+    Parameters
+    ----------
+    additional_endings
+        Additional endings to whitelist
+    """
+    tex_dir = config.get_dir("tex_dir")
+    file_suffix_whitelist = {".svg", ".tex", *additional_endings}
+
+    for f in tex_dir.iterdir():
+        if f.suffix not in file_suffix_whitelist:
+            f.unlink()
+
+
 def print_all_tex_errors(log_file: Path, tex_compiler: str, tex_file: Path) -> None:
     if not log_file.exists():
         raise RuntimeError(
@@ -262,7 +288,7 @@ def print_all_tex_errors(log_file: Path, tex_compiler: str, tex_file: Path) -> N
         index for index, line in enumerate(tex_compilation_log) if line.startswith("!")
     ]
     if error_indices:
-        with tex_file.open() as f:
+        with tex_file.open(encoding="utf-8") as f:
             tex = f.readlines()
         for error_index in error_indices:
             print_tex_error(tex_compilation_log, error_index, tex)
@@ -280,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:]}",
     )
@@ -314,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

@@ -1,4 +1,5 @@
 """A library of LaTeX templates."""
+
 from __future__ import annotations
 
 __all__ = [
@@ -11,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.17.0.dist-info → manim-0.19.1.dist-info}/METADATA

@@ -1,65 +1,63 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: manim
-Version: 0.17.0
+Version: 0.19.1
 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.8,<3.12
+Project-URL: repository, https://github.com/manimcommunity/manim
+Project-URL: documentation, https://docs.manim.community/
+Project-URL: homepage, https://www.manim.community/
+Project-URL: Bug Tracker, https://github.com/ManimCommunity/manim/issues
+Project-URL: Changelog, https://docs.manim.community/en/stable/changelog.html
+Project-URL: X / Twitter, https://x.com/manim_community
+Project-URL: Bluesky, https://bsky.app/profile/manim.community
+Project-URL: Discord, https://www.manim.community/discord/
+Author-email: The Manim Community Developers <contact@manim.community>, Grant '3Blue1Brown' Sanderson <grant@3blue1brown.com>
+License-Expression: MIT
+License-File: LICENSE
+License-File: LICENSE.community
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Multimedia :: Graphics
 Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: audioop-lts>=0.2.1; python_full_version >= '3.13'
+Requires-Dist: av<14.0.0,>=9.0.0
+Requires-Dist: beautifulsoup4>=4.12
+Requires-Dist: click>=8.0
+Requires-Dist: cloup>=2.0.0
+Requires-Dist: decorator>=4.3.2
+Requires-Dist: isosurfaces>=0.1.0
+Requires-Dist: manimpango<1.0.0,>=0.5.0
+Requires-Dist: mapbox-earcut>=1.0.0
+Requires-Dist: moderngl-window>=2.0.0
+Requires-Dist: moderngl<6.0.0,>=5.0.0
+Requires-Dist: networkx>=2.6
+Requires-Dist: numpy>=2.0
+Requires-Dist: numpy>=2.1; python_full_version >= '3.10'
+Requires-Dist: pillow>=9.1
+Requires-Dist: pycairo<2.0.0,>=1.13
+Requires-Dist: pydub>=0.20.0
+Requires-Dist: pygments>=2.0.0
+Requires-Dist: rich>=12.0.0
+Requires-Dist: scipy>=1.13.0
+Requires-Dist: scipy>=1.14.0; python_full_version >= '3.13'
+Requires-Dist: screeninfo>=0.7
+Requires-Dist: skia-pathops>=0.7.0
+Requires-Dist: srt>=3.0.0
+Requires-Dist: svgelements>=1.8.0
+Requires-Dist: tqdm>=4.0.0
+Requires-Dist: typing-extensions>=4.12.0
+Requires-Dist: watchdog>=2.0.0
 Provides-Extra: gui
+Requires-Dist: dearpygui>=1.0.0; extra == 'gui'
 Provides-Extra: jupyterlab
-Requires-Dist: Pillow (>=9.1,<10.0)
-Requires-Dist: Pygments (>=2.10.0,<3.0.0)
-Requires-Dist: backports.cached-property (>=1.0.1,<2.0.0); python_version < "3.8"
-Requires-Dist: click (>=7.2,<=9.0)
-Requires-Dist: click-default-group (>=1.2.2,<2.0.0)
-Requires-Dist: cloup (>=0.13.0,<0.14.0)
-Requires-Dist: colour (>=0.1.5,<0.2.0)
-Requires-Dist: dearpygui (>=1.3.1,<2.0.0); extra == "gui"
-Requires-Dist: decorator (>=5.0.7,<6.0.0)
-Requires-Dist: importlib-metadata (>=4.10.0,<5.0.0); python_version < "3.8"
-Requires-Dist: isosurfaces (==0.1.0)
-Requires-Dist: jupyterlab (>=3.0,<4.0); extra == "jupyterlab"
-Requires-Dist: manimpango (>=0.4.0.post0,<0.5.0)
-Requires-Dist: mapbox-earcut (>=1.0.0,<2.0.0)
-Requires-Dist: moderngl (>=5.6.3,<6.0.0)
-Requires-Dist: moderngl-window (>=2.3.0,<3.0.0)
-Requires-Dist: networkx (>=2.5,<3.0)
-Requires-Dist: notebook (>=6.4,<7.0); extra == "jupyterlab"
-Requires-Dist: numpy (>=1.19,<2.0)
-Requires-Dist: pycairo (>=1.21,<2.0)
-Requires-Dist: pydub (>=0.25.1,<0.26.0)
-Requires-Dist: requests (>=2.26.0,<3.0.0)
-Requires-Dist: rich (>=6.0,!=12.0.0)
-Requires-Dist: scipy (>=1.7.3,<2.0.0)
-Requires-Dist: screeninfo (>=0.8,<0.9)
-Requires-Dist: skia-pathops (>=0.7.0,<0.8.0)
-Requires-Dist: srt (>=3.5.0,<4.0.0)
-Requires-Dist: svgelements (>=1.7.2,<2.0.0)
-Requires-Dist: tqdm (>=4.62.3,<5.0.0)
-Requires-Dist: watchdog (>=2.1.6,<3.0.0)
-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: Repository, https://github.com/manimcommunity/manim
-Project-URL: Twitter, https://twitter.com/manim_community
+Requires-Dist: jupyterlab>=4.3.4; extra == 'jupyterlab'
+Requires-Dist: notebook>=7.3.2; extra == 'jupyterlab'
 Description-Content-Type: text/markdown
 
 <p align="center">
@@ -85,21 +83,23 @@ 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 (ManimCE) is a version maintained and developed by the community. It was 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 continues to maintain his own repository, 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:
 
--  [Installation](#installation)
--  [Usage](#usage)
--  [Documentation](#documentation)
--  [Docker](#docker)
--  [Help with Manim](#help-with-manim)
--  [Contributing](#contributing)
--  [License](#license)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Documentation](#documentation)
+- [Docker](#docker)
+- [Help with Manim](#help-with-manim)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## 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
@@ -152,9 +152,9 @@ The `-p` flag in the command above is for previewing, meaning the video file wil
 
 Some other useful flags include:
 
--  `-s` to skip to the end and just show the final frame.
--  `-n <number>` to skip ahead to the `n`'th animation of a scene.
--  `-f` show the file in the file browser.
+- `-s` to skip to the end and just show the final frame.
+- `-n <number>` to skip ahead to the `n`'th animation of a scene.
+- `-f` show the file in the file browser.
 
 For a thorough list of command line arguments, visit the [documentation](https://docs.manim.community/en/stable/guides/configuration.html).
 
@@ -182,8 +182,8 @@ The contribution guide may become outdated quickly; we highly recommend joining
 [Discord server](https://www.manim.community/discord/) to discuss any potential
 contributions and keep up to date with the latest developments.
 
-Most developers on the project use `poetry` for management. You'll want to have poetry installed and available in your environment.
-Learn more about `poetry` at its [documentation](https://python-poetry.org/docs/) and find out how to install manim with poetry at the [manim dev-installation guide](https://docs.manim.community/en/stable/contributing/development.html) in the manim documentation.
+Most developers on the project use `uv` for management. You'll want to have uv installed and available in your environment.
+Learn more about `uv` at its [documentation](https://docs.astral.sh/uv/) and find out how to install manim with uv at the [manim dev-installation guide](https://docs.manim.community/en/latest/contributing/development.html) in the manim documentation.
 
 ## How to Cite Manim
 
@@ -202,4 +202,3 @@ Our full code of conduct, and how we enforce it, can be read on [our website](ht
 ## License
 
 The software is double-licensed under the MIT license, with copyright by 3blue1brown LLC (see LICENSE), and copyright by Manim Community Developers (see LICENSE.community).
-