winipedia-utils 0.1.39__py3-none-any.whl → 0.1.41__py3-none-any.whl

winipedia_utils/pyside/ui/widgets/media_player.py

@@ -4,11 +4,11 @@ This module contains the media player class.
 """
 
 import time
-from collections.abc import Callable
 from functools import partial
 from pathlib import Path
 from typing import Any
 
+from cryptography.hazmat.primitives.ciphers.aead import AESGCM
 from PySide6.QtCore import Qt, QTimer, QUrl
 from PySide6.QtMultimedia import QAudioOutput, QMediaPlayer
 from PySide6.QtWidgets import (
@@ -22,7 +22,11 @@ from PySide6.QtWidgets import (
     QWidget,
 )
 
-from winipedia_utils.pyside.core.py_qiodevice import PyQFile, PyQIODevice
+from winipedia_utils.pyside.core.py_qiodevice import (
+    EncryptedPyQFile,
+    PyQFile,
+    PyQIODevice,
+)
 from winipedia_utils.pyside.ui.base.base import Base as BaseUI
 from winipedia_utils.pyside.ui.widgets.clickable_widget import ClickableVideoWidget
 
@@ -31,13 +35,23 @@ class MediaPlayer(QMediaPlayer):
     """Media player class."""
 
     def __init__(self, parent_layout: QLayout, *args: Any, **kwargs: Any) -> None:
-        """Initialize the media player."""
+        """Initialize the media player.
+
+        Args:
+            parent_layout: The parent layout to add the media player widget to.
+            *args: Additional positional arguments passed to parent constructor.
+            **kwargs: Additional keyword arguments passed to parent constructor.
+        """
         super().__init__(*args, **kwargs)
         self.parent_layout = parent_layout
         self.make_widget()
 
     def make_widget(self) -> None:
-        """Make the widget."""
+        """Make the widget.
+
+        Creates the main media player widget with vertical layout, adds media controls
+        above and below the video widget, and creates the video widget itself.
+        """
         self.media_player_widget = QWidget()
         self.media_player_layout = QVBoxLayout(self.media_player_widget)
         self.parent_layout.addWidget(self.media_player_widget)
@@ -46,7 +60,11 @@ class MediaPlayer(QMediaPlayer):
         self.add_media_controls_below()
 
     def make_video_widget(self) -> None:
-        """Make the video widget."""
+        """Make the video widget.
+
+        Creates a clickable video widget with expanding size policy, sets up
+        audio output, and connects the click signal to toggle media controls.
+        """
         self.video_widget = ClickableVideoWidget()
         self.video_widget.clicked.connect(self.on_video_clicked)
         self.video_widget.setSizePolicy(
@@ -60,24 +78,37 @@ class MediaPlayer(QMediaPlayer):
         self.media_player_layout.addWidget(self.video_widget)
 
     def on_video_clicked(self) -> None:
-        """Handle video widget click."""
+        """Handle video widget click.
+
+        Toggles the visibility of media controls when the video widget is clicked.
+        """
         if self.media_controls_widget_above.isVisible():
             self.hide_media_controls()
             return
         self.show_media_controls()
 
     def show_media_controls(self) -> None:
-        """Show media controls."""
+        """Show media controls.
+
+        Makes both the above and below media control widgets visible.
+        """
         self.media_controls_widget_above.show()
         self.media_controls_widget_below.show()
 
     def hide_media_controls(self) -> None:
-        """Hide media controls."""
+        """Hide media controls.
+
+        Hides both the above and below media control widgets.
+        """
         self.media_controls_widget_above.hide()
         self.media_controls_widget_below.hide()
 
     def add_media_controls_above(self) -> None:
-        """Add media controls above the video."""
+        """Add media controls above the video.
+
+        Creates the top control bar with left, center, and right sections,
+        then adds speed, volume, playback, and fullscreen controls.
+        """
         # main above widget
         self.media_controls_widget_above = QWidget()
         self.media_controls_layout_above = QHBoxLayout(self.media_controls_widget_above)
@@ -106,14 +137,21 @@ class MediaPlayer(QMediaPlayer):
         self.add_fullscreen_control()
 
     def add_media_controls_below(self) -> None:
-        """Add media controls below the video."""
+        """Add media controls below the video.
+
+        Creates the bottom control bar and adds the progress control slider.
+        """
         self.media_controls_widget_below = QWidget()
         self.media_controls_layout_below = QHBoxLayout(self.media_controls_widget_below)
         self.media_player_layout.addWidget(self.media_controls_widget_below)
         self.add_progress_control()
 
     def add_playback_control(self) -> None:
-        """Add playback control."""
+        """Add playback control.
+
+        Creates a play/pause button with appropriate icons and connects it
+        to the toggle_playback method. Adds the button to the center controls.
+        """
         self.play_icon = BaseUI.get_svg_icon("play_icon")
         self.pause_icon = BaseUI.get_svg_icon("pause_icon")
         # Pause symbol: ⏸ (U+23F8)
@@ -124,7 +162,11 @@ class MediaPlayer(QMediaPlayer):
         self.center_controls_layout.addWidget(self.playback_button)
 
     def toggle_playback(self) -> None:
-        """Toggle playback."""
+        """Toggle playback.
+
+        Switches between play and pause states, updating the button icon
+        accordingly based on the current playback state.
+        """
         if self.playbackState() == QMediaPlayer.PlaybackState.PlayingState:
             self.pause()
             self.playback_button.setIcon(self.play_icon)
@@ -135,7 +177,8 @@ class MediaPlayer(QMediaPlayer):
     def add_speed_control(self) -> None:
         """Add speed control.
 
-        A button in the top left that on click shows a dropdown to select the speed.
+        Creates a button in the top left that shows a dropdown menu to select
+        playback speed from predefined options (0.2x to 5x).
         """
         self.default_speed = 1
         self.speed_options = [0.2, 0.5, self.default_speed, 1.5, 2, 3, 4, 5]
@@ -149,24 +192,40 @@ class MediaPlayer(QMediaPlayer):
         self.left_controls_layout.addWidget(self.speed_button)
 
     def change_speed(self, speed: float) -> None:
-        """Change playback speed."""
+        """Change playback speed.
+
+        Args:
+            speed: The new playback speed multiplier.
+        """
         self.setPlaybackRate(speed)
         self.speed_button.setText(f"{speed}x")
 
     def add_volume_control(self) -> None:
-        """Add volume control."""
+        """Add volume control.
+
+        Creates a horizontal slider for volume control with range 0-100
+        and connects it to the volume change handler.
+        """
         self.volume_slider = QSlider(Qt.Orientation.Horizontal)
         self.volume_slider.setRange(0, 100)
         self.volume_slider.valueChanged.connect(self.on_volume_changed)
         self.left_controls_layout.addWidget(self.volume_slider)
 
     def on_volume_changed(self, value: int) -> None:
-        """Handle volume slider value change."""
+        """Handle volume slider value change.
+
+        Args:
+            value: The new volume value from 0-100.
+        """
         volume = value / 100.0  # Convert to 0.0-1.0 range
         self.audio_output.setVolume(volume)
 
     def add_fullscreen_control(self) -> None:
-        """Add fullscreen control."""
+        """Add fullscreen control.
+
+        Creates a fullscreen toggle button with appropriate icons and determines
+        which widgets to hide/show when entering/exiting fullscreen mode.
+        """
         self.fullscreen_icon = BaseUI.get_svg_icon("fullscreen_icon")
         self.exit_fullscreen_icon = BaseUI.get_svg_icon("exit_fullscreen_icon")
         self.fullscreen_button = QPushButton()
@@ -187,7 +246,11 @@ class MediaPlayer(QMediaPlayer):
         self.right_controls_layout.addWidget(self.fullscreen_button)
 
     def toggle_fullscreen(self) -> None:
-        """Toggle fullscreen mode."""
+        """Toggle fullscreen mode.
+
+        Switches between fullscreen and windowed mode, hiding/showing other
+        widgets and updating the button icon accordingly.
+        """
         # Get the main window
         main_window = self.media_player_widget.window()
         if main_window.isFullScreen():
@@ -203,7 +266,11 @@ class MediaPlayer(QMediaPlayer):
             self.fullscreen_button.setIcon(self.exit_fullscreen_icon)
 
     def add_progress_control(self) -> None:
-        """Add progress control."""
+        """Add progress control.
+
+        Creates a horizontal progress slider and connects it to media player
+        signals for position updates and user interaction handling.
+        """
         self.progress_slider = QSlider(Qt.Orientation.Horizontal)
         self.media_controls_layout_below.addWidget(self.progress_slider)
 
@@ -218,17 +285,32 @@ class MediaPlayer(QMediaPlayer):
         self.progress_slider.sliderReleased.connect(self.on_slider_released)
 
     def update_slider_position(self, position: int) -> None:
-        """Update the progress slider position."""
+        """Update the progress slider position.
+
+        Args:
+            position: The current media position in milliseconds.
+        """
         # Only update if not being dragged to prevent jumps during manual sliding
         if not self.progress_slider.isSliderDown():
             self.progress_slider.setValue(position)
 
     def set_slider_range(self, duration: int) -> None:
-        """Set the progress slider range based on media duration."""
+        """Set the progress slider range based on media duration.
+
+        Args:
+            duration: The total media duration in milliseconds.
+        """
         self.progress_slider.setRange(0, duration)
 
     def on_slider_moved(self, position: int) -> None:
-        """Set the media position when slider is moved."""
+        """Set the media position when slider is moved.
+
+        Implements throttling to prevent excessive position updates during
+        slider dragging for better performance.
+
+        Args:
+            position: The new position from the slider in milliseconds.
+        """
         current_time = time.time()
         if (
             current_time - self.last_slider_moved_update
@@ -238,37 +320,104 @@ class MediaPlayer(QMediaPlayer):
             self.last_slider_moved_update = current_time
 
     def on_slider_released(self) -> None:
-        """Handle slider release event."""
+        """Handle slider release event.
+
+        Sets the final media position when the user releases the slider.
+        """
         self.setPosition(self.progress_slider.value())
 
     def play_video(
-        self, set_source_func: Callable[..., Any], *args: Any, **kwargs: Any
+        self,
+        io_device: PyQIODevice,
+        source_url: QUrl,
+        position: int = 0,
     ) -> None:
-        """Play the video."""
+        """Play the video.
+
+        Stops current playback and starts a new video using the provided
+        source function with a delay to prevent freezing.
+
+        Args:
+            io_device: The PyQIODevice to use as the media source.
+            source_url: The QUrl representing the source location.
+            position: The position to start playback from in milliseconds.
+        """
         self.stop()
 
+        self.resume_func = partial(self.resume_to_position, position=position)
+        self.mediaStatusChanged.connect(self.resume_func)
+
         # prevents freezing when starting a new video while another is playing
         QTimer.singleShot(
-            100, partial(self.set_source_and_play, set_source_func, *args, **kwargs)
+            100,
+            partial(
+                self.set_source_and_play, io_device=io_device, source_url=source_url
+            ),
         )
 
+    def resume_to_position(
+        self, status: QMediaPlayer.MediaStatus, position: int
+    ) -> None:
+        """Resume playback to a position.
+
+        Args:
+            status: The current media status.
+            position: The position to resume playback from in milliseconds.
+        """
+        if status == QMediaPlayer.MediaStatus.BufferedMedia:
+            self.setPosition(position)
+            self.mediaStatusChanged.disconnect(self.resume_func)
+
     def set_source_and_play(
-        self, set_source_func: Callable[..., Any], *args: Any, **kwargs: Any
+        self,
+        io_device: PyQIODevice,
+        source_url: QUrl,
     ) -> None:
-        """Set the source and play the video."""
-        set_source_func(*args, **kwargs)
+        """Set the source and play the video.
+
+        Args:
+            io_device: The PyQIODevice to use as the media source.
+            source_url: The QUrl representing the source location.
+        """
+        self.set_source_device(io_device, source_url)
         self.play()
 
-    def play_file(self, path: Path) -> None:
-        """Play the video."""
+    def set_source_device(self, io_device: PyQIODevice, source_url: QUrl) -> None:
+        """Set the source device for playback.
+
+        Args:
+            io_device: The PyQIODevice to use as the media source.
+            source_url: The QUrl representing the source location.
+        """
+        self.source_url = source_url
+        self.io_device = io_device
+        self.setSourceDevice(self.io_device, self.source_url)
+
+    def play_file(self, path: Path, position: int = 0) -> None:
+        """Play a regular video file.
+
+        Args:
+            path: The file path to the video file to play.
+            position: The position to start playback from in milliseconds.
+        """
         self.play_video(
-            self.set_source_device,
+            position=position,
             io_device=PyQFile(path),
             source_url=QUrl.fromLocalFile(path),
         )
 
-    def set_source_device(self, io_device: PyQIODevice, source_url: QUrl) -> None:
-        """Play the video."""
-        self.source_url = source_url
-        self.io_device = io_device
-        self.setSourceDevice(self.io_device, self.source_url)
+    def play_encrypted_file(
+        self, path: Path, aes_gcm: AESGCM, position: int = 0
+    ) -> None:
+        """Play an encrypted video file.
+
+        Args:
+            path: The file path to the encrypted video file to play.
+            aes_gcm: The AES-GCM cipher instance for decryption.
+            position: The position to start playback from in milliseconds.
+        """
+        self.play_video(
+            position=position,
+            io_device=EncryptedPyQFile(path, aes_gcm),
+            source_url=QUrl.fromLocalFile(path),
+        )

winipedia_utils/pyside/ui/widgets/notification.py

@@ -26,11 +26,10 @@ class Notification(Toast):  # type: ignore[misc]
         The notification is shown in the top middle of the screen.
 
         Args:
-            parent (QWidget): The parent widget.
-            title (str): The title of the notification.
-            text (str): The text of the notification.
-            icon (ToastIcon, optional): The icon of the notification.
-            duration (int, optional): The duration of the notification in milliseconds.
+            title: The title of the notification.
+            text: The text of the notification.
+            icon: The icon of the notification. Defaults to INFORMATION.
+            duration: The duration of the notification in milliseconds. Defaults to 10000.
         """
         super().__init__(QApplication.activeWindow())
         self.setDuration(duration)
@@ -39,17 +38,39 @@ class Notification(Toast):  # type: ignore[misc]
         self.set_text(text)
 
     def set_title(self, title: str) -> None:
-        """Set the title of the notification."""
+        """Set the title of the notification.
+
+        Truncates the title to fit within half the window width before setting it.
+
+        Args:
+            title: The title text to set.
+        """
         title = self.str_to_half_window_width(title)
         self.setTitle(title)
 
     def set_text(self, text: str) -> None:
-        """Set the text of the notification."""
+        """Set the text of the notification.
+
+        Truncates the text to fit within half the window width before setting it.
+
+        Args:
+            text: The notification text to set.
+        """
         text = self.str_to_half_window_width(text)
         self.setText(text)
 
     def str_to_half_window_width(self, string: str) -> str:
-        """Truncate the string to the width of the active window."""
+        """Truncate the string to the width of the active window.
+
+        Calculates half the width of the active window and truncates the string
+        to fit within that width. Falls back to 500 pixels if no active window.
+
+        Args:
+            string: The string to truncate.
+
+        Returns:
+            The truncated string that fits within half the window width.
+        """
         main_window = QApplication.activeWindow()
         width = main_window.width() / 2 if main_window is not None else 500
         width = int(width)

{winipedia_utils-0.1.39.dist-info → winipedia_utils-0.1.41.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: winipedia-utils
-Version: 0.1.39
+Version: 0.1.41
 Summary: A package with many utility functions
 License: MIT
 Author: Winipedia

{winipedia_utils-0.1.39.dist-info → winipedia_utils-0.1.41.dist-info}/RECORD

@@ -42,20 +42,20 @@ winipedia_utils/projects/project.py,sha256=2nz1Hh51A-shjgdPCgiDw-ODrVtOtiHEHQnMP
 winipedia_utils/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 winipedia_utils/pyside/__init__.py,sha256=knliQxknKWqxCEfxlI1K02OtbBfnTkYUZFqyYcLJNDI,52
 winipedia_utils/pyside/core/__init__.py,sha256=5VmASY9rUuZ8_PeZt8KMqnZUGxhsnE0EKbDhCIXj6Gk,57
-winipedia_utils/pyside/core/py_qiodevice.py,sha256=YPBeEyLJizQPdb-c45XKmmqUIKe3iFZyJQHdgp8Lqfk,3182
+winipedia_utils/pyside/core/py_qiodevice.py,sha256=NE5PuvwldxoBV0XUD0vsdEqrwloU7Tujde0GvDpfZak,15789
 winipedia_utils/pyside/ui/__init__.py,sha256=h5NJ6WyveMMqxIgt0x65_mqndtncxgNmx5816KD3ubU,55
 winipedia_utils/pyside/ui/base/__init__.py,sha256=p-maJQh7gYbXwhkqKU4wL6UNGzRAy988JP8_qLoTZDk,24
-winipedia_utils/pyside/ui/base/base.py,sha256=ru-CC-y9KQCHqkVHWGmV7ovIe4D149vBjpsNRPyoVAY,4146
+winipedia_utils/pyside/ui/base/base.py,sha256=GthjIwaL-4n837TzK_sJNYDUzWu7Uc8z84CwGwzI_cI,5889
 winipedia_utils/pyside/ui/pages/__init__.py,sha256=p-maJQh7gYbXwhkqKU4wL6UNGzRAy988JP8_qLoTZDk,24
 winipedia_utils/pyside/ui/pages/base/__init__.py,sha256=p-maJQh7gYbXwhkqKU4wL6UNGzRAy988JP8_qLoTZDk,24
-winipedia_utils/pyside/ui/pages/base/base.py,sha256=9pt0Hsewo2q_sMu6xI5grF0dcoazRL73EiML8zKOzuE,2059
-winipedia_utils/pyside/ui/pages/browser.py,sha256=SzX356snnmEdzCrtIXl5mPaUkM1-_REfUurOotpVIkY,696
-winipedia_utils/pyside/ui/pages/player.py,sha256=PPmUNejMibKeNUm-a-1VA6i14G743YFxuxem0NZzFz4,795
+winipedia_utils/pyside/ui/pages/base/base.py,sha256=-bn9rLc9hc98SZxlR7ohKZ1RU4GhccHG96462aqZ0CE,2624
+winipedia_utils/pyside/ui/pages/browser.py,sha256=bAk3WYcn_4oRTQtkKIbf9_aJUZnRU9ZF9QkvhLVG7Nc,886
+winipedia_utils/pyside/ui/pages/player.py,sha256=pE_DmOpiaFRnrtdxlSidg7eEo89pFwaOfLjpZqpu2OE,2861
 winipedia_utils/pyside/ui/widgets/__init__.py,sha256=p-maJQh7gYbXwhkqKU4wL6UNGzRAy988JP8_qLoTZDk,24
-winipedia_utils/pyside/ui/widgets/browser.py,sha256=5oUyQKYOYu9Zzx6adbewTtAIfnn_RVs8CLoX3rU2g28,6160
-winipedia_utils/pyside/ui/widgets/clickable_widget.py,sha256=nUZ7ngPFQ7utJuq9A-72TeT1wqCt_xubAxBg3xQSL64,856
-winipedia_utils/pyside/ui/widgets/media_player.py,sha256=jcAGeZo3ey177K2jAmqg1LOyARzn_5z26krZGKVj99c,10909
-winipedia_utils/pyside/ui/widgets/notification.py,sha256=_zBq9Q6SDFu3fV2AkbvyCNQmOEOy1l9mKOFAAdyteg4,1941
+winipedia_utils/pyside/ui/widgets/browser.py,sha256=0wZ13XE_i2HV3fT6YZqjE7U_VcNv-jYPgifFCMvHQB0,8411
+winipedia_utils/pyside/ui/widgets/clickable_widget.py,sha256=TIQsLYnzgo7hyVjq_mKxo7IoSdwb20qt6JgkJj59ZVE,1779
+winipedia_utils/pyside/ui/widgets/media_player.py,sha256=09PM6XamO_NivAqLW4ZhXnbFSs8vSVGtQkERqeEkwjs,15924
+winipedia_utils/pyside/ui/widgets/notification.py,sha256=vtD3KZvQoFWYat_poDZCywsVNciScFeA8dGC1Bih2so,2532
 winipedia_utils/pyside/ui/windows/__init__.py,sha256=p-maJQh7gYbXwhkqKU4wL6UNGzRAy988JP8_qLoTZDk,24
 winipedia_utils/pyside/ui/windows/base/__init__.py,sha256=p-maJQh7gYbXwhkqKU4wL6UNGzRAy988JP8_qLoTZDk,24
 winipedia_utils/pyside/ui/windows/base/base.py,sha256=httMbYu5QiHevD_2SrUTLnFat9nsvSNAtjTL84tRUao,1496
@@ -91,7 +91,7 @@ winipedia_utils/testing/tests/base/utils/utils.py,sha256=dUPDrgAxlfREQb33zz23Mfz
 winipedia_utils/testing/tests/conftest.py,sha256=8RounBlI8Jq1aLaLNpv84MW4ne8Qq0aavQextDOp5ng,920
 winipedia_utils/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
 winipedia_utils/text/string.py,sha256=1jbBftlgxffGgSlPnQh3aRPIr8XekEwpSenjFCW6JyM,3478
-winipedia_utils-0.1.39.dist-info/LICENSE,sha256=3PrKJ2CWNrnyyHaC_r0wPDSukVWgmjOxHr__eQVH7cw,1087
-winipedia_utils-0.1.39.dist-info/METADATA,sha256=PEZW6MkX2O4ZuDOXmfWUuhYLriJJQjGbOqKmvL8hOS4,12576
-winipedia_utils-0.1.39.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-winipedia_utils-0.1.39.dist-info/RECORD,,
+winipedia_utils-0.1.41.dist-info/LICENSE,sha256=3PrKJ2CWNrnyyHaC_r0wPDSukVWgmjOxHr__eQVH7cw,1087
+winipedia_utils-0.1.41.dist-info/METADATA,sha256=jPd3kqsgclQyiazoqQv2bcs25VFA7_chKzQrwtTFAF4,12576
+winipedia_utils-0.1.41.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+winipedia_utils-0.1.41.dist-info/RECORD,,