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

winipedia_utils/{testing → dev/testing}/convention.py

@@ -13,7 +13,7 @@ from collections.abc import Callable, Iterable
 from types import ModuleType
 from typing import Any
 
-from winipedia_utils.modules.module import (
+from winipedia_utils.utils.modules.module import (
     get_isolated_obj_name,
     import_obj_from_importpath,
     make_obj_importpath,

winipedia_utils/{testing → dev/testing}/create_tests.py

@@ -9,31 +9,31 @@ NotImplementedError to indicate tests that need to be written.
 from types import ModuleType
 from typing import cast
 
-from winipedia_utils.modules.class_ import (
+from winipedia_utils.dev.configs.testing import ConftestConfigFile, ZeroTestConfigFile
+from winipedia_utils.dev.testing import tests
+from winipedia_utils.dev.testing.convention import (
+    get_test_obj_from_obj,
+    make_test_obj_importpath_from_obj,
+    make_test_obj_name,
+    reverse_make_test_obj_name,
+)
+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.module import (
+from winipedia_utils.utils.modules.function import get_all_functions_from_module
+from winipedia_utils.utils.modules.inspection import get_qualname_of_obj
+from winipedia_utils.utils.modules.module import (
     create_module,
     get_isolated_obj_name,
     get_module_content_as_str,
-    get_qualname_of_obj,
     to_path,
 )
-from winipedia_utils.modules.package import (
+from winipedia_utils.utils.modules.package import (
     copy_package,
     get_src_package,
     walk_package,
 )
-from winipedia_utils.testing import tests
-from winipedia_utils.testing.config import ConftestConfigFile, ZeroTestConfigFile
-from winipedia_utils.testing.convention import (
-    get_test_obj_from_obj,
-    make_test_obj_importpath_from_obj,
-    make_test_obj_name,
-    reverse_make_test_obj_name,
-)
 
 
 def create_tests() -> None:
@@ -50,7 +50,7 @@ def create_tests_base() -> None:
     """Create the base test structure.
 
     This function:
-    1. Creates a mirror of winipedia_utils.testing.tests in the tests directory
+    1. Creates a mirror of testing.tests in the tests directory
     2. Skips copying __init__.py file contents
     3. Writes new __init__.py files for all packages
     4. Creates a conftest.py file with the appropriate pytest plugin configuration

winipedia_utils/dev/testing/tests/__init__.py

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

winipedia_utils/dev/testing/tests/base/__init__.py

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

winipedia_utils/dev/testing/tests/base/fixtures/__init__.py

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

winipedia_utils/{testing → dev/testing}/tests/base/fixtures/fixture.py

@@ -10,7 +10,7 @@ from pathlib import Path
 
 import pytest
 
-from winipedia_utils.text.config import ConfigFile
+from winipedia_utils.dev.configs.base.config import ConfigFile
 
 
 @pytest.fixture

winipedia_utils/dev/testing/tests/base/fixtures/scopes/__init__.py

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

winipedia_utils/{testing → dev/testing}/tests/base/fixtures/scopes/class_.py

@@ -8,8 +8,8 @@ mechanism.
 
 import pytest
 
-from winipedia_utils.testing.fixtures import autouse_class_fixture
-from winipedia_utils.testing.tests.base.utils.utils import assert_no_untested_objs
+from winipedia_utils.dev.testing.utils import assert_no_untested_objs
+from winipedia_utils.utils.testing.fixtures import autouse_class_fixture
 
 
 @autouse_class_fixture

winipedia_utils/{testing → dev/testing}/tests/base/fixtures/scopes/module.py

@@ -10,8 +10,8 @@ from typing import TYPE_CHECKING
 
 import pytest
 
-from winipedia_utils.testing.fixtures import autouse_module_fixture
-from winipedia_utils.testing.tests.base.utils.utils import assert_no_untested_objs
+from winipedia_utils.dev.testing.utils import assert_no_untested_objs
+from winipedia_utils.utils.testing.fixtures import autouse_module_fixture
 
 if TYPE_CHECKING:
     from types import ModuleType

winipedia_utils/{testing → dev/testing}/tests/base/fixtures/scopes/session.py

@@ -10,21 +10,21 @@ from importlib import import_module
 from pathlib import Path
 
 import winipedia_utils
-from winipedia_utils.modules.package import (
-    find_packages,
-    get_src_package,
-    walk_package,
-)
-from winipedia_utils.projects.poetry.config import (
+from winipedia_utils.dev.configs.base.config import ConfigFile
+from winipedia_utils.dev.configs.pyproject import (
     PyprojectConfigFile,
 )
-from winipedia_utils.testing.assertions import assert_with_msg
-from winipedia_utils.testing.convention import (
+from winipedia_utils.dev.testing.convention import (
     TESTS_PACKAGE_NAME,
     make_test_obj_importpath_from_obj,
 )
-from winipedia_utils.testing.fixtures import autouse_session_fixture
-from winipedia_utils.text.config import ConfigFile
+from winipedia_utils.utils.modules.package import (
+    find_packages,
+    get_src_package,
+    walk_package,
+)
+from winipedia_utils.utils.testing.assertions import assert_with_msg
+from winipedia_utils.utils.testing.fixtures import autouse_session_fixture
 
 
 @autouse_session_fixture

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

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

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

@@ -0,0 +1 @@
+"""Testing utilities."""

winipedia_utils/{testing → dev/testing}/tests/conftest.py

@@ -7,13 +7,13 @@ 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
+from winipedia_utils.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
+    package_path / to_path("dev.testing", is_package=True) / custom_plugin_path
 )
 
 custom_plugin_module_names = [

winipedia_utils/{testing/tests/base/utils → dev/testing}/utils.py

@@ -13,18 +13,17 @@ from collections.abc import Callable
 from types import ModuleType
 from typing import Any
 
-from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.modules.function import is_abstractmethod
-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 (
+from winipedia_utils.dev.testing.convention import (
     get_obj_from_test_obj,
     make_test_obj_importpath_from_obj,
     make_untested_summary_error_msg,
 )
+from winipedia_utils.utils.logging.logger import get_logger
+from winipedia_utils.utils.modules.module import (
+    get_objs_from_obj,
+    make_obj_importpath,
+)
+from winipedia_utils.utils.testing.assertions import assert_with_msg
 
 logger = get_logger(__name__)
 
@@ -63,19 +62,3 @@ def assert_no_untested_objs(
     untested_objs = supposed_test_objs_paths - test_objs_paths
 
     assert_with_msg(not untested_objs, make_untested_summary_error_msg(untested_objs))
-
-
-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/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,11 +12,15 @@ from importlib import import_module
 from types import ModuleType
 from typing import Any
 
-from winipedia_utils.modules.function import is_func
+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(
-    class_: type, *, exclude_parent_methods: bool = False
+    class_: type,
+    *,
+    exclude_parent_methods: bool = False,
+    include_annotate: bool = False,
 ) -> list[Callable[..., Any]]:
     """Get all methods from a class.
 
@@ -27,17 +31,21 @@ def get_all_methods_from_cls(
         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
+        include_annotate: If False, exclude __annotate__ method
+        introduced in Python 3.14, defaults to False
+
     Returns:
         A list of callable methods from the class
 
     """
-    from winipedia_utils.modules.module import (  # noqa: PLC0415  # avoid circular import
-        get_def_line,
+    from winipedia_utils.utils.modules.module import (  # noqa: PLC0415  # avoid circular import
         get_module_of_obj,
     )
 
     methods = [
-        (method, name) for name, method in inspect.getmembers(class_) if is_func(method)
+        (method, name)
+        for name, method in get_obj_members(class_, include_annotate=include_annotate)
+        if is_func(method)
     ]
 
     if exclude_parent_methods:
@@ -66,8 +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
-        get_def_line,
+    from winipedia_utils.utils.modules.module import (  # noqa: PLC0415  # avoid circular import
         get_module_of_obj,
     )
 
@@ -104,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,6 +12,8 @@ from importlib import import_module
 from types import ModuleType
 from typing import Any
 
+from winipedia_utils.utils.modules.inspection import get_def_line, get_obj_members
+
 
 def is_func_or_method(obj: Any) -> bool:
     """Return True if *obj* is a function or method.
@@ -57,7 +59,9 @@ def is_func(obj: Any) -> bool:
     return is_func_or_method(unwrapped)
 
 
-def get_all_functions_from_module(module: ModuleType | str) -> list[Callable[..., Any]]:
+def get_all_functions_from_module(
+    module: ModuleType | str, *, include_annotate: bool = False
+) -> list[Callable[..., Any]]:
     """Get all functions defined in a module.
 
     Retrieves all function objects that are defined directly in the specified module,
@@ -66,13 +70,14 @@ def get_all_functions_from_module(module: ModuleType | str) -> list[Callable[...
 
     Args:
         module: The module to extract functions from
+        include_annotate: If False, exclude __annotate__ method
+        introduced in Python 3.14, defaults to False
 
     Returns:
         A list of callable functions defined in the module
 
     """
-    from winipedia_utils.modules.module import (  # noqa: PLC0415  # avoid circular import
-        get_def_line,
+    from winipedia_utils.utils.modules.module import (  # noqa: PLC0415  # avoid circular import
         get_module_of_obj,
     )
 
@@ -80,7 +85,8 @@ def get_all_functions_from_module(module: ModuleType | str) -> list[Callable[...
         module = import_module(module)
     funcs = [
         func
-        for _name, func in inspect.getmembers(module, is_func)
+        for _name, func in get_obj_members(module, include_annotate=include_annotate)
+        if is_func(func)
         if get_module_of_obj(func).__name__ == module.__name__
     ]
     # sort by definition order

winipedia_utils/utils/modules/inspection.py

@@ -0,0 +1,56 @@
+"""Inspection utilities for introspecting Python objects.
+
+This module provides utility functions for inspecting Python objects,
+including checking if an object is a function or method, and unwrapping
+methods to their underlying functions.
+"""
+
+import inspect
+import sys
+from collections.abc import Callable
+from typing import Any, cast
+
+
+def get_obj_members(
+    obj: Any, *, include_annotate: bool = False
+) -> list[tuple[str, Any]]:
+    """Get all members of an object."""
+    members = [(member, value) for member, value in inspect.getmembers(obj)]
+    if not include_annotate:
+        members = [
+            (member, value)
+            for member, value in members
+            if member not in ("__annotate__", "__annotate_func__")
+        ]
+    return members
+
+
+def inside_frozen_bundle() -> bool:
+    """Return True if the code is running inside a frozen bundle."""
+    return getattr(sys, "frozen", False)
+
+
+def get_def_line(obj: Any) -> int:
+    """Return the line number where a method-like object is defined."""
+    if isinstance(obj, property):
+        obj = obj.fget
+    unwrapped = inspect.unwrap(obj)
+    if hasattr(unwrapped, "__code__"):
+        return int(unwrapped.__code__.co_firstlineno)
+    # getsourcelines does not work if in a pyinstaller bundle or something
+    if inside_frozen_bundle():
+        return 0
+    return inspect.getsourcelines(unwrapped)[1]
+
+
+def get_unwrapped_obj(obj: Any) -> Any:
+    """Return the unwrapped version of a method-like object."""
+    if isinstance(obj, property):
+        obj = obj.fget  # get the getter function of the property
+    return inspect.unwrap(obj)
+
+
+def get_qualname_of_obj(obj: Callable[..., Any] | type) -> str:
+    """Return the name of a method-like object."""
+    unwrapped = get_unwrapped_obj(obj)
+    return cast("str", unwrapped.__qualname__)