Skip to content

Commit f244be9

Browse files
authored
Improve docker api types (#11846)
1 parent 9178f5a commit f244be9

File tree

3 files changed

+38
-30
lines changed

3 files changed

+38
-30
lines changed

stubs/docker/docker/api/daemon.pyi

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
1-
from _typeshed import Incomplete
1+
from datetime import datetime
2+
from typing import Any
3+
4+
from docker.types.daemon import CancellableStream
25

36
class DaemonApiMixin:
4-
def df(self): ...
7+
def df(self) -> dict[str, Any]: ...
58
def events(
69
self,
7-
since: Incomplete | None = None,
8-
until: Incomplete | None = None,
9-
filters: Incomplete | None = None,
10-
decode: Incomplete | None = None,
11-
): ...
12-
def info(self): ...
10+
since: datetime | int | None = None,
11+
until: datetime | int | None = None,
12+
filters: dict[str, Any] | None = None,
13+
decode: bool | None = None,
14+
) -> CancellableStream: ...
15+
def info(self) -> dict[str, Any]: ...
1316
def login(
1417
self,
15-
username,
16-
password: Incomplete | None = None,
17-
email: Incomplete | None = None,
18-
registry: Incomplete | None = None,
18+
username: str,
19+
password: str | None = None,
20+
email: str | None = None,
21+
registry: str | None = None,
1922
reauth: bool = False,
20-
dockercfg_path: Incomplete | None = None,
21-
): ...
22-
def ping(self): ...
23-
def version(self, api_version: bool = True): ...
23+
dockercfg_path: str | None = None,
24+
) -> dict[str, Any]: ...
25+
def ping(self) -> bool: ...
26+
def version(self, api_version: bool = True) -> dict[str, Any]: ...

stubs/docker/docker/api/secret.pyi

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
from _typeshed import Incomplete
1+
from collections.abc import Iterable
2+
from typing import Any
3+
4+
from docker.types import DriverConfig
25

36
class SecretApiMixin:
4-
def create_secret(self, name, data, labels: Incomplete | None = None, driver: Incomplete | None = None): ...
5-
def inspect_secret(self, id): ...
6-
def remove_secret(self, id): ...
7-
def secrets(self, filters: Incomplete | None = None): ...
7+
def create_secret(
8+
self, name: str, data: bytes, labels: dict[str, Any] | None = None, driver: DriverConfig | None = None
9+
) -> dict[str, Any]: ...
10+
def inspect_secret(self, id: str) -> dict[str, Any]: ...
11+
def remove_secret(self, id: str) -> bool: ...
12+
def secrets(self, filters: dict[str, Any] | None = None) -> Iterable[dict[str, Any]]: ...

stubs/docker/docker/api/volume.pyi

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
from _typeshed import Incomplete
1+
from typing import Any
22

33
class VolumeApiMixin:
4-
def volumes(self, filters: Incomplete | None = None): ...
4+
def volumes(self, filters: dict[str, Any] | None = None) -> dict[str, Any]: ...
55
def create_volume(
66
self,
7-
name: Incomplete | None = None,
8-
driver: Incomplete | None = None,
9-
driver_opts: Incomplete | None = None,
10-
labels: Incomplete | None = None,
11-
): ...
12-
def inspect_volume(self, name): ...
13-
def prune_volumes(self, filters: Incomplete | None = None): ...
7+
name: str | None = None,
8+
driver: str | None = None,
9+
driver_opts: dict[str, Any] | None = None,
10+
labels: dict[str, Any] | None = None,
11+
) -> dict[str, Any]: ...
12+
def inspect_volume(self, name: str) -> dict[str, Any]: ...
13+
def prune_volumes(self, filters: dict[str, Any] | None = None) -> dict[str, Any]: ...
1414
def remove_volume(self, name, force: bool = False) -> None: ...

0 commit comments

Comments
 (0)