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

winipedia_utils/testing/tests/base/utils/utils.py

@@ -1,114 +1,111 @@
-"""Testing utilities for introspection and validation.
-
-This module provides utility functions for working with tests, including:
-- Asserting that all objects in the source have corresponding test objects
-- Generating the content for a conftest.py file
-
-Returns:
-    Various utility functions for testing introspection and validation.
-
-"""
-
-from collections.abc import Callable
-from pathlib import Path
-from types import ModuleType
-from typing import Any
-
-from winipedia_utils.modules.module import get_objs_from_obj, make_obj_importpath
-from winipedia_utils.testing.assertions import assert_with_msg
-from winipedia_utils.testing.convention import (
-    get_obj_from_test_obj,
-    make_test_obj_importpath_from_obj,
-    make_untested_summary_error_msg,
-)
-
-
-def _assert_no_untested_objs(
-    test_obj: ModuleType | type | Callable[..., Any],
-) -> None:
-    """Assert that all objects in the source have corresponding test objects.
-
-    This function verifies that every object (function, class, or method) in the
-    source module or class has a corresponding test object in the test module or class.
-
-    Args:
-        test_obj: The test object (module, class, or function) to check
-
-    Raises:
-        AssertionError: If any object in the source lacks a corresponding test object,
-            with a detailed error message listing the untested objects
-
-    """
-    test_objs = get_objs_from_obj(test_obj)
-    test_objs_paths = {make_obj_importpath(o) for o in test_objs}
-
-    obj = get_obj_from_test_obj(test_obj)
-    objs = get_objs_from_obj(obj)
-    supposed_test_objs_paths = {make_test_obj_importpath_from_obj(o) for o in objs}
-
-    untested_objs = supposed_test_objs_paths - test_objs_paths
-
-    assert_with_msg(not untested_objs, make_untested_summary_error_msg(untested_objs))
-
-
-def _get_conftest_content() -> str:
-    """Get the content for a conftest.py file when using winipedia_utils."""
-    return '''
-"""Pytest configuration for tests.
-
-This module configures pytest plugins for the test suite, setting up the necessary
-fixtures and hooks for the different
-test scopes (function, class, module, package, session).
-It also import custom plugins from tests/base/scopes.
-This file should not be modified manually.
-"""
-
-pytest_plugins = ["winipedia_utils.testing.tests.conftest"]
-'''.strip()
-
-
-def _conftest_content_is_correct(conftest_path: Path) -> bool:
-    """Check if the conftest.py file has the correct content.
-
-    Args:
-        conftest_path: The path to the conftest.py file
-
-    Returns:
-        True if the conftest.py file exists and has the correct content, False otherwise
-
-    """
-    if not conftest_path.exists():
-        return False
-    return conftest_path.read_text().startswith(_get_conftest_content())
-
-
-def _get_test_0_content() -> str:
-    """Get the content for a test_0.py file when using winipedia_utils."""
-    return '''
-"""Contains an empty test."""
-
-import pytest
-
-
-@pytest.mark.skip(reason="Can not test a test")
-def test_0() -> None:
-    """Empty test.
-
-    Exists so that when no tests are written yet the base fixtures are executed.
-    """
-'''.strip()
-
-
-def _test_0_content_is_correct(test_0_path: Path) -> bool:
-    """Check if the test_0.py file has the correct content.
-
-    Args:
-        test_0_path: The path to the test_0.py file
-
-    Returns:
-        True if the test_0.py file exists and has the correct content, False otherwise
-
-    """
-    if not test_0_path.exists():
-        return False
-    return test_0_path.read_text().startswith(_get_test_0_content())
+"""Testing utilities for introspection and validation.
+
+This module provides utility functions for working with tests, including:
+- Asserting that all objects in the source have corresponding test objects
+- Generating the content for a conftest.py file
+
+Returns:
+    Various utility functions for testing introspection and validation.
+
+"""
+
+from collections.abc import Callable
+from pathlib import Path
+from types import ModuleType
+from typing import Any
+
+from winipedia_utils.modules.module import get_objs_from_obj, make_obj_importpath
+from winipedia_utils.testing.assertions import assert_with_msg
+from winipedia_utils.testing.convention import (
+    get_obj_from_test_obj,
+    make_test_obj_importpath_from_obj,
+    make_untested_summary_error_msg,
+)
+
+
+def _assert_no_untested_objs(
+    test_obj: ModuleType | type | Callable[..., Any],
+) -> None:
+    """Assert that all objects in the source have corresponding test objects.
+
+    This function verifies that every object (function, class, or method) in the
+    source module or class has a corresponding test object in the test module or class.
+
+    Args:
+        test_obj: The test object (module, class, or function) to check
+
+    Raises:
+        AssertionError: If any object in the source lacks a corresponding test object,
+            with a detailed error message listing the untested objects
+
+    """
+    test_objs = get_objs_from_obj(test_obj)
+    test_objs_paths = {make_obj_importpath(o) for o in test_objs}
+
+    obj = get_obj_from_test_obj(test_obj)
+    objs = get_objs_from_obj(obj)
+    supposed_test_objs_paths = {make_test_obj_importpath_from_obj(o) for o in objs}
+
+    untested_objs = supposed_test_objs_paths - test_objs_paths
+
+    assert_with_msg(not untested_objs, make_untested_summary_error_msg(untested_objs))
+
+
+def _get_conftest_content() -> str:
+    """Get the content for a conftest.py file when using winipedia_utils."""
+    return '''
+"""Pytest configuration for tests.
+
+This module configures pytest plugins for the test suite, setting up the necessary
+fixtures and hooks for the different
+test scopes (function, class, module, package, session).
+It also import custom plugins from tests/base/scopes.
+This file should not be modified manually.
+"""
+
+pytest_plugins = ["winipedia_utils.testing.tests.conftest"]
+'''.strip()
+
+
+def _conftest_content_is_correct(conftest_path: Path) -> bool:
+    """Check if the conftest.py file has the correct content.
+
+    Args:
+        conftest_path: The path to the conftest.py file
+
+    Returns:
+        True if the conftest.py file exists and has the correct content, False otherwise
+
+    """
+    if not conftest_path.exists():
+        return False
+    return conftest_path.read_text().startswith(_get_conftest_content())
+
+
+def _get_test_0_content() -> str:
+    """Get the content for a test_0.py file when using winipedia_utils."""
+    return '''
+"""Contains an empty test."""
+
+
+def test_0() -> None:
+    """Empty test.
+
+    Exists so that when no tests are written yet the base fixtures are executed.
+    """
+'''.strip()
+
+
+def _test_0_content_is_correct(test_0_path: Path) -> bool:
+    """Check if the test_0.py file has the correct content.
+
+    Args:
+        test_0_path: The path to the test_0.py file
+
+    Returns:
+        True if the test_0.py file exists and has the correct content, False otherwise
+
+    """
+    if not test_0_path.exists():
+        return False
+    return test_0_path.read_text().startswith(_get_test_0_content())

winipedia_utils/testing/tests/conftest.py

@@ -1,32 +1,32 @@
-"""Pytest configuration for winipedia_utils tests.
-
-finds all the plugins in the tests directory and the package's testing module
-and adds them to pytest_plugins. This way defining reusable fixtures is easy.
-"""
-
-from pathlib import Path
-
-import winipedia_utils
-from winipedia_utils.modules.module import to_module_name, to_path
-
-package_path = Path(winipedia_utils.__path__[0])
-
-custom_plugin_path = to_path("tests.base.fixtures", is_package=True)
-package_plugin_path = (
-    package_path / to_path("testing", is_package=True) / custom_plugin_path
-)
-
-custom_plugin_module_names = [
-    to_module_name(path) for path in custom_plugin_path.rglob("*.py")
-]
-
-package_plugin_module_names = [
-    to_module_name(path.relative_to(package_path.parent))
-    for path in package_plugin_path.rglob("*.py")
-]
-
-
-pytest_plugins = [
-    *package_plugin_module_names,
-    *custom_plugin_module_names,
-]
+"""Pytest configuration for winipedia_utils tests.
+
+finds all the plugins in the tests directory and the package's testing module
+and adds them to pytest_plugins. This way defining reusable fixtures is easy.
+"""
+
+from pathlib import Path
+
+import winipedia_utils
+from winipedia_utils.modules.module import to_module_name, to_path
+
+package_path = Path(winipedia_utils.__path__[0])
+
+custom_plugin_path = to_path("tests.base.fixtures", is_package=True)
+package_plugin_path = (
+    package_path / to_path("testing", is_package=True) / custom_plugin_path
+)
+
+custom_plugin_module_names = [
+    to_module_name(path) for path in custom_plugin_path.rglob("*.py")
+]
+
+package_plugin_module_names = [
+    to_module_name(path.relative_to(package_path.parent))
+    for path in package_plugin_path.rglob("*.py")
+]
+
+
+pytest_plugins = [
+    *package_plugin_module_names,
+    *custom_plugin_module_names,
+]

winipedia_utils/text/string.py

@@ -1,126 +1,126 @@
-"""String manipulation utilities for text processing.
-
-This module provides utility functions for working with strings, including
-input handling, XML parsing, string truncation, and hashing operations.
-These utilities simplify common string manipulation tasks throughout the application.
-"""
-
-import hashlib
-import textwrap
-from io import StringIO
-
-from defusedxml import ElementTree as DefusedElementTree
-
-from winipedia_utils.concurrent.multiprocessing import (
-    cancel_on_timeout,
-)
-from winipedia_utils.logging.logger import get_logger
-
-logger = get_logger(__name__)
-
-
-def ask_for_input_with_timeout(prompt: str, timeout: int) -> str:
-    """Request user input with a timeout constraint.
-
-    Args:
-        prompt: The text prompt to display to the user
-        timeout: Maximum time in seconds to wait for input
-
-    Returns:
-        The user's input as a string
-
-    Raises:
-        TimeoutError: If the user doesn't provide input within the timeout period
-
-    """
-
-    @cancel_on_timeout(timeout, "Input not given within the timeout")
-    def give_input() -> str:
-        return input(prompt)
-
-    user_input: str = give_input()
-
-    return user_input
-
-
-def find_xml_namespaces(xml: str | StringIO) -> dict[str, str]:
-    """Extract namespace declarations from XML content.
-
-    Args:
-        xml: XML content as a string or StringIO object
-
-    Returns:
-        Dictionary mapping namespace prefixes to their URIs,
-        excluding the default namespace
-
-    """
-    if not isinstance(xml, StringIO):
-        xml = StringIO(xml)
-    # Extract the namespaces from the root tag
-    namespaces_: dict[str, str] = {}
-    iter_ns = DefusedElementTree.iterparse(xml, events=["start-ns"])
-    for _, namespace_data in iter_ns:
-        prefix, uri = namespace_data
-        namespaces_[str(prefix)] = str(uri)
-
-    namespaces_.pop("", None)
-
-    return namespaces_
-
-
-def value_to_truncated_string(value: object, max_length: int) -> str:
-    """Convert any value to a string and truncate if longer than max_length.
-
-    Args:
-        value: Any object to convert to string
-        max_length: Maximum length of the resulting string
-
-    Returns:
-        Truncated string representation of the value
-
-    """
-    string = str(value)
-    return textwrap.shorten(string, width=max_length, placeholder="...")
-
-
-def get_reusable_hash(value: object) -> str:
-    """Generate a consistent hash for any object.
-
-    Creates a SHA-256 hash of the string representation of the given value.
-    This hash is deterministic and can be used for caching or identification.
-
-    Args:
-        value: Any object to hash
-
-    Returns:
-        Hexadecimal string representation of the SHA-256 hash
-
-    """
-    value_str = str(value)
-    return hashlib.sha256(value_str.encode("utf-8")).hexdigest()
-
-
-def split_on_uppercase(string: str) -> list[str]:
-    """Split a string on uppercase letters.
-
-    Args:
-        string: String to split
-
-    Returns:
-        List of substrings split on uppercase letters
-
-    Example:
-        split_on_uppercase("HelloWorld") -> ["Hello", "World"]
-
-    """
-    letters = list(string)
-    parts = []
-    current_part = ""
-    for letter in letters:
-        if letter.isupper() and current_part:
-            parts.append(current_part)
-            current_part = letter
-        else:
-            current_part += letter
-    parts.append(current_part)
-    return parts
+"""String manipulation utilities for text processing.
+
+This module provides utility functions for working with strings, including
+input handling, XML parsing, string truncation, and hashing operations.
+These utilities simplify common string manipulation tasks throughout the application.
+"""
+
+import hashlib
+import textwrap
+from io import StringIO
+
+from defusedxml import ElementTree as DefusedElementTree
+
+from winipedia_utils.concurrent.multiprocessing import (
+    cancel_on_timeout,
+)
+from winipedia_utils.logging.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+def ask_for_input_with_timeout(prompt: str, timeout: int) -> str:
+    """Request user input with a timeout constraint.
+
+    Args:
+        prompt: The text prompt to display to the user
+        timeout: Maximum time in seconds to wait for input
+
+    Returns:
+        The user's input as a string
+
+    Raises:
+        TimeoutError: If the user doesn't provide input within the timeout period
+
+    """
+
+    @cancel_on_timeout(timeout, "Input not given within the timeout")
+    def give_input() -> str:
+        return input(prompt)
+
+    user_input: str = give_input()
+
+    return user_input
+
+
+def find_xml_namespaces(xml: str | StringIO) -> dict[str, str]:
+    """Extract namespace declarations from XML content.
+
+    Args:
+        xml: XML content as a string or StringIO object
+
+    Returns:
+        Dictionary mapping namespace prefixes to their URIs,
+        excluding the default namespace
+
+    """
+    if not isinstance(xml, StringIO):
+        xml = StringIO(xml)
+    # Extract the namespaces from the root tag
+    namespaces_: dict[str, str] = {}
+    iter_ns = DefusedElementTree.iterparse(xml, events=["start-ns"])
+    for _, namespace_data in iter_ns:
+        prefix, uri = namespace_data
+        namespaces_[str(prefix)] = str(uri)
+
+    namespaces_.pop("", None)
+
+    return namespaces_
+
+
+def value_to_truncated_string(value: object, max_length: int) -> str:
+    """Convert any value to a string and truncate if longer than max_length.
+
+    Args:
+        value: Any object to convert to string
+        max_length: Maximum length of the resulting string
+
+    Returns:
+        Truncated string representation of the value
+
+    """
+    string = str(value)
+    return textwrap.shorten(string, width=max_length, placeholder="...")
+
+
+def get_reusable_hash(value: object) -> str:
+    """Generate a consistent hash for any object.
+
+    Creates a SHA-256 hash of the string representation of the given value.
+    This hash is deterministic and can be used for caching or identification.
+
+    Args:
+        value: Any object to hash
+
+    Returns:
+        Hexadecimal string representation of the SHA-256 hash
+
+    """
+    value_str = str(value)
+    return hashlib.sha256(value_str.encode("utf-8")).hexdigest()
+
+
+def split_on_uppercase(string: str) -> list[str]:
+    """Split a string on uppercase letters.
+
+    Args:
+        string: String to split
+
+    Returns:
+        List of substrings split on uppercase letters
+
+    Example:
+        split_on_uppercase("HelloWorld") -> ["Hello", "World"]
+
+    """
+    letters = list(string)
+    parts = []
+    current_part = ""
+    for letter in letters:
+        if letter.isupper() and current_part:
+            parts.append(current_part)
+            current_part = letter
+        else:
+            current_part += letter
+    parts.append(current_part)
+    return parts