From f244be921e4a3dfb8f7d84ae404e1515815df2ce Mon Sep 17 00:00:00 2001 From: kasium <15907922+kasium@users.noreply.github.com> Date: Tue, 30 Apr 2024 13:43:08 +0200 Subject: [PATCH] Improve docker api types (#11846) --- stubs/docker/docker/api/daemon.pyi | 35 ++++++++++++++++-------------- stubs/docker/docker/api/secret.pyi | 15 ++++++++----- stubs/docker/docker/api/volume.pyi | 18 +++++++-------- 3 files changed, 38 insertions(+), 30 deletions(-) diff --git a/stubs/docker/docker/api/daemon.pyi b/stubs/docker/docker/api/daemon.pyi index 349ab91ea..81adb4aef 100644 --- a/stubs/docker/docker/api/daemon.pyi +++ b/stubs/docker/docker/api/daemon.pyi @@ -1,23 +1,26 @@ -from _typeshed import Incomplete +from datetime import datetime +from typing import Any + +from docker.types.daemon import CancellableStream class DaemonApiMixin: - def df(self): ... + def df(self) -> dict[str, Any]: ... def events( self, - since: Incomplete | None = None, - until: Incomplete | None = None, - filters: Incomplete | None = None, - decode: Incomplete | None = None, - ): ... - def info(self): ... + since: datetime | int | None = None, + until: datetime | int | None = None, + filters: dict[str, Any] | None = None, + decode: bool | None = None, + ) -> CancellableStream: ... + def info(self) -> dict[str, Any]: ... def login( self, - username, - password: Incomplete | None = None, - email: Incomplete | None = None, - registry: Incomplete | None = None, + username: str, + password: str | None = None, + email: str | None = None, + registry: str | None = None, reauth: bool = False, - dockercfg_path: Incomplete | None = None, - ): ... - def ping(self): ... - def version(self, api_version: bool = True): ... + dockercfg_path: str | None = None, + ) -> dict[str, Any]: ... + def ping(self) -> bool: ... + def version(self, api_version: bool = True) -> dict[str, Any]: ... diff --git a/stubs/docker/docker/api/secret.pyi b/stubs/docker/docker/api/secret.pyi index 6f4b104c5..18e6acde3 100644 --- a/stubs/docker/docker/api/secret.pyi +++ b/stubs/docker/docker/api/secret.pyi @@ -1,7 +1,12 @@ -from _typeshed import Incomplete +from collections.abc import Iterable +from typing import Any + +from docker.types import DriverConfig class SecretApiMixin: - def create_secret(self, name, data, labels: Incomplete | None = None, driver: Incomplete | None = None): ... - def inspect_secret(self, id): ... - def remove_secret(self, id): ... - def secrets(self, filters: Incomplete | None = None): ... + def create_secret( + self, name: str, data: bytes, labels: dict[str, Any] | None = None, driver: DriverConfig | None = None + ) -> dict[str, Any]: ... + def inspect_secret(self, id: str) -> dict[str, Any]: ... + def remove_secret(self, id: str) -> bool: ... + def secrets(self, filters: dict[str, Any] | None = None) -> Iterable[dict[str, Any]]: ... diff --git a/stubs/docker/docker/api/volume.pyi b/stubs/docker/docker/api/volume.pyi index 888a0a158..b798f9f79 100644 --- a/stubs/docker/docker/api/volume.pyi +++ b/stubs/docker/docker/api/volume.pyi @@ -1,14 +1,14 @@ -from _typeshed import Incomplete +from typing import Any class VolumeApiMixin: - def volumes(self, filters: Incomplete | None = None): ... + def volumes(self, filters: dict[str, Any] | None = None) -> dict[str, Any]: ... def create_volume( self, - name: Incomplete | None = None, - driver: Incomplete | None = None, - driver_opts: Incomplete | None = None, - labels: Incomplete | None = None, - ): ... - def inspect_volume(self, name): ... - def prune_volumes(self, filters: Incomplete | None = None): ... + name: str | None = None, + driver: str | None = None, + driver_opts: dict[str, Any] | None = None, + labels: dict[str, Any] | None = None, + ) -> dict[str, Any]: ... + def inspect_volume(self, name: str) -> dict[str, Any]: ... + def prune_volumes(self, filters: dict[str, Any] | None = None) -> dict[str, Any]: ... def remove_volume(self, name, force: bool = False) -> None: ...