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

winipedia_utils/oop/mixins/mixin.py

@@ -1,37 +1,37 @@
-"""Mixin utilities for class composition and behavior extension.
-
-This module provides metaclasses and mixins that facilitate class composition
-through the mixin pattern. It includes utilities for:
-- Automatic method logging with performance tracking
-- Abstract class implementation enforcement with type checking
-- Combined metaclasses that merge multiple behaviors
-
-These utilities help create robust class hierarchies with proper implementation
-enforcement and built-in logging capabilities.
-"""
-
-from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.oop.mixins.meta import ABCLoggingMeta, StrictABCLoggingMeta
-
-logger = get_logger(__name__)
-
-
-class StrictABCLoggingMixin(metaclass=StrictABCLoggingMeta):
-    """mixin class that provides implementation, logging, and ABC functionality.
-
-    This mixin can be used as a base class for other mixins that need:
-    - Abstract method declaration (from ABC)
-    - Implementation enforcement (from ImplementationMeta)
-    - Automatic method logging (from LoggingMeta)
-
-    Subclasses must set __abstract__ = False when they provide concrete implementations.
-    """
-
-
-class ABCLoggingMixin(metaclass=ABCLoggingMeta):
-    """Mixin class that provides automatic method logging with performance tracking.
-
-    This mixin can be used as a base class for other mixins that need:
-    - Automatic method logging (from LoggingMeta)
-
-    """
+"""Mixin utilities for class composition and behavior extension.
+
+This module provides metaclasses and mixins that facilitate class composition
+through the mixin pattern. It includes utilities for:
+- Automatic method logging with performance tracking
+- Abstract class implementation enforcement with type checking
+- Combined metaclasses that merge multiple behaviors
+
+These utilities help create robust class hierarchies with proper implementation
+enforcement and built-in logging capabilities.
+"""
+
+from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.oop.mixins.meta import ABCLoggingMeta, StrictABCLoggingMeta
+
+logger = get_logger(__name__)
+
+
+class StrictABCLoggingMixin(metaclass=StrictABCLoggingMeta):
+    """mixin class that provides implementation, logging, and ABC functionality.
+
+    This mixin can be used as a base class for other mixins that need:
+    - Abstract method declaration (from ABC)
+    - Implementation enforcement (from ImplementationMeta)
+    - Automatic method logging (from LoggingMeta)
+
+    Subclasses must set __abstract__ = False when they provide concrete implementations.
+    """
+
+
+class ABCLoggingMixin(metaclass=ABCLoggingMeta):
+    """Mixin class that provides automatic method logging with performance tracking.
+
+    This mixin can be used as a base class for other mixins that need:
+    - Automatic method logging (from LoggingMeta)
+
+    """

winipedia_utils/os/__init__.py

@@ -1 +1 @@
-"""__init__ module for winipedia_utils.os."""
+"""__init__ module for winipedia_utils.os."""

winipedia_utils/os/os.py

@@ -1,63 +1,63 @@
-"""OS utilities for finding commands and paths.
-
-This module provides utility functions for working with the operating system,
-including finding the path to commands and managing environment variables.
-These utilities help with system-level operations and configuration.
-"""
-
-import shutil
-import subprocess  # nosec: B404
-from pathlib import Path
-from typing import Any
-
-
-def which_with_raise(cmd: str, *, raise_error: bool = True) -> str | None:
-    """Give the path to the given command.
-
-    Args:
-        cmd: The command to find
-        raise_error: Whether to raise an error if the command is not found
-
-    Returns:
-        The path to the command
-
-    Raises:
-        FileNotFoundError: If the command is not found
-
-    """
-    path = shutil.which(cmd)
-    if path is None:
-        msg = f"Command {cmd} not found"
-        if raise_error:
-            raise FileNotFoundError(msg)
-    return path
-
-
-def run_subprocess(
-    args: list[str | Path],
-    *,
-    input_: str | bytes | None = None,
-    capture_output: bool = True,
-    timeout: int | None = None,
-    check: bool = True,
-    **kwargs: Any,
-) -> subprocess.CompletedProcess[Any]:
-    """Run a subprocess.
-
-    Args:
-        args: The arguments to pass to the subprocess
-        input_: The input to pass to the subprocess
-        capture_output: Whether to capture the output of the subprocess
-        timeout: The timeout for the subprocess
-        check: to raise an exception if the subprocess returns a non-zero exit code
-        kwargs: Any other arguments to pass to subprocess.run()
-
-    """
-    return subprocess.run(  # noqa: S603  # nosec: B603
-        args,
-        check=check,
-        input=input_,
-        capture_output=capture_output,
-        timeout=timeout,
-        **kwargs,
-    )
+"""OS utilities for finding commands and paths.
+
+This module provides utility functions for working with the operating system,
+including finding the path to commands and managing environment variables.
+These utilities help with system-level operations and configuration.
+"""
+
+import shutil
+import subprocess  # nosec: B404
+from pathlib import Path
+from typing import Any
+
+
+def which_with_raise(cmd: str, *, raise_error: bool = True) -> str | None:
+    """Give the path to the given command.
+
+    Args:
+        cmd: The command to find
+        raise_error: Whether to raise an error if the command is not found
+
+    Returns:
+        The path to the command
+
+    Raises:
+        FileNotFoundError: If the command is not found
+
+    """
+    path = shutil.which(cmd)
+    if path is None:
+        msg = f"Command {cmd} not found"
+        if raise_error:
+            raise FileNotFoundError(msg)
+    return path
+
+
+def run_subprocess(
+    args: list[str | Path],
+    *,
+    input_: str | bytes | None = None,
+    capture_output: bool = True,
+    timeout: int | None = None,
+    check: bool = True,
+    **kwargs: Any,
+) -> subprocess.CompletedProcess[Any]:
+    """Run a subprocess.
+
+    Args:
+        args: The arguments to pass to the subprocess
+        input_: The input to pass to the subprocess
+        capture_output: Whether to capture the output of the subprocess
+        timeout: The timeout for the subprocess
+        check: to raise an exception if the subprocess returns a non-zero exit code
+        kwargs: Any other arguments to pass to subprocess.run()
+
+    """
+    return subprocess.run(  # noqa: S603  # nosec: B603
+        args,
+        check=check,
+        input=input_,
+        capture_output=capture_output,
+        timeout=timeout,
+        **kwargs,
+    )

winipedia_utils/projects/__init__.py

@@ -1 +1 @@
-"""__init__ module for winipedia_utils.projects."""
+"""__init__ module for winipedia_utils.projects."""

winipedia_utils/projects/poetry/__init__.py

@@ -1 +1 @@
-"""__init__ module for winipedia_utils.projects.poetry."""
+"""__init__ module for winipedia_utils.projects.poetry."""

winipedia_utils/projects/poetry/config.py

@@ -1,91 +1,91 @@
-"""Config utilities for poetry and pyproject.toml."""
-
-from pathlib import Path
-from typing import Any
-
-import tomlkit
-from tomlkit.toml_document import TOMLDocument
-
-from winipedia_utils.projects.poetry.poetry import logger
-
-
-def laod_pyproject_toml() -> TOMLDocument:
-    """Load the pyproject.toml file."""
-    return tomlkit.parse(Path("pyproject.toml").read_text())
-
-
-def dump_pyproject_toml(toml: TOMLDocument) -> None:
-    """Dump the pyproject.toml file."""
-    with Path("pyproject.toml").open("w") as f:
-        tomlkit.dump(toml, f)
-
-
-def get_poetry_package_name() -> str:
-    """Get the name of the project from pyproject.toml."""
-    toml = laod_pyproject_toml()
-    project_dict = toml.get("project", {})
-    project_name = str(project_dict.get("name", ""))
-    return project_name.replace("-", "_")
-
-
-def _get_pyproject_toml_tool_configs() -> dict[str, Any]:
-    """Get the tool configurations for pyproject.toml."""
-    return {
-        "ruff": {
-            "exclude": [".*", "**/migrations/*.py"],
-            "lint": {
-                "select": ["ALL"],
-                "ignore": ["D203", "D213", "COM812", "ANN401"],
-                "fixable": ["ALL"],
-                "pydocstyle": {
-                    "convention": "google",
-                },
-            },
-        },
-        "mypy": {
-            "strict": True,
-            "warn_unreachable": True,
-            "show_error_codes": True,
-            "files": ".",
-        },
-        "pytest": {
-            "ini_options": {
-                "testpaths": ["tests"],
-            }
-        },
-        "bandit": {},
-    }
-
-
-def _tool_config_is_correct(tool: str, config: dict[str, Any]) -> bool:
-    """Check if the tool configuration in pyproject.toml is correct."""
-    toml = laod_pyproject_toml()
-    actual_tools = toml.get("tool", {})
-
-    return bool(actual_tools.get(tool) == config)
-
-
-def _pyproject_tool_configs_are_correct() -> bool:
-    """Check if the tool configurations in pyproject.toml are correct."""
-    expected_tool_dict = _get_pyproject_toml_tool_configs()
-    for tool, config in expected_tool_dict.items():
-        if not _tool_config_is_correct(tool, config):
-            return False
-
-    return True
-
-
-def _add_configurations_to_pyproject_toml() -> None:
-    """Add tool.* configurations to pyproject.toml."""
-    expected_tool_dict = _get_pyproject_toml_tool_configs()
-    toml = laod_pyproject_toml()
-    actual_tool_dict = toml.get("tool", {})
-    # update the toml dct and dump it but only update the tools specified not all tools
-    for tool, config in expected_tool_dict.items():
-        # if tool section already exists skip it
-        if not _tool_config_is_correct(tool, config):
-            logger.info("Adding tool.%s configuration to pyproject.toml", tool)
-            # updates inplace of toml_dict["tool"][tool]
-            actual_tool_dict[tool] = config
-
-    dump_pyproject_toml(toml)
+"""Config utilities for poetry and pyproject.toml."""
+
+from pathlib import Path
+from typing import Any
+
+import tomlkit
+from tomlkit.toml_document import TOMLDocument
+
+from winipedia_utils.projects.poetry.poetry import logger
+
+
+def laod_pyproject_toml() -> TOMLDocument:
+    """Load the pyproject.toml file."""
+    return tomlkit.parse(Path("pyproject.toml").read_text())
+
+
+def dump_pyproject_toml(toml: TOMLDocument) -> None:
+    """Dump the pyproject.toml file."""
+    with Path("pyproject.toml").open("w") as f:
+        tomlkit.dump(toml, f)
+
+
+def get_poetry_package_name() -> str:
+    """Get the name of the project from pyproject.toml."""
+    toml = laod_pyproject_toml()
+    project_dict = toml.get("project", {})
+    project_name = str(project_dict.get("name", ""))
+    return project_name.replace("-", "_")
+
+
+def _get_pyproject_toml_tool_configs() -> dict[str, Any]:
+    """Get the tool configurations for pyproject.toml."""
+    return {
+        "ruff": {
+            "exclude": [".*", "**/migrations/*.py"],
+            "lint": {
+                "select": ["ALL"],
+                "ignore": ["D203", "D213", "COM812", "ANN401"],
+                "fixable": ["ALL"],
+                "pydocstyle": {
+                    "convention": "google",
+                },
+            },
+        },
+        "mypy": {
+            "strict": True,
+            "warn_unreachable": True,
+            "show_error_codes": True,
+            "files": ".",
+        },
+        "pytest": {
+            "ini_options": {
+                "testpaths": ["tests"],
+            }
+        },
+        "bandit": {},
+    }
+
+
+def _tool_config_is_correct(tool: str, config: dict[str, Any]) -> bool:
+    """Check if the tool configuration in pyproject.toml is correct."""
+    toml = laod_pyproject_toml()
+    actual_tools = toml.get("tool", {})
+
+    return bool(actual_tools.get(tool) == config)
+
+
+def _pyproject_tool_configs_are_correct() -> bool:
+    """Check if the tool configurations in pyproject.toml are correct."""
+    expected_tool_dict = _get_pyproject_toml_tool_configs()
+    for tool, config in expected_tool_dict.items():
+        if not _tool_config_is_correct(tool, config):
+            return False
+
+    return True
+
+
+def _add_configurations_to_pyproject_toml() -> None:
+    """Add tool.* configurations to pyproject.toml."""
+    expected_tool_dict = _get_pyproject_toml_tool_configs()
+    toml = laod_pyproject_toml()
+    actual_tool_dict = toml.get("tool", {})
+    # update the toml dct and dump it but only update the tools specified not all tools
+    for tool, config in expected_tool_dict.items():
+        # if tool section already exists skip it
+        if not _tool_config_is_correct(tool, config):
+            logger.info("Adding tool.%s configuration to pyproject.toml", tool)
+            # updates inplace of toml_dict["tool"][tool]
+            actual_tool_dict[tool] = config
+
+    dump_pyproject_toml(toml)

winipedia_utils/projects/poetry/poetry.py

@@ -1,31 +1,31 @@
-"""Project utilities for introspection and manipulation.
-
-This module provides utility functions for working with Python projects
-"""
-
-import sys
-
-from winipedia_utils.consts import _DEV_DEPENDENCIES
-from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.os.os import run_subprocess, which_with_raise
-
-logger = get_logger(__name__)
-
-
-POETRY_PATH = which_with_raise("poetry", raise_error=False) or "poetry"
-
-POETRY_RUN_ARGS = [POETRY_PATH, "run"]
-
-POETRY_ADD_ARGS = [POETRY_PATH, "add"]
-
-POETRY_ADD_DEV_ARGS = [*POETRY_ADD_ARGS, "--group", "dev"]
-
-POETRY_RUN_PYTHON_ARGS = [*POETRY_RUN_ARGS, sys.executable]
-
-POETRY_RUN_RUFF_ARGS = [*POETRY_RUN_ARGS, "ruff"]
-
-
-def _install_dev_dependencies() -> None:
-    """Install winipedia_utils dev dependencies as dev dependencies."""
-    logger.info("Adding dev dependencies: %s", _DEV_DEPENDENCIES)
-    run_subprocess([*POETRY_ADD_DEV_ARGS, *_DEV_DEPENDENCIES], check=True)
+"""Project utilities for introspection and manipulation.
+
+This module provides utility functions for working with Python projects
+"""
+
+import sys
+
+from winipedia_utils.consts import _DEV_DEPENDENCIES
+from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.os.os import run_subprocess, which_with_raise
+
+logger = get_logger(__name__)
+
+
+POETRY_PATH = which_with_raise("poetry", raise_error=False) or "poetry"
+
+POETRY_RUN_ARGS = [POETRY_PATH, "run"]
+
+POETRY_ADD_ARGS = [POETRY_PATH, "add"]
+
+POETRY_ADD_DEV_ARGS = [*POETRY_ADD_ARGS, "--group", "dev"]
+
+POETRY_RUN_PYTHON_ARGS = [*POETRY_RUN_ARGS, sys.executable]
+
+POETRY_RUN_RUFF_ARGS = [*POETRY_RUN_ARGS, "ruff"]
+
+
+def _install_dev_dependencies() -> None:
+    """Install winipedia_utils dev dependencies as dev dependencies."""
+    logger.info("Adding dev dependencies: %s", _DEV_DEPENDENCIES)
+    run_subprocess([*POETRY_ADD_DEV_ARGS, *_DEV_DEPENDENCIES], check=True)

winipedia_utils/projects/project.py

@@ -1,48 +1,48 @@
-"""Utilities for working with Python projects."""
-
-from types import ModuleType
-
-from winipedia_utils.modules.module import create_module, to_path
-from winipedia_utils.modules.package import get_src_package
-from winipedia_utils.projects.poetry.config import get_poetry_package_name
-
-
-def _create_project_root() -> None:
-    """Create the project root."""
-    src_package_name = get_poetry_package_name()
-    create_module(src_package_name, is_package=True)
-    _create_py_typed()
-
-
-def _create_py_typed() -> None:
-    """Create the py.typed file."""
-    src_package_name = get_src_package().__name__
-    py_typed_path = to_path(src_package_name, is_package=True) / "py.typed"
-    py_typed_path.touch()
-
-
-def make_name_from_package(
-    package: ModuleType,
-    split_on: str = "_",
-    join_on: str = "-",
-    *,
-    capitalize: bool = True,
-) -> str:
-    """Make a name from a package.
-
-    takes a package and makes a name from it that is readable by humans.
-
-    Args:
-        package (ModuleType): The package to make a name from
-        split_on (str, optional): what to split the package name on. Defaults to "_".
-        join_on (str, optional): what to join the package name with. Defaults to "-".
-        capitalize (bool, optional): Whether to capitalize each part. Defaults to True.
-
-    Returns:
-        str: _description_
-    """
-    package_name = package.__name__.split(".")[-1]
-    parts = package_name.split(split_on)
-    if capitalize:
-        parts = [part.capitalize() for part in parts]
-    return join_on.join(parts)
+"""Utilities for working with Python projects."""
+
+from types import ModuleType
+
+from winipedia_utils.modules.module import create_module, to_path
+from winipedia_utils.modules.package import get_src_package
+from winipedia_utils.projects.poetry.config import get_poetry_package_name
+
+
+def _create_project_root() -> None:
+    """Create the project root."""
+    src_package_name = get_poetry_package_name()
+    create_module(src_package_name, is_package=True)
+    _create_py_typed()
+
+
+def _create_py_typed() -> None:
+    """Create the py.typed file."""
+    src_package_name = get_src_package().__name__
+    py_typed_path = to_path(src_package_name, is_package=True) / "py.typed"
+    py_typed_path.touch()
+
+
+def make_name_from_package(
+    package: ModuleType,
+    split_on: str = "_",
+    join_on: str = "-",
+    *,
+    capitalize: bool = True,
+) -> str:
+    """Make a name from a package.
+
+    takes a package and makes a name from it that is readable by humans.
+
+    Args:
+        package (ModuleType): The package to make a name from
+        split_on (str, optional): what to split the package name on. Defaults to "_".
+        join_on (str, optional): what to join the package name with. Defaults to "-".
+        capitalize (bool, optional): Whether to capitalize each part. Defaults to True.
+
+    Returns:
+        str: _description_
+    """
+    package_name = package.__name__.split(".")[-1]
+    parts = package_name.split(split_on)
+    if capitalize:
+        parts = [part.capitalize() for part in parts]
+    return join_on.join(parts)

winipedia_utils/pyside/__init__.py

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

winipedia_utils/pyside/core/__init__.py

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