Fix type annotations for Docker labels (#621)

aio-libs · Nov 15, 2021 · 315af29 · 315af29
1 parent decc34c
commit 315af29
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 7 deletions.
diff --git a/CHANGES/621.misc b/CHANGES/621.misc
@@ -0,0 +1 @@
+Fix type annotations for Docker labels.
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
@@ -23,4 +23,5 @@ Paul Tagliamonte
 Tianon Gravi
 Tommy Beadle
 Travis DePrato
+Vivien Maisonneuve
 Yannick Perrenet
diff --git a/aiodocker/configs.py b/aiodocker/configs.py
@@ -1,6 +1,6 @@
 import json
 from base64 import b64encode
-from typing import Any, List, Mapping
+from typing import Any, List, Mapping, Optional
 
 from .utils import clean_filters, clean_map
 
@@ -33,7 +33,7 @@ async def create(
         data: str,
         *,
         b64: bool = False,
-        labels: List = None,
+        labels: Optional[Mapping[str, str]] = None,
         templating: Mapping = None,
     ) -> Mapping[str, Any]:
         """
@@ -108,7 +108,7 @@ async def update(
         name: str = None,
         data: str = None,
         b64: bool = False,
-        labels: List = None,
+        labels: Optional[Mapping[str, str]] = None,
         templating: Mapping = None,
     ) -> bool:
         """

diff --git a/aiodocker/secrets.py b/aiodocker/secrets.py
@@ -1,6 +1,6 @@
 import json
 from base64 import b64encode
-from typing import Any, List, Mapping
+from typing import Any, List, Mapping, Optional
 
 from .utils import clean_filters, clean_map
 
@@ -33,7 +33,7 @@ async def create(
         data: str,
         *,
         b64: bool = False,
-        labels: List = None,
+        labels: Optional[Mapping[str, str]] = None,
         driver: Mapping = None,
         templating: Mapping = None,
     ) -> Mapping[str, Any]:
@@ -111,7 +111,7 @@ async def update(
         name: str = None,
         data: str = None,
         b64: bool = False,
-        labels: List = None,
+        labels: Optional[Mapping[str, str]] = None,
         driver: Mapping = None,
         templating: Mapping = None,
     ) -> bool:

diff --git a/aiodocker/services.py b/aiodocker/services.py
@@ -41,7 +41,7 @@ async def create(
         task_template: Mapping[str, Any],
         *,
         name: str = None,
-        labels: List = None,
+        labels: Optional[Mapping[str, str]] = None,
         mode: Mapping = None,
         update_config: Mapping = None,
         rollback_config: Mapping = None,