chore(deps): bump ManimGL to 1.7.1 (#499)

* chore(deps): bump ManimGL to 1.7.1

Bump ManimGL's minimal version, so relax constraints on other deps and remove compatibility issues with Manim

* fix(docs): correct PR number

* fix(lib): update ManimGL's init

See 3b1b/manim#2261

* fix(lib): force float

* chore(tests): correctly ignore warning

* fix(tests)

* fix(tests): add skips

* chore(fmt): auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix(tests)

* oops

* fix on 3.12

* fix(lib): correctly patch ManimGL

* fix(deps): pyrr issue

* fix: version

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: jeertmans

CHANGELOG.md

@@ -21,6 +21,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   [@PeculiarProgrammer](https://github.com/PeculiarProgrammer)
   [#482](https://github.com/jeertmans/manim-slides/pull/482)
 
+(unreleased-chore)=
+### Chore
+
+- Bump ManimGL to `>=1.7.1`, to remove conflicting dependencies
+  with Manim's.
+  [#499](https://github.com/jeertmans/manim-slides/pull/499)
+
 (v5.1.10)=
 ## [v5.1.10](https://github.com/jeertmans/manim-slides/compare/v5.1.9...v5.1.10)
 

docs/source/faq.md

@@ -29,13 +29,8 @@ ManimGL support is only guaranteed to work
 on a very minimal set of versions, because it differs quite a lot from ManimCE,
 and its development is not very active.
 
-The typical issues are that (1) ManimGL needs an outdated NumPy version
-and (2) ManimGL **should not** be installed from the GitHub repository,
-at least not from the `main` branch, but from a version released to PyPI.
-
-To solve the NumPy issue, you can safely downgrade NumPy to a version supported
-by ManimGL,
-while ignoring the possible *conflicting dependencies* messages from `pip` (or else).
+The typical issue is that ManimGL `<1.7.1` needs an outdated NumPy version, but
+can be resolved by manually downgrading NumPy, or upgrading ManimGL (**recommended**).
 
 ### Presenting
 

docs/source/installation.md

@@ -29,19 +29,6 @@ please refer to their specific installation guidelines:
 - [Manim](https://docs.manim.community/en/stable/installation.html)
 - [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)
 
-:::{warning}
-If you install Manim from its git repository, as suggested by ManimGL,
-make sure to first check out a supported version (e.g., `git checkout tags/v1.6.1`
-for ManimGL), otherwise it might install an unsupported version of Manim!
-See [#314](https://github.com/jeertmans/manim-slides/issues/314).
-
-Also, note that ManimGL uses outdated dependencies, and may
-not work out-of-the-box. One example is NumPy: ManimGL
-does not specify any restriction on this package, but
-only `numpy<1.25` will work, see
-[#2053](https://github.com/3b1b/manim/issues/2053).
-:::
-
 <!-- end deps -->
 
 ## Pip Install

manim_slides/slide/manimlib.py

@@ -10,29 +10,39 @@
 class Slide(BaseSlide, Scene):  # type: ignore[misc]
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         kwargs.setdefault("file_writer_config", {}).update(
-            skip_animations=True,
             break_into_partial_movies=True,
             write_to_movie=True,
         )
+        # See: https://github.com/3b1b/manim/issues/2261
+        if kwargs["file_writer_config"].setdefault("output_directory", ".") == "":
+            kwargs["file_writer_config"]["output_directory"] = "."
 
         kwargs["preview"] = False  # Avoid opening a preview window
         super().__init__(*args, **kwargs)
 
     @property
     def _frame_height(self) -> float:
-        return self.camera.frame.get_height()  # type: ignore
+        return float(self.camera.get_frame_height())
 
     @property
     def _frame_width(self) -> float:
-        return self.camera.frame.get_width()  # type: ignore
+        return float(self.camera.get_frame_width())
 
     @property
     def _background_color(self) -> str:
-        return self.camera_config["background_color"].hex  # type: ignore
+        rgba = self.camera.background_rgba
+        r = int(255 * rgba[0])
+        g = int(255 * rgba[1])
+        b = int(255 * rgba[2])
+        if rgba[3] == 1.0:
+            return f"#{r:02x}{g:02x}{b:02x}"
+
+        a = int(255 * rgba[3])
+        return f"#{r:02x}{g:02x}{b:02x}{a:02x}"
 
     @property
     def _resolution(self) -> tuple[int, int]:
-        return self.camera_config["pixel_width"], self.camera_config["pixel_height"]
+        return self.camera.get_pixel_width(), self.camera.get_pixel_height()
 
     @property
     def _partial_movie_files(self) -> list[Path]:

pyproject.toml

@@ -59,7 +59,7 @@ full = [
 ]
 magic = ["manim-slides[manim]", "ipython>=8.12.2"]
 manim = ["manim>=0.18.0"]
-manimgl = ["manimgl>=1.6.1;python_version<'3.12'"]
+manimgl = ["manimgl>=1.7.1", "pyrr"]
 pyqt6 = ["pyqt6>=6.7.0"]
 pyqt6-full = ["manim-slides[full,pyqt6]"]
 pyside6 = ["pyside6>=6.6.1"]
@@ -190,7 +190,8 @@ filterwarnings = [
   '''ignore:'audioop' is deprecated:DeprecationWarning''',
   'ignore:pkg_resources is deprecated as an API:DeprecationWarning',
   'ignore::DeprecationWarning:pkg_resources.*:',
-  'ignore::DeprecationWarning:pydub.*:',
+  'ignore:invalid escape sequence.*:DeprecationWarning',
+  'ignore:invalid escape sequence.*:SyntaxWarning',
 ]
 
 [tool.ruff]
@@ -227,9 +228,3 @@ dev-dependencies = [
   "pre-commit>=3.5.0",
   "setuptools>=73.0.1",
 ]
-override-dependencies = [
-  # Bypass constraints from ManimGL
-  "manimpango>=0.5.0,<1.0.0",
-  "numpy<=1.24;python_version < '3.12'",
-  "numpy>=1.26;python_version >= '3.12'",
-]

tests/test_checkhealth.py

@@ -39,6 +39,13 @@ def test_checkhealth(
         del sys.modules["qtpy"]  # Avoid using cached module
 
     with missing_modules(*names):
+        if (
+            not manimlib_missing
+            and not MANIMGL_NOT_INSTALLED
+            and sys.version_info < (3, 10)
+        ):
+            pytest.skip("See https://github.com/3b1b/manim/issues/2263")
+
         result = runner.invoke(
             checkhealth,
             env={"QT_API": "pyqt6", "FORCE_QT_API": "1"},

tests/test_manim.py

@@ -6,6 +6,11 @@
 
 import manim_slides.slide as slide
 
+skip_if_py39 = pytest.mark.skipif(
+    sys.version_info < (3, 10),
+    reason="See https://github.com/3b1b/manim/issues/2263",
+)
+
 
 def assert_import(
     *,
@@ -20,6 +25,7 @@ def assert_import(
     assert slide.MANIMGL == manimgl
 
 
+@skip_if_py39
 def test_force_api() -> None:
     pytest.importorskip("manimlib")
     import manim  # noqa: F401
@@ -53,6 +59,7 @@ def test_invalid_api() -> None:
     del os.environ[slide.MANIM_API]
 
 
+@skip_if_py39
 @pytest.mark.filterwarnings("ignore:assert_import")
 def test_manim_and_manimgl_imported() -> None:
     pytest.importorskip("manimlib")
@@ -79,6 +86,7 @@ def test_manim_imported() -> None:
     )
 
 
+@skip_if_py39
 def test_manimgl_imported() -> None:
     pytest.importorskip("manimlib")
     import manimlib  # noqa: F401

tests/test_slide.py

@@ -26,23 +26,32 @@
 from manim_slides.render import render
 from manim_slides.slide.manim import Slide as CESlide
 
-
-class CEGLSlide(CESlide):
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        super().__init__(*args, renderer=OpenGLRenderer(), **kwargs)
-
-
-if sys.version_info >= (3, 12):
+if sys.version_info < (3, 10):
 
     class _GLSlide:
-        pass
+        def construct(self) -> None:
+            pass
+
+        def render(self) -> None:
+            pass
 
-    GLSlide = pytest.param(_GLSlide, marks=pytest.mark.skip())
+    GLSlide = pytest.param(
+        _GLSlide,
+        marks=pytest.mark.skip(reason="See https://github.com/3b1b/manim/issues/2263"),
+    )
 else:
     from manim_slides.slide.manimlib import Slide as GLSlide
 
-SlideType = Union[type[CESlide], type[GLSlide], type[CEGLSlide]]
-Slide = Union[CESlide, GLSlide, CEGLSlide]
+    _GLSlide = GLSlide
+
+
+class CEGLSlide(CESlide):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, renderer=OpenGLRenderer(), **kwargs)
+
+
+SlideType = Union[type[CESlide], type[_GLSlide], type[CEGLSlide]]
+Slide = Union[CESlide, _GLSlide, CEGLSlide]
 
 
 @pytest.mark.parametrize(
@@ -52,8 +61,8 @@ class _GLSlide:
         pytest.param(
             "--GL",
             marks=pytest.mark.skipif(
-                sys.version_info >= (3, 12),
-                reason="ManimGL requires numpy<1.25, which is outdated and Python < 3.12",
+                sys.version_info < (3, 10),
+                reason="See https://github.com/3b1b/manim/issues/2263.",
             ),
         ),
     ],
@@ -161,8 +170,8 @@ def test_clear_cache(
         pytest.param(
             "--GL",
             marks=pytest.mark.skipif(
-                sys.version_info >= (3, 12),
-                reason="ManimGL requires numpy<1.25, which is outdated and Python < 3.12",
+                sys.version_info < (3, 10),
+                reason="See https://github.com/3b1b/manim/issues/2263.",
             ),
         ),
     ],