wexample-wex-addon-dev-python 0.0.49__py3-none-any.whl → 0.0.60__py3-none-any.whl

wexample_wex_addon_dev_python/config_value/python_package_readme_config_value.py

@@ -21,41 +21,8 @@ class PythonPackageReadmeContentConfigValue(ReadmeContentConfigValue):
     )
 
     def get_templates(self) -> list[str] | None:
-        # Use TOMLDocument from the workdir
-        doc = self.workdir.get_project_config()
-        project = doc.get("project", {}) if isinstance(doc, dict) else {}
-
-        # Extract information
-        description = project.get("description", "")
-        python_version = project.get("requires-python", "")
-        dependencies = project.get("dependencies", [])
-        urls = (
-            project.get("urls", {}) if isinstance(project.get("urls", {}), dict) else {}
-        )
-        # Accept both lowercase and capitalized homepage key variants
-        homepage = urls.get("homepage") or urls.get("Homepage") or ""
-        license_field = project.get("license", {})
-        if isinstance(license_field, dict):
-            license_info = license_field.get("text", "") or license_field.get(
-                "file", ""
-            )
-        else:
-            license_info = str(license_field) if license_field else ""
-
-        # Format dependencies list
-        deps_list = "\n".join([f"- {dep}" for dep in dependencies])
-
         # Prepare context for Jinja2 rendering
-        context = {
-            "package_name": self.workdir.get_package_name(),
-            "version": self.workdir.get_project_version(),
-            "description": description,
-            "python_version": python_version,
-            "dependencies": dependencies,
-            "deps_list": deps_list,
-            "homepage": homepage,
-            "license_info": license_info,
-        }
+        context = self._get_template_context()
 
         # Define fixed order of README sections
         section_names = [
@@ -118,6 +85,43 @@ class PythonPackageReadmeContentConfigValue(ReadmeContentConfigValue):
 
         return [rendered_content]
 
+    def _get_template_context(self) -> dict:
+        # Use TOMLDocument from the workdir
+        doc = self.workdir.get_project_config()
+        project = doc.get("project", {}) if isinstance(doc, dict) else {}
+
+        # Extract information
+        description = project.get("description", "")
+        python_version = project.get("requires-python", "")
+        dependencies = project.get("dependencies", [])
+        urls = (
+            project.get("urls", {}) if isinstance(project.get("urls", {}), dict) else {}
+        )
+        # Accept both lowercase and capitalized homepage key variants
+        homepage = urls.get("homepage") or urls.get("Homepage") or ""
+        license_field = project.get("license", {})
+        if isinstance(license_field, dict):
+            license_info = license_field.get("text", "") or license_field.get(
+                "file", ""
+            )
+        else:
+            license_info = str(license_field) if license_field else ""
+
+        # Format dependencies list
+        deps_list = "\n".join([f"- {dep}" for dep in dependencies])
+
+        return {
+            "package_name": self.workdir.get_package_name(),
+            "version": self.workdir.get_project_version(),
+            "description": description,
+            "python_version": python_version,
+            "dependencies": dependencies,
+            "deps_list": deps_list,
+            "homepage": homepage,
+            "license_info": license_info,
+            "workdir": self.workdir,
+        }
+
     def _render_readme_section(self, section_name: str, context: dict) -> str | None:
         """
         Render a README section from .md or .md.j2 file with Jinja2 support.
@@ -137,6 +141,7 @@ class PythonPackageReadmeContentConfigValue(ReadmeContentConfigValue):
             Rendered content or None if section file not found
         """
         from pathlib import Path
+
         from jinja2 import Environment, FileSystemLoader, TemplateNotFound
         from wexample_app.const.globals import WORKDIR_SETUP_DIR
 
@@ -201,6 +206,7 @@ class PythonPackageReadmeContentConfigValue(ReadmeContentConfigValue):
             True if section file exists, False otherwise
         """
         from pathlib import Path
+
         from wexample_app.const.globals import WORKDIR_SETUP_DIR
 
         workdir_path = self.workdir.get_path()

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/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:
@@ -268,6 +318,7 @@ class PythonPackageTomlFile(TomlFile):
             toml_get_string_value,
             toml_sort_string_array,
         )
+
         from wexample_wex_addon_dev_python.const.package import (
             RUNTIME_DEPENDENCY_REMOVE_NAMES,
         )
@@ -275,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"
             )
@@ -287,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
@@ -329,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
@@ -391,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/resources/readme_templates/tests.md.j2

@@ -0,0 +1,48 @@
+## Tests
+
+This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
+
+### Installation
+
+First, install the required testing dependencies:
+```bash
+.venv/bin/python -m pip install pytest pytest-cov
+```
+
+### Basic Usage
+
+Run all tests with coverage:
+```bash
+.venv/bin/python -m pytest --cov --cov-report=html
+```
+
+### Common Commands
+```bash
+# Run tests with coverage for a specific module
+.venv/bin/python -m pytest --cov=your_module
+
+# Show which lines are not covered
+.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
+
+# Generate an HTML coverage report
+.venv/bin/python -m pytest --cov=your_module --cov-report=html
+
+# Combine terminal and HTML reports
+.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
+
+# Run specific test file with coverage
+.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
+```
+
+### Viewing HTML Reports
+
+After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
+
+### Coverage Threshold
+
+To enforce a minimum coverage percentage:
+```bash
+.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
+```
+
+This will cause the test suite to fail if coverage drops below 80%.