Skip to content

Commit a9d7e86

Browse files
Add a number of types to docker.models.containers (#11912)
1 parent b859441 commit a9d7e86

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

stubs/docker/docker/models/containers.pyi

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ from .resource import Collection, Model
88

99
class Container(Model):
1010
@property
11-
def name(self): ...
11+
def name(self) -> str | None: ...
1212
@property
13-
def image(self): ...
13+
def image(self) -> Image | None: ...
1414
@property
1515
def labels(self): ...
1616
@property
17-
def status(self): ...
17+
def status(self) -> str: ...
1818
@property
19-
def health(self): ...
19+
def health(self) -> str: ...
2020
@property
21-
def ports(self): ...
21+
def ports(self) -> dict[Incomplete, Incomplete]: ...
2222
def attach(self, **kwargs): ...
2323
def attach_socket(self, **kwargs): ...
2424
def commit(self, repository: str | None = None, tag: str | None = None, **kwargs): ...
@@ -38,16 +38,18 @@ class Container(Model):
3838
environment: Incomplete | None = None,
3939
workdir: Incomplete | None = None,
4040
demux: bool = False,
41-
): ...
42-
def export(self, chunk_size=2097152): ...
43-
def get_archive(self, path, chunk_size=2097152, encode_stream: bool = False): ...
41+
) -> ExecResult: ...
42+
def export(self, chunk_size: int | None = 2097152) -> str: ...
43+
def get_archive(
44+
self, path, chunk_size: int | None = 2097152, encode_stream: bool = False
45+
) -> tuple[Incomplete, Incomplete]: ...
4446
def kill(self, signal: Incomplete | None = None): ...
4547
def logs(self, **kwargs) -> CancellableStream | bytes: ...
4648
def pause(self): ...
47-
def put_archive(self, path, data): ...
49+
def put_archive(self, path: str, data) -> bool: ...
4850
def remove(self, **kwargs) -> None: ...
49-
def rename(self, name): ...
50-
def resize(self, height, width): ...
51+
def rename(self, name: str): ...
52+
def resize(self, height: int, width: int): ...
5153
def restart(self, **kwargs): ...
5254
def start(self, **kwargs) -> None: ...
5355
def stats(self, **kwargs): ...
@@ -68,22 +70,22 @@ class ContainerCollection(Collection[Container]):
6870
remove: bool = False,
6971
**kwargs,
7072
): ...
71-
def create(self, image: str, command: str | list[str] | None = None, **kwargs): ... # type:ignore[override]
72-
def get(self, container_id: str): ...
73+
def create(self, image: str, command: str | list[str] | None = None, **kwargs) -> Container: ... # type:ignore[override]
74+
def get(self, container_id: str) -> Container: ...
7375
def list(
7476
self,
7577
all: bool = False,
76-
before: Incomplete | None = None,
78+
before: str | None = None,
7779
filters: Incomplete | None = None,
7880
limit: int = -1,
79-
since: Incomplete | None = None,
81+
since: str | None = None,
8082
sparse: bool = False,
8183
ignore_removed: bool = False,
8284
): ...
8385
def prune(self, filters: Incomplete | None = None): ...
8486

85-
RUN_CREATE_KWARGS: Incomplete
86-
RUN_HOST_CONFIG_KWARGS: Incomplete
87+
RUN_CREATE_KWARGS: list[str]
88+
RUN_HOST_CONFIG_KWARGS: list[str]
8789

8890
class ExecResult(NamedTuple):
8991
exit_code: Incomplete

0 commit comments

Comments
 (0)