chore: add mypy type checking

Author: rexzhang

.pre-commit-config.yaml

@@ -17,4 +17,8 @@ repos:
   - repo: https://github.com/PyCQA/flake8
     rev: 7.3.0
     hooks:
-      - id: flake8
+      - id: flake8
+  # - repo: https://github.com/pre-commit/mirrors-mypy
+  #   rev: v1.19.0
+  #   hooks:
+  #     - id: mypy

asgi_webdav/__main__.py

@@ -7,7 +7,7 @@
 """
 
 
-def main():
+def main() -> None:
     import sys
 
     from .cli import main as cli_main

asgi_webdav/auth.py

@@ -90,7 +90,7 @@ class DAVPassword:
     data: list[str]
     message: str | None = None
 
-    def _parser_password_string(self):
+    def _parser_password_string(self) -> None:
         m = re.match(r"^<(?P<type>[a-zA-Z]+)>", self.password)
         if m is None:
             self.type = DAVPasswordType.RAW

asgi_webdav/cache.py

@@ -16,7 +16,8 @@ class DAVCacheType(DAVUpperEnumAbc):
 
 
 class DAVCacheAbc:  # pragma: no cover
-    async def prepare(self):
+
+    async def prepare(self) -> None:
         raise NotImplementedError
 
     async def get(self, key):
@@ -28,12 +29,13 @@ async def set(self, key, value):
     async def purge(self) -> None:
         raise NotImplementedError
 
-    async def close(self):
+    async def close(self) -> None:
         raise NotImplementedError
 
 
 class DAVCacheBypass(DAVCacheAbc):
-    async def prepare(self):  # pragma: no cover
+
+    async def prepare(self) -> None:  # pragma: no cover
         pass
 
     async def get(self, key):
@@ -45,7 +47,7 @@ async def set(self, key, value):
     async def purge(self) -> None:
         pass
 
-    async def close(self):  # pragma: no cover
+    async def close(self) -> None:  # pragma: no cover
         pass
 
 
@@ -57,7 +59,7 @@ def __init__(self) -> None:
         self._cache = {}
         self._lock = Lock()
 
-    async def prepare(self):  # pragma: no cover
+    async def prepare(self) -> None:  # pragma: no cover
         pass
 
     async def get(self, key):
@@ -72,7 +74,7 @@ async def purge(self) -> None:
         async with self._lock:
             self._cache.clear()
 
-    async def close(self):  # pragma: no cover
+    async def close(self) -> None:  # pragma: no cover
         pass
 
 
@@ -89,7 +91,7 @@ def __init__(self, cache_expiration: int) -> None:
         else:
             self._cache_expiration_timedelta = timedelta(seconds=cache_expiration)
 
-    async def prepare(self):  # pragma: no cover
+    async def prepare(self) -> None:  # pragma: no cover
         pass
 
     async def get(self, key):
@@ -111,7 +113,7 @@ async def purge(self) -> None:
         async with self._lock:
             self._cache.clear()
 
-    async def close(self):  # pragma: no cover
+    async def close(self) -> None:  # pragma: no cover
         pass
 
 

asgi_webdav/config.py

@@ -193,7 +193,7 @@ class Config(JSONPyWizard):
     logging: Logging = field(default_factory=Logging)
     sentry_dsn: str | None = None
 
-    def _update_from_env_config(self):
+    def _update_from_env_config(self) -> None:
         env_config = EnvConfig()
 
         # account_mapping
@@ -248,7 +248,7 @@ def _update_from_app_args(self, aep: AppEntryParameters):
             else:
                 self.provider_mapping[root_path_index].uri = root_path_uri
 
-    def _complete_config(self):
+    def _complete_config(self) -> None:
         # auth - anonymous
         if self.anonymous.enable:
             self.account_mapping.append(self.anonymous.user)

asgi_webdav/constants.py

@@ -259,10 +259,10 @@ class DAVLockInfo:
     owner: str
     token: UUID  # <opaquelocktoken:UUID.__str__()>
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         self.update_expire()
 
-    def update_expire(self):
+    def update_expire(self) -> None:
         self.expire = time() + self.timeout
 
     def __repr__(self):
@@ -356,7 +356,7 @@ class DAVUser:
     permissions_allow: list[str] = field(default_factory=list)
     permissions_deny: list[str] = field(default_factory=list)
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         for permission in self.permissions:
             if permission[0] == "+":
                 self.permissions_allow.append(permission[1:])

asgi_webdav/lock.py

@@ -15,7 +15,7 @@ class Path2TokenMap:
 
     data: dict[DAVPath, tuple[DAVLockScope, set[UUID]]]
 
-    def __init__(self):
+    def __init__(self) -> None:
         self.data = dict()
 
     def __contains__(self, item: DAVPath):
@@ -61,7 +61,8 @@ def remove(self, path: DAVPath, token: UUID) -> bool:
 
 
 class DAVLock:
-    def __init__(self):
+
+    def __init__(self) -> None:
         self.lock = asyncio.Lock()
 
         self.path2token_map = Path2TokenMap()

asgi_webdav/log.py

@@ -119,7 +119,8 @@ def get_dav_logging_config(config: Config) -> dict:
 
 
 class DAVLogHandler(logging.Handler):
-    def __init__(self):
+
+    def __init__(self) -> None:
         super().__init__()
 
     def emit(self, record):

asgi_webdav/property.py

@@ -19,7 +19,7 @@ class DAVPropertyBasicData:
     content_length: int = field(default=0)
     content_encoding: str | None = None
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         # https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Basics_of_HTTP/MIME_types
         if self.content_type is None:
             if self.is_collection:

asgi_webdav/provider/memory.py

@@ -104,7 +104,7 @@ def remove_child(self, name) -> bool:
         self.children.pop(name)
         return True
 
-    def remove_all_child(self):
+    def remove_all_child(self) -> None:
         for child_name in list(self.children):
             self.remove_child(child_name)