refactor: use PyQT5 for window display (#49)

* wip: use PyQT5 for window display

* [pre-commit.ci] auto fixes from pre-commit.com hooks

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

* wip: first slide is shown

* [pre-commit.ci] auto fixes from pre-commit.com hooks

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

* wip: pushing non-working code

* [pre-commit.ci] auto fixes from pre-commit.com hooks

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

* wip: some logging

* [pre-commit.ci] auto fixes from pre-commit.com hooks

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

* feat: new configuration wizard working

* fix: prevent key error

* wip: making action work

* [pre-commit.ci] auto fixes from pre-commit.com hooks

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

* wip: soon done! info + video

* [pre-commit.ci] auto fixes from pre-commit.com hooks

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

* fix: bugs in sleep and exiting

* [pre-commit.ci] auto fixes from pre-commit.com hooks

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

* try: offscreen

* fix: pop default value if not present

* [pre-commit.ci] auto fixes from pre-commit.com hooks

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

* feat: add aspect ratio option

* chore: typing wip

* fix: now() function returns seconds, not milliseconds anymore

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

Author: jeertmans

.github/workflows/test_examples.yml

@@ -6,6 +6,9 @@ on:
 
 name: Test Examples
 
+env:
+  QT_QPA_PLATFORM: offscreen
+
 jobs:
   build-examples:
     strategy:

.pre-commit-config.yaml

@@ -38,17 +38,13 @@ repos:
         - --ignore-missing-imports
         # Disallow dynamic typing
         - --disallow-any-unimported
-        - --disallow-any-expr
-        - --disallow-any-decorated
         - --disallow-any-generics
-        - --disallow-any-explicit
         - --disallow-subclassing-any
 
         # Disallow untyped definitions and calls
         - --disallow-untyped-defs
         - --disallow-incomplete-defs
         - --check-untyped-defs
-        - --disallow-untyped-decorators
 
         # None and optional handling
         - --no-implicit-optional

manim_slides/config.py

@@ -3,8 +3,8 @@
 from typing import List, Optional, Set
 
 from pydantic import BaseModel, root_validator, validator
+from PyQt5.QtCore import Qt
 
-from .defaults import LEFT_ARROW_KEY_CODE, RIGHT_ARROW_KEY_CODE
 from .manim import logger
 
 
@@ -14,13 +14,16 @@ class Key(BaseModel):
     ids: Set[int]
     name: Optional[str] = None
 
+    def set_ids(self, *ids: int) -> None:
+        self.ids = set(ids)
+
     @validator("ids", each_item=True)
-    def id_is_posint(cls, v: int):
+    def id_is_posint(cls, v: int) -> int:
         if v < 0:
             raise ValueError("Key ids cannot be negative integers")
         return v
 
-    def match(self, key_id: int):
+    def match(self, key_id: int) -> bool:
         m = key_id in self.ids
 
         if m:
@@ -32,12 +35,12 @@ def match(self, key_id: int):
 class Config(BaseModel):
     """General Manim Slides config"""
 
-    QUIT: Key = Key(ids=[ord("q")], name="QUIT")
-    CONTINUE: Key = Key(ids=[RIGHT_ARROW_KEY_CODE], name="CONTINUE / NEXT")
-    BACK: Key = Key(ids=[LEFT_ARROW_KEY_CODE], name="BACK")
-    REVERSE: Key = Key(ids=[ord("v")], name="REVERSE")
-    REWIND: Key = Key(ids=[ord("r")], name="REWIND")
-    PLAY_PAUSE: Key = Key(ids=[32], name="PLAY / PAUSE")
+    QUIT: Key = Key(ids=[Qt.Key_Q], name="QUIT")
+    CONTINUE: Key = Key(ids=[Qt.Key_Right], name="CONTINUE / NEXT")
+    BACK: Key = Key(ids=[Qt.Key_Left], name="BACK")
+    REVERSE: Key = Key(ids=[Qt.Key_V], name="REVERSE")
+    REWIND: Key = Key(ids=[Qt.Key_R], name="REWIND")
+    PLAY_PAUSE: Key = Key(ids=[Qt.Key_Space], name="PLAY / PAUSE")
 
     @root_validator
     def ids_are_unique_across_keys(cls, values):
@@ -46,7 +49,7 @@ def ids_are_unique_across_keys(cls, values):
         for key in values.values():
             if len(ids.intersection(key.ids)) != 0:
                 raise ValueError(
-                    "Two or more keys share a common key code: please make sure each key has distinc key codes"
+                    "Two or more keys share a common key code: please make sure each key has distinct key codes"
                 )
             ids.update(key.ids)
 

manim_slides/defaults.py

@@ -1,32 +1,2 @@
-import platform
-from typing import Tuple
-
-import cv2
-
-__all__ = [
-    "FONT_ARGS",
-    "FOLDER_PATH",
-    "CONFIG_PATH",
-    "RIGHT_ARROW_KEY_CODE",
-    "LEFT_ARROW_KEY_CODE",
-]
-
-FONT_ARGS: Tuple[int, int, int, int, int] = (
-    cv2.FONT_HERSHEY_SIMPLEX,  # type: ignore
-    1,
-    255,
-    1,
-    cv2.LINE_AA,  # type: ignore
-)
 FOLDER_PATH: str = "./slides"
 CONFIG_PATH: str = ".manim-slides.json"
-
-if platform.system() == "Windows":
-    RIGHT_ARROW_KEY_CODE: int = 2555904
-    LEFT_ARROW_KEY_CODE: int = 2424832
-elif platform.system() == "Darwin":
-    RIGHT_ARROW_KEY_CODE = 63235
-    LEFT_ARROW_KEY_CODE = 63234
-else:
-    RIGHT_ARROW_KEY_CODE = 65363
-    LEFT_ARROW_KEY_CODE = 65361

manim_slides/main.py

@@ -9,7 +9,7 @@
 @click.group(cls=DefaultGroup, default="present", default_if_no_args=True)
 @click.version_option(__version__, "-v", "--version")
 @click.help_option("-h", "--help")
-def cli():
+def cli() -> None:
     """
     Manim Slides command-line utilities.
 

manim_slides/manim.py

@@ -2,6 +2,7 @@
 import sys
 from contextlib import contextmanager
 from importlib.util import find_spec
+from typing import Iterator
 
 __all__ = [
     "MANIM",
@@ -21,7 +22,7 @@
 
 
 @contextmanager
-def suppress_stdout() -> None:
+def suppress_stdout() -> Iterator[None]:
     with open(os.devnull, "w") as devnull:
         old_stdout = sys.stdout
         sys.stdout = devnull
@@ -65,8 +66,6 @@ def suppress_stdout() -> None:
     )
 
 
-FFMPEG_BIN = None
-
 if MANIMGL:
     from manimlib import Scene, ThreeDScene, config
     from manimlib.constants import FFMPEG_BIN