common-python-tasks 0.12.1__py3-none-any.whl → 0.13.0__py3-none-any.whl

common_python_tasks/docker.py

@@ -100,7 +100,7 @@ def _build_docker_build_command(
     plain: bool,
     target: BuildStage | None = None,
     tags: Sequence[str] | None = None,
-    docker_build_args: Sequence[str] | None = None,
+    docker_build_options: Sequence[str] | None = None,
 ) -> list[str]:
     build_cmd = [
         "docker",
@@ -123,8 +123,8 @@ def _build_docker_build_command(
             build_cmd += ["-t", tag]
     if plain:
         build_cmd += ["--progress", "plain"]
-    if docker_build_args:
-        build_cmd += [str(arg) for arg in docker_build_args]
+    if docker_build_options:
+        build_cmd += [str(option) for option in docker_build_options]
     build_cmd.append(str(context_path))
 
     return build_cmd
@@ -180,7 +180,7 @@ def render_build_image(
     omit_target: bool = False,
     image_name: str | None = None,
     extra_build_args: dict[str, str] | None = None,
-    docker_build_args: Sequence[str] | None = None,
+    docker_build_options: Sequence[str] | None = None,
     dockerfile_hook_path: Path | None = None,
     keep_generated_files: bool = True,
 ) -> RenderedBuildPlan:
@@ -197,7 +197,7 @@ def render_build_image(
         omit_target: Whether to omit the target stage from the command.
         image_name: Optional image name override.
         extra_build_args: Extra build-time arguments.
-        docker_build_args: Additional arguments passed directly to `docker build`.
+        docker_build_options: Additional options passed directly to `docker build`.
         dockerfile_hook_path: Optional executable script path that can mutate
             the generated Dockerfile in-place before build.
         keep_generated_files: Whether to leave the generated Dockerfile in place.
@@ -338,7 +338,7 @@ def render_build_image(
             plain,
             target=None if omit_target else target,
             tags=all_tags,
-            docker_build_args=docker_build_args,
+            docker_build_options=docker_build_options,
         )
         command_display = " ".join(quote(str(arg)) for arg in build_cmd)
         return RenderedBuildPlan(
@@ -473,7 +473,7 @@ def build_deps_image(
     plain: bool = False,
     single_arch: bool = False,
     extra_build_args: dict[str, str] | None = None,
-    docker_build_args: Sequence[str] | None = None,
+    docker_build_options: Sequence[str] | None = None,
     cache_id_suffix: str = "",
 ) -> str:
     """Build the dependency collector image and return its full tag.
@@ -486,7 +486,7 @@ def build_deps_image(
         plain: If `True`, use plain output mode for the Docker build.
         single_arch: If `True`, build the image for the current host architecture only.
         extra_build_args: Additional build arguments for the Docker build as a dictionary of `KEY: VALUE` pairs.
-        docker_build_args: Additional arguments passed directly to `docker build`.
+        docker_build_options: Additional options passed directly to `docker build`.
         cache_id_suffix: A suffix to append to the cache ID.
 
     Returns:
@@ -574,7 +574,7 @@ def build_deps_image(
         no_cache,
         plain,
         tags=[full_tag],
-        docker_build_args=docker_build_args,
+        docker_build_options=docker_build_options,
     )
 
     LOGGER.info("Building deps image: %s", full_tag)
@@ -597,7 +597,7 @@ def build_image(
     omit_target: bool = False,
     image_name: str | None = None,
     extra_build_args: dict[str, str] | None = None,
-    docker_build_args: Sequence[str] | None = None,
+    docker_build_options: Sequence[str] | None = None,
     dockerfile_hook_path: Path | None = None,
 ) -> tuple[str, str]:
     """Build the primary image and return its version and commit tags.
@@ -613,7 +613,7 @@ def build_image(
         omit_target: If `True`, omit the target stage.
         image_name: Name of the image to build.
         extra_build_args: Additional build arguments for the Docker build as a dictionary of `KEY: VALUE` pairs.
-        docker_build_args: Additional arguments passed directly to `docker build`.
+        docker_build_options: Additional options passed directly to `docker build`.
         dockerfile_hook_path: Optional executable script path that can mutate
             the generated Dockerfile in-place before build.
 
@@ -636,7 +636,7 @@ def build_image(
         omit_target=omit_target,
         image_name=image_name,
         extra_build_args=extra_build_args,
-        docker_build_args=docker_build_args,
+        docker_build_options=docker_build_options,
         dockerfile_hook_path=dockerfile_hook_path,
         keep_generated_files=True,
     )

common_python_tasks/env.py

@@ -81,14 +81,16 @@ def uv_index_secret_mounts(credentials: list[dict[str, str | None]]) -> list[str
     ]
 
 
-def uv_index_secret_build_args(credentials: list[dict[str, str | None]]) -> list[str]:
-    """Return `docker build --secret` arg pairs for UV index credentials.
+def uv_index_secret_build_options(
+    credentials: list[dict[str, str | None]],
+) -> list[str]:
+    """Return `docker build --secret` option 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.
+        A flat list of `--secret` option-value pairs for the Docker build command.
     """
     return [
         item
@@ -131,13 +133,13 @@ def get_python_variant() -> str:
 def inject_auto_build_args_from_env(
     build_args: dict[str, str] | None,
 ) -> dict[str, str]:
-    """Inject configured environment variables into managed Docker build args.
+    """Inject configured environment variables into managed Dockerfile build arguments.
 
     Environment-driven build args are only injected if they are set, and never
     override arguments already managed by the image builder.
 
     Args:
-        build_args: Existing managed Docker build arguments.
+        build_args: Existing managed Dockerfile build arguments.
 
     Returns:
         A build-arg dictionary with auto-injected env values merged in.
@@ -337,28 +339,29 @@ def split_colon_delimited_values(value: str) -> list[str]:
     return split_delimited_values(value, separators=":", allow_whitespace=True)
 
 
-def resolve_container_docker_build_args(
-    cli_docker_build_args: tuple[str, ...], env_docker_build_args: str | None
+def resolve_container_docker_build_options(
+    cli_docker_build_options: tuple[str, ...],
+    env_docker_build_options: str | None,
 ) -> list[str]:
-    """Resolve arguments passed directly to `docker build`.
+    """Resolve options passed directly to `docker build`.
 
     Args:
-        cli_docker_build_args: Free arguments provided after the task's `--`
+        cli_docker_build_options: Free options provided after the task's `--`
             separator.
-        env_docker_build_args: Shell-tokenized arguments from the environment.
+        env_docker_build_options: Shell-tokenized options from the environment.
 
     Returns:
-        The CLI arguments when provided, otherwise the environment arguments.
+        The CLI options when provided, otherwise the environment options.
     """
-    if cli_docker_build_args:
-        return list(cli_docker_build_args)
-    if not env_docker_build_args:
+    if cli_docker_build_options:
+        return list(cli_docker_build_options)
+    if not env_docker_build_options:
         return []
 
     try:
-        return shlex.split(env_docker_build_args)
+        return shlex.split(env_docker_build_options)
     except ValueError as error:
-        utils.fatal(f"Invalid CONTAINER_DOCKER_BUILD_ARGS: {error}")
+        utils.fatal(f"Invalid CONTAINER_DOCKER_BUILD_OPTIONS: {error}")
 
 
 def _resolve_optional_file_path(

common_python_tasks/tasks.py

@@ -490,7 +490,7 @@ def docs_serve(
 
 @tasks.script(tags=["containers", "build"])
 def build_image(
-    *docker_build_args: str,
+    *docker_build_options: str,
     debug: bool = False,
     no_cache: bool = False,
     plain: bool = False,
@@ -503,9 +503,9 @@ def build_image(
     """Build the container image using a project-owned or bundled Dockerfile.
 
     Args:
-        *docker_build_args: Additional arguments passed directly to `docker build`.
+        *docker_build_options: Additional options passed directly to `docker build`.
             Provide them after the task's `--` separator. Overrides
-            `CONTAINER_DOCKER_BUILD_ARGS` when provided.
+            `CONTAINER_DOCKER_BUILD_OPTIONS` when provided.
         debug: Build the debug image.
         no_cache: Do not use cache when building the image.
         plain: Do not pretty-print output.
@@ -538,12 +538,12 @@ def build_image(
         parse_container_deps_source,
         parse_container_extensions,
         render_container_deps_move_script,
-        resolve_container_docker_build_args,
+        resolve_container_docker_build_options,
         resolve_container_dockerfile_hook_path,
         resolve_container_dockerfile_path,
         resolve_extension_build_context,
         resolve_extension_content,
-        uv_index_secret_build_args,
+        uv_index_secret_build_options,
         uv_index_secret_mounts,
     )
     from .project import (
@@ -578,9 +578,9 @@ def build_image(
         if (context := resolve_extension_build_context(desc)) is not None
     ]
 
-    resolved_docker_build_args = resolve_container_docker_build_args(
-        docker_build_args,
-        os.getenv("CONTAINER_DOCKER_BUILD_ARGS"),
+    resolved_docker_build_options = resolve_container_docker_build_options(
+        docker_build_options,
+        os.getenv("CONTAINER_DOCKER_BUILD_OPTIONS"),
     )
     uv_credentials = collect_uv_index_credentials()
     if uv_credentials:
@@ -588,9 +588,9 @@ def build_image(
             "Passing UV index credentials for: %s",
             ", ".join(c["index_name"] for c in uv_credentials),
         )
-        resolved_docker_build_args = uv_index_secret_build_args(uv_credentials) + list(
-            resolved_docker_build_args
-        )
+        resolved_docker_build_options = uv_index_secret_build_options(
+            uv_credentials
+        ) + list(resolved_docker_build_options)
     resolved_dockerfile_hook_path = resolve_container_dockerfile_hook_path(
         dockerfile_hook_path,
         os.getenv("CONTAINER_DOCKERFILE_HOOK_PATH"),
@@ -609,7 +609,7 @@ def build_image(
             single_arch=single_arch,
             omit_target=not debug,
             extra_build_args=top_level_build_args or None,
-            docker_build_args=resolved_docker_build_args,
+            docker_build_options=resolved_docker_build_options,
             dockerfile_hook_path=resolved_dockerfile_hook_path,
         )
         _prune_container_images(version_tag, commit_tag)
@@ -713,7 +713,7 @@ def build_image(
 
     if deps_content or deps_dockerfile_path:
         deps_image_tag = build_deps_image_task(
-            *resolved_docker_build_args,
+            *resolved_docker_build_options,
             no_cache=no_cache,
             plain=plain,
             single_arch=single_arch,
@@ -746,8 +746,8 @@ def build_image(
         plain=plain,
         single_arch=single_arch,
         extra_build_args=merged_build_args or None,
-        docker_build_args=[
-            *resolved_docker_build_args,
+        docker_build_options=[
+            *resolved_docker_build_options,
             *(
                 item
                 for name, path in extension_build_contexts
@@ -768,7 +768,7 @@ def build_image(
 
 @tasks.script(task_name="build-deps-image", tags=["containers", "build"])
 def build_deps_image_task(
-    *docker_build_args: str,
+    *docker_build_options: str,
     no_cache: bool = False,
     plain: bool = False,
     single_arch: bool = False,
@@ -776,9 +776,9 @@ def build_deps_image_task(
     """Build only the container dependency collector image for this project.
 
     Args:
-        *docker_build_args: Additional arguments passed directly to `docker build`.
+        *docker_build_options: Additional options passed directly to `docker build`.
             Provide them after the task's `--` separator. Overrides
-            `CONTAINER_DOCKER_BUILD_ARGS` when provided.
+            `CONTAINER_DOCKER_BUILD_OPTIONS` when provided.
         no_cache: Do not use cache when building the deps image.
         plain: Do not pretty-print output.
         single_arch: Build images for a single architecture.
@@ -791,7 +791,7 @@ def build_deps_image_task(
         get_cache_id_suffix,
         inject_auto_build_args_from_env,
         parse_container_deps_source,
-        resolve_container_docker_build_args,
+        resolve_container_docker_build_options,
     )
     from .utils import fatal
 
@@ -801,9 +801,9 @@ def build_deps_image_task(
             "No container dependency source found. Set CONTAINER_DEPS_CONTENT or CONTAINER_DEPS_FILE."
         )
 
-    resolved_docker_build_args = resolve_container_docker_build_args(
-        docker_build_args,
-        os.getenv("CONTAINER_DOCKER_BUILD_ARGS"),
+    resolved_docker_build_options = resolve_container_docker_build_options(
+        docker_build_options,
+        os.getenv("CONTAINER_DOCKER_BUILD_OPTIONS"),
     )
     extra_build_args = inject_auto_build_args_from_env({})
     cache_id_suffix = get_cache_id_suffix(no_cache)
@@ -817,7 +817,7 @@ def build_deps_image_task(
         plain=plain,
         single_arch=single_arch,
         extra_build_args=extra_build_args or None,
-        docker_build_args=resolved_docker_build_args,
+        docker_build_options=resolved_docker_build_options,
         cache_id_suffix=cache_id_suffix,
     )
 

{common_python_tasks-0.12.1.dist-info → common_python_tasks-0.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: common-python-tasks
-Version: 0.12.1
+Version: 0.13.0
 Summary: Opinionated Poe the Poet tasks for Python package development.
 Project-URL: Homepage, http://github.com/ci-sourcerer/common-python-tasks
 Project-URL: Source, http://github.com/ci-sourcerer/common-python-tasks.git
@@ -35,14 +35,14 @@ Description-Content-Type: text/markdown
 
 `common-python-tasks` provides reusable, opinionated [Poe the Poet](https://poethepoet.natn.io/guides/packaged_tasks.html) tasks for Python development, packaging, releases, containers, and documentation.
 
-Read the [complete documentation](https://ci-sourcerer.github.io/common-python-tasks/) for the task reference, configuration options, and deployment guidance.
+Read the [complete documentation](https://common-python-tasks.ci-sourcerer.com/) for the task reference, configuration options, and deployment guidance.
 
 ## Quick start
 
 Add the package as a development dependency.
 
 ```shell
-uv add --dev common-python-tasks==0.12.1
+uv add --dev common-python-tasks==0.13.0
 ```
 
 Expose the default task set in `pyproject.toml`.
@@ -83,12 +83,12 @@ poe docs-build
 poe docs-serve
 ```
 
-The [documentation workflow guide](https://ci-sourcerer.github.io/common-python-tasks/documentation-workflows/) covers GitHub Actions artifacts, optional Cloudflare Pages previews, and GitHub Pages deployment.
+The [documentation workflow guide](https://common-python-tasks.ci-sourcerer.com/documentation-workflows/) covers GitHub Actions artifacts, optional Cloudflare Pages previews, and GitHub Pages deployment.
 
 ## Learn more
 
-- [Getting started](https://ci-sourcerer.github.io/common-python-tasks/getting-started/)
-- [Task reference](https://ci-sourcerer.github.io/common-python-tasks/tasks/)
-- [Configuration reference](https://ci-sourcerer.github.io/common-python-tasks/configuration/)
+- [Getting started](https://common-python-tasks.ci-sourcerer.com/getting-started/)
+- [Task reference](https://common-python-tasks.ci-sourcerer.com/tasks/)
+- [Configuration reference](https://common-python-tasks.ci-sourcerer.com/configuration/)
 
 The project is in alpha, so minor releases may contain breaking changes. It is distributed under the [MIT license](LICENSE).

{common_python_tasks-0.12.1.dist-info → common_python_tasks-0.13.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
 common_python_tasks/__init__.py,sha256=tqRLgOwmMQHDb1A84XbML9sWfzMymkSPhJjoF6aCHgA,916
 common_python_tasks/__main__.py,sha256=GpgSd_toMbEaWA_cZvgsZE7jo4XpzuI-awBVm2uhVyw,3512
-common_python_tasks/docker.py,sha256=_YW-hyHWlUK-kMCvI6QTgxSfmXQQKhYLOKRBPfUmtHA,24176
+common_python_tasks/docker.py,sha256=1vmuDfxmdKkqOATpJfERkILAykpQp-vNxuWYjH6GQi4,24221
 common_python_tasks/docker_compose.py,sha256=NGgMei3oCYS0RbNaQXE-2veXFylO3XtZ7lU-PTtocik,21338
-common_python_tasks/env.py,sha256=hSjWe8L1RXguLqIMh1IsgbkHa_64b1U8lBHqDIS3zko,21779
+common_python_tasks/env.py,sha256=3Ehrqte8xaVp2Xn7limHMb75hQdvfc74KIpDnnobnd8,21832
 common_python_tasks/git.py,sha256=0X472w_vHdtbrHHxCmJ85NoQjjogEEDs_0SRXfxbWi0,11719
 common_python_tasks/github.py,sha256=_LVanl-z4PsdLM94L8y7tkX-AZO2n3Qy39FRY7reDhA,21589
 common_python_tasks/project.py,sha256=PQ_GQicTrSQgVDB9cJ9E6pU0UhLPom2xou1sGFscr3E,17377
-common_python_tasks/tasks.py,sha256=vMCFXZKo-0Dj1TLmZ3lo6oFCAhJSEp637qZWhaWOmpA,64199
+common_python_tasks/tasks.py,sha256=7Y_MdlaQ5MePWqyx8g33kB6lgyj5_-YGkiHZkYgVx9Q,64276
 common_python_tasks/utils.py,sha256=hR7w0Cb7uQ7ILyIegTQ4znWHVoWANlCgxrOnO-Rh5oE,20798
 common_python_tasks/data/dockerfile_extensions/docker-in-docker/Dockerfile,sha256=m7jeQyFe6mAv8AVGpM89NHljzG21ctcSyllbvoEL0Do,1021
 common_python_tasks/data/dockerfile_extensions/docker-in-docker/install.sh,sha256=F87oojGFYT5F1mdcMchRNlUeI_viAO4ip04UHBC_8bQ,1224
@@ -23,7 +23,7 @@ common_python_tasks/data/generic/Dockerfile.j2,sha256=UrR9T794V2ESNIkSVE7K5vEbx4
 common_python_tasks/data/generic/cliff.toml,sha256=po1MnEGEEgrpyBz3XLWr0h7emXb6ASX63lrU2r6o240,77
 common_python_tasks/data/generic/pytest.ini,sha256=RHak5QrLzKHvUBjFmaaiOYFrd_8YBRQubXEOT0NJfco,134
 common_python_tasks/data/generic/ruff.toml,sha256=njvd-5inSGmgY865SWCT4SR9IrKlzS7JQFZmAG2UT_E,53
-common_python_tasks-0.12.1.dist-info/METADATA,sha256=p-x2WeHmobmT8MQV2xYAIhKIv3MFUiVkhcMQ5Dna1Ls,3307
-common_python_tasks-0.12.1.dist-info/WHEEL,sha256=THafob7ofN-NsuMN7Mg4qZyHaQI7KkD-QlcQatYhXPo,87
-common_python_tasks-0.12.1.dist-info/licenses/LICENSE,sha256=RsSweM-DyzxFPx38fQOJqHrKyeT9Fiz8rO7yox-fOsw,1070
-common_python_tasks-0.12.1.dist-info/RECORD,,
+common_python_tasks-0.13.0.dist-info/METADATA,sha256=aTcg2agqAGku-6bCQvMPq1U1Fpql4U7e42bYIQuLDyM,3277
+common_python_tasks-0.13.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+common_python_tasks-0.13.0.dist-info/licenses/LICENSE,sha256=RsSweM-DyzxFPx38fQOJqHrKyeT9Fiz8rO7yox-fOsw,1070
+common_python_tasks-0.13.0.dist-info/RECORD,,

{common_python_tasks-0.12.1.dist-info → common_python_tasks-0.13.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.32.3
+Generator: hatchling 1.32.4
 Root-Is-Purelib: true
 Tag: py3-none-any