Fix type hinting to match Pylance "basic" type checking

Problem: 
The "Basic" type checking level from Pylance notified multiple errors

Solution: 
Add the correct type hinting, and ignore type comments to deal with all Pylance errors

Signed off: Serhiy <serhiy1@live.co.uk>

Author: serhiy

.gitignore

@@ -12,3 +12,5 @@ htmlcov/
 .cache/
 .eggs/
 .task/
+*.pyi
+.vscode

Taskfile.yml

@@ -23,7 +23,7 @@ tasks:
     desc: Build a docker environment with the right dependencies and utilities
     cmds:
       - docker build --no-cache --build-arg VERSION=3.8 -f Dockerfile-builder -t jitsuin-archivist-python-builder .
-  
+
   builder-3.9:
     desc: Build a docker environment with the right dependencies and utilities
     cmds:
@@ -46,23 +46,23 @@ tasks:
   docs:
     desc: Create sphinx documentation
     deps: [about]
-    cmds: 
+    cmds:
       - ./scripts/builder.sh /bin/bash -c "cd docs && make html"
 
   format:
     desc: Format code using black
     deps: [about]
-    cmds: 
+    cmds:
       - ./scripts/builder.sh black archivist examples functests unittests
 
   functests:
     desc: Run functests - requires an archivist instance and a authtoken
     deps: [about]
     cmds:
       - ./scripts/builder.sh ./scripts/functests.sh
-  
+
   publish:
-    desc: pubish wheel package (will require username and password)
+    desc: publish wheel package (will require username and password)
     deps: [about]
     cmds:
       - ./scripts/builder.sh python3 -m twine upload --repository pypi dist/*
@@ -72,12 +72,12 @@ tasks:
     deps: [about]
     cmds:
       - ./scripts/builder.sh ./scripts/unittests.sh
-  
+
   wheel:
     desc: Builds python wheel package
     deps: [about]
     cmds:
       - rm -rf *egg-info
-      - rm -rf build 
+      - rm -rf build
       - rm -f dist/*
       - python3 setup.py bdist_wheel

archivist/access_policies.py

@@ -21,7 +21,7 @@
 
 """
 
-from typing import List, Optional
+from typing import Dict, List, Optional
 import logging
 from copy import deepcopy
 
@@ -65,7 +65,7 @@ def __init__(self, archivist: "type_helper.Archivist"):
         self._archivist = archivist
 
     def create(
-        self, props: dict, filters: List, access_permissions: List
+        self, props: Dict, filters: List, access_permissions: List
     ) -> AccessPolicy:
         """Create access policy
 
@@ -85,7 +85,7 @@ def create(
             self.__query(props, filters=filters, access_permissions=access_permissions),
         )
 
-    def create_from_data(self, data: dict) -> AccessPolicy:
+    def create_from_data(self, data: Dict) -> AccessPolicy:
         """Create access policy
 
         Creates access policy with request body from data stream.
@@ -127,9 +127,9 @@ def read(self, identity: str) -> AccessPolicy:
     def update(
         self,
         identity,
-        props: Optional[dict] = None,
-        filters: Optional[list] = None,
-        access_permissions: Optional[list] = None,
+        props: Optional[Dict] = None,
+        filters: Optional[List] = None,
+        access_permissions: Optional[List] = None,
     ) -> AccessPolicy:
         """Update Access Policy
 
@@ -155,7 +155,7 @@ def update(
             )
         )
 
-    def delete(self, identity: str) -> dict:
+    def delete(self, identity: str) -> Dict:
         """Delete Access Policy
 
         Deletes access policy.
@@ -170,7 +170,12 @@ def delete(self, identity: str) -> dict:
         return self._archivist.delete(ACCESS_POLICIES_SUBPATH, identity)
 
     @staticmethod
-    def __query(props, *, filters=None, access_permissions=None):
+    def __query(
+        props: Optional[Dict],
+        *,
+        filters: Optional[List] = None,
+        access_permissions: Optional[List] = None,
+    ) -> Dict:
         query = deepcopy(props) if props else {}
         if filters is not None:
             query["filters"] = filters

archivist/archivist.py

@@ -33,7 +33,7 @@
 
 import json
 from os.path import isfile as os_path_isfile
-from typing import IO, Optional
+from typing import BinaryIO, Dict, Optional
 from requests.models import Response
 
 from flatten_dict import flatten
@@ -142,7 +142,7 @@ def __getattr__(self, value: str):
         return c
 
     @property
-    def headers(self) -> dict:
+    def headers(self) -> Dict:
         """dict: Headers REST headers from response"""
         return self._headers
 
@@ -157,11 +157,11 @@ def verify(self) -> bool:
         return self._verify
 
     @property
-    def cert(self) -> str:
+    def cert(self) -> Optional[str]:
         """str: filepath containing authorisation certificate."""
         return self._cert
 
-    def __add_headers(self, headers):
+    def __add_headers(self, headers: Optional[Dict]) -> Dict:
         """docstring"""
         if headers is not None:
             newheaders = {**self.headers, **headers}
@@ -171,8 +171,8 @@ def __add_headers(self, headers):
         return newheaders
 
     def get(
-        self, subpath: str, identity: str, *, headers: Optional[dict] = None
-    ) -> dict:
+        self, subpath: str, identity: str, *, headers: Optional[Dict] = None
+    ) -> Dict:
         """GET method (REST)
 
         Args:
@@ -198,7 +198,12 @@ def get(
         return response.json()
 
     def get_file(
-        self, subpath: str, identity: str, fd: IO, *, headers: Optional[dict] = None
+        self,
+        subpath: str,
+        identity: str,
+        fd: BinaryIO,
+        *,
+        headers: Optional[Dict] = None,
     ) -> Response:
         """GET method (REST) - chunked
 
@@ -232,7 +237,7 @@ def get_file(
 
         return response
 
-    def post(self, path: str, request: dict, *, headers: Optional[dict] = None) -> dict:
+    def post(self, path: str, request: Dict, *, headers: Optional[Dict] = None) -> Dict:
         """POST method (REST)
 
         Creates an entity
@@ -261,7 +266,7 @@ def post(self, path: str, request: dict, *, headers: Optional[dict] = None) -> d
 
         return response.json()
 
-    def post_file(self, path: str, fd: IO, mtype: str) -> dict:
+    def post_file(self, path: str, fd: BinaryIO, mtype: str) -> Dict:
         """POST method (REST) - upload binary
 
         Uploads a file to an endpoint
@@ -286,7 +291,7 @@ def post_file(self, path: str, fd: IO, mtype: str) -> dict:
         }
         response = requests.post(
             SEP.join((self.url, ROOT, path)),
-            data=multipart,
+            data=multipart,  # type: ignore      https://github.com/requests/toolbelt/issues/312
             headers=self.__add_headers(headers),
             verify=self.verify,
             cert=self.cert,
@@ -299,8 +304,8 @@ def post_file(self, path: str, fd: IO, mtype: str) -> dict:
         return response.json()
 
     def delete(
-        self, subpath: str, identity: str, *, headers: Optional[dict] = None
-    ) -> dict:
+        self, subpath: str, identity: str, *, headers: Optional[Dict] = None
+    ) -> Dict:
         """DELETE method (REST)
 
         Deletes an entity
@@ -331,10 +336,10 @@ def patch(
         self,
         subpath: str,
         identity: str,
-        request: dict,
+        request: Dict,
         *,
-        headers: Optional[dict] = None,
-    ) -> dict:
+        headers: Optional[Dict] = None,
+    ) -> Dict:
         """PATCH method (REST)
 
         Updates the specified entity.
@@ -364,7 +369,7 @@ def patch(
 
         return response.json()
 
-    def __list(self, path, args, *, headers=None):
+    def __list(self, path, args, *, headers=None) -> Response:
         if args:
             path = "?".join((path, args))
 
@@ -381,14 +386,14 @@ def __list(self, path, args, *, headers=None):
         return response
 
     @staticmethod
-    def __query(query):
+    def __query(query: Optional[Dict]):
         return query and "&".join(
             sorted(f"{k}={v}" for k, v in flatten(query, reducer="dot").items())
         )
 
     def get_by_signature(
-        self, path: str, field: str, query: dict, *, headers: Optional[dict] = None
-    ) -> dict:
+        self, path: str, field: str, query: Dict, *, headers: Optional[Dict] = None
+    ) -> Dict:
         """GET method (REST) with query string
 
         Reads an entity indirectly by searching for its signature
@@ -417,7 +422,7 @@ def get_by_signature(
 
         response = self.__list(
             path,
-            "&".join((a for a in (paging, qry) if a)),
+            "&".join((a for a in (paging, qry) if a)),  # type: ignore
             headers=headers,
         )
 
@@ -436,7 +441,7 @@ def get_by_signature(
 
         return records[0]
 
-    def count(self, path: str, *, query: Optional[dict] = None) -> int:
+    def count(self, path: str, *, query: Optional[Dict] = None) -> int:
         """GET method (REST) with query string
 
         Returns the count of objects that match query
@@ -456,7 +461,7 @@ def count(self, path: str, *, query: Optional[dict] = None) -> int:
 
         response = self.__list(
             path,
-            "&".join((a for a in (paging, qry) if a)),
+            "&".join((a for a in (paging, qry) if a)),  # type: ignore
             headers=headers,
         )
 
@@ -467,9 +472,9 @@ def list(
         path: str,
         field: str,
         *,
-        page_size: Optional[int] = None,
-        query: Optional[dict] = None,
-        headers: Optional[dict] = None,
+        page_size: int = None,
+        query: Optional[Dict] = None,
+        headers: Optional[Dict] = None,
     ):
         """GET method (REST) with query string
 
@@ -502,7 +507,7 @@ def list(
         while True:
             response = self.__list(
                 path,
-                "&".join((a for a in (paging, qry) if a)),
+                "&".join((a for a in (paging, qry) if a)),  # type: ignore
                 headers=headers,
             )
             data = response.json()