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

manim/utils/file_ops.py

@@ -28,11 +28,13 @@ from shutil import copyfile
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
+    from manim.typing import StrPath
+
     from ..scene.scene_file_writer import SceneFileWriter
 
 from manim import __version__, config, logger
 
-from .. import config, console
+from .. import console
 
 
 def is_mp4_format() -> bool:
@@ -45,7 +47,8 @@ def is_mp4_format() -> bool:
         ``True`` if format is set as mp4
 
     """
-    return config["format"] == "mp4"
+    val: bool = config["format"] == "mp4"
+    return val
 
 
 def is_gif_format() -> bool:
@@ -58,7 +61,8 @@ def is_gif_format() -> bool:
         ``True`` if format is set as gif
 
     """
-    return config["format"] == "gif"
+    val: bool = config["format"] == "gif"
+    return val
 
 
 def is_webm_format() -> bool:
@@ -71,7 +75,8 @@ def is_webm_format() -> bool:
         ``True`` if format is set as webm
 
     """
-    return config["format"] == "webm"
+    val: bool = config["format"] == "webm"
+    return val
 
 
 def is_mov_format() -> bool:
@@ -84,7 +89,8 @@ def is_mov_format() -> bool:
         ``True`` if format is set as mov
 
     """
-    return config["format"] == "mov"
+    val: bool = config["format"] == "mov"
+    return val
 
 
 def is_png_format() -> bool:
@@ -97,7 +103,8 @@ def is_png_format() -> bool:
         ``True`` if format is set as png
 
     """
-    return config["format"] == "png"
+    val: bool = config["format"] == "png"
+    return val
 
 
 def write_to_movie() -> bool:
@@ -124,7 +131,7 @@ def write_to_movie() -> bool:
 
 def ensure_executable(path_to_exe: Path) -> bool:
     if path_to_exe.parent == Path("."):
-        executable = shutil.which(path_to_exe.stem)
+        executable: StrPath | None = shutil.which(path_to_exe.stem)
         if executable is None:
             return False
     else:
@@ -159,7 +166,7 @@ def guarantee_empty_existence(path: Path) -> Path:
 
 
 def seek_full_path_from_defaults(
-    file_name: str, default_dir: Path, extensions: list[str]
+    file_name: StrPath, default_dir: Path, extensions: list[str]
 ) -> Path:
     possible_paths = [Path(file_name).expanduser()]
     possible_paths += [
@@ -186,10 +193,12 @@ def modify_atime(file_path: str) -> None:
     os.utime(file_path, times=(time.time(), Path(file_path).stat().st_mtime))
 
 
-def open_file(file_path, in_browser=False):
+def open_file(file_path: Path, in_browser: bool = False) -> None:
     current_os = platform.system()
     if current_os == "Windows":
-        os.startfile(file_path if not in_browser else file_path.parent)
+        # The method os.startfile is only available in Windows,
+        # ignoring type error caused by this.
+        os.startfile(file_path if not in_browser else file_path.parent)  # type: ignore[attr-defined]
     else:
         if current_os == "Linux":
             commands = ["xdg-open"]
@@ -198,17 +207,14 @@ def open_file(file_path, in_browser=False):
             commands = ["cygstart"]
             file_path = file_path if not in_browser else file_path.parent
         elif current_os == "Darwin":
-            if is_gif_format():
-                commands = ["ffplay", "-loglevel", config["ffmpeg_loglevel"].lower()]
-            else:
-                commands = ["open"] if not in_browser else ["open", "-R"]
+            commands = ["open"] if not in_browser else ["open", "-R"]
         else:
             raise OSError("Unable to identify your operating system...")
 
         # check after so that file path is set correctly
         if config.preview_command:
             commands = [config.preview_command]
-        commands.append(file_path)
+        commands.append(str(file_path))
         sp.run(commands)
 
 
@@ -252,7 +258,7 @@ def get_template_path() -> Path:
     return Path.resolve(Path(__file__).parent.parent / "templates")
 
 
-def add_import_statement(file: Path):
+def add_import_statement(file: Path) -> None:
     """Prepends an import statement in a file
 
     Parameters

manim/utils/hashing.py

@@ -14,13 +14,13 @@ from typing import Any
 
 import numpy as np
 
-from manim.animation.animation import Animation
-from manim.camera.camera import Camera
-from manim.mobject.mobject import Mobject
-
-from .. import config, logger
+from manim._config import config, logger
 
 if typing.TYPE_CHECKING:
+    from manim.animation.animation import Animation
+    from manim.camera.camera import Camera
+    from manim.mobject.mobject import Mobject
+    from manim.opengl.opengl_renderer import OpenGLCamera
     from manim.scene.scene import Scene
 
 __all__ = ["KEYS_TO_FILTER_OUT", "get_hash_from_play_call", "get_json"]
@@ -223,7 +223,7 @@ class _CustomEncoder(json.JSONEncoder):
             # We return the repr and not a list to avoid the JsonEncoder to iterate over it.
             return repr(obj)
         elif hasattr(obj, "__dict__"):
-            temp = getattr(obj, "__dict__")
+            temp = obj.__dict__
             # MappingProxy is scene-caching nightmare. It contains all of the object methods and attributes. We skip it as the mechanism will at some point process the object, but instantiated.
             # Indeed, there is certainly no case where scene-caching will receive only a non instancied object, as this is never used in the library or encouraged to be used user-side.
             if isinstance(temp, MappingProxyType):
@@ -324,7 +324,7 @@ def get_json(obj: dict):
 
 def get_hash_from_play_call(
     scene_object: Scene,
-    camera_object: Camera,
+    camera_object: Camera | OpenGLCamera,
     animations_list: typing.Iterable[Animation],
     current_mobjects_list: typing.Iterable[Mobject],
 ) -> str:

manim/utils/images.py

@@ -9,16 +9,22 @@ __all__ = [
     "change_to_rgba_array",
 ]
 
-from pathlib import Path
+from pathlib import Path, PurePath
+from typing import TYPE_CHECKING
 
 import numpy as np
 from PIL import Image
 
+from manim.typing import RGBPixelArray
+
 from .. import config
 from ..utils.file_ops import seek_full_path_from_defaults
 
+if TYPE_CHECKING:
+    pass
+
 
-def get_full_raster_image_path(image_file_name: str) -> Path:
+def get_full_raster_image_path(image_file_name: str | PurePath) -> Path:
     return seek_full_path_from_defaults(
         image_file_name,
         default_dir=config.get_dir("assets_dir"),
@@ -26,7 +32,7 @@ def get_full_raster_image_path(image_file_name: str) -> Path:
     )
 
 
-def get_full_vector_image_path(image_file_name: str) -> Path:
+def get_full_vector_image_path(image_file_name: str | PurePath) -> Path:
     return seek_full_path_from_defaults(
         image_file_name,
         default_dir=config.get_dir("assets_dir"),
@@ -49,7 +55,7 @@ def invert_image(image: np.array) -> Image:
     return Image.fromarray(arr)
 
 
-def change_to_rgba_array(image, dtype="uint8"):
+def change_to_rgba_array(image: RGBPixelArray, dtype: str = "uint8") -> RGBPixelArray:
     """Converts an RGB array into RGBA with the alpha value opacity maxed."""
     pa = image
     if len(pa.shape) == 2:

manim/utils/ipython_magic.py

@@ -3,13 +3,12 @@
 from __future__ import annotations
 
 import mimetypes
-import os
 import shutil
 from datetime import datetime
 from pathlib import Path
 from typing import Any
 
-from manim import Group, config, logger, tempconfig
+from manim import config, logger, tempconfig
 from manim.__main__ import main
 from manim.renderer.shader import shader_program_cache
 
@@ -35,15 +34,15 @@ else:
     class ManimMagic(Magics):
         def __init__(self, shell: InteractiveShell) -> None:
             super().__init__(shell)
-            self.rendered_files = {}
+            self.rendered_files: dict[Path, Path] = {}
 
         @needs_local_scope
         @line_cell_magic
         def manim(
             self,
             line: str,
-            cell: str = None,
-            local_ns: dict[str, Any] = None,
+            cell: str | None = None,
+            local_ns: dict[str, Any] | None = None,
         ) -> None:
             r"""Render Manim scenes contained in IPython cells.
             Works as a line or cell magic.
@@ -128,8 +127,9 @@ else:
 
             modified_args = self.add_additional_args(args)
             args = main(modified_args, standalone_mode=False, prog_name="manim")
+            assert isinstance(local_ns, dict)
             with tempconfig(local_ns.get("config", {})):
-                config.digest_args(args)
+                config.digest_args(args)  # type: ignore[arg-type]
 
                 renderer = None
                 if config.renderer == RendererType.OPENGL:
@@ -168,8 +168,9 @@ else:
                 shutil.copy(local_path, tmpfile)
 
                 file_type = mimetypes.guess_type(config["output_file"])[0]
+                assert isinstance(file_type, str)
                 embed = config["media_embed"]
-                if embed is None:
+                if not embed:
                     # videos need to be embedded when running in google colab.
                     # do this automatically in case config.media_embed has not been
                     # set explicitly.
@@ -195,4 +196,7 @@ else:
 
 
 def _generate_file_name() -> str:
-    return config["scene_names"][0] + "@" + datetime.now().strftime("%Y-%m-%d@%H-%M-%S")
+    val: str = (
+        config["scene_names"][0] + "@" + datetime.now().strftime("%Y-%m-%d@%H-%M-%S")
+    )
+    return val