deps_rocker.docker_cli
======================

.. py:module:: deps_rocker.docker_cli

.. autoapi-nested-parse::

   Helpers for running Docker builds via the docker CLI.



Attributes
----------

.. autoapisummary::

   deps_rocker.docker_cli.OutputCallback


Functions
---------

.. autoapisummary::

   deps_rocker.docker_cli._prepare_env
   deps_rocker.docker_cli._build_cli_command
   deps_rocker.docker_cli._stream_process_output
   deps_rocker.docker_cli.run_docker_cli
   deps_rocker.docker_cli.docker_build_with_cli


Module Contents
---------------

.. py:data:: OutputCallback

.. py:function:: _prepare_env(env: Optional[MutableMapping[str, str]] = None) -> MutableMapping[str, str]

   Return an env mapping with BuildKit guaranteed to be enabled.


.. py:function:: _build_cli_command(*, path: str, tag: Optional[str], rm: bool, nocache: bool, pull: bool, dockerfile: Optional[str], buildargs: Optional[Dict[str, Any]]) -> list[str]

   Construct a docker build command.


.. py:function:: _stream_process_output(process: subprocess.Popen[str], output_callback: OutputCallback) -> None

   Forward process output to the optional callback.


.. py:function:: run_docker_cli(*, command: Sequence[str], env: Mapping[str, str], output_callback: OutputCallback = None) -> Optional[str]

   Execute the docker CLI command and return the resulting image identifier if available.


.. py:function:: docker_build_with_cli(*, path: str, tag: Optional[str], rm: bool, nocache: bool, pull: bool, dockerfile: Optional[str], buildargs: Optional[Dict[str, Any]], output_callback: OutputCallback, env: Optional[MutableMapping[str, str]] = None) -> Optional[str]

   High level helper used by the rocker patch to build with the docker CLI.