common-python-tasks 0.8.0__py3-none-any.whl → 0.10.0__py3-none-any.whl

common_python_tasks/__init__.py

@@ -1,7 +1,7 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from typing import Sequence
+    from collections.abc import Sequence
 
 from poethepoet_tasks import TaskCollection
 
@@ -9,7 +9,8 @@ __all__ = ["TaskCollection"]
 
 
 def tasks(
-    include_tags: "Sequence[str] | None" = None, exclude_tags: "Sequence[str]" = tuple()
+    include_tags: "Sequence[str] | None" = None,
+    exclude_tags: "Sequence[str] | None" = None,
 ) -> dict:
     """Return the task collection filtered by the requested tags.
 
@@ -25,6 +26,9 @@ def tasks(
     if include_tags is None and not exclude_tags:
         include_tags = ("common",)
     elif include_tags is None:
-        include_tags = tuple()
+        include_tags = ()
+
+    if exclude_tags is None:
+        exclude_tags = ()
 
     return task_collection(include_tags=include_tags, exclude_tags=exclude_tags)

common_python_tasks/data/fastapi/compose-base.yml.j2

@@ -9,8 +9,7 @@ x-common-environment: &common-environment
 x-common-build-args: &common-build-args
   PACKAGE_NAME: ${PACKAGE_NAME}
   PYTHON_VERSION: ${PYTHON_VERSION}
-  PACKAGE_MANAGER: ${PACKAGE_MANAGER}
-  PACKAGE_MANAGER_VERSION: ${PACKAGE_MANAGER_VERSION}
+  UV_VERSION: ${UV_VERSION}
 
 services:
   api:

common_python_tasks/data/fastapi/compose-db.yml.j2

@@ -8,8 +8,7 @@ x-common-environment: &common-environment
 x-common-build-args: &common-build-args
   PACKAGE_NAME: ${PACKAGE_NAME}
   PYTHON_VERSION: ${PYTHON_VERSION}
-  PACKAGE_MANAGER: ${PACKAGE_MANAGER}
-  PACKAGE_MANAGER_VERSION: ${PACKAGE_MANAGER_VERSION}
+  UV_VERSION: ${UV_VERSION}
   WORKDIR_PATH: ${WORKDIR_PATH}
 
 services:

common_python_tasks/data/fastapi/compose-debug.yml.j2

@@ -22,7 +22,7 @@ services:
           path: ./src/${PACKAGE_UNDERSCORE_NAME}
           target: /${PACKAGE_UNDERSCORE_NAME}
         - action: rebuild
-          path: poetry.lock
+          path: uv.lock
     ports:
       - mode: ingress
         target: 5678

common_python_tasks/data/generic/.dockerignore

@@ -1,7 +1,7 @@
 *
 !dist/*.whl
 !pyproject.toml
-!poetry.lock
+!uv.lock
 !README.md
 !LICENSE
 

common_python_tasks/data/generic/Dockerfile.deps.j2

@@ -5,7 +5,12 @@
 ARG PYTHON_VERSION=3
 ARG PYTHON_VARIANT=slim
 
-FROM python:${PYTHON_VERSION}-${PYTHON_VARIANT} AS deps
+FROM python:${PYTHON_VERSION}${PYTHON_VARIANT:+-${PYTHON_VARIANT}} AS deps
+ARG PYTHON_VERSION
+ARG PYTHON_VARIANT
+
+LABEL org.opencontainers.image.base.name="python:${PYTHON_VERSION}${PYTHON_VARIANT:+-${PYTHON_VARIANT}}" \
+      org.opencontainers.image.python.variant="${PYTHON_VARIANT}"
 
 ARG CACHE_ID_SUFFIX
 RUN printf '%s' "$CACHE_ID_SUFFIX" >/tmp/.cache_id_suffix

common_python_tasks/data/generic/Dockerfile.j2

@@ -4,36 +4,12 @@
 # the latest. The `build-image` task passes the version properly here
 ARG PYTHON_VERSION=3
 # Variant for the runtime image, e.g. slim, alpine, etc.
-# See https://hub.docker.com/_/python for available variants
+# See https://hub.docker.com/_/python for available variants. Leave empty for no variant.
 ARG PYTHON_VARIANT=slim
-ARG WORKDIR_PATH=/workspace
-{% set package_manager = PACKAGE_MANAGER|default('poetry') %}
 
 FROM python:${PYTHON_VERSION} AS builder
 
 ARG PACKAGE_VERSION
-
-{% if package_manager == 'poetry' %}
-ARG POETRY_VERSION
-ARG POETRY_DYNAMIC_VERSIONING_PLUGIN_VERSION
-ARG POETRY_PLUGIN_EXPORT_VERSION
-
-# Bypass VCS-based version detection: use the host-computed version directly.
-# This avoids requiring a .git directory in the build context and prevents
-# false dirty-version detection from a partial working tree.
-ENV POETRY_DYNAMIC_VERSIONING_BYPASS=${PACKAGE_VERSION}
-
-# Install Poetry and required Poetry plugins for package build
-RUN --mount=type=cache,target=/root/.cache/pip,id=pip-cache{{ CACHE_ID_SUFFIX }} \
-    sh -c 'set -eu; \
-    poetry_spec="poetry"; \
-    if [ -n "${POETRY_VERSION:-}" ]; then poetry_spec="poetry==$POETRY_VERSION"; fi; \
-    dynamic_spec="poetry-dynamic-versioning[plugin]"; \
-    if [ -n "${POETRY_DYNAMIC_VERSIONING_PLUGIN_VERSION:-}" ]; then dynamic_spec="poetry-dynamic-versioning[plugin]==$POETRY_DYNAMIC_VERSIONING_PLUGIN_VERSION"; fi; \
-    export_spec="poetry-plugin-export"; \
-    if [ -n "${POETRY_PLUGIN_EXPORT_VERSION:-}" ]; then export_spec="poetry-plugin-export==$POETRY_PLUGIN_EXPORT_VERSION"; fi; \
-    pip install --root-user-action=ignore "$poetry_spec" "$dynamic_spec" "$export_spec"'
-{% else %}
 ARG UV_VERSION
 
 # Bypass VCS-based version detection: use the host-computed version directly.
@@ -48,7 +24,6 @@ RUN --mount=type=cache,target=/root/.cache/pip,id=pip-cache{{ CACHE_ID_SUFFIX }}
     else \
         pip install --root-user-action=ignore uv; \
     fi'
-{% endif %}
 
 # Build package
 WORKDIR /tmp/build
@@ -56,28 +31,27 @@ COPY . /tmp/build/
 
 {% if HAS_DEBUG_DEPS %}
 # Export debug requirements when the project defines a debug dependency group
-{% if package_manager == 'poetry' %}
-RUN --mount=type=cache,target=/root/.cache/pip,id=pip-cache{{ CACHE_ID_SUFFIX }} \
-    poetry export --only debug --without-hashes -f requirements.txt --output requirements-debug.txt
-{% else %}
-RUN --mount=type=cache,target=/root/.cache/uv,id=uv-cache{{ CACHE_ID_SUFFIX }} \
+RUN --mount=type=cache,target=/root/.cache/uv,id=uv-cache{{ CACHE_ID_SUFFIX }}{% for mount in UV_INDEX_SECRET_MOUNTS %} \
+    --mount={{ mount }}{% endfor %} \
     uv export --group debug --no-hashes --format requirements-txt --output-file requirements-debug.txt
 {% endif %}
-{% endif %}
 
-# Build the wheel, caching the package-manager cache directory to speed up subsequent builds.
+# Build the wheel, caching the uv cache directory to speed up subsequent builds.
 # If running this in a CI system, you must be using a persistent builder to take
 # advantage of the cache mount, and you should configure your CI to persist the
 # cache directory between builds
-{% if package_manager == 'poetry' %}
-RUN --mount=type=cache,target=/root/.cache/pypoetry,id=pypoetry-cache{{ CACHE_ID_SUFFIX }} poetry build --format=wheel
-{% else %}
-RUN --mount=type=cache,target=/root/.cache/uv,id=uv-cache{{ CACHE_ID_SUFFIX }} uv build --wheel
-{% endif %}
+RUN --mount=type=cache,target=/root/.cache/uv,id=uv-cache{{ CACHE_ID_SUFFIX }}{% for mount in UV_INDEX_SECRET_MOUNTS %} \
+    --mount={{ mount }}{% endfor %} \
+    uv build --wheel
 
-FROM python:${PYTHON_VERSION}-${PYTHON_VARIANT} AS runtime
+FROM python:${PYTHON_VERSION}${PYTHON_VARIANT:+-${PYTHON_VARIANT}} AS runtime
+ARG PYTHON_VERSION
+ARG PYTHON_VARIANT
 ARG WORKDIR_PATH=/workspace
 
+LABEL org.opencontainers.image.base.name="python:${PYTHON_VERSION}${PYTHON_VARIANT:+-${PYTHON_VARIANT}}" \
+      org.opencontainers.image.python.variant="${PYTHON_VARIANT}"
+
 ENV PYTHONUNBUFFERED=1
 ENV PYTHONDONTWRITEBYTECODE=1
 

common_python_tasks/data/generic/ruff.toml

@@ -1,2 +1,2 @@
 line-length = 88
-extend-exclude = [".dist", ".poetry", "build"]
+extend-exclude = [".dist", "build"]

common_python_tasks/docker.py

@@ -3,14 +3,14 @@ import logging
 import platform
 import re
 import tempfile
+from collections.abc import Sequence
 from dataclasses import dataclass
 from enum import IntEnum, StrEnum
 from pathlib import Path
 from shlex import quote
-from typing import Sequence
 
 from . import git, project, utils
-from .env import get_cache_id_suffix, get_workdir_path
+from .env import get_cache_id_suffix, get_python_variant, get_workdir_path
 
 LOGGER = logging.getLogger(__name__)
 
@@ -289,37 +289,17 @@ def render_build_image(
             commit_tag = version_tag
 
         python_version = platform.python_version()
-        package_manager = project.get_package_manager()
-        package_manager_version = project.get_package_manager_version(package_manager)
-
-        manager_build_args: dict[str, str | None]
-        if package_manager == project.PackageManager.POETRY:
-            manager_build_args = {
-                "POETRY_VERSION": package_manager_version,
-                "POETRY_DYNAMIC_VERSIONING_PLUGIN_VERSION": project.get_installed_requirement_version(
-                    "poetry-dynamic-versioning[plugin]"
-                ),
-                "POETRY_PLUGIN_EXPORT_VERSION": project.get_installed_requirement_version(
-                    "poetry-plugin-export"
-                ),
-            }
-        else:
-            manager_build_args = {
-                "UV_VERSION": package_manager_version,
-            }
 
         build_args = _merge_build_args(
             {
                 "PYTHON_VERSION": python_version,
-                "PACKAGE_MANAGER": package_manager,
-                "PACKAGE_MANAGER_VERSION": package_manager_version,
+                "UV_VERSION": project.get_uv_version(),
                 "PACKAGE_VERSION": package_version,
                 "PACKAGE_NAME": utils.get_package_name(use_underscores=True),
                 "AUTHORS": ",".join(
                     [f"{name} <{email}>" for name, email in project.get_authors()]
                 ),
                 "GIT_COMMIT": commit_tag,
-                **manager_build_args,
             },
             extra_build_args,
         )
@@ -580,7 +560,10 @@ def build_deps_image(
     archs = _resolve_archs(single_arch)
 
     build_args = _merge_build_args(
-        {"PYTHON_VERSION": python_version},
+        {
+            "PYTHON_VERSION": python_version,
+            "PYTHON_VARIANT": get_python_variant(),
+        },
         extra_build_args,
     )
     if cache_id_suffix:

common_python_tasks/docker_compose.py

@@ -5,16 +5,17 @@ import logging
 import os
 import platform
 import tempfile
+from collections.abc import Sequence
 from pathlib import Path
 from shlex import quote
-from typing import NoReturn, Sequence
+from typing import NoReturn
 
 from jinja2 import Template
 from poethepoet_tasks import TaskCollection
 
 from . import utils
 from .env import get_workdir_path
-from .project import get_package_manager, get_package_manager_version
+from .project import get_uv_version
 
 LOGGER = logging.getLogger(__name__)
 
@@ -113,16 +114,15 @@ def render_file(
         if extra_template_vars:
             template_vars.update(extra_template_vars)
         rendered = Template(path_obj.read_text()).render(**template_vars)
-        tf = tempfile.NamedTemporaryFile(
+        with tempfile.NamedTemporaryFile(
             mode="w",
             encoding="utf-8",
             delete=False,
             prefix=path_obj.stem + ".",
             suffix=suffix,
-        )
-        temp_path = Path(tf.name)
-        tf.write(rendered)
-        tf.close()
+        ) as temp_file:
+            temp_path = Path(temp_file.name)
+            temp_file.write(rendered)
         return temp_path, True
 
     return path_obj, False
@@ -154,7 +154,7 @@ def read_dotenv(path: Path, error_on_fail: bool = False) -> dict[str, str]:
             value = value.strip().strip('"').strip("'")
             if key:
                 env[key] = value
-    except Exception as exc:
+    except (OSError, UnicodeError) as exc:
         if error_on_fail:
             utils.fatal(f"Failed to parse .env file {path}: {exc}")
         else:
@@ -169,9 +169,9 @@ def append_dotenv(path: Path, items: dict[str, str]) -> None:
         path: Path to the `.env` file.
         items: Environment variables to append to the file.
     """
-    from datetime import datetime
+    from datetime import UTC, datetime
 
-    header = f"\n# Auto-generated by common_python_tasks on {datetime.now().isoformat(timespec='seconds')}\n"
+    header = f"\n# Auto-generated by common_python_tasks on {datetime.now(UTC).astimezone().isoformat(timespec='seconds')}\n"
     with path.open("a", encoding="utf-8") as f:
         f.write(header)
         for k, v in items.items():
@@ -214,7 +214,7 @@ def get_or_generate_secret(
     try:
         append_dotenv(dotenv_path, {key_name: token})
         LOGGER.info("Generated %s and stored it in .env", key_name)
-    except Exception as exc:
+    except OSError as exc:
         LOGGER.warning(
             "Failed to persist %s to .env (%s); using in-memory only", key_name, exc
         )
@@ -239,8 +239,7 @@ _COMPOSE_VAR_REQUIREMENTS: dict[str, dict[str, set[str]]] = {
             "ENVIRONMENT",
             "IMAGE_TAG",
             "PYTHON_VERSION",
-            "PACKAGE_MANAGER",
-            "PACKAGE_MANAGER_VERSION",
+            "UV_VERSION",
         },
         "compose-db": {
             "PACKAGE_NAME",
@@ -250,8 +249,7 @@ _COMPOSE_VAR_REQUIREMENTS: dict[str, dict[str, set[str]]] = {
             "DB_PORT",
             "IMAGE_TAG",
             "PYTHON_VERSION",
-            "PACKAGE_MANAGER",
-            "PACKAGE_MANAGER_VERSION",
+            "UV_VERSION",
             "POSTGRES_VERSION",
             "WORKDIR_PATH",
         },
@@ -337,13 +335,12 @@ def get_compose_env(
         "ENVIRONMENT": os.getenv("ENVIRONMENT", "production"),
         "IMAGE_TAG": image_tag or "latest",
         "PACKAGE_NAME": package_name,
-        "PACKAGE_MANAGER": get_package_manager(),
-        "PACKAGE_MANAGER_VERSION": get_package_manager_version(),
         "PACKAGE_UNDERSCORE_NAME": utils.package_name_to_underscore(package_name),
         "WORKDIR_PATH": get_workdir_path(),
         "POSTGRES_VERSION": os.getenv("POSTGRES_VERSION", "17"),
         "PYTHON_VERSION": platform.python_version(),
         "SECRET_KEY": os.getenv("SECRET_KEY", ""),
+        "UV_VERSION": get_uv_version(),
     }
 
     if compose_type and compose_files:
@@ -593,14 +590,14 @@ def build_exec_script(
     Returns:
         Absolute path to the temporary script file.
     """
-    script_fd = tempfile.NamedTemporaryFile(
+    with tempfile.NamedTemporaryFile(
         mode="w",
         encoding="utf-8",
         delete=False,
         prefix="compose-exec.",
         suffix=".sh",
-    )
-    script_path = Path(script_fd.name)
+    ) as temp_file:
+        script_path = Path(temp_file.name)
     script_path_str = str(script_path.resolve())
 
     lines = [

common_python_tasks/env.py

@@ -1,5 +1,6 @@
 import logging
 import os
+import re
 import secrets
 import shlex
 from pathlib import Path
@@ -21,6 +22,82 @@ TRUTHY_VALUES = {
 WORKDIR_PATH_ENV_VAR = "WORKDIR_PATH"
 WORKDIR_PATH_DEFAULT = "/workspace"
 _AUTO_INJECTED_BUILD_ARG_ENV_VARS = (WORKDIR_PATH_ENV_VAR,)
+_UV_INDEX_CREDENTIAL_PATTERN = re.compile(r"^UV_INDEX_(.+)_(USERNAME|PASSWORD)$")
+
+
+def collect_uv_index_credentials() -> list[dict[str, str | None]]:
+    """Collect present `UV_INDEX_{name}_{USERNAME,PASSWORD}` host env vars.
+
+    Returns:
+        A list of dicts with keys `index_name`, `username_env`, and
+        `password_env`. Only indices with at least one credential set are
+        included, sorted by index name.
+    """
+    found = {}
+    for key in os.environ:
+        match = _UV_INDEX_CREDENTIAL_PATTERN.match(key)
+        if match:
+            found.setdefault(match.group(1), set()).add(match.group(2))
+
+    return [
+        {
+            "index_name": name,
+            "username_env": f"UV_INDEX_{name}_USERNAME"
+            if "USERNAME" in found[name]
+            else None,
+            "password_env": f"UV_INDEX_{name}_PASSWORD"
+            if "PASSWORD" in found[name]
+            else None,
+        }
+        for name in sorted(found)
+    ]
+
+
+def uv_index_secret_mounts(credentials: list[dict[str, str | None]]) -> list[str]:
+    """Return Dockerfile ``--mount`` strings for UV index credentials.
+
+    Args:
+        credentials: Output of `collect_uv_index_credentials`.
+
+    Returns:
+        A list of ``type=secret,...`` strings for Dockerfile ``RUN --mount=``
+        directives.
+    """
+    mounts = []
+    for cred in credentials:
+        name = cred["index_name"].lower()
+        if cred["username_env"]:
+            mounts.append(
+                f"type=secret,id=uv_index_{name}_username,env={cred['username_env']}"
+            )
+        if cred["password_env"]:
+            mounts.append(
+                f"type=secret,id=uv_index_{name}_password,env={cred['password_env']}"
+            )
+    return mounts
+
+
+def uv_index_secret_build_args(credentials: list[dict[str, str | None]]) -> list[str]:
+    """Return ``docker build --secret`` arg pairs for UV index credentials.
+
+    Args:
+        credentials: Output of `collect_uv_index_credentials`.
+
+    Returns:
+        A flat list of ``--secret`` flag-value pairs for the docker build command.
+    """
+    args = []
+    for cred in credentials:
+        name = cred["index_name"].lower()
+        if cred["username_env"]:
+            args.extend(
+                ["--secret", f"id=uv_index_{name}_username,env={cred['username_env']}"]
+            )
+        if cred["password_env"]:
+            args.extend(
+                ["--secret", f"id=uv_index_{name}_password,env={cred['password_env']}"]
+            )
+    return args
 
 
 def env_truthy(env_var: str) -> bool:
@@ -44,6 +121,16 @@ def get_workdir_path() -> str:
     return os.getenv(WORKDIR_PATH_ENV_VAR, WORKDIR_PATH_DEFAULT)
 
 
+def get_python_variant() -> str:
+    """Return the Python image variant for container builds.
+
+    Returns:
+        The variant from `CONTAINER_PYTHON_VARIANT`, or 'slim' by default.
+        An empty string disables the variant (e.g., `FROM python:3.11`).
+    """
+    return os.getenv("CONTAINER_PYTHON_VARIANT", "slim").strip()
+
+
 def inject_auto_build_args_from_env(
     build_args: dict[str, str] | None,
 ) -> dict[str, str]:
@@ -454,7 +541,7 @@ def render_container_deps_move_script(mappings: dict[str, str]) -> str:
         "import shutil",
         "import sys",
         "",
-        f"mappings = {repr(mappings)}",
+        f"mappings = {mappings!r}",
         'source_root = pathlib.Path("/tmp/deps")',
         "",
         "for name, dest in mappings.items():",
@@ -523,7 +610,7 @@ def get_prune_keep() -> int:
         return -1
     try:
         return int(raw)
-    except Exception:
+    except ValueError:
         LOGGER.warning(
             "Invalid CONTAINER_PRUNE_KEEP value '%s' - defaulting to -1 (no prune)",
             raw,

common_python_tasks/git.py

@@ -178,13 +178,13 @@ def infer_bump_component_from_git_cliff() -> ReleaseComponent:
     normalized_version = version_text.lstrip("v")
     try:
         bumped = Version.parse(normalized_version)
-    except Exception:
+    except ValueError:
         utils.fatal(f"Unable to parse bumped version from git-cliff: {version_text!r}")
 
     current_version = project.get_project_version()
     try:
         current = Version.parse(current_version)
-    except Exception:
+    except ValueError:
         utils.fatal(f"Unable to parse current project version: {current_version!r}")
 
     def _parse_semver(version_value: str | Any) -> tuple[int, int, int]:

common_python_tasks/github.py

@@ -28,6 +28,18 @@ def _is_unreleased_placeholder(notes: str) -> bool:
     return normalized in {"[unreleased]", "## [unreleased]", "## unreleased"}
 
 
+def _pattern_targets_hidden_paths(pattern: str) -> bool:
+    return any(
+        part.startswith(".")
+        for part in pattern.split("/")
+        if part and part not in {".", ".."}
+    )
+
+
+def _path_has_hidden_segment(path: Path) -> bool:
+    return any(part.startswith(".") for part in path.parts if part not in {".", ".."})
+
+
 def _latest_tagged_changelog() -> str | None:
     result = utils.run_git_cliff(["--latest"], capture_output=True)
     changelog = result.stdout.strip()
@@ -538,6 +550,8 @@ def get_github_release_asset_paths(
             interpreted as colon-separated paths or glob patterns.
             If not provided, the default value is `dist/*`. An empty list
             explicitly disables asset selection.
+            Wildcard patterns only include hidden files when the pattern itself
+            explicitly targets hidden paths (for example, `dist/.*`).
 
     Returns:
         A sorted list of existing asset paths.
@@ -561,9 +575,14 @@ def get_github_release_asset_paths(
     asset_paths = []
     for part in source_items:
         if any(char in part for char in "*?[]"):
+            matches = [path for path in Path(".").glob(part) if path.is_file()]
+            if not _pattern_targets_hidden_paths(part):
+                matches = [
+                    path for path in matches if not _path_has_hidden_segment(path)
+                ]
             asset_paths.extend(
                 sorted(
-                    [path for path in Path(".").glob(part) if path.is_file()],
+                    matches,
                     key=lambda p: str(p),
                 )
             )