images

镜像资源的模型和管理器。

class Image(attrs: Mapping[str, Any] | None = None, client: APIClient | None = None, collection: Manager | None = None)[source]

基类:PodmanResource

由 Podman 服务管理的镜像的详细信息和配置。

初始化 PodmanResource 的基类。

参数:
  • attrs – 来自 Podman 服务的资源属性映射。

  • client – 配置连接到 Podman 服务。

  • collection – 此类资源的管理器,命名为 collection 以保持兼容性

history() List[Dict[str, Any]][source]

返回镜像的历史记录。

引发:

APIError – 当服务返回错误时

reload() None

从服务刷新此对象的数据。

remove(**kwargs) List[Dict[Literal['Deleted', 'Untagged', 'Errors', 'ExitCode'], str | int]][source]

从 Podman 服务删除镜像。

仅限 Podman

关键字参数:
  • force – 即使镜像正在使用,也强制删除。

  • noprune – 被忽略。

返回:

关于哪些镜像被删除和取消标记的报告,包括任何报告的错误。

引发:
  • ImageNotFound – 当镜像不存在时

  • APIError – 当服务返回错误时

save(chunk_size: int | None = 2097152, named: str | bool = False) Iterator[bytes][source]

将镜像作为 tarball 返回。

格式设置为 docker-archive,这允许 load() 导入此 tarball。

参数:
  • chunk_size – 如果为 None,则数据将以接收到的缓冲区大小流式传输。如果非 None,则数据将以指定大小的缓冲区返回。默认值:2MB

  • named – 被忽略。

引发:

APIError – 当服务返回错误时

tag(repository: str, tag: str | None, force: bool = False) bool[source]

将镜像标记到存储库中。

参数:
  • repository – 标记镜像的存储库。

  • tag – 可选的标记名称。

  • force – 忽略客户端错误

返回:

操作成功时返回 True。

引发:
  • ImageNotFound – 当服务找不到镜像时

  • APIError – 当服务返回错误时

property id

返回对象的标识符。

类型:

str

property labels

返回与镜像关联的标签。

类型:

dict[str, str]

property short_id

返回截断的标识符。’sha256’ 在包含在 id 中时会保留。

不会尝试确保返回值对所有资源在语义上都有意义。

类型:

str

property tags

返回镜像的标签。

类型:

list[str]