winipedia-utils 0.4.43__tar.gz → 0.4.48__tar.gz

{winipedia_utils-0.4.43 → winipedia_utils-0.4.48}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.4.43
+Version: 0.4.48
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -15,6 +15,7 @@ Requires-Dist: cryptography
 Requires-Dist: defusedxml
 Requires-Dist: dotenv
 Requires-Dist: keyring
+Requires-Dist: networkx
 Requires-Dist: pathspec
 Requires-Dist: polars
 Requires-Dist: pygithub
@@ -78,7 +79,8 @@ git clone https://github.com/owner/repo.git
 poetry init # or poetry new
 # 4: Poetry will ask you some stuff when you run poetry init.
 # First author name must be equal to the GitHub repository owner (username).
-# The repository name must be equal to the package/project name.
+# The repository name must be equal to the package/project name. 
+# (- instead of _ is fine, but only as the project name in pyproject.toml, folder names should all be _)
 
 # 5: Add winipedia-utils to your project
 poetry add winipedia-utils

{winipedia_utils-0.4.43 → winipedia_utils-0.4.48}/README.md

@@ -52,7 +52,8 @@ git clone https://github.com/owner/repo.git
 poetry init # or poetry new
 # 4: Poetry will ask you some stuff when you run poetry init.
 # First author name must be equal to the GitHub repository owner (username).
-# The repository name must be equal to the package/project name.
+# The repository name must be equal to the package/project name. 
+# (- instead of _ is fine, but only as the project name in pyproject.toml, folder names should all be _)
 
 # 5: Add winipedia-utils to your project
 poetry add winipedia-utils

{winipedia_utils-0.4.43 → winipedia_utils-0.4.48}/pyproject.toml

@@ -1,7 +1,7 @@
 # Project section
 [project]
 name = "winipedia-utils"
-version = "0.4.43"
+version = "0.4.48"
 description = "A package with many utility functions"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -32,6 +32,7 @@ cryptography = "*"
 polars = "*"
 pygithub = "*"
 dotenv = "*"
+networkx = "*"
 
 [tool.poetry.group.dev.dependencies]
 ruff = "*"
@@ -44,6 +45,7 @@ types-tqdm = "*"
 types-defusedxml = "*"
 types-pyyaml = "*"
 pytest-mock = "*"
+types-networkx = "*"
 
 [tool.ruff]
 exclude = [ ".*", "**/migrations/*.py",]
@@ -64,3 +66,4 @@ files = "."
 testpaths = [ "tests",]
 
 [tool.bandit]
+exclude_dirs = ["experiment.py"]

{winipedia_utils-0.4.43 → winipedia_utils-0.4.48}/winipedia_utils/git/pre_commit/hooks.py

@@ -127,7 +127,7 @@ def check_static_types() -> list[str | Path]:
 
     This function returns the input for subprocess.run() to check the static types.
     """
-    return ["mypy"]
+    return ["mypy", "--exclude-gitignore"]
 
 
 def check_security() -> list[str | Path]:

{winipedia_utils-0.4.43 → winipedia_utils-0.4.48}/winipedia_utils/modules/module.py

@@ -379,3 +379,25 @@ def get_unwrapped_obj(obj: Any) -> Any:
     if isinstance(obj, property):
         obj = obj.fget  # get the getter function of the property
     return inspect.unwrap(obj)
+
+
+def get_executing_module() -> ModuleType:
+    """Get the module where execution has started.
+
+    The executing module is the module that contains the __main__ attribute as __name__
+    E.g. if you run `python -m winipedia_utils.setup` from the command line,
+    then the executing module is winipedia_utils.modules.setup
+
+    Returns:
+        The module where execution has started
+
+    Raises:
+        ValueError: If no __main__ module is found or if the executing module
+                    cannot be determined
+
+    """
+    main = sys.modules.get("__main__")
+    if main is None:
+        msg = "No __main__ module found"
+        raise ValueError(msg)
+    return main

{winipedia_utils-0.4.43 → winipedia_utils-0.4.48}/winipedia_utils/modules/package.py

@@ -9,17 +9,23 @@ The utilities support both static package analysis and dynamic package manipulat
 making them suitable for code generation, testing frameworks, and package management.
 """
 
+import importlib.metadata
+import importlib.util
 import os
 import pkgutil
+import re
 import sys
 from collections.abc import Generator, Iterable
 from importlib import import_module
 from pathlib import Path
 from types import ModuleType
+from typing import Any
 
+import networkx as nx
 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
 
 logger = get_logger(__name__)
@@ -428,3 +434,89 @@ def make_name_from_package(
     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."""
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        """Initialize the dependency graph and build it immediately."""
+        super().__init__(*args, **kwargs)
+        self.build()
+
+    def build(self) -> None:
+        """Build the graph from installed Python distributions."""
+        for dist in importlib.metadata.distributions():
+            name = self.parse_distname_from_metadata(dist)
+            self.add_node(name)
+
+            requires = dist.requires or []
+            for req in requires:
+                dep = self.parse_pkg_name_from_req(req)
+                if dep:
+                    self.add_edge(name, dep)  # package → dependency
+
+    @staticmethod
+    def parse_distname_from_metadata(dist: importlib.metadata.Distribution) -> str:
+        """Extract the distribution name from its metadata."""
+        # replace - with _ to handle packages like winipedia-utils
+        name: str = dist.metadata["Name"]
+        return DependencyGraph.normalize_package_name(name)
+
+    @staticmethod
+    def normalize_package_name(name: str) -> str:
+        """Normalize a package name."""
+        return name.lower().replace("-", "_").strip()
+
+    @staticmethod
+    def parse_pkg_name_from_req(req: str) -> str | None:
+        """Extract the bare dependency name from a requirement string."""
+        # split on the first non alphanumeric character like >, <, =, etc.
+        dep = re.split(r"[^a-zA-Z0-9]", req.strip())[0].strip()
+        return DependencyGraph.normalize_package_name(dep) if dep else None
+
+    def get_all_depending_on(
+        self, package: ModuleType, *, include_self: bool = False
+    ) -> set[ModuleType]:
+        """Return all packages that directly or indirectly depend on the given package.
+
+        Args:
+            package: The module whose dependents should be found.
+            include_self: Whether to include the package itself in the result.
+
+        Returns:
+            A set of imported module objects representing dependents.
+        """
+        # replace - with _ to handle packages like winipedia-utils
+        target = package.__name__.lower()
+        if target not in self:
+            msg = f"Package '{target}' not found in dependency graph"
+            raise ValueError(msg)
+
+        dependents = nx.ancestors(self, target)
+        if include_self:
+            dependents.add(target)
+
+        return self.import_packages(dependents)
+
+    @staticmethod
+    def import_packages(names: set[str]) -> set[ModuleType]:
+        """Attempt to import all module names that can be resolved."""
+        modules: set[ModuleType] = set()
+        for name in names:
+            spec = importlib.util.find_spec(name)
+            if spec is not None:
+                modules.add(importlib.import_module(name))
+        return modules
+
+    def get_all_depending_on_winipedia_utils(
+        self, *, include_winipedia_utils: bool = False
+    ) -> set[ModuleType]:
+        """Return all packages that directly or indirectly depend on winipedia_utils."""
+        if get_src_package() == winipedia_utils:
+            deps: set[ModuleType] = set()
+        else:
+            deps = self.get_all_depending_on(winipedia_utils, include_self=False)
+        if include_winipedia_utils:
+            deps.add(winipedia_utils)
+        return deps

{winipedia_utils-0.4.43 → winipedia_utils-0.4.48}/winipedia_utils/projects/poetry/config.py

@@ -5,6 +5,7 @@ from typing import Any, cast
 
 from winipedia_utils.modules.package import get_src_package, make_name_from_package
 from winipedia_utils.projects.poetry.poetry import VersionConstraint
+from winipedia_utils.testing.config import ExperimentConfigFile
 from winipedia_utils.testing.convention import TESTS_PACKAGE_NAME
 from winipedia_utils.text.config import ConfigFile, TomlConfigFile
 
@@ -62,7 +63,9 @@ class PyprojectConfigFile(TomlConfigFile):
                     "files": ".",
                 },
                 "pytest": {"ini_options": {"testpaths": [TESTS_PACKAGE_NAME]}},
-                "bandit": {},
+                "bandit": {
+                    "exclude_dirs": [ExperimentConfigFile.get_path().as_posix()],
+                },
             },
         }
 

{winipedia_utils-0.4.43 → winipedia_utils-0.4.48}/winipedia_utils/text/config.py

@@ -9,10 +9,9 @@ import tomlkit
 import yaml
 from dotenv import dotenv_values
 
-import winipedia_utils
 from winipedia_utils.iterating.iterate import nested_structure_is_subset
 from winipedia_utils.modules.class_ import init_all_nonabstract_subclasses
-from winipedia_utils.modules.package import get_src_package
+from winipedia_utils.modules.package import DependencyGraph, get_src_package
 from winipedia_utils.projects.poetry.poetry import (
     get_python_module_script,
 )
@@ -149,8 +148,14 @@ class ConfigFile(ABC):
     @classmethod
     def init_config_files(cls) -> None:
         """Initialize all subclasses."""
-        init_all_nonabstract_subclasses(cls, load_package_before=winipedia_utils)
-        init_all_nonabstract_subclasses(cls, load_package_before=get_src_package())
+        pkgs_depending_on_winipedia_utils = (
+            DependencyGraph().get_all_depending_on_winipedia_utils(
+                include_winipedia_utils=True
+            )
+        )
+        pkgs_depending_on_winipedia_utils.add(get_src_package())
+        for pkg in pkgs_depending_on_winipedia_utils:
+            init_all_nonabstract_subclasses(cls, load_package_before=pkg)
 
     @staticmethod
     def get_python_setup_script() -> str: