add pyright task to tox and fix pyright errors

Author: thomasf

.editorconfig

@@ -13,3 +13,9 @@ max_line_length =  88
 [.travis.yml]
 indent_style = space
 indent_size = 2
+
+[*.json]
+charset = utf-8
+indent_style = space
+indent_size = 2
+max_line_length =  88

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.1
+
+Fix type hints
+
 ## 0.5.0
 
 Switched the minio-py client library version from `<7` to `>=7`.

minio_storage/policy.py

@@ -26,11 +26,11 @@ def bucket(
         return pol
 
 
-def _none(bucket_name: str) -> T.Dict:
+def _none(bucket_name: str) -> T.Dict[str, T.Any]:
     return {"Version": "2012-10-17", "Statement": []}
 
 
-def _get(bucket_name: str) -> T.Dict:
+def _get(bucket_name: str) -> T.Dict[str, T.Any]:
     return {
         "Version": "2012-10-17",
         "Statement": [
@@ -44,7 +44,7 @@ def _get(bucket_name: str) -> T.Dict:
     }
 
 
-def _read(bucket_name: str) -> T.Dict:
+def _read(bucket_name: str) -> T.Dict[str, T.Any]:
     return {
         "Version": "2012-10-17",
         "Statement": [
@@ -70,7 +70,7 @@ def _read(bucket_name: str) -> T.Dict:
     }
 
 
-def _write(bucket_name: str) -> T.Dict:
+def _write(bucket_name: str) -> T.Dict[str, T.Any]:
     return {
         "Version": "2012-10-17",
         "Statement": [
@@ -101,7 +101,7 @@ def _write(bucket_name: str) -> T.Dict:
     }
 
 
-def _read_write(bucket_name: str) -> T.Dict:
+def _read_write(bucket_name: str) -> T.Dict[str, T.Any]:
     return {
         "Version": "2012-10-17",
         "Statement": [

minio_storage/storage.py

@@ -2,9 +2,8 @@
 import mimetypes
 import posixpath
 import typing as T
-import urllib
 from logging import getLogger
-from urllib.parse import urlsplit, urlunsplit
+from urllib.parse import quote, urlsplit, urlunsplit
 
 import minio
 import minio.error as merr
@@ -119,10 +118,6 @@ def _create_base_url_client(client: minio.Minio, bucket_name: str, base_url: str
             region=client._get_region(bucket_name, None),
             http_client=client._http,
         )
-        if hasattr(client, "_credentials"):
-            # Client credentials do not exist prior to minio-py 5.0.7, but
-            # they should be reused if possible
-            base_url_client._credentials = client._credentials
 
         return base_url_client
 
@@ -154,7 +149,7 @@ def _open(self, name, mode="rb"):
             raise minio_error(f"File {name} could not be saved: {str(e)}", e)
         return f
 
-    def _save(self, name: str, content: bytes) -> str:
+    def _save(self, name: str, content: T.BinaryIO) -> str:
         try:
             if hasattr(content, "seek") and callable(content.seek):
                 content.seek(0)
@@ -212,16 +207,15 @@ def exists(self, name: str) -> bool:
             return True
         except merr.InvalidResponseError as error:
             # TODO - deprecate
-            if error.code == "NoSuchKey":
+            if error._code == "NoSuchKey":
                 return False
             else:
                 raise minio_error(f"Could not stat file {name}", error)
         except merr.S3Error:
             return False
-        except merr.S3Error:
-            raise
         except Exception as error:
             logger.error(error)
+        return False
 
     def listdir(self, path: str) -> T.Tuple[T.List, T.List]:
         #  [None, "", "."] is supported to mean the configured root among various
@@ -263,7 +257,7 @@ def size(self, name: str) -> int:
 
     def _presigned_url(
         self, name: str, max_age: T.Optional[datetime.timedelta] = None
-    ) -> str:
+    ) -> T.Optional[str]:
         kwargs = {}
         if max_age is not None:
             kwargs["expires"] = max_age
@@ -293,11 +287,14 @@ def _presigned_url(
                     url_parts.fragment,
                 )
             )
-        return url
+        if url:
+            return str(url)
+        return None
 
     def url(
         self, name: str, *args, max_age: T.Optional[datetime.timedelta] = None
-    ) -> str:
+    ) -> T.Optional[str]:
+        url = ""
         if self.presign_urls:
             url = self._presigned_url(name, max_age=max_age)
         else:
@@ -313,14 +310,12 @@ def strip_end(path):
                 return path
 
             if self.base_url is not None:
-                url = "{}/{}".format(
-                    strip_end(self.base_url), urllib.parse.quote(strip_beg(name))
-                )
+                url = "{}/{}".format(strip_end(self.base_url), quote(strip_beg(name)))
             else:
                 url = "{}/{}/{}".format(
                     strip_end(self.endpoint_url),
                     self.bucket_name,
-                    urllib.parse.quote(strip_beg(name)),
+                    quote(strip_beg(name)),
                 )
         return url
 
@@ -353,7 +348,7 @@ def modified_time(self, name: str) -> datetime.datetime:
 _NoValue = object()
 
 
-def get_setting(name, default=_NoValue):
+def get_setting(name: str, default=_NoValue) -> T.Any:
     result = getattr(settings, name, default)
     if result is _NoValue:
         # print("Attr {} : {}".format(name, getattr(settings, name, default)))

pyrightconfig.json

@@ -0,0 +1,18 @@
+{
+  "include": [
+    "minio_storage",
+    "tests"
+  ],
+  "exclude": [
+    "**/migrations"
+  ],
+  "reportMissingImports": true,
+  "reportMissingTypeStubs": false,
+  "strictParameterNoneValue": false,
+  "reportInvalidStringEscapeSequence": "warning",
+  "reportUnboundVariable": "warning",
+  "reportOptionalMemberAccess": "warning",
+  "reportOptionalIterable": "warning",
+  "pythonVersion": "3.8",
+  "pythonPlatform": "Linux"
+}

tox.ini

@@ -10,7 +10,7 @@ python =
        3.8: py38
        3.9: py39
        3.10: py310
-       3.11: py311, lint, docs
+       3.11: py311, lint, docs, pyright
 
 
 [testenv]
@@ -40,6 +40,15 @@ commands =
     coverage html
 depends=py311-django42-minioknown
 
+[testenv:pyright]
+basepython = python3.11
+deps =
+        pyright
+        -rdev-requirements.txt
+commands =
+    pyright --skipunannotated --level WARNING
+
+
 [testenv:lint]
 setenv=
     PYTHONWARNINGS=ignore