[docker] Add restart_policy type annotation to Container model (#12366)

This commit is contained in:
Nelson Yeung
2024-07-19 17:39:29 +01:00
committed by GitHub
parent cc7c950381
commit 389b318691

View File

@@ -1,6 +1,7 @@
import datetime
from _typeshed import Incomplete
from typing import Literal, NamedTuple, overload
from typing import Literal, NamedTuple, TypedDict, overload
from typing_extensions import NotRequired
from docker._types import ContainerWeightDevice, WaitContainerResponse
from docker.types import EndpointConfig
@@ -11,6 +12,10 @@ from docker.types.services import Mount
from .images import Image
from .resource import Collection, Model
class _RestartPolicy(TypedDict):
MaximumRetryCount: NotRequired[int]
Name: NotRequired[Literal["always", "on-failure"]]
class Container(Model):
@property
def name(self) -> str | None: ...
@@ -99,7 +104,7 @@ class Container(Model):
mem_reservation: float | str | None = None,
memswap_limit: int | str | None = None,
kernel_memory: int | str | None = None,
restart_policy: Incomplete | None = None,
restart_policy: _RestartPolicy | None = None,
): ...
def wait(
self, *, timeout: float | None = None, condition: Literal["not-running", "next-exit", "removed"] | None = None
@@ -180,7 +185,7 @@ class ContainerCollection(Collection[Container]):
privileged: bool = False,
publish_all_ports: bool = False,
read_only: bool | None = None,
restart_policy: dict[Incomplete, Incomplete] | None = None,
restart_policy: _RestartPolicy | None = None,
runtime: str | None = None,
security_opt: list[str] | None = None,
shm_size: str | int | None = None,
@@ -275,7 +280,7 @@ class ContainerCollection(Collection[Container]):
privileged: bool = False,
publish_all_ports: bool = False,
read_only: bool | None = None,
restart_policy: dict[Incomplete, Incomplete] | None = None,
restart_policy: _RestartPolicy | None = None,
runtime: str | None = None,
security_opt: list[str] | None = None,
shm_size: str | int | None = None,
@@ -366,7 +371,7 @@ class ContainerCollection(Collection[Container]):
privileged: bool = False,
publish_all_ports: bool = False,
read_only: bool | None = None,
restart_policy: dict[Incomplete, Incomplete] | None = None,
restart_policy: _RestartPolicy | None = None,
runtime: str | None = None,
security_opt: list[str] | None = None,
shm_size: str | int | None = None,