flet-video 0.2.0.dev76__tar.gz → 0.2.0.dev84__tar.gz

{flet_video-0.2.0.dev76/src/flet_video.egg-info → flet_video-0.2.0.dev84}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-video
-Version: 0.2.0.dev76
+Version: 0.2.0.dev84
 Summary: A cross-platform video player for Flet apps.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0

{flet_video-0.2.0.dev76 → flet_video-0.2.0.dev84}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flet-video"
-version = "0.2.0.dev76"
+version = "0.2.0.dev84"
 description = "A cross-platform video player for Flet apps."
 readme = "README.md"
 authors = [
@@ -22,22 +22,43 @@ Issues = "https://github.com/flet-dev/flet-video/issues"
 "flutter.flet_video" = ["**/*"]
 
 [dependency-groups]
+test = [
+    "pytest >=7.2.0",
+]
+lint = [
+    "ruff >=0.11.7",
+]
 dev = [
-    "pre-commit>=4.2.0",
-    "ruff>=0.11.7",
+    "pre-commit >=4.2.0",
+    { include-group = 'lint' },
+    { include-group = 'test' },
+]
+docs-coverage = [
+    "docstr-coverage >=2.3.2",
 ]
 docs = [
-    "mkdocs",
-    "mkdocs-material",
-    "mkdocstrings[python]",
-    "mkdocstrings-python-xref",
-    "mike",
-    "markdown>=3.6",
-    "pymdown-extensions",
-    "mkdocs-glightbox",
-    "mkdocs-section-index",
-    "griffe-modernized-annotations",
-    "pygments>=2.16",
+    "mkdocs >=1.6.1",
+    "mkdocs-material >=9.6.15",
+    "mkdocstrings-python >=1.16.12",
+    "mkdocstrings-python-xref >=1.16.3",
+    "mike >=2.1.3",
+    "markdown >=3.6",
+    "pymdown-extensions >=10.16",
+    "mkdocs-exclude >=1.0.2",
+    "mkdocs-glightbox >=0.4.0",
+    "mkdocs-open-in-new-tab >=1.0.8",
+    "mkdocs-section-index >=0.3.10",
+    "griffe-modernized-annotations >=1.0.8",
+    "griffe-warnings-deprecated >=1.1.0",
+    "pygments >=2.16",
+    "markdown-exec[ansi] >=1.11.0",
+    "pydocstyle >=6.3.0",
+    "linkcheckmd >=1.4.0",
+    { include-group = 'docs-coverage' },
+]
+all = [
+    { include-group = 'dev' },
+    { include-group = 'docs' },
 ]
 
 [build-system]
@@ -66,6 +87,7 @@ select = [
     "I"
 ]
 preview = true
+pydocstyle = { convention = 'google' }
 
 [tool.ruff.format]
 quote-style = "double"

{flet_video-0.2.0.dev76 → flet_video-0.2.0.dev84}/src/flet_video/__init__.py

@@ -6,3 +6,12 @@ from .types import (
     VideoSubtitleTrack,
 )
 from .video import Video
+
+__all__ = [
+    "PlaylistMode",
+    "Video",
+    "VideoConfiguration",
+    "VideoMedia",
+    "VideoSubtitleConfiguration",
+    "VideoSubtitleTrack",
+]

{flet_video-0.2.0.dev76 → flet_video-0.2.0.dev84}/src/flet_video/types.py

@@ -1,13 +1,13 @@
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import Dict, Optional
+from typing import Optional
 
 import flet as ft
 
 __all__ = [
     "PlaylistMode",
-    "VideoMedia",
     "VideoConfiguration",
+    "VideoMedia",
     "VideoSubtitleConfiguration",
     "VideoSubtitleTrack",
 ]
@@ -33,10 +33,10 @@ class VideoMedia:
     resource: str
     """URI of the media resource."""
 
-    http_headers: Optional[Dict[str, str]] = None
+    http_headers: Optional[dict[str, str]] = None
     """HTTP headers to be used for the media resource."""
 
-    extras: Optional[Dict[str, str]] = None
+    extras: Optional[dict[str, str]] = None
     """Additional metadata for the media resource."""
 
 
@@ -46,8 +46,9 @@ class VideoConfiguration:
 
     output_driver: Optional[str] = None
     """
-    Sets the [--vo](https://mpv.io/manual/stable/#options-vo) property on native backend.
-    
+    Sets the [--vo](https://mpv.io/manual/stable/#options-vo) property
+    on native backend.
+
     The default value is platform dependent:
         - Windows, GNU/Linux, macOS & iOS : `"libmpv"`
         - Android: `"gpu"`
@@ -55,8 +56,9 @@ class VideoConfiguration:
 
     hardware_decoding_api: Optional[str] = None
     """
-    Sets the [--hwdec](https://mpv.io/manual/stable/#options-hwdec) property on native backend.
-    
+    Sets the [--hwdec](https://mpv.io/manual/stable/#options-hwdec)
+    property on native backend.
+
     The default value is platform dependent:
         - Windows, GNU/Linux, macOS & iOS : `"auto"`
         - Android: `"auto-safe"`
@@ -80,8 +82,8 @@ class VideoConfiguration:
 
     scale: ft.Number = 1.0
     """
-    The scale for the video output. 
-    Specifying this option will cause `width` & `height` to be ignored.
+    The scale for the video output.
+    Specifying this option will cause [`width`][..] & [`height`][..] to be ignored.
     """
 
 
@@ -91,8 +93,8 @@ class VideoSubtitleTrack:
 
     src: str
     """
-    The subtitle source. 
-    
+    The subtitle source.
+
     Supported values:
         - A URL (e.g. "https://example.com/subs.srt" or "www.example.com/sub.vtt")
         - An absolute local file path (not supported on the web platform)

{flet_video-0.2.0.dev76 → flet_video-0.2.0.dev84}/src/flet_video/video.py

@@ -21,7 +21,8 @@ class Video(ft.ConstrainedControl):
     A control that displays a video from a playlist.
 
     Raises:
-        AssertionError: If the [`volume`][(c).] is not between `0.0` and `100.0` (inclusive).
+        AssertionError: If the [`volume`][(c).] is not between
+            `0.0` and `100.0` (inclusive).
     """
 
     playlist: list[VideoMedia] = field(default_factory=list)
@@ -31,7 +32,7 @@ class Video(ft.ConstrainedControl):
 
     title: str = "flet-video"
     """
-    Defines the name of the underlying window & process for native backend. 
+    Defines the name of the underlying window & process for native backend.
     This is visible inside the windows' volume mixer.
     """
 
@@ -47,8 +48,9 @@ class Video(ft.ConstrainedControl):
 
     wakelock: bool = True
     """
-    Whether to acquire wake lock while playing the video. 
-    When `True`, device's display will not go to standby/sleep while the video is playing.
+    Whether to acquire wake lock while playing the video.
+    When `True`, device's display will not go to standby/sleep while
+    the video is playing.
     """
 
     autoplay: bool = False
@@ -79,9 +81,10 @@ class Video(ft.ConstrainedControl):
     volume: ft.Number = 100.0
     """
     Defines the volume of the video player.
-    
+
     Note:
-        It's value ranges between `0.0` to `100.0` (inclusive), where `0.0` is muted and `100.0` is the maximum volume.
+        It's value ranges between `0.0` to `100.0` (inclusive), where `0.0`
+        is muted and `100.0` is the maximum volume.
         An exception will be raised if the value is outside this range.
     """
 
@@ -90,7 +93,7 @@ class Video(ft.ConstrainedControl):
     Defines the playback rate of the video player.
     """
 
-    alignment: ft.Alignment = field(default_factory=lambda: ft.Alignment.center())
+    alignment: ft.Alignment = field(default_factory=lambda: ft.Alignment.CENTER)
     """
     Defines the Alignment of the viewport.
     """
@@ -98,10 +101,12 @@ class Video(ft.ConstrainedControl):
     filter_quality: ft.FilterQuality = ft.FilterQuality.LOW
     """
     Filter quality of the texture used to render the video output.
-    
-    Note: 
-        Android was reported to show blurry images when using `ft.FilterQuality.HIGH`. 
-        Prefer the usage of `ft.FilterQuality.MEDIUM` on this platform.
+
+    Note:
+        Android was reported to show blurry images when using
+        [`FilterQuality.HIGH`][flet.FilterQuality.HIGH].
+        Prefer the usage of [`FilterQuality.MEDIUM`][flet.FilterQuality.MEDIUM]
+        on this platform.
     """
 
     pause_upon_entering_background_mode: bool = True
@@ -111,8 +116,9 @@ class Video(ft.ConstrainedControl):
 
     resume_upon_entering_foreground_mode: bool = False
     """
-    Whether to resume the video when application enters foreground mode. 
-    Has effect only if `pause_upon_entering_background_mode` is also set to `True`.
+    Whether to resume the video when application enters foreground mode.
+    Has effect only if [`pause_upon_entering_background_mode`][..] is also set to
+    `True`.
     """
 
     pitch: ft.Number = 1.0
@@ -139,35 +145,39 @@ class Video(ft.ConstrainedControl):
     Defines the subtitle track for the video player.
     """
 
-    on_load: ft.OptionalControlEventHandler["Video"] = None
+    on_load: Optional[ft.ControlEventHandler["Video"]] = None
     """Fires when the video player is initialized and ready for playback."""
 
-    on_enter_fullscreen: ft.OptionalControlEventHandler["Video"] = None
+    on_enter_fullscreen: Optional[ft.ControlEventHandler["Video"]] = None
     """Fires when the video player enters fullscreen."""
 
-    on_exit_fullscreen: ft.OptionalControlEventHandler["Video"] = None
+    on_exit_fullscreen: Optional[ft.ControlEventHandler["Video"]] = None
     """Fires when the video player exits fullscreen"""
 
-    on_error: ft.OptionalControlEventHandler["Video"] = None
+    on_error: Optional[ft.ControlEventHandler["Video"]] = None
     """
     Fires when an error occurs.
-    
-    Event handler argument's `data` property contains information about the error.
+
+    Event handler argument's [`data`][flet.Event.data] property contains
+    information about the error.
     """
 
-    on_complete: ft.OptionalControlEventHandler["Video"] = None
+    on_complete: Optional[ft.ControlEventHandler["Video"]] = None
     """Fires when a video player completes."""
 
-    on_track_change: ft.OptionalControlEventHandler["Video"] = None
+    on_track_change: Optional[ft.ControlEventHandler["Video"]] = None
     """
     Fires when a video track changes.
-    
-    Event handler argument's `data` property contains the index of the new track.
+
+    Event handler argument's [`data`][flet.Event.data] property contains
+    the index of the new track.
     """
 
     def before_update(self):
         super().before_update()
-        assert 0 <= self.volume <= 100, "volume must be between 0 and 100 inclusive"
+        assert 0 <= self.volume <= 100, (
+            f"volume must be between 0 and 100 inclusive, got {self.volume}"
+        )
 
     def play(self):
         """Starts playing the video."""
@@ -208,48 +218,58 @@ class Video(ft.ConstrainedControl):
         return self._invoke_method_async("stop")
 
     def next(self):
-        """Jumps to the next `VideoMedia` in the `playlist`."""
+        """Jumps to the next `VideoMedia` in the [`playlist`][..]."""
         asyncio.create_task(self.next_async())
 
     def next_async(self):
-        """Jumps to the next `VideoMedia` in the `playlist`."""
+        """Jumps to the next `VideoMedia` in the [`playlist`][..]."""
         return self._invoke_method_async("next")
 
     def previous(self):
-        """Jumps to the previous `VideoMedia` in the `playlist`."""
+        """Jumps to the previous `VideoMedia` in the [`playlist`][..]."""
         asyncio.create_task(self.previous_async())
 
     def previous_async(self):
-        """Jumps to the previous `VideoMedia` in the `playlist`."""
+        """Jumps to the previous `VideoMedia` in the [`playlist`][..]."""
         return self._invoke_method_async("previous")
 
     def seek(self, position: ft.DurationValue):
         """
-        Seeks the currently playing `VideoMedia` from the `playlist` at the specified `position`.
+        Seeks the currently playing `VideoMedia` from the
+        [`playlist`][..] at the specified `position`.
         """
         asyncio.create_task(self.seek_async(position))
 
     def seek_async(self, position: ft.DurationValue):
         """
-        Seeks the currently playing `VideoMedia` from the `playlist` at the specified `position`.
+        Seeks the currently playing `VideoMedia` from the
+        [`playlist`][..] at the specified `position`.
         """
-        return self._invoke_method_async("seek", {"position": position})
+        return self._invoke_method_async(
+            "seek",
+            {"position": position},
+        )
 
     def jump_to(self, media_index: int):
         """
-        Jumps to the `VideoMedia` at the specified `media_index` in the `playlist`.
+        Jumps to the `VideoMedia` at the specified `media_index`
+        in the [`playlist`][..].
         """
         asyncio.create_task(self.jump_to_async(media_index))
 
     async def jump_to_async(self, media_index: int):
         """
-        Jumps to the `VideoMedia` at the specified `media_index` in the `playlist`.
+        Jumps to the `VideoMedia` at the specified `media_index`
+        in the [`playlist`][..].
         """
         assert self.playlist[media_index], "media_index is out of range"
         if media_index < 0:
             # dart doesn't support negative indexes
             media_index = len(self.playlist) + media_index
-        await self._invoke_method_async("jump_to", {"media_index": media_index})
+        await self._invoke_method_async(
+            method_name="jump_to",
+            arguments={"media_index": media_index},
+        )
 
     def playlist_add(self, media: VideoMedia):
         """Appends/Adds the provided `media` to the `playlist`."""
@@ -258,7 +278,10 @@ class Video(ft.ConstrainedControl):
     async def playlist_add_async(self, media: VideoMedia):
         """Appends/Adds the provided `media` to the `playlist`."""
         assert media.resource, "media has no resource"
-        await self._invoke_method_async("playlist_add", {"media": media})
+        await self._invoke_method_async(
+            method_name="playlist_add",
+            arguments={"media": media},
+        )
         self.playlist.append(media)
 
     def playlist_remove(self, media_index: int):
@@ -268,7 +291,10 @@ class Video(ft.ConstrainedControl):
     async def playlist_remove_async(self, media_index: int):
         """Removes the provided `media` from the `playlist`."""
         assert self.playlist[media_index], "index out of range"
-        await self._invoke_method_async("playlist_remove", {"media_index": media_index})
+        await self._invoke_method_async(
+            method_name="playlist_remove",
+            arguments={"media_index": media_index},
+        )
         self.playlist.pop(media_index)
 
     async def is_playing_async(self) -> bool:
@@ -282,7 +308,7 @@ class Video(ft.ConstrainedControl):
         """
         Returns:
             `True` if video player has reached the end of
-            the currently playing media, `False` otherwise.
+                the currently playing media, `False` otherwise.
         """
         return await self._invoke_method_async("is_completed")
 

{flet_video-0.2.0.dev76 → flet_video-0.2.0.dev84/src/flet_video.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-video
-Version: 0.2.0.dev76
+Version: 0.2.0.dev84
 Summary: A cross-platform video player for Flet apps.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0

{flet_video-0.2.0.dev76 → flet_video-0.2.0.dev84}/src/flutter/flet_video/pubspec.lock

@@ -150,7 +150,7 @@ packages:
     description:
       path: "packages/flet"
       ref: main
-      resolved-ref: b996d06ff462b88f5b31d6cceafac34ea6f57968
+      resolved-ref: cf8823c5d766ea7866480986aa3ee871f4091e78
       url: "https://github.com/flet-dev/flet.git"
     source: git
     version: "0.70.0"
@@ -171,10 +171,10 @@ packages:
     dependency: "direct dev"
     description:
       name: flutter_lints
-      sha256: a25a15ebbdfc33ab1cd26c63a6ee519df92338a9c10f122adda92938253bef04
+      sha256: "9e8c3858111da373efc5aa341de011d9bd23e2c5c5e0c62bccf32438e192d7b1"
       url: "https://pub.dev"
     source: hosted
-    version: "2.0.3"
+    version: "3.0.2"
   flutter_localizations:
     dependency: transitive
     description: flutter
@@ -290,10 +290,10 @@ packages:
     dependency: transitive
     description:
       name: lints
-      sha256: "0a217c6c989d21039f1498c3ed9f3ed71b354e69873f13a8dfc3c9fe76f1b452"
+      sha256: cbf8d4b858bb0134ef3ef87841abdf8d63bfc255c266b7bf6b39daa1085c4290
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.1"
+    version: "3.0.0"
   logging:
     dependency: transitive
     description:
@@ -943,10 +943,10 @@ packages:
     dependency: transitive
     description:
       name: window_manager
-      sha256: "51d50168ab267d344b975b15390426b1243600d436770d3f13de67e55b05ec16"
+      sha256: "7eb6d6c4164ec08e1bf978d6e733f3cebe792e2a23fb07cbca25c2872bfdbdcd"
       url: "https://pub.dev"
     source: hosted
-    version: "0.5.0"
+    version: "0.5.1"
   window_to_front:
     dependency: transitive
     description:

{flet_video-0.2.0.dev76 → flet_video-0.2.0.dev84}/src/flutter/flet_video/pubspec.yaml

@@ -22,4 +22,4 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  flutter_lints: ^2.0.0
+  flutter_lints: ^3.0.0