More type hints

radicale/httputils.py

@@ -22,53 +22,57 @@ Helper functions for HTTP.
 
 """
 
+import contextlib
 from http import client
+from typing import List, cast
 
+from radicale import config, types
 from radicale.log import logger
 
-NOT_ALLOWED = (
+NOT_ALLOWED: types.WSGIResponse = (
     client.FORBIDDEN, (("Content-Type", "text/plain"),),
     "Access to the requested resource forbidden.")
-FORBIDDEN = (
+FORBIDDEN: types.WSGIResponse = (
     client.FORBIDDEN, (("Content-Type", "text/plain"),),
     "Action on the requested resource refused.")
-BAD_REQUEST = (
+BAD_REQUEST: types.WSGIResponse = (
     client.BAD_REQUEST, (("Content-Type", "text/plain"),), "Bad Request")
-NOT_FOUND = (
+NOT_FOUND: types.WSGIResponse = (
     client.NOT_FOUND, (("Content-Type", "text/plain"),),
     "The requested resource could not be found.")
-CONFLICT = (
+CONFLICT: types.WSGIResponse = (
     client.CONFLICT, (("Content-Type", "text/plain"),),
     "Conflict in the request.")
-METHOD_NOT_ALLOWED = (
+METHOD_NOT_ALLOWED: types.WSGIResponse = (
     client.METHOD_NOT_ALLOWED, (("Content-Type", "text/plain"),),
     "The method is not allowed on the requested resource.")
-PRECONDITION_FAILED = (
+PRECONDITION_FAILED: types.WSGIResponse = (
     client.PRECONDITION_FAILED,
     (("Content-Type", "text/plain"),), "Precondition failed.")
-REQUEST_TIMEOUT = (
+REQUEST_TIMEOUT: types.WSGIResponse = (
     client.REQUEST_TIMEOUT, (("Content-Type", "text/plain"),),
     "Connection timed out.")
-REQUEST_ENTITY_TOO_LARGE = (
+REQUEST_ENTITY_TOO_LARGE: types.WSGIResponse = (
     client.REQUEST_ENTITY_TOO_LARGE, (("Content-Type", "text/plain"),),
     "Request body too large.")
-REMOTE_DESTINATION = (
+REMOTE_DESTINATION: types.WSGIResponse = (
     client.BAD_GATEWAY, (("Content-Type", "text/plain"),),
     "Remote destination not supported.")
-DIRECTORY_LISTING = (
+DIRECTORY_LISTING: types.WSGIResponse = (
     client.FORBIDDEN, (("Content-Type", "text/plain"),),
     "Directory listings are not supported.")
-INTERNAL_SERVER_ERROR = (
+INTERNAL_SERVER_ERROR: types.WSGIResponse = (
     client.INTERNAL_SERVER_ERROR, (("Content-Type", "text/plain"),),
     "A server error occurred.  Please contact the administrator.")
 
-DAV_HEADERS = "1, 2, 3, calendar-access, addressbook, extended-mkcol"
+DAV_HEADERS: str = "1, 2, 3, calendar-access, addressbook, extended-mkcol"
 
 
-def decode_request(configuration, environ, text):
+def decode_request(configuration: "config.Configuration",
+                   environ: types.WSGIEnviron, text: bytes) -> str:
     """Try to magically decode ``text`` according to given ``environ``."""
     # List of charsets to try
-    charsets = []
+    charsets: List[str] = []
 
     # First append content charset given in the request
     content_type = environ.get("CONTENT_TYPE")
@@ -76,7 +80,7 @@ def decode_request(configuration, environ, text):
         charsets.append(
             content_type.split("charset=")[1].split(";")[0].strip())
     # Then append default Radicale charset
-    charsets.append(configuration.get("encoding", "request"))
+    charsets.append(cast(str, configuration.get("encoding", "request")))
     # Then append various fallbacks
     charsets.append("utf-8")
     charsets.append("iso8859-1")
@@ -87,15 +91,14 @@ def decode_request(configuration, environ, text):
 
     # Try to decode
     for charset in charsets:
-        try:
+        with contextlib.suppress(UnicodeDecodeError):
             return text.decode(charset)
-        except UnicodeDecodeError:
-            pass
     raise UnicodeDecodeError("decode_request", text, 0, len(text),
                              "all codecs failed [%s]" % ", ".join(charsets))
 
 
-def read_raw_request_body(configuration, environ):
+def read_raw_request_body(configuration: "config.Configuration",
+                          environ: types.WSGIEnviron) -> bytes:
     content_length = int(environ.get("CONTENT_LENGTH") or 0)
     if not content_length:
         return b""
@@ -105,8 +108,9 @@ def read_raw_request_body(configuration, environ):
     return content
 
 
-def read_request_body(configuration, environ):
-    content = decode_request(
-        configuration, environ, read_raw_request_body(configuration, environ))
+def read_request_body(configuration: "config.Configuration",
+                      environ: types.WSGIEnviron) -> str:
+    content = decode_request(configuration, environ,
+                             read_raw_request_body(configuration, environ))
     logger.debug("Request content:\n%s", content)
     return content