winipedia-utils 0.1.62__py3-none-any.whl → 0.2.0__py3-none-any.whl

winipedia_utils/pyside/ui/__init__.py

@@ -1 +1 @@
-"""__init__ module for winipedia_utils.pyside6.ui."""
+"""__init__ module for winipedia_utils.pyside6.ui."""

winipedia_utils/pyside/ui/base/__init__.py

@@ -1 +1 @@
-"""__init__ module."""
+"""__init__ module."""

winipedia_utils/pyside/ui/base/base.py

@@ -1,180 +1,180 @@
-"""Base UI module.
-
-This module contains the base UI class for the VideoVault application.
-"""
-
-from abc import abstractmethod
-from types import ModuleType
-from typing import TYPE_CHECKING, Any, Self, cast
-
-from PySide6.QtCore import QObject
-from PySide6.QtGui import QIcon
-from PySide6.QtWidgets import QApplication, QStackedWidget
-
-from winipedia_utils.modules.class_ import (
-    get_all_nonabstract_subclasses,
-)
-from winipedia_utils.modules.package import get_main_package, walk_package
-from winipedia_utils.oop.mixins.meta import ABCLoggingMeta
-from winipedia_utils.resources.svgs.svg import get_svg_path
-from winipedia_utils.text.string import split_on_uppercase
-
-# Avoid circular import
-if TYPE_CHECKING:
-    from winipedia_utils.pyside.ui.pages.base.base import Base as BasePage
-    from winipedia_utils.pyside.ui.windows.base.base import Base as BaseWindow
-
-
-class QABCLoggingMeta(
-    ABCLoggingMeta,
-    type(QObject),  # type: ignore[misc]
-):
-    """Metaclass for the QABCImplementationLoggingMixin."""
-
-
-class Base(metaclass=QABCLoggingMeta):
-    """Base UI class for a Qt application."""
-
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        """Initialize the base UI."""
-        super().__init__(*args, **kwargs)
-        self.base_setup()
-        self.pre_setup()
-        self.setup()
-        self.post_setup()
-
-    @abstractmethod
-    def base_setup(self) -> None:
-        """Setup the base Qt object of the UI.
-
-        This method should initialize the core Qt components required
-        for the UI to function properly.
-        """
-
-    @abstractmethod
-    def setup(self) -> None:
-        """Setup the main UI components.
-
-        This method should contain the primary UI initialization logic.
-        """
-
-    @abstractmethod
-    def pre_setup(self) -> None:
-        """Setup operations to run before main setup.
-
-        This method should contain any initialization that needs to happen
-        before the main setup method is called.
-        """
-
-    @abstractmethod
-    def post_setup(self) -> None:
-        """Setup operations to run after main setup.
-
-        This method should contain any finalization that needs to happen
-        after the main setup method is called.
-        """
-
-    @classmethod
-    def get_display_name(cls) -> str:
-        """Get the display name of the UI.
-
-        Returns:
-            The human-readable display name derived from the class name.
-        """
-        return " ".join(split_on_uppercase(cls.__name__))
-
-    @classmethod
-    def get_subclasses(cls, package: ModuleType | None = None) -> list[type[Self]]:
-        """Get all subclasses of the UI.
-
-        Args:
-            package: The package to search for subclasses in. If None,
-                searches in the main package.
-
-        Returns:
-            A sorted list of all non-abstract subclasses.
-        """
-        if package is None:
-            # find the main package
-            package = get_main_package()
-
-        _ = list(walk_package(package))
-
-        children = get_all_nonabstract_subclasses(cls)
-        return sorted(children, key=lambda cls: cls.__name__)
-
-    def set_current_page(self, page_cls: type["BasePage"]) -> None:
-        """Set the current page in the stack.
-
-        Args:
-            page_cls: The page class to set as current.
-        """
-        self.get_stack().setCurrentWidget(self.get_page(page_cls))
-
-    def get_stack(self) -> QStackedWidget:
-        """Get the stack widget of the window.
-
-        Returns:
-            The QStackedWidget containing all pages.
-        """
-        window = cast("BaseWindow", (getattr(self, "window", lambda: None)()))
-
-        return window.stack
-
-    def get_stack_pages(self) -> list["BasePage"]:
-        """Get all pages from the stack.
-
-        Returns:
-            A list of all pages currently in the stack.
-        """
-        # Import here to avoid circular import
-
-        stack = self.get_stack()
-        # get all the pages
-        return [cast("BasePage", stack.widget(i)) for i in range(stack.count())]
-
-    def get_page[T: "BasePage"](self, page_cls: type[T]) -> T:
-        """Get a specific page from the stack.
-
-        Args:
-            page_cls: The class of the page to retrieve.
-
-        Returns:
-            The page instance of the specified class.
-        """
-        page = next(
-            page for page in self.get_stack_pages() if page.__class__ is page_cls
-        )
-        return cast("T", page)
-
-    @classmethod
-    def get_svg_icon(cls, svg_name: str, package: ModuleType | None = None) -> QIcon:
-        """Get a QIcon for an SVG file.
-
-        Args:
-            svg_name: The name of the SVG file.
-            package: The package to search for the SVG in. If None,
-                searches in the main package.
-
-        Returns:
-            A QIcon created from the SVG file.
-        """
-        return QIcon(str(get_svg_path(svg_name, package=package)))
-
-    @classmethod
-    def get_page_static[T: "BasePage"](cls, page_cls: type[T]) -> T:
-        """Get a page statically from the main window.
-
-        Args:
-            page_cls: The class of the page to retrieve.
-
-        Returns:
-            The page instance of the specified class from the main window.
-        """
-        from winipedia_utils.pyside.ui.windows.base.base import Base as BaseWindow
-
-        top_level_widgets = QApplication.topLevelWidgets()
-        main_window = next(
-            widget for widget in top_level_widgets if isinstance(widget, BaseWindow)
-        )
-        return main_window.get_page(page_cls)
+"""Base UI module.
+
+This module contains the base UI class for the VideoVault application.
+"""
+
+from abc import abstractmethod
+from types import ModuleType
+from typing import TYPE_CHECKING, Any, Self, cast
+
+from PySide6.QtCore import QObject
+from PySide6.QtGui import QIcon
+from PySide6.QtWidgets import QApplication, QStackedWidget
+
+from winipedia_utils.modules.class_ import (
+    get_all_nonabstract_subclasses,
+)
+from winipedia_utils.modules.package import get_main_package, walk_package
+from winipedia_utils.oop.mixins.meta import ABCLoggingMeta
+from winipedia_utils.resources.svgs.svg import get_svg_path
+from winipedia_utils.text.string import split_on_uppercase
+
+# Avoid circular import
+if TYPE_CHECKING:
+    from winipedia_utils.pyside.ui.pages.base.base import Base as BasePage
+    from winipedia_utils.pyside.ui.windows.base.base import Base as BaseWindow
+
+
+class QABCLoggingMeta(
+    ABCLoggingMeta,
+    type(QObject),  # type: ignore[misc]
+):
+    """Metaclass for the QABCImplementationLoggingMixin."""
+
+
+class Base(metaclass=QABCLoggingMeta):
+    """Base UI class for a Qt application."""
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        """Initialize the base UI."""
+        super().__init__(*args, **kwargs)
+        self.base_setup()
+        self.pre_setup()
+        self.setup()
+        self.post_setup()
+
+    @abstractmethod
+    def base_setup(self) -> None:
+        """Setup the base Qt object of the UI.
+
+        This method should initialize the core Qt components required
+        for the UI to function properly.
+        """
+
+    @abstractmethod
+    def setup(self) -> None:
+        """Setup the main UI components.
+
+        This method should contain the primary UI initialization logic.
+        """
+
+    @abstractmethod
+    def pre_setup(self) -> None:
+        """Setup operations to run before main setup.
+
+        This method should contain any initialization that needs to happen
+        before the main setup method is called.
+        """
+
+    @abstractmethod
+    def post_setup(self) -> None:
+        """Setup operations to run after main setup.
+
+        This method should contain any finalization that needs to happen
+        after the main setup method is called.
+        """
+
+    @classmethod
+    def get_display_name(cls) -> str:
+        """Get the display name of the UI.
+
+        Returns:
+            The human-readable display name derived from the class name.
+        """
+        return " ".join(split_on_uppercase(cls.__name__))
+
+    @classmethod
+    def get_subclasses(cls, package: ModuleType | None = None) -> list[type[Self]]:
+        """Get all subclasses of the UI.
+
+        Args:
+            package: The package to search for subclasses in. If None,
+                searches in the main package.
+
+        Returns:
+            A sorted list of all non-abstract subclasses.
+        """
+        if package is None:
+            # find the main package
+            package = get_main_package()
+
+        _ = list(walk_package(package))
+
+        children = get_all_nonabstract_subclasses(cls)
+        return sorted(children, key=lambda cls: cls.__name__)
+
+    def set_current_page(self, page_cls: type["BasePage"]) -> None:
+        """Set the current page in the stack.
+
+        Args:
+            page_cls: The page class to set as current.
+        """
+        self.get_stack().setCurrentWidget(self.get_page(page_cls))
+
+    def get_stack(self) -> QStackedWidget:
+        """Get the stack widget of the window.
+
+        Returns:
+            The QStackedWidget containing all pages.
+        """
+        window = cast("BaseWindow", (getattr(self, "window", lambda: None)()))
+
+        return window.stack
+
+    def get_stack_pages(self) -> list["BasePage"]:
+        """Get all pages from the stack.
+
+        Returns:
+            A list of all pages currently in the stack.
+        """
+        # Import here to avoid circular import
+
+        stack = self.get_stack()
+        # get all the pages
+        return [cast("BasePage", stack.widget(i)) for i in range(stack.count())]
+
+    def get_page[T: "BasePage"](self, page_cls: type[T]) -> T:
+        """Get a specific page from the stack.
+
+        Args:
+            page_cls: The class of the page to retrieve.
+
+        Returns:
+            The page instance of the specified class.
+        """
+        page = next(
+            page for page in self.get_stack_pages() if page.__class__ is page_cls
+        )
+        return cast("T", page)
+
+    @classmethod
+    def get_svg_icon(cls, svg_name: str, package: ModuleType | None = None) -> QIcon:
+        """Get a QIcon for an SVG file.
+
+        Args:
+            svg_name: The name of the SVG file.
+            package: The package to search for the SVG in. If None,
+                searches in the main package.
+
+        Returns:
+            A QIcon created from the SVG file.
+        """
+        return QIcon(str(get_svg_path(svg_name, package=package)))
+
+    @classmethod
+    def get_page_static[T: "BasePage"](cls, page_cls: type[T]) -> T:
+        """Get a page statically from the main window.
+
+        Args:
+            page_cls: The class of the page to retrieve.
+
+        Returns:
+            The page instance of the specified class from the main window.
+        """
+        from winipedia_utils.pyside.ui.windows.base.base import Base as BaseWindow
+
+        top_level_widgets = QApplication.topLevelWidgets()
+        main_window = next(
+            widget for widget in top_level_widgets if isinstance(widget, BaseWindow)
+        )
+        return main_window.get_page(page_cls)

winipedia_utils/pyside/ui/pages/__init__.py

@@ -1 +1 @@
-"""__init__ module."""
+"""__init__ module."""

winipedia_utils/pyside/ui/pages/base/__init__.py

@@ -1 +1 @@
-"""__init__ module."""
+"""__init__ module."""

winipedia_utils/pyside/ui/pages/base/base.py

@@ -1,92 +1,92 @@
-"""Base page module.
-
-This module contains the base page class for the VideoVault application.
-"""
-
-from functools import partial
-from typing import TYPE_CHECKING, Any
-
-from PySide6.QtCore import Qt
-from PySide6.QtWidgets import (
-    QHBoxLayout,
-    QLayout,
-    QMenu,
-    QPushButton,
-    QSizePolicy,
-    QVBoxLayout,
-    QWidget,
-)
-
-from winipedia_utils.pyside.ui.base.base import Base as BaseUI
-
-if TYPE_CHECKING:
-    from winipedia_utils.pyside.ui.windows.base.base import Base as BaseWindow
-
-
-class Base(BaseUI, QWidget):
-    """Base page class for the VideoVault application."""
-
-    def __init__(self, base_window: "BaseWindow", *args: Any, **kwargs: Any) -> None:
-        """Initialize the base page."""
-        self.base_window = base_window
-        super().__init__(*args, **kwargs)
-
-    def base_setup(self) -> None:
-        """Setup the base Qt object of the UI.
-
-        Initializes the main vertical layout, adds a horizontal layout for the top row,
-        and sets up the menu dropdown button.
-        """
-        self.v_layout = QVBoxLayout()
-        self.setLayout(self.v_layout)
-
-        # add a horizontal layout for the top row
-        self.h_layout = QHBoxLayout()
-        self.v_layout.addLayout(self.h_layout)
-
-        self.add_menu_dropdown_button()
-        self.base_window.add_page(self)
-
-    def add_menu_dropdown_button(self) -> None:
-        """Add a dropdown menu that leads to each page.
-
-        Creates a menu button with a dropdown containing actions for all available
-        page subclasses. Each action connects to the set_current_page method.
-        """
-        self.menu_button = QPushButton("Menu")
-        self.menu_button.setIcon(self.get_svg_icon("menu_icon"))
-        self.menu_button.setSizePolicy(
-            QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Minimum
-        )
-        self.h_layout.addWidget(
-            self.menu_button,
-            alignment=Qt.AlignmentFlag.AlignTop | Qt.AlignmentFlag.AlignLeft,
-        )
-        self.menu_dropdown = QMenu(self.menu_button)
-        self.menu_button.setMenu(self.menu_dropdown)
-
-        for page_cls in self.base_window.get_all_page_classes():
-            action = self.menu_dropdown.addAction(page_cls.get_display_name())
-            action.triggered.connect(partial(self.set_current_page, page_cls))
-
-    def add_to_page_button(
-        self, to_page_cls: type["Base"], layout: QLayout
-    ) -> QPushButton:
-        """Add a button to go to the specified page.
-
-        Args:
-            to_page_cls: The page class to navigate to when button is clicked.
-            layout: The layout to add the button to.
-
-        Returns:
-            The created QPushButton widget.
-        """
-        button = QPushButton(to_page_cls.get_display_name())
-
-        # connect to open page on click
-        button.clicked.connect(lambda: self.set_current_page(to_page_cls))
-
-        # add to layout
-        layout.addWidget(button)
-
-        return button
+"""Base page module.
+
+This module contains the base page class for the VideoVault application.
+"""
+
+from functools import partial
+from typing import TYPE_CHECKING, Any
+
+from PySide6.QtCore import Qt
+from PySide6.QtWidgets import (
+    QHBoxLayout,
+    QLayout,
+    QMenu,
+    QPushButton,
+    QSizePolicy,
+    QVBoxLayout,
+    QWidget,
+)
+
+from winipedia_utils.pyside.ui.base.base import Base as BaseUI
+
+if TYPE_CHECKING:
+    from winipedia_utils.pyside.ui.windows.base.base import Base as BaseWindow
+
+
+class Base(BaseUI, QWidget):
+    """Base page class for the VideoVault application."""
+
+    def __init__(self, base_window: "BaseWindow", *args: Any, **kwargs: Any) -> None:
+        """Initialize the base page."""
+        self.base_window = base_window
+        super().__init__(*args, **kwargs)
+
+    def base_setup(self) -> None:
+        """Setup the base Qt object of the UI.
+
+        Initializes the main vertical layout, adds a horizontal layout for the top row,
+        and sets up the menu dropdown button.
+        """
+        self.v_layout = QVBoxLayout()
+        self.setLayout(self.v_layout)
+
+        # add a horizontal layout for the top row
+        self.h_layout = QHBoxLayout()
+        self.v_layout.addLayout(self.h_layout)
+
+        self.add_menu_dropdown_button()
+        self.base_window.add_page(self)
+
+    def add_menu_dropdown_button(self) -> None:
+        """Add a dropdown menu that leads to each page.
+
+        Creates a menu button with a dropdown containing actions for all available
+        page subclasses. Each action connects to the set_current_page method.
+        """
+        self.menu_button = QPushButton("Menu")
+        self.menu_button.setIcon(self.get_svg_icon("menu_icon"))
+        self.menu_button.setSizePolicy(
+            QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Minimum
+        )
+        self.h_layout.addWidget(
+            self.menu_button,
+            alignment=Qt.AlignmentFlag.AlignTop | Qt.AlignmentFlag.AlignLeft,
+        )
+        self.menu_dropdown = QMenu(self.menu_button)
+        self.menu_button.setMenu(self.menu_dropdown)
+
+        for page_cls in self.base_window.get_all_page_classes():
+            action = self.menu_dropdown.addAction(page_cls.get_display_name())
+            action.triggered.connect(partial(self.set_current_page, page_cls))
+
+    def add_to_page_button(
+        self, to_page_cls: type["Base"], layout: QLayout
+    ) -> QPushButton:
+        """Add a button to go to the specified page.
+
+        Args:
+            to_page_cls: The page class to navigate to when button is clicked.
+            layout: The layout to add the button to.
+
+        Returns:
+            The created QPushButton widget.
+        """
+        button = QPushButton(to_page_cls.get_display_name())
+
+        # connect to open page on click
+        button.clicked.connect(lambda: self.set_current_page(to_page_cls))
+
+        # add to layout
+        layout.addWidget(button)
+
+        return button

winipedia_utils/pyside/ui/pages/browser.py

@@ -1,26 +1,26 @@
-"""Add downloads page module.
-
-This module contains the add downloads page class for the VideoVault application.
-"""
-
-from winipedia_utils.pyside.ui.pages.base.base import Base as BasePage
-from winipedia_utils.pyside.ui.widgets.browser import Browser as BrowserWidget
-
-
-class Browser(BasePage):
-    """Add downloads page for the VideoVault application."""
-
-    def setup(self) -> None:
-        """Setup the UI.
-
-        Initializes the browser page by adding a browser widget to the layout.
-        """
-        self.add_brwoser()
-
-    def add_brwoser(self) -> None:
-        """Add a browser to surf the web.
-
-        Creates and adds a BrowserWidget instance to the vertical layout,
-        enabling web browsing functionality within the page.
-        """
-        self.browser = BrowserWidget(self.v_layout)
+"""Add downloads page module.
+
+This module contains the add downloads page class for the VideoVault application.
+"""
+
+from winipedia_utils.pyside.ui.pages.base.base import Base as BasePage
+from winipedia_utils.pyside.ui.widgets.browser import Browser as BrowserWidget
+
+
+class Browser(BasePage):
+    """Add downloads page for the VideoVault application."""
+
+    def setup(self) -> None:
+        """Setup the UI.
+
+        Initializes the browser page by adding a browser widget to the layout.
+        """
+        self.add_brwoser()
+
+    def add_brwoser(self) -> None:
+        """Add a browser to surf the web.
+
+        Creates and adds a BrowserWidget instance to the vertical layout,
+        enabling web browsing functionality within the page.
+        """
+        self.browser = BrowserWidget(self.v_layout)