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

winipedia_utils/setup.py

@@ -1,47 +1,47 @@
-"""A script that can be called after you installed the package.
-
-This script calls create tests, creates the pre-commit config, and
-creates the pyproject.toml file and some other things to set up a project.
-This package assumes you are using poetry and pre-commit.
-This script is intended to be called once at the beginning of a project.
-"""
-
-from winipedia_utils.git.gitignore.gitignore import _add_package_patterns_to_gitignore
-from winipedia_utils.git.pre_commit.config import (
-    _add_package_hook_to_pre_commit_config,
-    _pre_commit_install,
-)
-from winipedia_utils.git.pre_commit.run_hooks import _run_all_hooks
-from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.projects.poetry.config import (
-    _add_configurations_to_pyproject_toml,
-)
-from winipedia_utils.projects.poetry.poetry import (
-    _install_dev_dependencies,
-)
-from winipedia_utils.projects.project import _create_project_root
-
-logger = get_logger(__name__)
-
-
-def _setup() -> None:
-    """Set up the project."""
-    # install winipedia_utils dev dependencies as dev
-    _install_dev_dependencies()
-    # create pre-commit config
-    _add_package_hook_to_pre_commit_config()
-    # install pre-commit
-    _pre_commit_install()
-    # add patterns to .gitignore
-    _add_package_patterns_to_gitignore()
-    # add tool.* configurations to pyproject.toml
-    _add_configurations_to_pyproject_toml()
-    # create the project root
-    _create_project_root()
-    # run pre-commit once, create tests is included here
-    _run_all_hooks()
-    logger.info("Setup complete!")
-
-
-if __name__ == "__main__":
-    _setup()
+"""A script that can be called after you installed the package.
+
+This script calls create tests, creates the pre-commit config, and
+creates the pyproject.toml file and some other things to set up a project.
+This package assumes you are using poetry and pre-commit.
+This script is intended to be called once at the beginning of a project.
+"""
+
+from winipedia_utils.git.gitignore.gitignore import _add_package_patterns_to_gitignore
+from winipedia_utils.git.pre_commit.config import (
+    _add_package_hook_to_pre_commit_config,
+    _pre_commit_install,
+)
+from winipedia_utils.git.pre_commit.run_hooks import _run_all_hooks
+from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.projects.poetry.config import (
+    _add_configurations_to_pyproject_toml,
+)
+from winipedia_utils.projects.poetry.poetry import (
+    _install_dev_dependencies,
+)
+from winipedia_utils.projects.project import _create_project_root
+
+logger = get_logger(__name__)
+
+
+def _setup() -> None:
+    """Set up the project."""
+    # install winipedia_utils dev dependencies as dev
+    _install_dev_dependencies()
+    # create pre-commit config
+    _add_package_hook_to_pre_commit_config()
+    # install pre-commit
+    _pre_commit_install()
+    # add patterns to .gitignore
+    _add_package_patterns_to_gitignore()
+    # add tool.* configurations to pyproject.toml
+    _add_configurations_to_pyproject_toml()
+    # create the project root
+    _create_project_root()
+    # run pre-commit once, create tests is included here
+    _run_all_hooks()
+    logger.info("Setup complete!")
+
+
+if __name__ == "__main__":
+    _setup()

winipedia_utils/testing/assertions.py

@@ -1,23 +1,23 @@
-"""Testing assertion utilities for enhanced test validation.
-
-This module provides custom assertion functions that extend Python's built-in
-assert statement with additional features like improved error messages and
-specialized validation logic for common testing scenarios.
-"""
-
-
-def assert_with_msg(expr: bool, msg: str) -> None:  # noqa: FBT001
-    """Assert that an expression is true with a custom error message.
-
-    A thin wrapper around Python's built-in assert statement that makes it
-    easier to provide meaningful error messages when assertions fail.
-
-    Args:
-        expr: The expression to evaluate for truthiness
-        msg: The error message to display if the assertion fails
-
-    Raises:
-        AssertionError: If the expression evaluates to False
-
-    """
-    assert expr, msg  # noqa: S101  # nosec: B101
+"""Testing assertion utilities for enhanced test validation.
+
+This module provides custom assertion functions that extend Python's built-in
+assert statement with additional features like improved error messages and
+specialized validation logic for common testing scenarios.
+"""
+
+
+def assert_with_msg(expr: bool, msg: str) -> None:  # noqa: FBT001
+    """Assert that an expression is true with a custom error message.
+
+    A thin wrapper around Python's built-in assert statement that makes it
+    easier to provide meaningful error messages when assertions fail.
+
+    Args:
+        expr: The expression to evaluate for truthiness
+        msg: The error message to display if the assertion fails
+
+    Raises:
+        AssertionError: If the expression evaluates to False
+
+    """
+    assert expr, msg  # noqa: S101  # nosec: B101

winipedia_utils/testing/convention.py

@@ -1,177 +1,177 @@
-"""Testing conventions and utilities.
-
-This module provides functions and constants for managing test naming conventions,
-mapping between test objects and their corresponding implementation objects,
-and utilities for test discovery and validation.
-
-Returns:
-    Various utility functions and constants for testing conventions.
-
-"""
-
-from collections.abc import Callable, Iterable
-from types import ModuleType
-from typing import Any
-
-from winipedia_utils.modules.module import (
-    get_isolated_obj_name,
-    import_obj_from_importpath,
-    make_obj_importpath,
-)
-
-TEST_FUNCTION_PREFIX = "test_"
-
-TEST_CLASS_PREFIX = "Test"
-
-TEST_MODULE_PREFIX = TEST_FUNCTION_PREFIX
-
-TEST_PREFIXES = [TEST_FUNCTION_PREFIX, TEST_CLASS_PREFIX, TEST_MODULE_PREFIX]
-
-TESTS_PACKAGE_NAME = "tests"
-
-
-def get_right_test_prefix(obj: Callable[..., Any] | type | ModuleType) -> str:
-    """Get the appropriate test prefix for an object based on its type.
-
-    Args:
-        obj: The object to get the test prefix for (function, class, or module)
-
-    Returns:
-        The appropriate test prefix string for the given object type
-
-    """
-    if isinstance(obj, ModuleType):
-        return TEST_MODULE_PREFIX
-    if isinstance(obj, type):
-        return TEST_CLASS_PREFIX
-    return TEST_FUNCTION_PREFIX
-
-
-def make_test_obj_name(obj: Callable[..., Any] | type | ModuleType) -> str:
-    """Create a test name for an object by adding the appropriate prefix.
-
-    Args:
-        obj: The object to create a test name for
-
-    Returns:
-        The test name with the appropriate prefix
-
-    """
-    prefix = get_right_test_prefix(obj)
-    name = get_isolated_obj_name(obj)
-    return prefix + name
-
-
-def reverse_make_test_obj_name(test_name: str) -> str:
-    """Extract the original object name from a test name by removing the prefix.
-
-    Args:
-        test_name: The test name to extract the original name from
-
-    Returns:
-        The original object name without the test prefix
-
-    Raises:
-        ValueError: If the test name doesn't start with any of the expected prefixes
-
-    """
-    for prefix in TEST_PREFIXES:
-        if test_name.startswith(prefix):
-            return test_name.removeprefix(prefix)
-    msg = f"{test_name=} is expected to start with one of {TEST_PREFIXES=}"
-    raise ValueError(msg)
-
-
-def make_test_obj_importpath_from_obj(
-    obj: Callable[..., Any] | type | ModuleType,
-) -> str:
-    """Create an import path for a test object based on the original object.
-
-    Args:
-        obj: The original object to create a test import path for
-
-    Returns:
-        The import path for the corresponding test object
-
-    """
-    parts = make_obj_importpath(obj).split(".")
-    test_name = make_test_obj_name(obj)
-    test_parts = [
-        (TEST_MODULE_PREFIX if part[0].islower() else TEST_CLASS_PREFIX) + part
-        for part in parts
-    ]
-    test_parts[-1] = test_name
-    test_parts.insert(0, TESTS_PACKAGE_NAME)
-    return ".".join(test_parts)
-
-
-def make_obj_importpath_from_test_obj(
-    test_obj: Callable[..., Any] | type | ModuleType,
-) -> str:
-    """Create an import path for an original object based on its test object.
-
-    Args:
-        test_obj: The test object to create an original import path for
-
-    Returns:
-        The import path for the corresponding original object
-
-    """
-    test_parts = make_obj_importpath(test_obj).split(".")
-    test_parts = test_parts[1:]
-    parts = [reverse_make_test_obj_name(part) for part in test_parts]
-    return ".".join(parts)
-
-
-def get_test_obj_from_obj(
-    obj: Callable[..., Any] | type | ModuleType,
-) -> Callable[..., Any] | type | ModuleType:
-    """Get the test object corresponding to an original object.
-
-    Args:
-        obj: The original object to get the test object for
-
-    Returns:
-        The corresponding test object
-
-    """
-    test_obj_path = make_test_obj_importpath_from_obj(obj)
-    return import_obj_from_importpath(test_obj_path)
-
-
-def get_obj_from_test_obj(
-    test_obj: Callable[..., Any] | type | ModuleType,
-) -> Callable[..., Any] | type | ModuleType:
-    """Get the original object corresponding to a test object.
-
-    Args:
-        test_obj: The test object to get the original object for
-
-    Returns:
-        The corresponding original object
-
-    """
-    obj_importpath = make_obj_importpath_from_test_obj(test_obj)
-    return import_obj_from_importpath(obj_importpath)
-
-
-def make_untested_summary_error_msg(
-    untested_objs: Iterable[str],
-) -> str:
-    """Create an error message summarizing untested objects.
-
-    Args:
-        untested_objs: Collection of import paths for untested objects
-
-    Returns:
-        A formatted error message listing all untested objects
-
-    """
-    msg = """
-    Found untested objects:
-    """
-    for untested in untested_objs:
-        msg += f"""
-        - {untested}
-        """
-    return msg
+"""Testing conventions and utilities.
+
+This module provides functions and constants for managing test naming conventions,
+mapping between test objects and their corresponding implementation objects,
+and utilities for test discovery and validation.
+
+Returns:
+    Various utility functions and constants for testing conventions.
+
+"""
+
+from collections.abc import Callable, Iterable
+from types import ModuleType
+from typing import Any
+
+from winipedia_utils.modules.module import (
+    get_isolated_obj_name,
+    import_obj_from_importpath,
+    make_obj_importpath,
+)
+
+TEST_FUNCTION_PREFIX = "test_"
+
+TEST_CLASS_PREFIX = "Test"
+
+TEST_MODULE_PREFIX = TEST_FUNCTION_PREFIX
+
+TEST_PREFIXES = [TEST_FUNCTION_PREFIX, TEST_CLASS_PREFIX, TEST_MODULE_PREFIX]
+
+TESTS_PACKAGE_NAME = "tests"
+
+
+def get_right_test_prefix(obj: Callable[..., Any] | type | ModuleType) -> str:
+    """Get the appropriate test prefix for an object based on its type.
+
+    Args:
+        obj: The object to get the test prefix for (function, class, or module)
+
+    Returns:
+        The appropriate test prefix string for the given object type
+
+    """
+    if isinstance(obj, ModuleType):
+        return TEST_MODULE_PREFIX
+    if isinstance(obj, type):
+        return TEST_CLASS_PREFIX
+    return TEST_FUNCTION_PREFIX
+
+
+def make_test_obj_name(obj: Callable[..., Any] | type | ModuleType) -> str:
+    """Create a test name for an object by adding the appropriate prefix.
+
+    Args:
+        obj: The object to create a test name for
+
+    Returns:
+        The test name with the appropriate prefix
+
+    """
+    prefix = get_right_test_prefix(obj)
+    name = get_isolated_obj_name(obj)
+    return prefix + name
+
+
+def reverse_make_test_obj_name(test_name: str) -> str:
+    """Extract the original object name from a test name by removing the prefix.
+
+    Args:
+        test_name: The test name to extract the original name from
+
+    Returns:
+        The original object name without the test prefix
+
+    Raises:
+        ValueError: If the test name doesn't start with any of the expected prefixes
+
+    """
+    for prefix in TEST_PREFIXES:
+        if test_name.startswith(prefix):
+            return test_name.removeprefix(prefix)
+    msg = f"{test_name=} is expected to start with one of {TEST_PREFIXES=}"
+    raise ValueError(msg)
+
+
+def make_test_obj_importpath_from_obj(
+    obj: Callable[..., Any] | type | ModuleType,
+) -> str:
+    """Create an import path for a test object based on the original object.
+
+    Args:
+        obj: The original object to create a test import path for
+
+    Returns:
+        The import path for the corresponding test object
+
+    """
+    parts = make_obj_importpath(obj).split(".")
+    test_name = make_test_obj_name(obj)
+    test_parts = [
+        (TEST_MODULE_PREFIX if part[0].islower() else TEST_CLASS_PREFIX) + part
+        for part in parts
+    ]
+    test_parts[-1] = test_name
+    test_parts.insert(0, TESTS_PACKAGE_NAME)
+    return ".".join(test_parts)
+
+
+def make_obj_importpath_from_test_obj(
+    test_obj: Callable[..., Any] | type | ModuleType,
+) -> str:
+    """Create an import path for an original object based on its test object.
+
+    Args:
+        test_obj: The test object to create an original import path for
+
+    Returns:
+        The import path for the corresponding original object
+
+    """
+    test_parts = make_obj_importpath(test_obj).split(".")
+    test_parts = test_parts[1:]
+    parts = [reverse_make_test_obj_name(part) for part in test_parts]
+    return ".".join(parts)
+
+
+def get_test_obj_from_obj(
+    obj: Callable[..., Any] | type | ModuleType,
+) -> Callable[..., Any] | type | ModuleType:
+    """Get the test object corresponding to an original object.
+
+    Args:
+        obj: The original object to get the test object for
+
+    Returns:
+        The corresponding test object
+
+    """
+    test_obj_path = make_test_obj_importpath_from_obj(obj)
+    return import_obj_from_importpath(test_obj_path)
+
+
+def get_obj_from_test_obj(
+    test_obj: Callable[..., Any] | type | ModuleType,
+) -> Callable[..., Any] | type | ModuleType:
+    """Get the original object corresponding to a test object.
+
+    Args:
+        test_obj: The test object to get the original object for
+
+    Returns:
+        The corresponding original object
+
+    """
+    obj_importpath = make_obj_importpath_from_test_obj(test_obj)
+    return import_obj_from_importpath(obj_importpath)
+
+
+def make_untested_summary_error_msg(
+    untested_objs: Iterable[str],
+) -> str:
+    """Create an error message summarizing untested objects.
+
+    Args:
+        untested_objs: Collection of import paths for untested objects
+
+    Returns:
+        A formatted error message listing all untested objects
+
+    """
+    msg = """
+    Found untested objects:
+    """
+    for untested in untested_objs:
+        msg += f"""
+        - {untested}
+        """
+    return msg