winipedia-utils 0.5.22__py3-none-any.whl → 0.7.1__py3-none-any.whl

winipedia_utils/setup.py

@@ -9,16 +9,20 @@ This script is intended to be called once at the beginning of a project.
 from collections.abc import Callable
 from typing import Any
 
-from winipedia_utils.git.gitignore.config import GitIgnoreConfigFile
-from winipedia_utils.git.pre_commit.run_hooks import run_hooks
-from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.projects.project import create_project_root
+from winipedia_utils.dev.configs.gitignore import GitIgnoreConfigFile
+from winipedia_utils.dev.configs.pyproject import PyprojectConfigFile
+from winipedia_utils.dev.git.pre_commit.run_hooks import run_hooks
+from winipedia_utils.dev.projects.project import create_project_root
+from winipedia_utils.utils.logging.logger import get_logger
 
 logger = get_logger(__name__)
 
 
 SETUP_STEPS: list[Callable[..., Any]] = [
-    GitIgnoreConfigFile,  # must be first
+    GitIgnoreConfigFile,  # must be before create_project_root
+    PyprojectConfigFile,  # must be before create_project_root
+    PyprojectConfigFile.update_poetry,  # must be before create_project_root
+    PyprojectConfigFile.update_with_dev,  # must be before create_project_root
     create_project_root,
     run_hooks,
 ]

winipedia_utils/utils/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

winipedia_utils/utils/data/dataframe/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

winipedia_utils/{data → utils/data}/dataframe/cleaning.py

@@ -12,7 +12,7 @@ from typing import Any
 import polars as pl
 from polars.datatypes.classes import FloatType
 
-from winipedia_utils.oop.mixins.mixin import ABCLoggingMixin
+from winipedia_utils.utils.oop.mixins.mixin import ABCLoggingMixin
 
 
 class CleaningDF(ABCLoggingMixin):

winipedia_utils/utils/data/structures/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

winipedia_utils/{text → utils/data/structures/text}/string.py

@@ -7,14 +7,17 @@ These utilities simplify common string manipulation tasks throughout the applica
 
 import hashlib
 import textwrap
+from collections.abc import Callable
 from io import StringIO
+from types import ModuleType
+from typing import Any
 
 from defusedxml import ElementTree as DefusedElementTree
 
-from winipedia_utils.concurrent.multiprocessing import (
+from winipedia_utils.utils.iterating.concurrent.multiprocessing import (
     cancel_on_timeout,
 )
-from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.utils.logging.logger import get_logger
 
 logger = get_logger(__name__)
 
@@ -114,7 +117,7 @@ def split_on_uppercase(string: str) -> list[str]:
 
     """
     letters = list(string)
-    parts = []
+    parts: list[str] = []
     current_part = ""
     for letter in letters:
         if letter.isupper() and current_part:
@@ -124,3 +127,33 @@ def split_on_uppercase(string: str) -> list[str]:
             current_part += letter
     parts.append(current_part)
     return parts
+
+
+def make_name_from_obj(
+    package: ModuleType | Callable[..., Any] | type | str,
+    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_
+    """
+    if not isinstance(package, str):
+        package_name = package.__name__.split(".")[-1]
+    else:
+        package_name = package
+    parts = package_name.split(split_on)
+    if capitalize:
+        parts = [part.capitalize() for part in parts]
+    return join_on.join(parts)

winipedia_utils/utils/git/__init__.py

@@ -0,0 +1 @@
+"""__init__ module for winipedia_utils.git."""

winipedia_utils/utils/git/github/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

winipedia_utils/{git → utils/git}/github/github.py

@@ -2,7 +2,7 @@
 
 import os
 
-from winipedia_utils.text.config import DotEnvConfigFile
+from winipedia_utils.dev.configs.base.config import DotEnvConfigFile
 
 
 def get_github_repo_token() -> str:

winipedia_utils/utils/git/github/repo/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

winipedia_utils/{git → utils/git}/github/repo/repo.py

@@ -6,7 +6,7 @@ from github import Github
 from github.Auth import Token
 from github.Repository import Repository
 
-from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.utils.logging.logger import get_logger
 
 logger = get_logger(__name__)
 

winipedia_utils/{git → utils/git}/gitignore/gitignore.py

@@ -12,8 +12,8 @@ from pathlib import Path
 
 import pathspec
 
-from winipedia_utils.git.gitignore.config import GitIgnoreConfigFile
-from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.dev.configs.gitignore import GitIgnoreConfigFile
+from winipedia_utils.utils.logging.logger import get_logger
 
 logger = get_logger(__name__)
 

winipedia_utils/{concurrent → utils/iterating/concurrent}/concurrent.py

@@ -20,8 +20,8 @@ from typing import TYPE_CHECKING, Any, cast
 
 from tqdm import tqdm
 
-from winipedia_utils.iterating.iterate import get_len_with_default
-from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.utils.iterating.iterate import get_len_with_default
+from winipedia_utils.utils.logging.logger import get_logger
 
 if TYPE_CHECKING:
     from multiprocessing.pool import Pool
@@ -208,10 +208,10 @@ def concurrent_loop(  # noqa: PLR0913
     Returns:
         list[Any]: Results from the process_function executions
     """
-    from winipedia_utils.concurrent.multiprocessing import (  # noqa: PLC0415  # avoid circular import
+    from winipedia_utils.utils.iterating.concurrent.multiprocessing import (  # noqa: PLC0415  # avoid circular import
         get_spwan_pool,
     )
-    from winipedia_utils.concurrent.multithreading import (  # noqa: PLC0415  # avoid circular import
+    from winipedia_utils.utils.iterating.concurrent.multithreading import (  # noqa: PLC0415  # avoid circular import
         imap_unordered,
     )
 

winipedia_utils/{concurrent → utils/iterating/concurrent}/multiprocessing.py

@@ -15,8 +15,8 @@ from functools import wraps
 from multiprocessing.pool import Pool
 from typing import Any
 
-from winipedia_utils.concurrent.concurrent import concurrent_loop
-from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.utils.iterating.concurrent.concurrent import concurrent_loop
+from winipedia_utils.utils.logging.logger import get_logger
 
 logger = get_logger(__name__)
 

winipedia_utils/{concurrent → utils/iterating/concurrent}/multithreading.py

@@ -15,7 +15,7 @@ from collections.abc import Callable, Generator, Iterable
 from concurrent.futures import Future, ThreadPoolExecutor, as_completed
 from typing import Any
 
-from winipedia_utils.concurrent.concurrent import concurrent_loop
+from winipedia_utils.utils.iterating.concurrent.concurrent import concurrent_loop
 
 
 def get_future_results_as_completed(

winipedia_utils/{logging → utils/logging}/logger.py

@@ -8,7 +8,7 @@ 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
+from winipedia_utils.utils.logging.config import LOGGING_CONFIG
 
 dictConfig(LOGGING_CONFIG)
 

winipedia_utils/{modules → utils/modules}/class_.py

@@ -12,8 +12,8 @@ from importlib import import_module
 from types import ModuleType
 from typing import Any
 
-from winipedia_utils.modules.function import is_func
-from winipedia_utils.modules.inspection import get_def_line, get_obj_members
+from winipedia_utils.utils.modules.function import is_func
+from winipedia_utils.utils.modules.inspection import get_def_line, get_obj_members
 
 
 def get_all_methods_from_cls(
@@ -38,7 +38,7 @@ def get_all_methods_from_cls(
         A list of callable methods from the class
 
     """
-    from winipedia_utils.modules.module import (  # noqa: PLC0415  # avoid circular import
+    from winipedia_utils.utils.modules.module import (  # noqa: PLC0415  # avoid circular import
         get_module_of_obj,
     )
 
@@ -74,7 +74,7 @@ def get_all_cls_from_module(module: ModuleType | str) -> list[type]:
         A list of class types defined in the module
 
     """
-    from winipedia_utils.modules.module import (  # noqa: PLC0415  # avoid circular import
+    from winipedia_utils.utils.modules.module import (  # noqa: PLC0415  # avoid circular import
         get_module_of_obj,
     )
 
@@ -111,7 +111,7 @@ def get_all_subclasses(
         A list of subclasses of the given class
 
     """
-    from winipedia_utils.modules.package import (  # noqa: PLC0415  # avoid circular import
+    from winipedia_utils.utils.modules.package import (  # noqa: PLC0415  # avoid circular import
         walk_package,
     )
 

winipedia_utils/{modules → utils/modules}/function.py

@@ -12,7 +12,7 @@ from importlib import import_module
 from types import ModuleType
 from typing import Any
 
-from winipedia_utils.modules.inspection import get_def_line, get_obj_members
+from winipedia_utils.utils.modules.inspection import get_def_line, get_obj_members
 
 
 def is_func_or_method(obj: Any) -> bool:
@@ -77,7 +77,7 @@ def get_all_functions_from_module(
         A list of callable functions defined in the module
 
     """
-    from winipedia_utils.modules.module import (  # noqa: PLC0415  # avoid circular import
+    from winipedia_utils.utils.modules.module import (  # noqa: PLC0415  # avoid circular import
         get_module_of_obj,
     )
 

winipedia_utils/{modules → utils/modules}/module.py

@@ -19,14 +19,17 @@ from pathlib import Path
 from types import ModuleType
 from typing import Any
 
-from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.modules.class_ import (
+from winipedia_utils.utils.logging.logger import get_logger
+from winipedia_utils.utils.modules.class_ import (
     get_all_cls_from_module,
     get_all_methods_from_cls,
 )
-from winipedia_utils.modules.function import get_all_functions_from_module
-from winipedia_utils.modules.inspection import get_qualname_of_obj, get_unwrapped_obj
-from winipedia_utils.modules.package import (
+from winipedia_utils.utils.modules.function import get_all_functions_from_module
+from winipedia_utils.utils.modules.inspection import (
+    get_qualname_of_obj,
+    get_unwrapped_obj,
+)
+from winipedia_utils.utils.modules.package import (
     get_modules_and_packages_from_package,
     make_dir_with_init_file,
     module_is_package,

winipedia_utils/{modules → utils/modules}/package.py

@@ -26,7 +26,7 @@ from setuptools import find_namespace_packages as _find_namespace_packages
 from setuptools import find_packages as _find_packages
 
 import winipedia_utils
-from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.utils.logging.logger import get_logger
 
 logger = get_logger(__name__)
 
@@ -46,11 +46,11 @@ def get_src_package() -> ModuleType:
                        if only the test package exists
 
     """
-    from winipedia_utils.testing.convention import (  # noqa: PLC0415  # avoid circular import
+    from winipedia_utils.dev.testing.convention import (  # noqa: PLC0415  # avoid circular import
         TESTS_PACKAGE_NAME,
     )
 
-    packages = find_packages_as_modules(depth=0)
+    packages = find_packages_as_modules(depth=0, include_namespace_packages=True)
     return next(p for p in packages if p.__name__ != TESTS_PACKAGE_NAME)
 
 
@@ -184,7 +184,7 @@ def find_packages(
         find_packages(depth=1) might return ["package1", "package2"]
 
     """
-    from winipedia_utils.git.gitignore.config import (  # noqa: PLC0415
+    from winipedia_utils.dev.configs.gitignore import (  # noqa: PLC0415
         GitIgnoreConfigFile,  # avoid circular import
     )
 
@@ -289,10 +289,10 @@ def make_init_modules_for_package(path: str | Path | ModuleType) -> None:
         from get_default_init_module_content.
 
     """
-    from winipedia_utils.git.gitignore.gitignore import (  # noqa: PLC0415
+    from winipedia_utils.utils.git.gitignore.gitignore import (  # noqa: PLC0415
         walk_os_skipping_gitignore_patterns,  # avoid circular import
     )
-    from winipedia_utils.modules.module import (  # noqa: PLC0415
+    from winipedia_utils.utils.modules.module import (  # noqa: PLC0415
         to_path,  # avoid circular import
     )
 
@@ -319,7 +319,7 @@ def make_init_module(path: str | Path) -> None:
         Creates parent directories if they don't exist.
 
     """
-    from winipedia_utils.modules.module import (  # noqa: PLC0415  # avoid circular import
+    from winipedia_utils.utils.modules.module import (  # noqa: PLC0415  # avoid circular import
         get_default_init_module_content,
         to_path,
     )
@@ -355,7 +355,7 @@ def copy_package(
         with_file_content (bool, optional): copies the content of the files.
 
     """
-    from winipedia_utils.modules.module import (  # noqa: PLC0415  # avoid circular import
+    from winipedia_utils.utils.modules.module import (  # noqa: PLC0415  # avoid circular import
         create_module,
         get_isolated_obj_name,
         get_module_content_as_str,
@@ -385,7 +385,7 @@ def get_main_package() -> ModuleType:
 
     Even when this package is installed as a module.
     """
-    from winipedia_utils.modules.module import (  # noqa: PLC0415  # avoid circular import
+    from winipedia_utils.utils.modules.module import (  # noqa: PLC0415  # avoid circular import
         to_module_name,
     )
 
@@ -409,33 +409,6 @@ def get_main_package() -> ModuleType:
     raise ValueError(msg)
 
 
-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)
-
-
 class DependencyGraph(nx.DiGraph):  # type: ignore [type-arg]
     """A directed graph representing Python package dependencies."""
 

winipedia_utils/{oop → utils/oop}/mixins/meta.py

@@ -13,10 +13,10 @@ from collections.abc import Callable
 from functools import wraps
 from typing import Any, final
 
-from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.modules.class_ import get_all_methods_from_cls
-from winipedia_utils.modules.function import is_func, unwrap_method
-from winipedia_utils.text.string import value_to_truncated_string
+from winipedia_utils.utils.data.structures.text.string import value_to_truncated_string
+from winipedia_utils.utils.logging.logger import get_logger
+from winipedia_utils.utils.modules.class_ import get_all_methods_from_cls
+from winipedia_utils.utils.modules.function import is_func, unwrap_method
 
 logger = get_logger(__name__)
 

winipedia_utils/{oop → utils/oop}/mixins/mixin.py

@@ -10,8 +10,8 @@ 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
+from winipedia_utils.utils.logging.logger import get_logger
+from winipedia_utils.utils.oop.mixins.meta import ABCLoggingMeta, StrictABCLoggingMeta
 
 logger = get_logger(__name__)
 

winipedia_utils/{os → utils/os}/os.py

@@ -7,7 +7,7 @@ These utilities help with system-level operations and configuration.
 
 import shutil
 import subprocess  # nosec: B404
-from pathlib import Path
+from collections.abc import Sequence
 from typing import Any
 
 
@@ -34,7 +34,7 @@ def which_with_raise(cmd: str, *, raise_error: bool = True) -> str | None:
 
 
 def run_subprocess(
-    args: list[str | Path],
+    args: Sequence[str],
     *,
     input_: str | bytes | None = None,
     capture_output: bool = True,

winipedia_utils/utils/resources/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

winipedia_utils/utils/resources/svgs/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

winipedia_utils/{resources → utils/resources}/svgs/svg.py

@@ -4,7 +4,7 @@ from importlib.resources import as_file, files
 from pathlib import Path
 from types import ModuleType
 
-from winipedia_utils.resources import svgs
+from winipedia_utils.utils.resources import svgs
 
 
 def get_svg_path(svg_name: str, package: ModuleType | None = None) -> Path:

winipedia_utils/utils/testing/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

winipedia_utils/{testing → utils/testing}/assertions.py

@@ -7,6 +7,8 @@ specialized validation logic for common testing scenarios.
 
 from typing import Any
 
+from winipedia_utils.utils.modules.function import is_abstractmethod
+
 
 def assert_with_msg(expr: bool, msg: str) -> None:  # noqa: FBT001
     """Assert that an expression is true with a custom error message.
@@ -46,3 +48,19 @@ Actual: {actual}
 {msg}
 """
     assert_with_msg(expr, msg)
+
+
+def assert_isabstrct_method(method: Any) -> None:
+    """Assert that a method is an abstract method.
+
+    Args:
+        method: The method to check
+
+    Raises:
+        AssertionError: If the method is not an abstract method
+
+    """
+    assert_with_msg(
+        is_abstractmethod(method),
+        f"Expected {method} to be abstract method",
+    )

winipedia_utils/{testing → utils/testing}/skip.py

@@ -4,7 +4,7 @@ import functools
 
 import pytest
 
-from winipedia_utils.git.github.github import running_in_github_actions
+from winipedia_utils.utils.git.github.github import running_in_github_actions
 
 skip_fixture_test: pytest.MarkDecorator = functools.partial(
     pytest.mark.skip,