wexample-wex-addon-dev-python 0.0.53__tar.gz → 0.0.60__tar.gz

{wexample_wex_addon_dev_python-0.0.53 → wexample_wex_addon_dev_python-0.0.60}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wexample-wex-addon-dev-python
-Version: 0.0.53
+Version: 0.0.60
 Summary: Python dev addon for wex
 Author-Email: weeger <contact@wexample.com>
 License: MIT
@@ -15,9 +15,9 @@ Requires-Dist: jinja2
 Requires-Dist: networkx
 Requires-Dist: pylint
 Requires-Dist: pyright
-Requires-Dist: wexample-filestate-python==0.0.48
-Requires-Dist: wexample-wex-addon-app==0.0.49
-Requires-Dist: wexample-wex-core==6.0.55
+Requires-Dist: wexample-filestate-python==0.0.54
+Requires-Dist: wexample-wex-addon-app==0.0.51
+Requires-Dist: wexample-wex-core==6.0.63
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -25,7 +25,7 @@ Description-Content-Type: text/markdown
 
 # wexample-wex-addon-dev-python
 
-Version: 0.0.53
+Version: 0.0.60
 
 Python dev addon for wex
 
@@ -44,7 +44,7 @@ First, install the required testing dependencies:
 
 Run all tests with coverage:
 ```bash
-.venv/bin/python -m pytest --cov
+.venv/bin/python -m pytest --cov --cov-report=html
 ```
 
 ### Common Commands

{wexample_wex_addon_dev_python-0.0.53 → wexample_wex_addon_dev_python-0.0.60}/README.md

@@ -1,6 +1,6 @@
 # wexample-wex-addon-dev-python
 
-Version: 0.0.53
+Version: 0.0.60
 
 Python dev addon for wex
 
@@ -19,7 +19,7 @@ First, install the required testing dependencies:
 
 Run all tests with coverage:
 ```bash
-.venv/bin/python -m pytest --cov
+.venv/bin/python -m pytest --cov --cov-report=html
 ```
 
 ### Common Commands

{wexample_wex_addon_dev_python-0.0.53 → wexample_wex_addon_dev_python-0.0.60}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
 
 [project]
 name = "wexample-wex-addon-dev-python"
-version = "0.0.53"
+version = "0.0.60"
 description = "Python dev addon for wex"
 authors = [
     { name = "weeger", email = "contact@wexample.com" },
@@ -24,9 +24,9 @@ dependencies = [
     "networkx",
     "pylint",
     "pyright",
-    "wexample-filestate-python==0.0.48",
-    "wexample-wex-addon-app==0.0.49",
-    "wexample-wex-core==6.0.55",
+    "wexample-filestate-python==0.0.54",
+    "wexample-wex-addon-app==0.0.51",
+    "wexample-wex-core==6.0.63",
 ]
 
 [project.readme]
@@ -45,6 +45,14 @@ dev = [
     "pytest-cov",
 ]
 
+[tool.setuptools.packages.find]
+include = [
+    "*",
+]
+exclude = [
+    "wexample_wex_addon_dev_python.testing*",
+]
+
 [tool.pdm]
 distribution = true
 
@@ -54,10 +62,31 @@ packages = [
     { include = "wexample_wex_addon_dev_python", from = "src" },
 ]
 
-[tool.setuptools.packages.find]
-include = [
-    "*",
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
 ]
-exclude = [
-    "wexample_wex_addon_dev_python.testing*",
+pythonpath = [
+    "src",
+]
+
+[tool.coverage.run]
+source = [
+    "wexample_wex_addon_dev_python",
+]
+omit = [
+    "*/tests/*",
+    "*/.venv/*",
+    "*/venv/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "@abstractmethod",
 ]

wexample_wex_addon_dev_python-0.0.60/src/wexample_wex_addon_dev_python/const/python.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+PYTHON_PYTEST_COV_REPORT_DIR: Path = Path("htmlcov")
+PYTHON_PYTEST_COV_FORMAT_HTML: str = "html"
+PYTHON_PYTEST_COV_FORMAT_JSON: str = "json"

{wexample_wex_addon_dev_python-0.0.53 → wexample_wex_addon_dev_python-0.0.60}/src/wexample_wex_addon_dev_python/file/python_package_toml_file.py

@@ -4,6 +4,7 @@ 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_addon_app.const.path import APP_PATH_README
 
 if TYPE_CHECKING:
     from tomlkit import TOMLDocument
@@ -22,19 +23,21 @@ class PythonPackageTomlFile(TomlFile):
         from wexample_filestate_python.helpers.toml import toml_sort_string_array
 
         deps = self._get_deps_array(optional=optional, group=group)
-        # Remove existing entries for the same package name before adding the new spec.
-        new_name = canonicalize_name(Requirement(spec).name)
-        removed = self.remove_dependency_by_name(
-            new_name, optional=optional, group=group
-        )
+        new_req = Requirement(spec)
+        new_name = canonicalize_name(new_req.name)
 
-        # Append (or re-append) the new spec if it is not already present verbatim
-        if spec not in deps:
-            deps.append(spec)
-            toml_sort_string_array(deps)
-            return True
+        old_spec = None
+        for dep in deps:
+            if canonicalize_name(Requirement(dep).name) == new_name:
+                old_spec = dep
+                break
+
+        self.remove_dependency_by_name(new_name, optional=optional, group=group)
 
-        return removed
+        deps.append(spec)
+        toml_sort_string_array(deps)
+
+        return old_spec != spec
 
     def dumps(self, content: TOMLDocument | dict | None = None) -> str:
         """Serialize a TOMLDocument (preferred) or a plain dict to TOML.
@@ -54,6 +57,7 @@ class PythonPackageTomlFile(TomlFile):
         self._enforce_project_metadata(content, project_name, project_version)
         self._normalize_dependencies(content)
         self._ensure_dev_dependencies(content)
+        self._enforce_pytest_coverage_config(content, import_name)
         self._reorder_toml_sections(content)
 
         result = dumps(content)
@@ -96,6 +100,19 @@ class PythonPackageTomlFile(TomlFile):
                 continue
         return names
 
+    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 remove_dependency_by_name(
         self, package_name: str, optional: bool = False, group: str = "dev"
     ) -> bool:
@@ -218,20 +235,55 @@ class PythonPackageTomlFile(TomlFile):
 
         # Add README if it exists
         if package:
-            from wexample_wex_addon_app.workdir.mixin.with_readme_workdir_mixin import (
-                WithReadmeWorkdirMixin,
-            )
+            pass
 
-            readme_file = package.find_by_name(WithReadmeWorkdirMixin.README_FILENAME)
+            readme_file = package.find_by_name(APP_PATH_README)
             if readme_file:
                 readme_tbl, _ = toml_ensure_table(project_tbl, ["readme"])
-                readme_tbl["file"] = WithReadmeWorkdirMixin.README_FILENAME
+                readme_tbl["file"] = str(APP_PATH_README)
                 readme_tbl["content-type"] = "text/markdown"
 
         # Add MIT license
         license_tbl, _ = toml_ensure_table(project_tbl, ["license"])
         license_tbl["text"] = "MIT"
 
+    def _enforce_pytest_coverage_config(
+        self, content: dict, import_name: str | None
+    ) -> None:
+        """Add pytest and coverage configuration to limit coverage to the package only."""
+        if not import_name:
+            return
+
+        from wexample_filestate_python.helpers.toml import toml_ensure_table
+
+        tool_tbl, _ = toml_ensure_table(content, ["tool"])
+
+        # Add pytest configuration
+        pytest_tbl, _ = toml_ensure_table(tool_tbl, ["pytest", "ini_options"])
+        pytest_tbl["testpaths"] = ["tests"]
+        pytest_tbl["pythonpath"] = ["src"]
+
+        # Add coverage.run configuration to limit source to the package
+        coverage_run_tbl, _ = toml_ensure_table(tool_tbl, ["coverage", "run"])
+        coverage_run_tbl["source"] = [import_name]
+        coverage_run_tbl["omit"] = [
+            "*/tests/*",
+            "*/.venv/*",
+            "*/venv/*",
+        ]
+
+        # Add coverage.report configuration
+        coverage_report_tbl, _ = toml_ensure_table(tool_tbl, ["coverage", "report"])
+        coverage_report_tbl["exclude_lines"] = [
+            "pragma: no cover",
+            "def __repr__",
+            "raise AssertionError",
+            "raise NotImplementedError",
+            "if __name__ == .__main__.:",
+            "if TYPE_CHECKING:",
+            "@abstractmethod",
+        ]
+
     def _ensure_dev_dependencies(self, content: dict) -> None:
         from wexample_filestate_python.helpers.package import package_normalize_name
         from wexample_filestate_python.helpers.toml import (
@@ -239,7 +291,7 @@ class PythonPackageTomlFile(TomlFile):
             toml_sort_string_array,
         )
 
-        dev_arr = self._optional_group_array("dev")
+        dev_arr = self.optional_group_array("dev")
         deps_arr = self._dependencies_array()
 
         runtime_pkgs = {
@@ -257,9 +309,7 @@ class PythonPackageTomlFile(TomlFile):
     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()
+            self.optional_group_array(group) if optional else self._dependencies_array()
         )
 
     def _normalize_dependencies(self, content: dict) -> None:
@@ -276,9 +326,24 @@ class PythonPackageTomlFile(TomlFile):
         deps_arr = self._dependencies_array()
         toml_sort_string_array(deps_arr)
 
+        # Read the keep list from [tool.filestate].keep
+        keep_packages: set[str] = set()
+        if "tool" in content and isinstance(content["tool"], dict):
+            tool_tbl = content["tool"]
+            if "filestate" in tool_tbl and isinstance(tool_tbl["filestate"], dict):
+                filestate_tbl = tool_tbl["filestate"]
+                if "keep" in filestate_tbl and isinstance(filestate_tbl["keep"], list):
+                    keep_packages = {
+                        package_normalize_name(str(pkg))
+                        for pkg in filestate_tbl["keep"]
+                    }
+
         # filter unwanted deps
         def _should_remove(item: object) -> bool:
             name = package_normalize_name(toml_get_string_value(item))
+            # Don't remove if in keep list
+            if name in keep_packages:
+                return False
             return name in RUNTIME_DEPENDENCY_REMOVE_NAMES or (
                 name == "typing-extensions"
             )
@@ -288,29 +353,6 @@ class PythonPackageTomlFile(TomlFile):
         deps_arr.extend(filtered)
         toml_sort_string_array(deps_arr)
 
-        # normalize attrs/cattrs
-        normalized = []
-        for it in list(deps_arr):
-            base = package_normalize_name(toml_get_string_value(it).strip())
-            if base == "attrs":
-                normalized.append("attrs>=23.1.0")
-            elif base == "cattrs":
-                normalized.append("cattrs>=23.1.0")
-            else:
-                normalized.append(it)
-        if normalized:
-            deps_arr.clear()
-            deps_arr.extend(normalized)
-            toml_sort_string_array(deps_arr)
-
-        # ensure they are present
-        names = {package_normalize_name(toml_get_string_value(it)) for it in deps_arr}
-        if "attrs" not in names:
-            deps_arr.append("attrs>=23.1.0")
-        if "cattrs" not in names:
-            deps_arr.append("cattrs>=23.1.0")
-        toml_sort_string_array(deps_arr)
-
     def _normalize_toml_formatting(self, content: str) -> str:
         """Normalize TOML formatting:
         - No empty lines at the beginning
@@ -330,19 +372,6 @@ class PythonPackageTomlFile(TomlFile):
 
         return content
 
-    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
@@ -392,9 +421,21 @@ class PythonPackageTomlFile(TomlFile):
             "optional-dependencies",
         ]
 
+        # Define the desired order for keys within [tool]
+        tool_key_order = [
+            "setuptools",
+            "pdm",
+            "pytest",
+            "coverage",
+        ]
+
         # Reorder top-level sections
         self._reorder_dict_keys(content, section_order)
 
         # Reorder keys within [project] if it exists
         if "project" in content:
             self._reorder_dict_keys(content["project"], project_key_order)
+
+        # Reorder keys within [tool] if it exists
+        if "tool" in content:
+            self._reorder_dict_keys(content["tool"], tool_key_order)

{wexample_wex_addon_dev_python-0.0.53 → wexample_wex_addon_dev_python-0.0.60}/src/wexample_wex_addon_dev_python/resources/readme_templates/tests.md.j2

@@ -13,7 +13,7 @@ First, install the required testing dependencies:
 
 Run all tests with coverage:
 ```bash
-.venv/bin/python -m pytest --cov
+.venv/bin/python -m pytest --cov --cov-report=html
 ```
 
 ### Common Commands