wexample-wex-addon-dev-python 0.0.45__py3-none-any.whl → 0.0.47__py3-none-any.whl

wexample_wex_addon_dev_python/commands/code/check/mypy.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
-from wexample_wex_core.common.kernel import Kernel
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from wexample_wex_core.common.kernel import Kernel
 
 
 def _code_check_mypy(kernel: Kernel, file_path: str) -> bool:
@@ -15,7 +18,6 @@ def _code_check_mypy(kernel: Kernel, file_path: str) -> bool:
     """
     import sys
 
-    # Import mypy modules
     from mypy import build
     from mypy.modulefinder import BuildSource
     from mypy.options import Options

wexample_wex_addon_dev_python/commands/code/check/pyright.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
-from wexample_wex_core.common.kernel import Kernel
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from wexample_wex_core.common.kernel import Kernel
 
 
 def _code_check_pyright(kernel: Kernel, file_path: str) -> bool:

wexample_wex_addon_dev_python/commands/code/check.py

@@ -43,7 +43,7 @@ def python__code__check(
     parallel: bool = True,
 ) -> bool:
     """Check a Python file using various code quality tools."""
-    from wexample_helpers.helpers.cli import cli_make_clickable_path
+    from wexample_app.response.failure_response import FailureResponse
     from wexample_wex_addon_dev_python.commands.code.check.mypy import _code_check_mypy
     from wexample_wex_addon_dev_python.commands.code.check.pylint import (
         _code_check_pylint,
@@ -80,7 +80,7 @@ def python__code__check(
         context.io.log_indent_up()
 
         context.io.log(
-            f"🐍 Python: {cli_make_clickable_path(context.kernel.host_workdir.get_resolved_target(file))}"
+            f"🐍 Python: {context.kernel.host_workdir.render_display_path(file)}"
         )
 
         check_result = check_function(context, file)
@@ -95,8 +95,6 @@ def python__code__check(
         if not check_result and stop_on_failure:
             context.io.error("One check failed")
 
-            from wexample_app.response.failure_response import FailureResponse
-
             context.io.log_indent_down()
 
             return FailureResponse(message="One check failed", kernel=context.kernel)

wexample_wex_addon_dev_python/commands/code/format/black.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
-from wexample_wex_core.common.kernel import Kernel
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from wexample_wex_core.common.kernel import Kernel
 
 
 def _code_format_black(kernel: Kernel, file_path: str) -> bool:

wexample_wex_addon_dev_python/commands/code/format/isort.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
-from wexample_wex_core.common.kernel import Kernel
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from wexample_wex_core.common.kernel import Kernel
 
 
 def _code_format_isort(kernel: Kernel, file_path: str) -> bool:

wexample_wex_addon_dev_python/commands/code/format.py

@@ -1,10 +1,14 @@
 from __future__ import annotations
 
-from wexample_wex_core.common.kernel import Kernel
+from typing import TYPE_CHECKING
+
 from wexample_wex_core.decorator.command import command
 from wexample_wex_core.decorator.middleware import middleware
 from wexample_wex_core.decorator.option import option
 
+if TYPE_CHECKING:
+    from wexample_wex_core.common.kernel import Kernel
+
 
 @option(
     name="tool",

wexample_wex_addon_dev_python/config_value/python_package_readme_config_value.py

@@ -1,38 +1,28 @@
 from __future__ import annotations
 
 import os
+from typing import TYPE_CHECKING
 
 from wexample_filestate.config_value.readme_content_config_value import (
     ReadmeContentConfigValue,
 )
+from wexample_helpers.classes.field import public_field
+from wexample_helpers.decorator.base_class import base_class
 from wexample_wex_addon_dev_python.workdir.python_package_workdir import (
     PythonPackageWorkdir,
 )
 
+if TYPE_CHECKING:
+    from wexample_wex_addon_dev_python.workdir.python_package_workdir import (
+        PythonPackageWorkdir,
+    )
 
-class PythonPackageReadmeContentConfigValue(ReadmeContentConfigValue):
-    workdir: PythonPackageWorkdir
-
-    def _get_doc_path(self, section: str) -> str:
-        """
-        Returns the path to a documentation section file
-        """
-        return os.path.join(
-            self.workdir.get_path(), ".wex", "doc", "readme", f"{section}.md"
-        )
-
-    def _add_section_if_exists(self, section: str) -> str:
-        """
-        Returns section content if the documentation file exists
-        """
-        doc_path = self._get_doc_path(section)
 
-        if os.path.exists(doc_path):
-            with open(doc_path, encoding="utf-8") as file:
-                content = file.read()
-                return f"## {section.title()}\n\n{content}\n\n"
-
-        return ""
+@base_class
+class PythonPackageReadmeContentConfigValue(ReadmeContentConfigValue):
+    workdir: PythonPackageWorkdir = public_field(
+        description="The python package workdir"
+    )
 
     def get_templates(self) -> list[str] | None:
         # Use TOMLDocument from the workdir
@@ -79,3 +69,24 @@ class PythonPackageReadmeContentConfigValue(ReadmeContentConfigValue):
             "## License\n\n"
             f"{license_info}"
         ]
+
+    def _add_section_if_exists(self, section: str) -> str:
+        """
+        Returns section content if the documentation file exists
+        """
+        doc_path = self._get_doc_path(section)
+
+        if os.path.exists(doc_path):
+            with open(doc_path, encoding="utf-8") as file:
+                content = file.read()
+                return f"## {section.title()}\n\n{content}\n\n"
+
+        return ""
+
+    def _get_doc_path(self, section: str) -> str:
+        """
+        Returns the path to a documentation section file
+        """
+        return os.path.join(
+            self.workdir.get_path(), ".wex", "doc", "readme", f"{section}.md"
+        )

wexample_wex_addon_dev_python/const/package.py

@@ -3,18 +3,19 @@ from __future__ import annotations
 # Names of dev/build tools to remove from runtime [project.dependencies]
 # Keep this list in sync with tooling expectations.
 RUNTIME_DEPENDENCY_REMOVE_NAMES: set[str] = {
-    "pytest",
-    "pip-tools",
+    # filestate: python-iterable-sort
     "black",
-    "ruff",
+    "build",
+    "coverage",
     "flake8",
-    "mypy",
     "isort",
-    "coverage",
-    "build",
-    "twine",
+    "mypy",
     "pip",
+    "pip-tools",
+    "pytest",
+    "ruff",
     "setuptools",
-    "wheel",
+    "twine",
     "typing-extensions",
+    "wheel",
 }

wexample_wex_addon_dev_python/file/python_package_toml_file.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from typing import TYPE_CHECKING
 
 from wexample_filestate.item.file.toml_file import TomlFile
+from wexample_helpers.decorator.base_class import base_class
 from wexample_wex_core.workdir.mixin.as_suite_package_item import (
     AsSuitePackageItem,
 )
@@ -14,79 +15,8 @@ if TYPE_CHECKING:
     )
 
 
+@base_class
 class PythonPackageTomlFile(AsSuitePackageItem, TomlFile):
-
-    def _project_table(self):
-        """Ensure and return the [project] table."""
-        from wexample_filestate_python.helpers.toml import toml_ensure_table
-
-        doc = self.read_parsed()
-        project, _ = toml_ensure_table(doc, ["project"])
-        return project
-
-    def _dependencies_array(self):
-        """Ensure and return project.dependencies as a multi-line TOML array."""
-        from wexample_filestate_python.helpers.toml import (
-            toml_ensure_array,
-        )
-
-        project = self._project_table()
-        deps, _ = toml_ensure_array(project, "dependencies")
-        deps.multiline(True)
-        return deps
-
-    def _optional_group_array(self, group: str):
-        """Ensure and return project.optional-dependencies[group] as multi-line array."""
-        from wexample_filestate_python.helpers.toml import (
-            toml_ensure_array,
-            toml_ensure_table,
-        )
-
-        project = self._project_table()
-        opt, _ = toml_ensure_table(project, ["optional-dependencies"])
-        arr, _ = toml_ensure_array(opt, group)
-        arr.multiline(True)
-        return arr
-
-    # --- Unified dependency accessors (runtime vs optional) ---
-    def _get_deps_array(self, optional: bool = False, group: str = "dev"):
-        """Return TOML array for runtime deps or optional group (multiline)."""
-        return (
-            self._optional_group_array(group)
-            if optional
-            else self._dependencies_array()
-        )
-
-    def list_dependencies(
-        self, optional: bool = False, group: str = "dev"
-    ) -> list[str]:
-        deps = self._get_deps_array(optional=optional, group=group)
-        return [str(x) for x in list(deps)]
-
-    def list_dependency_names(
-        self,
-        canonicalize_names: bool = True,
-        optional: bool = False,
-        group: str = "dev",
-    ) -> list[str]:
-        """Return dependency package names derived from list_dependencies().
-
-        If canonicalize_names is True, names are normalized using packaging's
-        canonicalize_name for robust comparisons (dash/underscore, case, etc.).
-        """
-        from packaging.requirements import Requirement
-        from packaging.utils import canonicalize_name
-
-        names: list[str] = []
-        for spec in self.list_dependencies(optional=optional, group=group):
-            try:
-                name = Requirement(spec).name
-                names.append(canonicalize_name(name) if canonicalize_names else name)
-            except Exception:
-                # Skip unparsable entries when deriving names
-                continue
-        return names
-
     def add_dependency(
         self, spec: str, optional: bool = False, group: str = "dev"
     ) -> bool:
@@ -109,44 +39,6 @@ class PythonPackageTomlFile(AsSuitePackageItem, TomlFile):
 
         return removed
 
-    def remove_dependency_by_name(
-        self, package_name: str, optional: bool = False, group: str = "dev"
-    ) -> bool:
-        """Remove all dependency entries that match the given package name.
-
-        The provided package_name can be raw; it will be canonicalized to ensure
-        consistent matching against entries parsed from list_dependencies().
-        """
-        from packaging.requirements import Requirement
-        from packaging.utils import canonicalize_name
-
-        deps = self._get_deps_array(optional=optional, group=group)
-
-        target = canonicalize_name(package_name)
-        filtered: list[str] = []
-        for existing in list(deps):
-            try:
-                existing_name = canonicalize_name(Requirement(str(existing)).name)
-            except Exception:
-                # Keep unparsable entries untouched
-                filtered.append(existing)
-                continue
-            if existing_name != target:
-                filtered.append(existing)
-
-        if len(filtered) != len(deps):
-            deps.clear()
-            deps.extend(filtered)
-            return True
-        return False
-
-    def find_package_workdir(self) -> CodeBaseWorkdir | None:
-        from wexample_wex_core.workdir.code_base_workdir import (
-            CodeBaseWorkdir,
-        )
-
-        return self.find_closest(CodeBaseWorkdir)
-
     def dumps(self, content: TOMLDocument | dict | None = None) -> str:
         """Serialize a TOMLDocument (preferred) or a plain dict to TOML.
         Using tomlkit.dumps preserves comments/formatting when content is a TOMLDocument.
@@ -154,10 +46,8 @@ class PythonPackageTomlFile(AsSuitePackageItem, TomlFile):
         from tomlkit import dumps, table
         from wexample_filestate_python.helpers.package import package_normalize_name
         from wexample_filestate_python.helpers.toml import (
-            toml_ensure_array_multiline,
             toml_ensure_table,
             toml_get_string_value,
-            toml_set_array_multiline,
             toml_sort_string_array,
         )
         from wexample_wex_addon_dev_python.const.package import (
@@ -192,20 +82,18 @@ class PythonPackageTomlFile(AsSuitePackageItem, TomlFile):
         tool_tbl, _ = toml_ensure_table(content, ["tool"])
         pdm_tbl, _ = toml_ensure_table(tool_tbl, ["pdm"])
         build_pdm_tbl, _ = toml_ensure_table(pdm_tbl, ["build"])
-        includes_arr, _ = toml_ensure_array_multiline(build_pdm_tbl, "includes")
 
         pdm_tbl["distribution"] = True
-        # Enforce src layout, packages, and includes (py.typed)
+        # Enforce src layout and packages (remove includes to avoid conflicts)
         if build_pdm_tbl.get("package-dir") != "src":
             build_pdm_tbl["package-dir"] = "src"
         if import_name:
             desired_pkgs = [{"include": import_name, "from": "src"}]
             if build_pdm_tbl.get("packages") != desired_pkgs:
                 build_pdm_tbl["packages"] = desired_pkgs
-            desired_includes = [f"src/{import_name}/*"]
-            current_includes = [str(x) for x in list(includes_arr)]
-            if current_includes != desired_includes:
-                toml_set_array_multiline(build_pdm_tbl, "includes", desired_includes)
+            # Remove includes to avoid conflicts with packages declaration
+            if "includes" in build_pdm_tbl:
+                del build_pdm_tbl["includes"]
 
         # --- [project] table and basic fields ---
         project_tbl, _ = toml_ensure_table(content, ["project"])
@@ -246,13 +134,13 @@ class PythonPackageTomlFile(AsSuitePackageItem, TomlFile):
                 exclude_add = {str(x).strip().lower() for x in ex_list}
 
         # Remove unwanted dev/build tools from runtime deps (unless kept)
-
         def _should_remove(item: object) -> bool:
             name = package_normalize_name(toml_get_string_value(item))
             if name in keep_names:
                 return False
             if name == "typing-extensions":
-                # Safe to drop when python >= 3.10 and we manage deps
+                # Safe to drop when py
+                # thon >= 3.10 and we manage deps
                 return True
             return name in RUNTIME_DEPENDENCY_REMOVE_NAMES
 
@@ -265,14 +153,17 @@ class PythonPackageTomlFile(AsSuitePackageItem, TomlFile):
             deps_arr.extend(to_keep)
             toml_sort_string_array(deps_arr)
 
-        # Normalize any pydantic spec to pydantic>=2,<3
+        # Normalize attrs/cattrs dependencies
         normalized = False
         new_deps = []
         for it in list(deps_arr):
             val = toml_get_string_value(it).strip()
             base = package_normalize_name(val)
-            if base == "pydantic":
-                new_deps.append("pydantic>=2,<3")
+            if base == "attrs":
+                new_deps.append("attrs>=23.1.0")
+                normalized = True
+            elif base == "cattrs":
+                new_deps.append("cattrs>=23.1.0")
                 normalized = True
             else:
                 new_deps.append(it)
@@ -281,12 +172,15 @@ class PythonPackageTomlFile(AsSuitePackageItem, TomlFile):
             deps_arr.extend(new_deps)
             toml_sort_string_array(deps_arr)
 
-        # Ensure pydantic>=2,<3 present unless excluded
+        # Ensure attrs and cattrs are present unless excluded
         existing_norm = {
             package_normalize_name(toml_get_string_value(it)) for it in list(deps_arr)
         }
-        if "pydantic" not in exclude_add and "pydantic" not in existing_norm:
-            deps_arr.append("pydantic>=2,<3")
+        if "attrs" not in exclude_add and "attrs" not in existing_norm:
+            deps_arr.append("attrs>=23.1.0")
+            toml_sort_string_array(deps_arr)
+        if "cattrs" not in exclude_add and "cattrs" not in existing_norm:
+            deps_arr.append("cattrs>=23.1.0")
             toml_sort_string_array(deps_arr)
 
         # Ensure optional dev group contains pytest unless already in runtime deps
@@ -302,3 +196,108 @@ class PythonPackageTomlFile(AsSuitePackageItem, TomlFile):
             toml_sort_string_array(dev_arr)
 
         return dumps(content)
+
+    def find_package_workdir(self) -> CodeBaseWorkdir | None:
+        from wexample_wex_core.workdir.code_base_workdir import CodeBaseWorkdir
+
+        return self.find_closest(CodeBaseWorkdir)
+
+    def list_dependencies(
+        self, optional: bool = False, group: str = "dev"
+    ) -> list[str]:
+        deps = self._get_deps_array(optional=optional, group=group)
+        return [str(x) for x in list(deps)]
+
+    def list_dependency_names(
+        self,
+        canonicalize_names: bool = True,
+        optional: bool = False,
+        group: str = "dev",
+    ) -> list[str]:
+        """Return dependency package names derived from list_dependencies().
+
+        If canonicalize_names is True, names are normalized using packaging's
+        canonicalize_name for robust comparisons (dash/underscore, case, etc.).
+        """
+        from packaging.requirements import Requirement
+        from packaging.utils import canonicalize_name
+
+        names: list[str] = []
+        for spec in self.list_dependencies(optional=optional, group=group):
+            try:
+                name = Requirement(spec).name
+                names.append(canonicalize_name(name) if canonicalize_names else name)
+            except Exception:
+                # Skip unparsable entries when deriving names
+                continue
+        return names
+
+    def remove_dependency_by_name(
+        self, package_name: str, optional: bool = False, group: str = "dev"
+    ) -> bool:
+        """Remove all dependency entries that match the given package name.
+
+        The provided package_name can be raw; it will be canonicalized to ensure
+        consistent matching against entries parsed from list_dependencies().
+        """
+        from packaging.requirements import Requirement
+        from packaging.utils import canonicalize_name
+
+        deps = self._get_deps_array(optional=optional, group=group)
+
+        target = canonicalize_name(package_name)
+        filtered: list[str] = []
+        for existing in list(deps):
+            try:
+                existing_name = canonicalize_name(Requirement(str(existing)).name)
+            except Exception:
+                # Keep unparsable entries untouched
+                filtered.append(existing)
+                continue
+            if existing_name != target:
+                filtered.append(existing)
+
+        if len(filtered) != len(deps):
+            deps.clear()
+            deps.extend(filtered)
+            return True
+        return False
+
+    def _dependencies_array(self):
+        """Ensure and return project.dependencies as a multi-line TOML array."""
+        from wexample_filestate_python.helpers.toml import toml_ensure_array
+
+        project = self._project_table()
+        deps, _ = toml_ensure_array(project, "dependencies")
+        deps.multiline(True)
+        return deps
+
+    # --- Unified dependency accessors (runtime vs optional) ---
+    def _get_deps_array(self, optional: bool = False, group: str = "dev"):
+        """Return TOML array for runtime deps or optional group (multiline)."""
+        return (
+            self._optional_group_array(group)
+            if optional
+            else self._dependencies_array()
+        )
+
+    def _optional_group_array(self, group: str):
+        """Ensure and return project.optional-dependencies[group] as multi-line array."""
+        from wexample_filestate_python.helpers.toml import (
+            toml_ensure_array,
+            toml_ensure_table,
+        )
+
+        project = self._project_table()
+        opt, _ = toml_ensure_table(project, ["optional-dependencies"])
+        arr, _ = toml_ensure_array(opt, group)
+        arr.multiline(True)
+        return arr
+
+    def _project_table(self):
+        """Ensure and return the [project] table."""
+        from wexample_filestate_python.helpers.toml import toml_ensure_table
+
+        doc = self.read_parsed()
+        project, _ = toml_ensure_table(doc, ["project"])
+        return project

wexample_wex_addon_dev_python/middleware/each_python_file_middleware.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import os.path
 from typing import TYPE_CHECKING
 
 from wexample_wex_core.middleware.each_file_middleware import EachFileMiddleware
@@ -16,9 +15,6 @@ class EachPythonFileMiddleware(EachFileMiddleware):
     - Ignores special directories like __pycache__ during recursion
     """
 
-    # Default extension to filter
-    python_extension_only: bool = True
-
     # Default list of directories to ignore during recursion
     ignored_directories: set[str] = {
         "__pycache__",
@@ -32,6 +28,8 @@ class EachPythonFileMiddleware(EachFileMiddleware):
         ".mypy_cache",
         ".ruff_cache",
     }
+    # Default extension to filter
+    python_extension_only: bool = True
 
     def __init__(self, **kwargs) -> None:
         # Allow overriding the default settings
@@ -43,6 +41,20 @@ class EachPythonFileMiddleware(EachFileMiddleware):
 
         super().__init__(**kwargs)
 
+    def _should_explore_directory(
+        self, request: CommandRequest, directory_name: str
+    ) -> bool:
+        """
+        Skip directories that are in the ignored_directories list.
+
+        Args:
+            directory_name: Name of the directory to check
+
+        Returns:
+            False if the directory is in the ignored list, True otherwise
+        """
+        return directory_name not in self.ignored_directories
+
     def _should_process_item(self, request: CommandRequest, item_path: str) -> bool:
         """
         Only process Python files based on extension.
@@ -63,17 +75,3 @@ class EachPythonFileMiddleware(EachFileMiddleware):
 
         # Otherwise, accept all files
         return True
-
-    def _should_explore_directory(
-        self, request: CommandRequest, directory_name: str
-    ) -> bool:
-        """
-        Skip directories that are in the ignored_directories list.
-
-        Args:
-            directory_name: Name of the directory to check
-
-        Returns:
-            False if the directory is in the ignored list, True otherwise
-        """
-        return directory_name not in self.ignored_directories

wexample_wex_addon_dev_python/python_addon_manager.py

@@ -1,7 +1,11 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from wexample_wex_core.common.abstract_addon_manager import AbstractAddonManager
-from wexample_wex_core.middleware.abstract_middleware import AbstractMiddleware
+
+if TYPE_CHECKING:
+    from wexample_wex_core.middleware.abstract_middleware import AbstractMiddleware
 
 
 class PythonAddonManager(AbstractAddonManager):