fix: Incorrect return type annotations of DockerImages methods (#909)

* fix: Wrong type declarations * chore: Add news fragment --------- Co-authored-by: J. Nick Koston <[email protected]> Co-authored-by: Andrew Svetlov <[email protected]>
aio-libs · Nov 20, 2024 · 286cfdc · 286cfdc
1 parent 702003d
commit 286cfdc
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/CHANGES/909.bugfix b/CHANGES/909.bugfix
@@ -0,0 +1 @@
+Fix `DockerImages.build()`, `DockerImages.pull()`, `DockerImages.push()` methods' incorrect return type declarations.
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
@@ -11,6 +11,7 @@ Edgar Ramírez Mondragón
 eevelweezel
 Gaopeiliang
 Greg Guthe
+Gyubong Lee
 Hiroki Kiyohara
 Igor Alexandrov
 Jason Kraus

diff --git a/aiodocker/images.py b/aiodocker/images.py
@@ -70,7 +70,7 @@ async def pull(
         platform: Optional[str] = None,
         stream: Literal[False] = False,
         timeout: Union[float, Sentinel, None] = SENTINEL,
-    ) -> Dict[str, Any]: ...
+    ) -> List[Dict[str, Any]]: ...
 
     @overload
     def pull(
@@ -158,7 +158,7 @@ async def push(
         tag: Optional[str] = None,
         stream: Literal[False] = False,
         timeout: Union[float, Sentinel, None] = SENTINEL,
-    ) -> Dict[str, Any]: ...
+    ) -> List[Dict[str, Any]]: ...
 
     @overload
     def push(
@@ -273,7 +273,7 @@ async def build(
         platform: Optional[str] = None,
         stream: Literal[False] = False,
         encoding: Optional[str] = None,
-    ) -> Dict[str, Any]:
+    ) -> List[Dict[str, Any]]:
         pass
 
     @overload
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Fix `DockerImages.build()`, `DockerImages.pull()`, `DockerImages.push()` methods' incorrect return type declarations.