chore(tests): adding tests for Qt widgets (#300)

* chore(tests): adding tests for Qt widgets

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

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

* fix: reset WINDOW name

* chore(tests): addign tests

* chore: adding more tests

* fix how bin existence is checked

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

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

* fix: which takes str

* more tests!

* todo: fix

* change verbosity in tests

---------

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

Author: jeertmans

.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     env:
       QT_QPA_PLATFORM: offscreen
-      MANIM_SLIDES_VERBOSITY: debug
+      MANIM_SLIDES_VERBOSITY: error
       PYTHONFAULTHANDLER: 1
       DISPLAY: :99
       GITHUB_WORKFLOWS: 1

CHANGELOG.md

@@ -46,6 +46,8 @@ In an effort to better document changes, this CHANGELOG document is now created.
 - Added `Slide.next_section` for compatibility with `manim`'s
   `Scene.next_section` method.
   [#295](https://github.com/jeertmans/manim-slides/pull/295)
+- Added `--playback-rate` option to `manim-slides present` for testing purposes.
+  [#300](https://github.com/jeertmans/manim-slides/pull/300)
 
 (v5-changed)=
 ### Changed

manim_slides/present/__init__.py

@@ -7,11 +7,11 @@
 from click import Context, Parameter
 from pydantic import ValidationError
 from PySide6.QtCore import Qt
-from PySide6.QtWidgets import QApplication
 
 from ..commons import config_path_option, folder_path_option, verbosity_option
 from ..config import Config, PresentationConfig
 from ..logger import logger
+from ..qt_utils import qapp
 from .player import Player
 
 ASPECT_RATIO_MODES = {
@@ -210,7 +210,14 @@ def str_to_int_or_none(value: str) -> Optional[int]:
     metavar="NUMBER",
     type=int,
     default=None,
-    help="Presents content on the given screen (a.k.a. display).",
+    help="Present content on the given screen (a.k.a. display).",
+)
+@click.option(
+    "--playback-rate",
+    metavar="RATE",
+    type=float,
+    default=1.0,
+    help="Playback rate of the video slides, see PySide6 docs for details.",
 )
 @click.help_option("-h", "--help")
 @verbosity_option
@@ -228,6 +235,7 @@ def present(
     start_at_scene_number: int,
     start_at_slide_number: int,
     screen_number: Optional[int] = None,
+    playback_rate: float = 1.0,
 ) -> None:
     """
     Present SCENE(s), one at a time, in order.
@@ -258,13 +266,9 @@ def present(
         start_at_scene_number = start_at[0]
 
     if start_at[1]:
-        start_at_scene_number = start_at[1]
-
-    if maybe_app := QApplication.instance():
-        app = maybe_app
-    else:
-        app = QApplication(sys.argv)
+        start_at_slide_number = start_at[1]
 
+    app = qapp()
     app.setApplicationName("Manim Slides")
 
     if screen_number is not None:
@@ -291,9 +295,10 @@ def present(
         presentation_index=start_at_scene_number,
         slide_index=start_at_slide_number,
         screen=screen,
+        playback_rate=playback_rate,
     )
 
     player.show()
 
     signal.signal(signal.SIGINT, signal.SIG_DFL)
-    sys.exit(app.exec_())
+    sys.exit(app.exec())

manim_slides/present/player.py

@@ -53,6 +53,7 @@ def __init__(
         presentation_index: int = 0,
         slide_index: int = 0,
         screen: Optional[QScreen] = None,
+        playback_rate: float = 1.0,
     ):
         super().__init__()
 
@@ -65,11 +66,12 @@ def __init__(
         self.presentation_configs = presentation_configs
         self.__current_presentation_index = 0
         self.__current_slide_index = 0
-        self.__current_file: Path = self.current_slide_config.file
 
         self.current_presentation_index = presentation_index
         self.current_slide_index = slide_index
 
+        self.__current_file: Path = self.current_slide_config.file
+
         self.__playing_reversed_slide = False
 
         # Widgets
@@ -100,6 +102,7 @@ def __init__(
 
         self.media_player = QMediaPlayer(self)
         self.media_player.setVideoOutput(self.video_widget)
+        self.media_player.setPlaybackRate(playback_rate)
 
         self.presentation_changed.connect(self.presentation_changed_callback)
         self.slide_changed.connect(self.slide_changed_callback)
@@ -108,7 +111,7 @@ def __init__(
 
         # Connecting key callbacks
 
-        self.config.keys.QUIT.connect(self.quit)
+        self.config.keys.QUIT.connect(self.close)
         self.config.keys.PLAY_PAUSE.connect(self.play_pause)
         self.config.keys.NEXT.connect(self.next)
         self.config.keys.PREVIOUS.connect(self.previous)
@@ -161,7 +164,7 @@ def current_presentation_index(self, index: int) -> None:
         elif -self.presentations_count <= index < 0:
             self.__current_presentation_index = index + self.presentations_count
         else:
-            logger.warn(f"Could not set presentation index to {index}")
+            logger.warn(f"Could not set presentation index to {index}.")
             return
 
         self.presentation_changed.emit()
@@ -185,7 +188,7 @@ def current_slide_index(self, index: int) -> None:
         elif -self.current_slides_count <= index < 0:
             self.__current_slide_index = index + self.current_slides_count
         else:
-            logger.warn(f"Could not set slide index to {index}")
+            logger.warn(f"Could not set slide index to {index}.")
             return
 
         self.slide_changed.emit()
@@ -257,7 +260,8 @@ def load_next_slide(self) -> None:
             self.current_presentation_index += 1
             self.current_slide_index = 0
         elif self.exit_after_last_slide:
-            self.quit()
+            self.close()
+            return
         else:
             logger.info("No more slide to play.")
             return
@@ -290,10 +294,9 @@ def show(self) -> None:
         self.info.show()
 
     @Slot()
-    def quit(self) -> None:
+    def close(self) -> None:
         logger.info("Closing gracefully...")
-        self.info.deleteLater()
-        self.deleteLater()
+        super().close()
 
     @Slot()
     def next(self) -> None:
@@ -338,7 +341,7 @@ def hide_mouse(self) -> None:
             self.setCursor(Qt.BlankCursor)
 
     def closeEvent(self, event: QCloseEvent) -> None:  # noqa: N802
-        self.quit()
+        self.close()
 
     def keyPressEvent(self, event: QKeyEvent) -> None:  # noqa: N802
         key = event.key()

manim_slides/qt_utils.py

@@ -0,0 +1,14 @@
+"""Qt utils."""
+
+from PySide6.QtWidgets import QApplication
+
+
+def qapp() -> QApplication:
+    """
+    Return a QApplication instance, creating one
+    if needed.
+    """
+    if app := QApplication.instance():
+        return app
+
+    return QApplication([])

manim_slides/slide/base.py

@@ -45,49 +45,49 @@ def _ffmpeg_bin(self) -> Path:
     @abstractmethod
     def _frame_height(self) -> float:
         """Return the scene's frame height."""
-        ...
+        raise NotImplementedError
 
     @property
     @abstractmethod
     def _frame_width(self) -> float:
         """Return the scene's frame width."""
-        ...
+        raise NotImplementedError
 
     @property
     @abstractmethod
     def _background_color(self) -> str:
         """Return the scene's background color."""
-        ...
+        raise NotImplementedError
 
     @property
     @abstractmethod
     def _resolution(self) -> Tuple[int, int]:
         """Return the scene's resolution used during rendering."""
-        ...
+        raise NotImplementedError
 
     @property
     @abstractmethod
     def _partial_movie_files(self) -> List[Path]:
         """Return a list of partial movie files, a.k.a animations."""
-        ...
+        raise NotImplementedError
 
     @property
     @abstractmethod
     def _show_progress_bar(self) -> bool:
         """Return True if progress bar should be displayed."""
-        ...
+        raise NotImplementedError
 
     @property
     @abstractmethod
     def _leave_progress_bar(self) -> bool:
         """Return True if progress bar should be left after completed."""
-        ...
+        raise NotImplementedError
 
     @property
     @abstractmethod
     def _start_at_animation_number(self) -> Optional[int]:
         """If set, return the animation number at which rendering start."""
-        ...
+        raise NotImplementedError
 
     @property
     def canvas(self) -> MutableMapping[str, Mobject]:
@@ -341,8 +341,9 @@ def construct(self):
                 )
             )
 
+            self._current_slide += 1
+
         self._pre_slide_config_kwargs = dict(loop=loop)
-        self._current_slide += 1
         self._start_animation = self._current_animation
 
     def _add_last_slide(self) -> None:

manim_slides/wizard.py

@@ -7,7 +7,6 @@
 from PySide6.QtCore import Qt
 from PySide6.QtGui import QIcon, QKeyEvent
 from PySide6.QtWidgets import (
-    QApplication,
     QDialog,
     QDialogButtonBox,
     QGridLayout,
@@ -22,6 +21,7 @@
 from .config import Config, Key
 from .defaults import CONFIG_PATH
 from .logger import logger
+from .qt_utils import qapp
 from .resources import *  # noqa: F403
 
 WINDOW_NAME: str = "Configuration Wizard"
@@ -57,12 +57,13 @@ def __init__(self, config: Config):
         self.config = config
         self.icon = QIcon(":/icon.png")
         self.setWindowIcon(self.icon)
+        self.closed_without_saving = False
 
         button = QDialogButtonBox.Save | QDialogButtonBox.Cancel
 
-        self.buttonBox = QDialogButtonBox(button)
-        self.buttonBox.accepted.connect(self.save_config)
-        self.buttonBox.rejected.connect(self.close_without_saving)
+        self.button_box = QDialogButtonBox(button)
+        self.button_box.accepted.connect(self.save_config)
+        self.button_box.rejected.connect(self.close_without_saving)
 
         self.buttons = []
 
@@ -87,17 +88,17 @@ def __init__(self, config: Config):
             )
             self.layout.addWidget(button, i, 1)
 
-        self.layout.addWidget(self.buttonBox, len(self.buttons), 1)
+        self.layout.addWidget(self.button_box, len(self.buttons), 1)
 
         self.setLayout(self.layout)
 
     def close_without_saving(self) -> None:
         logger.debug("Closing configuration wizard without saving")
+        self.closed_without_saving = True
         self.deleteLater()
-        sys.exit(0)
 
     def closeEvent(self, event: Any) -> None:  # noqa: N802
-        self.closeWithoutSaving()
+        self.close_without_saving()
         event.accept()
 
     def save_config(self) -> None:
@@ -111,15 +112,15 @@ def save_config(self) -> None:
                 "Two or more actions share a common key: make sure actions have distinct key codes."
             )
             msg.setWindowTitle("Error: duplicated keys")
-            msg.exec_()
+            msg.exec()
             return
 
         self.deleteLater()
 
     def open_dialog(self, button_number: int, key: Key) -> None:
         button = self.buttons[button_number]
         dialog = KeyInput()
-        dialog.exec_()
+        dialog.exec()
         if dialog.key is not None:
             key_name = keymap[dialog.key]
             key.set_ids(dialog.key)
@@ -180,12 +181,15 @@ def _init(
         if config_path.exists():
             config = Config.from_file(config_path)
 
-        app = QApplication(sys.argv)
+        app = qapp()
         app.setApplicationName("Manim Slides Wizard")
         window = Wizard(config)
         window.show()
         app.exec()
 
+        if window.closed_without_saving:
+            sys.exit(0)
+
         config = window.config
 
     if merge: