winipedia-utils 0.2.10__py3-none-any.whl → 0.2.17__py3-none-any.whl

winipedia_utils/git/pre_commit/hooks.py

@@ -1,109 +1,127 @@
-"""module contains functions that return the input for subprocess.run().
-
-Each function is named after the hook it represents. The docstring of each function
-describes the hook it represents. The function returns a list of strings that
-represent the command to run. The first string is the command, and the following
-strings are the arguments to the command. These funcs will be called by
-run_hooks.py, which will pass the returned list to subprocess.run().
-"""
-
-from pathlib import Path
-
-from winipedia_utils.projects.poetry.poetry import (
-    POETRY_PATH,
-    POETRY_RUN_ARGS,
-    POETRY_RUN_PYTHON_ARGS,
-    POETRY_RUN_RUFF_ARGS,
-)
-
-
-def _update_package_manager() -> list[str | Path]:
-    """Update the package manager.
-
-    This function returns the input for subprocess.run() to update the package
-    manager.
-    """
-    return [POETRY_PATH, "self", "update"]
-
-
-def _install_packages() -> list[str | Path]:
-    """Install all dependencies.
-
-    This function returns the input for subprocess.run() to install all dependencies.
-    """
-    return [POETRY_PATH, "install"]
-
-
-def _update_packages() -> list[str | Path]:
-    """Update all dependencies.
-
-    This function returns the input for subprocess.run() to update all dependencies.
-    """
-    return [POETRY_PATH, "update"]
-
-
-def _lock_dependencies() -> list[str | Path]:
-    """Lock the dependencies.
-
-    This function returns the input for subprocess.run() to lock the dependencies.
-    """
-    return [POETRY_PATH, "lock"]
-
-
-def _check_configurations() -> list[str | Path]:
-    """Check that poetry.lock and pyproject.toml is up to date.
-
-    This function returns the input for subprocess.run() to check that poetry.lock
-    is up to date.
-    """
-    return [POETRY_PATH, "check", "--strict"]
-
-
-def _creating_tests() -> list[str | Path]:
-    """Create all tests for the project.
-
-    This function returns the input for subprocess.run() to create all tests.
-    """
-    return [*POETRY_RUN_PYTHON_ARGS, "-m", "winipedia_utils.testing.create_tests"]
-
-
-def _linting() -> list[str | Path]:
-    """Check the code.
-
-    This function returns the input for subprocess.run() to lint the code.
-    It autofixes all errors that can be autofixed with --fix.
-    """
-    return [*POETRY_RUN_RUFF_ARGS, "check", "--fix"]
-
-
-def _formating() -> list[str | Path]:
-    """Format the code.
-
-    This function calls ruff format to format the code.
-    """
-    return [*POETRY_RUN_RUFF_ARGS, "format"]
-
-
-def _type_checking() -> list[str | Path]:
-    """Check the types.
-
-    This function returns the input for subprocess.run() to check the static types.
-    """
-    return [*POETRY_RUN_ARGS, "mypy"]
-
-
-def _security_checking() -> list[str | Path]:
-    """Check the security of the code.
-
-    This function returns the input for subprocess.run() to check the security of
-    the code.
-    """
-    return [*POETRY_RUN_ARGS, "bandit", "-c", "pyproject.toml", "-r", "."]
-
-
-def _testing() -> list[str | Path]:
-    """Run the tests.
-
-    This function returns the input for subprocess.run() to run all tests.
-    """
-    return [*POETRY_RUN_ARGS, "pytest"]
+"""module contains functions that return the input for subprocess.run().
+
+Each function is named after the hook it represents. The docstring of each function
+describes the hook it represents. The function returns a list of strings that
+represent the command to run. The first string is the command, and the following
+strings are the arguments to the command. These funcs will be called by
+run_hooks.py, which will pass the returned list to subprocess.run().
+"""
+
+from pathlib import Path
+
+from winipedia_utils.projects.poetry.poetry import (
+    POETRY_PATH,
+    POETRY_RUN_ARGS,
+    POETRY_RUN_PYTHON_ARGS,
+    POETRY_RUN_RUFF_ARGS,
+)
+
+
+def _version_patch() -> list[str | Path]:
+    """Patch the version in pyproject.toml.
+
+    This function returns the input for subprocess.run() to patch the version
+    in pyproject.toml.
+    """
+    return [POETRY_PATH, "version", "patch"]
+
+
+def _add_version_patch_to_git() -> list[str | Path]:
+    """Add the version patch to git.
+
+    This function returns the input for subprocess.run() to add the version
+    patch to git, so that the hook does not fail bc the file was changed.
+    """
+    return [*POETRY_RUN_ARGS, "git", "add", "pyproject.toml"]
+
+
+def _update_package_manager() -> list[str | Path]:
+    """Update the package manager.
+
+    This function returns the input for subprocess.run() to update the package
+    manager.
+    """
+    return [POETRY_PATH, "self", "update"]
+
+
+def _install_packages() -> list[str | Path]:
+    """Install all dependencies.
+
+    This function returns the input for subprocess.run() to install all dependencies.
+    """
+    return [POETRY_PATH, "install"]
+
+
+def _update_packages() -> list[str | Path]:
+    """Update all dependencies.
+
+    This function returns the input for subprocess.run() to update all dependencies.
+    """
+    return [POETRY_PATH, "update"]
+
+
+def _lock_dependencies() -> list[str | Path]:
+    """Lock the dependencies.
+
+    This function returns the input for subprocess.run() to lock the dependencies.
+    """
+    return [POETRY_PATH, "lock"]
+
+
+def _check_configurations() -> list[str | Path]:
+    """Check that poetry.lock and pyproject.toml is up to date.
+
+    This function returns the input for subprocess.run() to check that poetry.lock
+    is up to date.
+    """
+    return [POETRY_PATH, "check", "--strict"]
+
+
+def _creating_tests() -> list[str | Path]:
+    """Create all tests for the project.
+
+    This function returns the input for subprocess.run() to create all tests.
+    """
+    return [*POETRY_RUN_PYTHON_ARGS, "-m", "winipedia_utils.testing.create_tests"]
+
+
+def _linting() -> list[str | Path]:
+    """Check the code.
+
+    This function returns the input for subprocess.run() to lint the code.
+    It autofixes all errors that can be autofixed with --fix.
+    """
+    return [*POETRY_RUN_RUFF_ARGS, "check", "--fix"]
+
+
+def _formating() -> list[str | Path]:
+    """Format the code.
+
+    This function calls ruff format to format the code.
+    """
+    return [*POETRY_RUN_RUFF_ARGS, "format"]
+
+
+def _type_checking() -> list[str | Path]:
+    """Check the types.
+
+    This function returns the input for subprocess.run() to check the static types.
+    """
+    return [*POETRY_RUN_ARGS, "mypy"]
+
+
+def _security_checking() -> list[str | Path]:
+    """Check the security of the code.
+
+    This function returns the input for subprocess.run() to check the security of
+    the code.
+    """
+    return [*POETRY_RUN_ARGS, "bandit", "-c", "pyproject.toml", "-r", "."]
+
+
+def _testing() -> list[str | Path]:
+    """Run the tests.
+
+    This function returns the input for subprocess.run() to run all tests.
+    """
+    return [*POETRY_RUN_ARGS, "pytest"]

winipedia_utils/git/pre_commit/run_hooks.py

@@ -1,49 +1,49 @@
-"""Contains the pre-commit to run all hooks required by the winipedia_utils package.
-
-This script is meant to be run by pre-commit (https://pre-commit.com/)
-and should not be modified manually.
-"""
-
-import sys
-
-from winipedia_utils.git.pre_commit import hooks
-from winipedia_utils.logging.ansi import GREEN, RED, RESET
-from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.modules.function import get_all_functions_from_module
-from winipedia_utils.os.os import run_subprocess
-
-logger = get_logger(__name__)
-
-
-def _run_all_hooks() -> None:
-    """Import all funcs defined in hooks.py and runs them."""
-    hook_funcs = get_all_functions_from_module(hooks)
-
-    exit_code = 0
-    for hook_func in hook_funcs:
-        subprocess_args = hook_func()
-        result = run_subprocess(
-            subprocess_args, check=False, capture_output=True, text=True
-        )
-        passed = result.returncode == 0
-
-        log_method = logger.info
-        passed_str = (f"{GREEN}PASSED" if passed else f"{RED}FAILED") + RESET
-        if not passed:
-            log_method = logger.error
-            passed_str += f"\n{result.stdout}"
-            exit_code = 1
-        # make the dashes always the same lentgth by adjusting to len of hook name
-        num_dashes = 50 - len(hook_func.__name__)
-        log_method(
-            "Hook %s -%s> %s",
-            hook_func.__name__,
-            "-" * num_dashes,
-            passed_str,
-        )
-
-    sys.exit(exit_code)
-
-
-if __name__ == "__main__":
-    _run_all_hooks()
+"""Contains the pre-commit to run all hooks required by the winipedia_utils package.
+
+This script is meant to be run by pre-commit (https://pre-commit.com/)
+and should not be modified manually.
+"""
+
+import sys
+
+from winipedia_utils.git.pre_commit import hooks
+from winipedia_utils.logging.ansi import GREEN, RED, RESET
+from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.modules.function import get_all_functions_from_module
+from winipedia_utils.os.os import run_subprocess
+
+logger = get_logger(__name__)
+
+
+def _run_all_hooks() -> None:
+    """Import all funcs defined in hooks.py and runs them."""
+    hook_funcs = get_all_functions_from_module(hooks)
+
+    exit_code = 0
+    for hook_func in hook_funcs:
+        subprocess_args = hook_func()
+        result = run_subprocess(
+            subprocess_args, check=False, capture_output=True, text=True
+        )
+        passed = result.returncode == 0
+
+        log_method = logger.info
+        passed_str = (f"{GREEN}PASSED" if passed else f"{RED}FAILED") + RESET
+        if not passed:
+            log_method = logger.error
+            passed_str += f"\n{result.stdout}"
+            exit_code = 1
+        # make the dashes always the same lentgth by adjusting to len of hook name
+        num_dashes = 50 - len(hook_func.__name__)
+        log_method(
+            "Hook %s -%s> %s",
+            hook_func.__name__,
+            "-" * num_dashes,
+            passed_str,
+        )
+
+    sys.exit(exit_code)
+
+
+if __name__ == "__main__":
+    _run_all_hooks()

winipedia_utils/iterating/__init__.py

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

winipedia_utils/iterating/iterate.py

@@ -1,29 +1,29 @@
-"""Iterating utilities for handling iterables.
-
-This module provides utility functions for working with iterables,
-including getting the length of an iterable with a default value.
-These utilities help with iterable operations and manipulations.
-"""
-
-from collections.abc import Iterable
-from typing import Any
-
-
-def get_len_with_default(iterable: Iterable[Any], default: int | None = None) -> int:
-    """Get the length of an iterable with a default value.
-
-    Args:
-        iterable: Iterable to get the length of
-        default: Default value to return if the iterable is empty
-
-    Returns:
-        Length of the iterable or the default value if the iterable is empty
-
-    """
-    try:
-        return len(iterable)  # type: ignore[arg-type]
-    except TypeError as e:
-        if default is None:
-            msg = "Can't get length of iterable and no default value provided"
-            raise TypeError(msg) from e
-        return default
+"""Iterating utilities for handling iterables.
+
+This module provides utility functions for working with iterables,
+including getting the length of an iterable with a default value.
+These utilities help with iterable operations and manipulations.
+"""
+
+from collections.abc import Iterable
+from typing import Any
+
+
+def get_len_with_default(iterable: Iterable[Any], default: int | None = None) -> int:
+    """Get the length of an iterable with a default value.
+
+    Args:
+        iterable: Iterable to get the length of
+        default: Default value to return if the iterable is empty
+
+    Returns:
+        Length of the iterable or the default value if the iterable is empty
+
+    """
+    try:
+        return len(iterable)  # type: ignore[arg-type]
+    except TypeError as e:
+        if default is None:
+            msg = "Can't get length of iterable and no default value provided"
+            raise TypeError(msg) from e
+        return default

winipedia_utils/logging/ansi.py

@@ -1,6 +1,6 @@
-"""ANSI escape codes for terminal output."""
-
-RESET = "\033[0m"
-
-RED = "\033[91m"
-GREEN = "\033[92m"
+"""ANSI escape codes for terminal output."""
+
+RESET = "\033[0m"
+
+RED = "\033[91m"
+GREEN = "\033[92m"

winipedia_utils/logging/config.py

@@ -1,64 +1,64 @@
-"""Logging configuration for winipedia_utils.
-
-This module provides a standardized logging configuration dictionary that can be
-used with Python's logging.config.dictConfig() to set up consistent logging
-across the application. The configuration includes formatters, handlers, and
-logger settings for different components.
-"""
-
-# This dictionary can be passed directly to logging.config.dictConfig().
-# It sets up a single console handler that prints **all** log levels
-# (DEBUG, INFO, WARNING, ERROR and CRITICAL) using one consistent format.
-
-from typing import Any
-
-LOGGING_CONFIG: dict[str, Any] = {
-    "version": 1,  # Mandatory schema version for dictConfig
-    "disable_existing_loggers": False,  # Keep any loggers already created elsewhere
-    # ---------------------------- #
-    #  Define a single formatter   #
-    # ---------------------------- #
-    "formatters": {
-        "standard": {  # You can reference this formatter by name
-            "format": (
-                "%(asctime)s | "  # • %(asctime)s human-readable timestamp
-                "%(levelname)-8s | "  # • %(asctime)s human-readable timestamp
-                "%(filename)s:"  # • %(filename)s source file where the call was made
-                "%(lineno)d | "  # • %(lineno)d line number in that file
-                "%(message)s"  # • %(message)s the log message itself
-            ),
-            "datefmt": "%Y-%m-%d %H:%M:%S",  # Override default timestamp style
-        },
-    },
-    # --------------------------- #
-    #  Define the console output  #
-    # --------------------------- #
-    "handlers": {
-        "console": {
-            "class": "logging.StreamHandler",  # Send logs to sys.stderr
-            "level": "DEBUG",  # Capture *everything* ≥ DEBUG
-            "formatter": "standard",  # Use the formatter above
-            "stream": "ext://sys.stdout",  # Emit to stdout instead of stderr
-        },
-    },
-    # ------------------------------------------------------- #
-    #  Attach the handler to either the root logger or named  #
-    #  loggers. Below we set up the root so every message in  #
-    #  your application uses this setup automatically.        #
-    # ------------------------------------------------------- #
-    "root": {
-        "level": "DEBUG",  # Accept all levels from DEBUG upward
-        "handlers": ["console"],  # Pipe them through the console handler
-    },
-    # ------------------------------------------------------- #
-    #  Optionally, tweak individual libraries if they are     #
-    #  too noisy. For example, silence urllib3 INFO chatter.   #
-    # ------------------------------------------------------- #
-    "loggers": {
-        "urllib3": {
-            "level": "WARNING",  # Raise urllib3's threshold to WARNING
-            "handlers": ["console"],
-            "propagate": False,  # Prevent double-logging to the root
-        },
-    },
-}
+"""Logging configuration for winipedia_utils.
+
+This module provides a standardized logging configuration dictionary that can be
+used with Python's logging.config.dictConfig() to set up consistent logging
+across the application. The configuration includes formatters, handlers, and
+logger settings for different components.
+"""
+
+# This dictionary can be passed directly to logging.config.dictConfig().
+# It sets up a single console handler that prints **all** log levels
+# (DEBUG, INFO, WARNING, ERROR and CRITICAL) using one consistent format.
+
+from typing import Any
+
+LOGGING_CONFIG: dict[str, Any] = {
+    "version": 1,  # Mandatory schema version for dictConfig
+    "disable_existing_loggers": False,  # Keep any loggers already created elsewhere
+    # ---------------------------- #
+    #  Define a single formatter   #
+    # ---------------------------- #
+    "formatters": {
+        "standard": {  # You can reference this formatter by name
+            "format": (
+                "%(asctime)s | "  # • %(asctime)s human-readable timestamp
+                "%(levelname)-8s | "  # • %(asctime)s human-readable timestamp
+                "%(filename)s:"  # • %(filename)s source file where the call was made
+                "%(lineno)d | "  # • %(lineno)d line number in that file
+                "%(message)s"  # • %(message)s the log message itself
+            ),
+            "datefmt": "%Y-%m-%d %H:%M:%S",  # Override default timestamp style
+        },
+    },
+    # --------------------------- #
+    #  Define the console output  #
+    # --------------------------- #
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",  # Send logs to sys.stderr
+            "level": "DEBUG",  # Capture *everything* ≥ DEBUG
+            "formatter": "standard",  # Use the formatter above
+            "stream": "ext://sys.stdout",  # Emit to stdout instead of stderr
+        },
+    },
+    # ------------------------------------------------------- #
+    #  Attach the handler to either the root logger or named  #
+    #  loggers. Below we set up the root so every message in  #
+    #  your application uses this setup automatically.        #
+    # ------------------------------------------------------- #
+    "root": {
+        "level": "DEBUG",  # Accept all levels from DEBUG upward
+        "handlers": ["console"],  # Pipe them through the console handler
+    },
+    # ------------------------------------------------------- #
+    #  Optionally, tweak individual libraries if they are     #
+    #  too noisy. For example, silence urllib3 INFO chatter.   #
+    # ------------------------------------------------------- #
+    "loggers": {
+        "urllib3": {
+            "level": "WARNING",  # Raise urllib3's threshold to WARNING
+            "handlers": ["console"],
+            "propagate": False,  # Prevent double-logging to the root
+        },
+    },
+}

winipedia_utils/logging/logger.py

@@ -1,26 +1,26 @@
-"""Logger utilities for winipedia_utils.
-
-This module provides functions for creating and configuring loggers
-throughout the application. It applies the standardized logging configuration
-defined in the config module to ensure consistent logging behavior.
-"""
-
-import logging
-from logging.config import dictConfig
-
-from winipedia_utils.logging.config import LOGGING_CONFIG
-
-dictConfig(LOGGING_CONFIG)
-
-
-def get_logger(name: str) -> logging.Logger:
-    """Get a logger with the given name.
-
-    Args:
-        name: The name for the logger, typically __name__ from the calling module
-
-    Returns:
-        A configured logger instance with the specified name
-
-    """
-    return logging.getLogger(name)
+"""Logger utilities for winipedia_utils.
+
+This module provides functions for creating and configuring loggers
+throughout the application. It applies the standardized logging configuration
+defined in the config module to ensure consistent logging behavior.
+"""
+
+import logging
+from logging.config import dictConfig
+
+from winipedia_utils.logging.config import LOGGING_CONFIG
+
+dictConfig(LOGGING_CONFIG)
+
+
+def get_logger(name: str) -> logging.Logger:
+    """Get a logger with the given name.
+
+    Args:
+        name: The name for the logger, typically __name__ from the calling module
+
+    Returns:
+        A configured logger instance with the specified name
+
+    """
+    return logging.getLogger(name)