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

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)

winipedia_utils/modules/class_.py

@@ -1,119 +1,119 @@
-"""Class utilities for introspection and manipulation.
-
-This module provides utility functions for working with Python classes,
-including extracting methods from classes and finding classes within modules.
-These utilities are particularly useful for reflection, testing,
-and dynamic code generation.
-"""
-
-import inspect
-from collections.abc import Callable
-from importlib import import_module
-from types import ModuleType
-from typing import Any
-
-from winipedia_utils.modules.function import is_func
-
-
-def get_all_methods_from_cls(
-    class_: type, *, exclude_parent_methods: bool = False
-) -> list[Callable[..., Any]]:
-    """Get all methods from a class.
-
-    Retrieves all methods (functions or methods) from a class. Can optionally
-    exclude methods inherited from parent classes.
-
-    Args:
-        class_: The class to extract methods from
-        exclude_parent_methods: If True, only include methods defined in this class,
-        excluding those inherited from parent classes
-    Returns:
-        A list of callable methods from the class
-
-    """
-    from winipedia_utils.modules.module import get_def_line, get_module_of_obj
-
-    methods = [
-        (method, name) for name, method in inspect.getmembers(class_) if is_func(method)
-    ]
-
-    if exclude_parent_methods:
-        methods = [
-            (method, name)
-            for method, name in methods
-            if get_module_of_obj(method).__name__ == class_.__module__
-            and name in class_.__dict__
-        ]
-
-    only_methods = [method for method, _name in methods]
-    # sort by definition order
-    return sorted(only_methods, key=get_def_line)
-
-
-def get_all_cls_from_module(module: ModuleType | str) -> list[type]:
-    """Get all classes defined in a module.
-
-    Retrieves all class objects that are defined directly in the specified module,
-    excluding imported classes.
-
-    Args:
-        module: The module to extract classes from
-
-    Returns:
-        A list of class types defined in the module
-
-    """
-    from winipedia_utils.modules.module import get_def_line, get_module_of_obj
-
-    if isinstance(module, str):
-        module = import_module(module)
-
-    # necessary for bindings packages like AESGCM from cryptography._rust backend
-    default = ModuleType("default")
-    classes = [
-        obj
-        for _, obj in inspect.getmembers(module, inspect.isclass)
-        if get_module_of_obj(obj, default).__name__ == module.__name__
-    ]
-    # sort by definition order
-    return sorted(classes, key=get_def_line)
-
-
-def get_all_subclasses(cls: type) -> list[type]:
-    """Get all subclasses of a class.
-
-    Retrieves all classes that are subclasses of the specified class.
-    Also returns subclasses of subclasses (recursive).
-
-    Args:
-        cls: The class to find subclasses of
-
-    Returns:
-        A list of subclasses of the given class
-
-    """
-    subclasses_set = set(cls.__subclasses__())
-    for subclass in cls.__subclasses__():
-        subclasses_set.update(get_all_subclasses(subclass))
-    return list(subclasses_set)
-
-
-def get_all_nonabstract_subclasses(cls: type) -> list[type]:
-    """Get all non-abstract subclasses of a class.
-
-    Retrieves all classes that are subclasses of the specified class,
-    excluding abstract classes. Also returns subclasses of subclasses
-    (recursive).
-
-    Args:
-        cls: The class to find subclasses of
-
-    Returns:
-        A list of non-abstract subclasses of the given class
-
-    """
-    return [
-        subclass
-        for subclass in get_all_subclasses(cls)
-        if not inspect.isabstract(subclass)
-    ]
+"""Class utilities for introspection and manipulation.
+
+This module provides utility functions for working with Python classes,
+including extracting methods from classes and finding classes within modules.
+These utilities are particularly useful for reflection, testing,
+and dynamic code generation.
+"""
+
+import inspect
+from collections.abc import Callable
+from importlib import import_module
+from types import ModuleType
+from typing import Any
+
+from winipedia_utils.modules.function import is_func
+
+
+def get_all_methods_from_cls(
+    class_: type, *, exclude_parent_methods: bool = False
+) -> list[Callable[..., Any]]:
+    """Get all methods from a class.
+
+    Retrieves all methods (functions or methods) from a class. Can optionally
+    exclude methods inherited from parent classes.
+
+    Args:
+        class_: The class to extract methods from
+        exclude_parent_methods: If True, only include methods defined in this class,
+        excluding those inherited from parent classes
+    Returns:
+        A list of callable methods from the class
+
+    """
+    from winipedia_utils.modules.module import get_def_line, get_module_of_obj
+
+    methods = [
+        (method, name) for name, method in inspect.getmembers(class_) if is_func(method)
+    ]
+
+    if exclude_parent_methods:
+        methods = [
+            (method, name)
+            for method, name in methods
+            if get_module_of_obj(method).__name__ == class_.__module__
+            and name in class_.__dict__
+        ]
+
+    only_methods = [method for method, _name in methods]
+    # sort by definition order
+    return sorted(only_methods, key=get_def_line)
+
+
+def get_all_cls_from_module(module: ModuleType | str) -> list[type]:
+    """Get all classes defined in a module.
+
+    Retrieves all class objects that are defined directly in the specified module,
+    excluding imported classes.
+
+    Args:
+        module: The module to extract classes from
+
+    Returns:
+        A list of class types defined in the module
+
+    """
+    from winipedia_utils.modules.module import get_def_line, get_module_of_obj
+
+    if isinstance(module, str):
+        module = import_module(module)
+
+    # necessary for bindings packages like AESGCM from cryptography._rust backend
+    default = ModuleType("default")
+    classes = [
+        obj
+        for _, obj in inspect.getmembers(module, inspect.isclass)
+        if get_module_of_obj(obj, default).__name__ == module.__name__
+    ]
+    # sort by definition order
+    return sorted(classes, key=get_def_line)
+
+
+def get_all_subclasses(cls: type) -> list[type]:
+    """Get all subclasses of a class.
+
+    Retrieves all classes that are subclasses of the specified class.
+    Also returns subclasses of subclasses (recursive).
+
+    Args:
+        cls: The class to find subclasses of
+
+    Returns:
+        A list of subclasses of the given class
+
+    """
+    subclasses_set = set(cls.__subclasses__())
+    for subclass in cls.__subclasses__():
+        subclasses_set.update(get_all_subclasses(subclass))
+    return list(subclasses_set)
+
+
+def get_all_nonabstract_subclasses(cls: type) -> list[type]:
+    """Get all non-abstract subclasses of a class.
+
+    Retrieves all classes that are subclasses of the specified class,
+    excluding abstract classes. Also returns subclasses of subclasses
+    (recursive).
+
+    Args:
+        cls: The class to find subclasses of
+
+    Returns:
+        A list of non-abstract subclasses of the given class
+
+    """
+    return [
+        subclass
+        for subclass in get_all_subclasses(cls)
+        if not inspect.isabstract(subclass)
+    ]