wexample-wex-addon-dev-python 15.2.1__tar.gz → 15.3.1__tar.gz

wexample_wex_addon_dev_python-15.3.1/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.1
+Name: wexample-wex-addon-dev-python
+Version: 15.3.1
+Summary: Extends wex with commands to format, lint, and rename Python symbols, plus workdir types for Python packages and suites
+Author-Email: weeger <contact@wexample.com>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Project-URL: homepage, https://github.com/wexample/python-wex-dev-python
+Requires-Python: >=3.10
+Requires-Dist: attrs>=23.1.0
+Requires-Dist: black
+Requires-Dist: cattrs>=23.1.0
+Requires-Dist: griffe>=2.0.2
+Requires-Dist: isort
+Requires-Dist: networkx
+Requires-Dist: pylint
+Requires-Dist: pyright
+Requires-Dist: wexample-api>=6.8.0
+Requires-Dist: wexample-filestate-python>=9.1.4
+Requires-Dist: wexample-wex-addon-ai>=19.0.2
+Requires-Dist: wexample-wex-addon-app>=34.2.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Description-Content-Type: text/markdown
+
+# wex_addon_dev_python
+
+Version: 15.3.1
+
+Extends wex with commands to format, lint, and rename Python symbols, plus workdir types for Python packages and suites
+
+## Table of Contents
+
+- [Install](#install)
+- [Tests](#tests)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+
+## Installation
+
+```bash
+pip install wexample-wex-addon-dev-python
+```
+
+Requires Python >=3.10.
+
+## 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%.
+
+## Known Limitations & Roadmap
+
+Current limitations and planned features are tracked in the GitHub issues.
+
+See the [project roadmap](https://github.com/wexample/python-wex_addon_dev_python/issues) for upcoming features and improvements.
+
+## Status & Compatibility
+
+**Maturity**: Production-ready
+
+**Python Support**: >=3.10
+
+**OS Support**: Linux, macOS, Windows
+
+**Status**: Actively maintained
+
+## Useful Links
+
+- **Homepage**: https://github.com/wexample/python-wex-addon-dev-python
+- **Issue Tracker**: https://github.com/wexample/python-wex-addon-dev-python/issues
+- **Discussions**: https://github.com/wexample/python-wex-addon-dev-python/discussions
+- **PyPI**: [pypi.org/project/wexample-wex-addon-dev-python](https://pypi.org/project/wexample-wex-addon-dev-python/)

wexample_wex_addon_dev_python-15.3.1/README.md

@@ -0,0 +1,93 @@
+# wex_addon_dev_python
+
+Version: 15.3.1
+
+Extends wex with commands to format, lint, and rename Python symbols, plus workdir types for Python packages and suites
+
+## Table of Contents
+
+- [Install](#install)
+- [Tests](#tests)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+
+## Installation
+
+```bash
+pip install wexample-wex-addon-dev-python
+```
+
+Requires Python >=3.10.
+
+## 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%.
+
+## Known Limitations & Roadmap
+
+Current limitations and planned features are tracked in the GitHub issues.
+
+See the [project roadmap](https://github.com/wexample/python-wex_addon_dev_python/issues) for upcoming features and improvements.
+
+## Status & Compatibility
+
+**Maturity**: Production-ready
+
+**Python Support**: >=3.10
+
+**OS Support**: Linux, macOS, Windows
+
+**Status**: Actively maintained
+
+## Useful Links
+
+- **Homepage**: https://github.com/wexample/python-wex-addon-dev-python
+- **Issue Tracker**: https://github.com/wexample/python-wex-addon-dev-python/issues
+- **Discussions**: https://github.com/wexample/python-wex-addon-dev-python/discussions
+- **PyPI**: [pypi.org/project/wexample-wex-addon-dev-python](https://pypi.org/project/wexample-wex-addon-dev-python/)

{wexample_wex_addon_dev_python-15.2.1 → wexample_wex_addon_dev_python-15.3.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
 
 [project]
 name = "wexample-wex-addon-dev-python"
-version = "15.2.1"
+version = "15.3.1"
 description = "Extends wex with commands to format, lint, and rename Python symbols, plus workdir types for Python packages and suites"
 authors = [
     { name = "weeger", email = "contact@wexample.com" },
@@ -27,9 +27,9 @@ dependencies = [
     "pylint",
     "pyright",
     "wexample-api>=6.8.0",
-    "wexample-filestate-python>=9.1.0",
-    "wexample-wex-addon-ai>=19.0.0",
-    "wexample-wex-addon-app>=34.0.0",
+    "wexample-filestate-python>=9.1.4",
+    "wexample-wex-addon-ai>=19.0.2",
+    "wexample-wex-addon-app>=34.2.0",
 ]
 
 [project.readme]

{wexample_wex_addon_dev_python-15.2.1 → wexample_wex_addon_dev_python-15.3.1}/src/wexample_wex_addon_dev_python/common/pypi_registry_gateway.py

@@ -39,12 +39,22 @@ class PypiRegistryGateway(AbstractGateway):
     def has_version(self, package: str, version: str) -> bool:
         """Return True iff `package==version` is published on this index.
 
-        Uses the PEP 503 Simple index and matches the version string against
-        the HTML body. Returns False on 404 (unknown package, or version not
-        yet propagated through the registry's CDN).
+        Uses the Simple index and matches the version string against its
+        body. Returns False on 404 (unknown package, or version not yet
+        propagated through the registry's CDN).
+
+        Asked for exactly as pip asks for it: PyPI's CDN caches each
+        representation of the page apart, and they do not refresh together.
+        The gzipped HTML one stayed without a release for over ten minutes
+        after pip's JSON one listed it, so a check reading the former waited
+        on a version pip could already install.
         """
         response = self.make_request(
             endpoint=f"simple/{package}/",
+            headers={
+                "Accept": "application/vnd.pypi.simple.v1+json, "
+                "application/vnd.pypi.simple.v1+html; q=0.1, text/html; q=0.01",
+            },
             expected_status_codes=_HAS_VERSION_STATUS_CODES,
             fatal_if_unexpected=False,
             quiet=True,

wexample_wex_addon_dev_python-15.3.1/src/wexample_wex_addon_dev_python/resources/package_gitlab_ci.yml

@@ -0,0 +1,4 @@
+include:
+  - remote: 'https://gitlab.wexample.com/wexample-public/ci-cd/-/raw/main/.gitlab-ci.type.python.package.yml'
+variables:
+  MAIN_BRANCH_NAME: main

{wexample_wex_addon_dev_python-15.2.1 → wexample_wex_addon_dev_python-15.3.1}/src/wexample_wex_addon_dev_python/workdir/python_package_workdir.py

@@ -58,6 +58,18 @@ class PythonPackageWorkdir(PythonWorkdir):
                 "Install: pipx install pdm — then run: wex core::env/configure"
             )
 
+    def get_gitlab_registry_url(self) -> str | None:
+        """The GitLab PyPI registry of the group, when the suite publishes there.
+
+        `python.gitlab_registry.url`, the group's endpoint without `/simple`:
+        `https://gitlab.example.com/api/v4/groups/<group>/-/packages/pypi`.
+        Installs read its `/simple` index; each package uploads to its own
+        project's registry, which the group one gathers.
+        """
+        return self.search_app_or_suite_runtime_config(
+            "python.gitlab_registry.url", default=None
+        ).get_str_or_none()
+
     def get_required_knowledge_pages(self) -> dict[str, str]:
         return {
             **super().get_required_knowledge_pages(),
@@ -77,22 +89,28 @@ class PythonPackageWorkdir(PythonWorkdir):
         raw_value = super().prepare_value(raw_value=raw_value)
         children = raw_value.get("children")
 
-        # Add .gitlab-ci.yml for private GitLab registry packages.
-        # Both callbacks are evaluated after configure() completes, so base_name
-        # and runtime config are fully available at that point.
+        # Every package is tested by GitLab at each push, the way a consumer
+        # installs it: the file only includes the job, which lives in the ci-cd
+        # repository. A package published to the private GitLab registry gets
+        # the job publishing it on a tag instead, and no tests: the base
+        # template's workflow runs no tag pipeline. Created when absent, never
+        # rewritten. The callback is evaluated after configure() completes, so
+        # the runtime config is available at that point.
         children.append(
             {
                 "name": ".gitlab-ci.yml",
                 "type": DiskItemType.FILE,
-                "should_exist": lambda _target, _self=self: bool(
-                    _self.search_app_or_suite_runtime_config(
-                        "pdm.repository.url", default=None
-                    ).get_str_or_none()
-                ),
-                "default_content": lambda _: file_read(
+                "should_exist": True,
+                "default_content": lambda _, _self=self: file_read(
                     module_get_path(wexample_wex_addon_dev_python)
                     / "resources"
-                    / "package_publish_gitlab.yml"
+                    / (
+                        "package_publish_gitlab.yml"
+                        if _self.search_app_or_suite_runtime_config(
+                            "pdm.repository.url", default=None
+                        ).get_str_or_none()
+                        else "package_gitlab_ci.yml"
+                    )
                 ),
             }
         )
@@ -414,8 +432,9 @@ class PythonPackageWorkdir(PythonWorkdir):
         self.push_to_deployment_remote(branch_name=GIT_BRANCH_MAIN)
 
     def _publish(self, force: bool = False) -> None:
-        from wexample_filestate_python.common.pipy_gateway import PipyGateway
-        from wexample_helpers.helper.shell import shell_run
+        from wexample_helpers.exception.shell_command_failed_exception import (
+            ShellCommandFailedException,
+        )
         from wexample_helpers_git.helper.git import (
             git_push_tag,
             git_tag_annotated,
@@ -443,10 +462,75 @@ class PythonPackageWorkdir(PythonWorkdir):
             git_push_tag(tag, cwd=cwd, remote=remote, inherit_stdio=True)
             return
 
-        # TODO: align public PyPI packages with the private registry approach — publish
-        #       via a GitLab CI pipeline triggered by a git tag rather than running
-        #       `pdm publish` locally.
-        # PyPI public: publish locally
+        # Our own registry first, where the release counts: what installs read
+        # (wex, the apps) and what the publication waits for. PyPI then only
+        # mirrors it, and a refusal there no longer stops the suite.
+        if self.get_gitlab_registry_url():
+            self._publish_to_gitlab_registry(force=force)
+            try:
+                self._publish_to_pypi(force=force)
+            except ShellCommandFailedException as exception:
+                self.warning(
+                    f"PyPI refused {package_name} {version}, published on the GitLab "
+                    f"registry all the same: {exception}"
+                )
+            return
+
+        self._publish_to_pypi(force=force)
+
+    def _publish_to_gitlab_registry(self, force: bool = False) -> None:
+        import re
+        from urllib.parse import quote
+
+        from wexample_helpers.helper.shell import shell_run
+        from wexample_helpers_git.helper.git import git_get_remote_url
+
+        from wexample_wex_addon_dev_python.common.pypi_registry_gateway import (
+            PypiRegistryGateway,
+        )
+
+        package_name = self.get_package_name()
+        version = self.get_setup_version()
+        registry_url = self.get_gitlab_registry_url()
+
+        index = PypiRegistryGateway(base_url=registry_url, io=self.io, timeout=10)
+        if index.has_version(package_name, version) and not force:
+            self.log(f"{package_name} {version} is already on the GitLab registry.")
+            return
+
+        # The project is the package's origin: ssh://git@host:port/<group>/<name>.git
+        project_path = re.sub(
+            r"^(ssh://[^/]+/|git@[^:]+:|https?://[^/]+/)",
+            "",
+            git_get_remote_url(cwd=self.get_path()),
+        ).removesuffix(".git")
+        project = quote(project_path, safe="")
+        api_url = registry_url.split("/groups/", 1)[0]
+
+        self.subtitle("Publishing to the GitLab registry")
+        shell_run(
+            [
+                "pdm",
+                "publish",
+                "--repository",
+                f"{api_url}/projects/{project}/packages/pypi",
+                # GitLab authenticates the token alone; the name is required, not read.
+                "--username",
+                "__token__",
+                "--password",
+                self.get_env_parameter_or_suite_fallback("GITLAB_API_TOKEN"),
+            ],
+            inherit_stdio=True,
+            cwd=self.get_path(),
+        )
+
+    def _publish_to_pypi(self, force: bool = False) -> None:
+        from wexample_filestate_python.common.pipy_gateway import PipyGateway
+        from wexample_helpers.helper.shell import shell_run
+
+        package_name = self.get_package_name()
+        version = self.get_setup_version()
+
         client = PipyGateway(parent_io_handler=self)
         if client.package_release_exists(package_name=package_name, version=version):
             self.warning(
@@ -487,8 +571,12 @@ class PythonPackageWorkdir(PythonWorkdir):
             PypiRegistryGateway,
         )
 
+        # The GitLab registry, when the suite publishes there, is what installs
+        # read: it serves a version as soon as it is uploaded, where PyPI's CDN
+        # can lag for many minutes.
         repository_url = (
-            self.search_app_or_suite_runtime_config(
+            self.get_gitlab_registry_url()
+            or self.search_app_or_suite_runtime_config(
                 "pdm.repository.url", default=None
             ).get_str_or_none()
             or "https://pypi.org"

{wexample_wex_addon_dev_python-15.2.1 → wexample_wex_addon_dev_python-15.3.1}/src/wexample_wex_addon_dev_python/workdir/python_workdir.py

@@ -476,6 +476,23 @@ class PythonWorkdir(
 
         pyproject_path = self.get_path() / "pyproject.toml"
 
+        # The suite's GitLab registry beside PyPI: the wexample packages are
+        # there first. Written into requirements.txt, so `pip install -r` reads
+        # it too. Best match across both, as pip does: a package published
+        # before the registry existed is only on PyPI.
+        index_arguments: list[str] = []
+        registry_url = self.search_app_or_suite_runtime_config(
+            "python.gitlab_registry.url", default=None
+        ).get_str_or_none()
+        if registry_url:
+            index_arguments = [
+                "--extra-index-url",
+                f"{registry_url}/simple",
+                "--index-strategy",
+                "unsafe-best-match",
+                "--emit-index-url",
+            ]
+
         def _run_uv_compile() -> None:
             result = subprocess.run(
                 [
@@ -494,6 +511,7 @@ class PythonWorkdir(
                     # long as they satisfy constraints — causing stale
                     # transitives even after their direct dependents bumped.
                     "--upgrade",
+                    *index_arguments,
                 ],
                 capture_output=True,
                 text=True,