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

manim/cli/render/commands.py

@@ -5,15 +5,18 @@ Manim's render subcommand is accessed in the command-line interface via
 can specify options, and arguments for the render command.
 
 """
+
 from __future__ import annotations
 
+import http.client
 import json
 import sys
+import urllib.error
+import urllib.request
 from pathlib import Path
+from typing import cast
 
-import click
 import cloup
-import requests
 
 from ... import __version__, config, console, error_console, logger
 from ..._config import tempconfig
@@ -24,14 +27,16 @@ from .global_options import global_options
 from .output_options import output_options
 from .render_options import render_options
 
+__all__ = ["render"]
+
 
 @cloup.command(
     context_settings=None,
     no_args_is_help=True,
     epilog=EPILOG,
 )
-@click.argument("file", type=Path, required=True)
-@click.argument("scene_names", required=False, nargs=-1)
+@cloup.argument("file", type=Path, required=True)
+@cloup.argument("scene_names", required=False, nargs=-1)
 @global_options
 @output_options
 @render_options  # type: ignore
@@ -120,13 +125,26 @@ def render(
     if config.notify_outdated_version:
         manim_info_url = "https://pypi.org/pypi/manim/json"
         warn_prompt = "Cannot check if latest release of manim is installed"
-        req_info = {}
 
         try:
-            req_info = requests.get(manim_info_url, timeout=10)
-            req_info.raise_for_status()
-
-            stable = req_info.json()["info"]["version"]
+            with urllib.request.urlopen(
+                urllib.request.Request(manim_info_url),
+                timeout=10,
+            ) as response:
+                response = cast(http.client.HTTPResponse, response)
+                json_data = json.loads(response.read())
+        except urllib.error.HTTPError:
+            logger.debug("HTTP Error: %s", warn_prompt)
+        except urllib.error.URLError:
+            logger.debug("URL Error: %s", warn_prompt)
+        except json.JSONDecodeError:
+            logger.debug(
+                "Error while decoding JSON from %r: %s", manim_info_url, warn_prompt
+            )
+        except Exception:
+            logger.debug("Something went wrong: %s", warn_prompt)
+        else:
+            stable = json_data["info"]["version"]
             if stable != __version__:
                 console.print(
                     f"You are using manim version [red]v{__version__}[/red], but version [green]v{stable}[/green] is available.",
@@ -134,16 +152,5 @@ def render(
                 console.print(
                     "You should consider upgrading via [yellow]pip install -U manim[/yellow]",
                 )
-        except requests.exceptions.HTTPError:
-            logger.debug(f"HTTP Error: {warn_prompt}")
-        except requests.exceptions.ConnectionError:
-            logger.debug(f"Connection Error: {warn_prompt}")
-        except requests.exceptions.Timeout:
-            logger.debug(f"Timed Out: {warn_prompt}")
-        except json.JSONDecodeError:
-            logger.debug(warn_prompt)
-            logger.debug(f"Error decoding JSON from {manim_info_url}")
-        except Exception:
-            logger.debug(f"Something went wrong: {warn_prompt}")
 
     return args

manim/cli/render/ease_of_access_options.py

@@ -1,7 +1,8 @@
 from __future__ import annotations
 
-import click
-from cloup import option, option_group
+from cloup import Choice, option, option_group
+
+__all__ = ["ease_of_access_options"]
 
 ease_of_access_options = option_group(
     "Ease of access options",
@@ -9,7 +10,7 @@ ease_of_access_options = option_group(
         "--progress_bar",
         default=None,
         show_default=False,
-        type=click.Choice(
+        type=Choice(
             ["display", "leave", "none"],
             case_sensitive=False,
         ),

manim/cli/render/global_options.py

@@ -1,15 +1,12 @@
 from __future__ import annotations
 
 import re
-from typing import TYPE_CHECKING
 
-import click
-from cloup import option, option_group
+from cloup import Choice, option, option_group
 
 from ... import logger
 
-if TYPE_CHECKING:
-    from cloup._option_groups import OptionGroupDecorator
+__all__ = ["global_options"]
 
 
 def validate_gui_location(ctx, param, value):
@@ -22,7 +19,7 @@ def validate_gui_location(ctx, param, value):
             exit()
 
 
-global_options: OptionGroupDecorator = option_group(
+global_options = option_group(
     "Global options",
     option(
         "-c",
@@ -53,7 +50,7 @@ global_options: OptionGroupDecorator = option_group(
     option(
         "-v",
         "--verbosity",
-        type=click.Choice(
+        type=Choice(
             ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
             case_sensitive=False,
         ),
@@ -108,4 +105,9 @@ global_options: OptionGroupDecorator = option_group(
         help="Prevents deletion of .aux, .dvi, and .log files produced by Tex and MathTex.",
         default=False,
     ),
+    option(
+        "--preview_command",
+        help="The command used to preview the output file (for example vlc for video files)",
+        default="",
+    ),
 )

manim/cli/render/output_options.py

@@ -1,7 +1,8 @@
 from __future__ import annotations
 
-import click
-from cloup import option, option_group
+from cloup import IntRange, Path, option, option_group
+
+__all__ = ["output_options"]
 
 output_options = option_group(
     "Output options",
@@ -15,7 +16,7 @@ output_options = option_group(
     option(
         "-0",
         "--zero_pad",
-        type=click.IntRange(0, 9),
+        type=IntRange(0, 9),
         default=None,
         help="Zero padding for PNG file names.",
     ),
@@ -27,13 +28,13 @@ output_options = option_group(
     ),
     option(
         "--media_dir",
-        type=click.Path(),
+        type=Path(),
         default=None,
         help="Path to store rendered videos and latex.",
     ),
     option(
         "--log_dir",
-        type=click.Path(),
+        type=Path(),
         help="Path to store render logs.",
         default=None,
     ),

manim/cli/render/render_options.py

@@ -2,13 +2,14 @@ from __future__ import annotations
 
 import re
 
-import click
-from cloup import option, option_group
+from cloup import Choice, option, option_group
 
 from manim.constants import QUALITIES, RendererType
 
 from ... import logger
 
+__all__ = ["render_options"]
+
 
 def validate_scene_range(ctx, param, value):
     try:
@@ -55,15 +56,21 @@ render_options = option_group(
     ),
     option(
         "--format",
-        type=click.Choice(["png", "gif", "mp4", "webm", "mov"], case_sensitive=False),
+        type=Choice(["png", "gif", "mp4", "webm", "mov"], case_sensitive=False),
         default=None,
     ),
-    option("-s", "--save_last_frame", is_flag=True, default=None),
+    option(
+        "-s",
+        "--save_last_frame",
+        default=None,
+        is_flag=True,
+        help="Render and save only the last frame of a scene as a PNG image.",
+    ),
     option(
         "-q",
         "--quality",
         default=None,
-        type=click.Choice(
+        type=Choice(
             list(reversed([q["flag"] for q in QUALITIES.values() if q["flag"]])),  # type: ignore
             case_sensitive=False,
         ),
@@ -95,7 +102,7 @@ render_options = option_group(
     ),
     option(
         "--renderer",
-        type=click.Choice(
+        type=Choice(
             [renderer_type.value for renderer_type in RendererType],
             case_sensitive=False,
         ),
@@ -122,13 +129,6 @@ render_options = option_group(
         is_flag=True,
         help="Save section videos in addition to movie file.",
     ),
-    option(
-        "-s",
-        "--save_last_frame",
-        default=None,
-        is_flag=True,
-        help="Save last frame as png (Deprecated).",
-    ),
     option(
         "-t",
         "--transparent",

manim/constants.py

@@ -10,7 +10,7 @@ import numpy as np
 from cloup import Context
 from PIL.Image import Resampling
 
-from manim.typing import Vector3
+from manim.typing import Vector3D
 
 __all__ = [
     "SCENE_NOT_FOUND_MESSAGE",
@@ -76,6 +76,7 @@ __all__ = [
     "CTRL_VALUE",
     "RendererType",
     "LineJointType",
+    "CapStyleType",
 ]
 # Messages
 
@@ -122,43 +123,43 @@ RESAMPLING_ALGORITHMS = {
 }
 
 # Geometry: directions
-ORIGIN: Vector3 = np.array((0.0, 0.0, 0.0))
+ORIGIN: Vector3D = np.array((0.0, 0.0, 0.0))
 """The center of the coordinate system."""
 
-UP: Vector3 = np.array((0.0, 1.0, 0.0))
+UP: Vector3D = np.array((0.0, 1.0, 0.0))
 """One unit step in the positive Y direction."""
 
-DOWN: Vector3 = np.array((0.0, -1.0, 0.0))
+DOWN: Vector3D = np.array((0.0, -1.0, 0.0))
 """One unit step in the negative Y direction."""
 
-RIGHT: Vector3 = np.array((1.0, 0.0, 0.0))
+RIGHT: Vector3D = np.array((1.0, 0.0, 0.0))
 """One unit step in the positive X direction."""
 
-LEFT: Vector3 = np.array((-1.0, 0.0, 0.0))
+LEFT: Vector3D = np.array((-1.0, 0.0, 0.0))
 """One unit step in the negative X direction."""
 
-IN: Vector3 = np.array((0.0, 0.0, -1.0))
+IN: Vector3D = np.array((0.0, 0.0, -1.0))
 """One unit step in the negative Z direction."""
 
-OUT: Vector3 = np.array((0.0, 0.0, 1.0))
+OUT: Vector3D = np.array((0.0, 0.0, 1.0))
 """One unit step in the positive Z direction."""
 
 # Geometry: axes
-X_AXIS: Vector3 = np.array((1.0, 0.0, 0.0))
-Y_AXIS: Vector3 = np.array((0.0, 1.0, 0.0))
-Z_AXIS: Vector3 = np.array((0.0, 0.0, 1.0))
+X_AXIS: Vector3D = np.array((1.0, 0.0, 0.0))
+Y_AXIS: Vector3D = np.array((0.0, 1.0, 0.0))
+Z_AXIS: Vector3D = np.array((0.0, 0.0, 1.0))
 
 # Geometry: useful abbreviations for diagonals
-UL: Vector3 = UP + LEFT
+UL: Vector3D = UP + LEFT
 """One step up plus one step left."""
 
-UR: Vector3 = UP + RIGHT
+UR: Vector3D = UP + RIGHT
 """One step up plus one step right."""
 
-DL: Vector3 = DOWN + LEFT
+DL: Vector3D = DOWN + LEFT
 """One step down plus one step left."""
 
-DR: Vector3 = DOWN + RIGHT
+DR: Vector3D = DOWN + RIGHT
 """One step down plus one step right."""
 
 # Geometry
@@ -305,3 +306,41 @@ class LineJointType(Enum):
     ROUND = 1
     BEVEL = 2
     MITER = 3
+
+
+class CapStyleType(Enum):
+    """Collection of available cap styles.
+
+    See the example below for a visual illustration of the different
+    cap styles.
+
+    Examples
+    --------
+
+    .. manim:: CapStyleVariants
+        :save_last_frame:
+
+        class CapStyleVariants(Scene):
+            def construct(self):
+                arcs = VGroup(*[
+                    Arc(
+                        radius=1,
+                        start_angle=0,
+                        angle=TAU / 4,
+                        stroke_width=20,
+                        color=GREEN,
+                        cap_style=cap_style,
+                    )
+                    for cap_style in CapStyleType
+                ])
+                arcs.arrange(RIGHT, buff=1)
+                self.add(arcs)
+                for arc in arcs:
+                    label = Text(arc.cap_style.name, font_size=24).next_to(arc, DOWN)
+                    self.add(label)
+    """
+
+    AUTO = 0
+    ROUND = 1
+    BUTT = 2
+    SQUARE = 3

manim/gui/gui.py

@@ -13,6 +13,8 @@ except ImportError:
 from .. import __version__, config
 from ..utils.module_ops import scene_classes_from_file
 
+__all__ = ["configure_pygui"]
+
 if dearpygui_imported:
     dpg.create_context()
     window = dpg.generate_uuid()

manim/mobject/geometry/arc.py

@@ -67,7 +67,7 @@ if TYPE_CHECKING:
     from manim.mobject.mobject import Mobject
     from manim.mobject.text.tex_mobject import SingleStringMathTex, Tex
     from manim.mobject.text.text_mobject import Text
-    from manim.typing import CubicBezierPoints, Point3D, QuadraticBezierPoints, Vector
+    from manim.typing import CubicBezierPoints, Point3D, QuadraticBezierPoints, Vector3D
 
 
 class TipableVMobject(VMobject, metaclass=ConvertToOpenGL):
@@ -91,12 +91,12 @@ class TipableVMobject(VMobject, metaclass=ConvertToOpenGL):
     def __init__(
         self,
         tip_length: float = DEFAULT_ARROW_TIP_LENGTH,
-        normal_vector: Vector = OUT,
+        normal_vector: Vector3D = OUT,
         tip_style: dict = {},
         **kwargs,
     ) -> None:
         self.tip_length: float = tip_length
-        self.normal_vector: Vector = normal_vector
+        self.normal_vector: Vector3D = normal_vector
         self.tip_style: dict = tip_style
         super().__init__(**kwargs)
 
@@ -389,7 +389,7 @@ class Arc(TipableVMobject):
             # For a1 and a2 to lie at the same point arc radius
             # must be zero. Thus arc_center will also lie at
             # that point.
-            return a1
+            return np.copy(a1)
         # Tangent vectors
         t1 = h1 - a1
         t2 = h2 - a2

manim/mobject/geometry/boolean_ops.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 import numpy as np
 from pathops import Path as SkiaPath
 from pathops import PathVerb, difference, intersection, union, xor
@@ -9,7 +11,9 @@ from pathops import PathVerb, difference, intersection, union, xor
 from manim import config
 from manim.mobject.opengl.opengl_compatibility import ConvertToOpenGL
 from manim.mobject.types.vectorized_mobject import VMobject
-from manim.typing import Point2D_Array
+
+if TYPE_CHECKING:
+    from manim.typing import Point2D_Array, Point3D_Array
 
 from ...constants import RendererType
 
@@ -26,21 +30,21 @@ class _BooleanOps(VMobject, metaclass=ConvertToOpenGL):
         self,
         points: Point2D_Array,
         z_dim: float = 0.0,
-    ) -> list[np.ndarray]:
-        """Converts an iterable with coordinates in 2d to 3d by adding
-        :attr:`z_dim` as the z coordinate.
+    ) -> Point3D_Array:
+        """Converts an iterable with coordinates in 2D to 3D by adding
+        :attr:`z_dim` as the Z coordinate.
 
         Parameters
         ----------
         points:
-            An iterable which has the coordinates.
+            An iterable of points.
         z_dim:
-            The default value of z coordinate.
+            Default value for the Z coordinate.
 
         Returns
         -------
-        Point2D_Array
-            A list of array converted to 3d.
+        Point3D_Array
+            A list of the points converted to 3D.
 
         Example
         -------
@@ -66,7 +70,7 @@ class _BooleanOps(VMobject, metaclass=ConvertToOpenGL):
 
         Returns
         -------
-        SkiaPath:
+        SkiaPath
             The converted path.
         """
         path = SkiaPath()

manim/mobject/geometry/line.py

@@ -17,7 +17,6 @@ __all__ = [
 from typing import TYPE_CHECKING
 
 import numpy as np
-from typing_extensions import Self
 
 from manim import config
 from manim.constants import *
@@ -31,7 +30,9 @@ from manim.utils.color import WHITE
 from manim.utils.space_ops import angle_of_vector, line_intersection, normalize
 
 if TYPE_CHECKING:
-    from manim.typing import Point2D, Point3D, Vector
+    from typing_extensions import Self
+
+    from manim.typing import Point2D, Point3D, Vector3D
     from manim.utils.color import ParsableManimColor
 
     from ..matrix import Matrix  # Avoid circular import
@@ -107,7 +108,7 @@ class Line(TipableVMobject):
     def _pointify(
         self,
         mob_or_point: Mobject | Point3D,
-        direction: Vector | None = None,
+        direction: Vector3D | None = None,
     ) -> Point3D:
         """Transforms a mobject into its corresponding point. Does nothing if a point is passed.
 
@@ -163,16 +164,16 @@ class Line(TipableVMobject):
             self.generate_points()
         return super().put_start_and_end_on(start, end)
 
-    def get_vector(self) -> Vector:
+    def get_vector(self) -> Vector3D:
         return self.get_end() - self.get_start()
 
-    def get_unit_vector(self) -> Vector:
+    def get_unit_vector(self) -> Vector3D:
         return normalize(self.get_vector())
 
     def get_angle(self) -> float:
         return angle_of_vector(self.get_vector())
 
-    def get_projection(self, point: Point3D) -> Vector:
+    def get_projection(self, point: Point3D) -> Vector3D:
         """Returns the projection of a point onto a line.
 
         Parameters
@@ -579,7 +580,7 @@ class Arrow(Line):
             self.add_tip(tip=old_tips[1], at_start=True)
         return self
 
-    def get_normal_vector(self) -> Vector:
+    def get_normal_vector(self) -> Vector3D:
         """Returns the normal of a vector.
 
         Examples
@@ -632,6 +633,11 @@ class Arrow(Line):
 class Vector(Arrow):
     """A vector specialized for use in graphs.
 
+    .. caution::
+        Do not confuse with the :class:`~.Vector2D`,
+        :class:`~.Vector3D` or :class:`~.VectorND` type aliases,
+        which are not Mobjects!
+
     Parameters
     ----------
     direction
@@ -654,7 +660,9 @@ class Vector(Arrow):
                 self.add(plane, vector_1, vector_2)
     """
 
-    def __init__(self, direction: Vector = RIGHT, buff: float = 0, **kwargs) -> None:
+    def __init__(
+        self, direction: Point2D | Point3D = RIGHT, buff: float = 0, **kwargs
+    ) -> None:
         self.buff = buff
         if len(direction) == 2:
             direction = np.hstack([direction, 0])

manim/mobject/geometry/polygram.py

@@ -598,8 +598,10 @@ class Rectangle(Polygon):
             def construct(self):
                 rect1 = Rectangle(width=4.0, height=2.0, grid_xstep=1.0, grid_ystep=0.5)
                 rect2 = Rectangle(width=1.0, height=4.0)
+                rect3 = Rectangle(width=2.0, height=2.0, grid_xstep=1.0, grid_ystep=1.0)
+                rect3.grid_lines.set_stroke(width=1)
 
-                rects = Group(rect1,rect2).arrange(buff=1)
+                rects = Group(rect1, rect2, rect3).arrange(buff=1)
                 self.add(rects)
     """
 
@@ -617,10 +619,16 @@ class Rectangle(Polygon):
         super().__init__(UR, UL, DL, DR, color=color, **kwargs)
         self.stretch_to_fit_width(width)
         self.stretch_to_fit_height(height)
+
         v = self.get_vertices()
-        if grid_xstep is not None:
+        self.grid_lines = VGroup()
+
+        if grid_xstep or grid_ystep:
             from manim.mobject.geometry.line import Line
 
+            v = self.get_vertices()
+
+        if grid_xstep:
             grid_xstep = abs(grid_xstep)
             count = int(width / grid_xstep)
             grid = VGroup(
@@ -633,8 +641,9 @@ class Rectangle(Polygon):
                     for i in range(1, count)
                 )
             )
-            self.add(grid)
-        if grid_ystep is not None:
+            self.grid_lines.add(grid)
+
+        if grid_ystep:
             grid_ystep = abs(grid_ystep)
             count = int(height / grid_ystep)
             grid = VGroup(
@@ -647,7 +656,10 @@ class Rectangle(Polygon):
                     for i in range(1, count)
                 )
             )
-            self.add(grid)
+            self.grid_lines.add(grid)
+
+        if self.grid_lines:
+            self.add(self.grid_lines)
 
 
 class Square(Rectangle):

manim/mobject/geometry/tips.py

@@ -25,7 +25,7 @@ from manim.mobject.types.vectorized_mobject import VMobject
 from manim.utils.space_ops import angle_of_vector
 
 if TYPE_CHECKING:
-    from manim.typing import Point3D, Vector
+    from manim.typing import Point3D, Vector3D
 
 
 class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
@@ -149,7 +149,7 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
         return self.points[0]
 
     @property
-    def vector(self) -> Vector:
+    def vector(self) -> Vector3D:
         r"""The vector pointing from the base point to the tip point.
 
         Examples