containers_run

提供容器 run() 方法的 Mixin。

class RunMixin[source]

基类: object

为 ContainersManager 提供 run() 方法的类。

run(image: str | Image, command: str | List[str] | None = None, stdout=True, stderr=False, remove: bool = False, **kwargs) Container | Generator[str, None, None] | Iterator[str][source]

运行容器。

默认情况下,run() 会等待容器完成并返回其日志。

如果 detach=True,run() 将启动容器并返回 Container 对象而不是

日志。

参数:
  • image – 要运行的镜像。

  • command – 在容器中运行的命令。

  • stdout – 包含标准输出。默认值:True。

  • stderr – 包含标准错误输出。默认值:False。

  • remove – 容器进程退出时删除容器。默认值:False。

关键字参数:

arguments. (- 请参阅 create() 方法以获取关键字) –

返回值:

  • 当 detach 为 True 时,返回一个 Container

  • 如果 stdout 为 True,则在输出中包含来自容器的标准输出

  • 如果 stderr 为 True,则在输出中包含来自容器的标准错误输出

  • 当 stream 为 True 时,来自容器的输出作为生成器返回

  • 否则,在容器完成之后返回一个迭代器

引发:
  • ContainerError – 当容器以非零代码退出时

  • ImageNotFound – 当 Podman 服务找不到镜像时

  • APIError – 当 Podman 服务报告错误时