Resolving rest of pylint and black errors

Author: michalpokusa

adafruit_httpserver/methods.py

@@ -7,7 +7,8 @@
 * Author(s): Michał Pokusa
 """
 
-class HTTPMethod:
+
+class HTTPMethod:  # pylint: disable=too-few-public-methods
     """Enum with HTTP methods."""
 
     GET = "GET"

adafruit_httpserver/mime_type.py

@@ -7,92 +7,94 @@
 * Author(s): Dan Halbert, Michał Pokusa
 """
 
+
 class MIMEType:
     """Common MIME types.
     From https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
     """
 
-    AAC = "audio/aac"
-    ABW = "application/x-abiword"
-    ARC = "application/x-freearc"
-    AVI = "video/x-msvideo"
-    AZW = "application/vnd.amazon.ebook"
-    BIN = "application/octet-stream"
-    BMP = "image/bmp"
-    BZ = "application/x-bzip"
-    BZ2 = "application/x-bzip2"
-    CSH = "application/x-csh"
-    CSS = "text/css"
-    CSV = "text/csv"
-    DOC = "application/msword"
-    DOCX = "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
-    EOT = "application/vnd.ms-fontobject"
-    EPUB = "application/epub+zip"
-    GZ = "application/gzip"
-    GIF = "image/gif"
-    HTML = "text/html"
-    HTM = "text/html"
-    ICO = "image/vnd.microsoft.icon"
-    ICS = "text/calendar"
-    JAR = "application/java-archive"
-    JPEG = "image/jpeg"
-    JPG = "image/jpeg"
-    JS = "text/javascript"
-    JSON = "application/json"
-    JSONLD = "application/ld+json"
-    MID = "audio/midi"
-    MIDI = "audio/midi"
-    MJS = "text/javascript"
-    MP3 = "audio/mpeg"
-    CDA = "application/x-cdf"
-    MP4 = "video/mp4"
-    MPEG = "video/mpeg"
-    MPKG = "application/vnd.apple.installer+xml"
-    ODP = "application/vnd.oasis.opendocument.presentation"
-    ODS = "application/vnd.oasis.opendocument.spreadsheet"
-    ODT = "application/vnd.oasis.opendocument.text"
-    OGA = "audio/ogg"
-    OGV = "video/ogg"
-    OGX = "application/ogg"
-    OPUS = "audio/opus"
-    OTF = "font/otf"
-    PNG = "image/png"
-    PDF = "application/pdf"
-    PHP = "application/x-httpd-php"
-    PPT = "application/vnd.ms-powerpoint"
-    PPTX = "application/vnd.openxmlformats-officedocument.presentationml.presentation"
-    RAR = "application/vnd.rar"
-    RTF = "application/rtf"
-    SH = "application/x-sh"
-    SVG = "image/svg+xml"
-    SWF = "application/x-shockwave-flash"
-    TAR = "application/x-tar"
-    TIFF = "image/tiff"
-    TIF = "image/tiff"
-    TS = "video/mp2t"
-    TTF = "font/ttf"
-    TXT = "text/plain"
-    VSD = "application/vnd.visio"
-    WAV = "audio/wav"
-    WEBA = "audio/webm"
-    WEBM = "video/webm"
-    WEBP = "image/webp"
-    WOFF = "font/woff"
-    WOFF2 = "font/woff2"
-    XHTML = "application/xhtml+xml"
-    XLS = "application/vnd.ms-excel"
-    XLSX = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
-    XML = "application/xml"
-    XUL = "application/vnd.mozilla.xul+xml"
-    ZIP = "application/zip"
-    _7Z = "application/x-7z-compressed"
+    TYPE_AAC = "audio/aac"
+    TYPE_ABW = "application/x-abiword"
+    TYPE_ARC = "application/x-freearc"
+    TYPE_AVI = "video/x-msvideo"
+    TYPE_AZW = "application/vnd.amazon.ebook"
+    TYPE_BIN = "application/octet-stream"
+    TYPE_BMP = "image/bmp"
+    TYPE_BZ = "application/x-bzip"
+    TYPE_BZ2 = "application/x-bzip2"
+    TYPE_CSH = "application/x-csh"
+    TYPE_CSS = "text/css"
+    TYPE_CSV = "text/csv"
+    TYPE_DOC = "application/msword"
+    TYPE_DOCX = (
+        "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
+    )
+    TYPE_EOT = "application/vnd.ms-fontobject"
+    TYPE_EPUB = "application/epub+zip"
+    TYPE_GZ = "application/gzip"
+    TYPE_GIF = "image/gif"
+    TYPE_HTML = "text/html"
+    TYPE_HTM = "text/html"
+    TYPE_ICO = "image/vnd.microsoft.icon"
+    TYPE_ICS = "text/calendar"
+    TYPE_JAR = "application/java-archive"
+    TYPE_JPEG = "image/jpeg"
+    TYPE_JPG = "image/jpeg"
+    TYPE_JS = "text/javascript"
+    TYPE_JSON = "application/json"
+    TYPE_JSONLD = "application/ld+json"
+    TYPE_MID = "audio/midi"
+    TYPE_MIDI = "audio/midi"
+    TYPE_MJS = "text/javascript"
+    TYPE_MP3 = "audio/mpeg"
+    TYPE_CDA = "application/x-cdf"
+    TYPE_MP4 = "video/mp4"
+    TYPE_MPEG = "video/mpeg"
+    TYPE_MPKG = "application/vnd.apple.installer+xml"
+    TYPE_ODP = "application/vnd.oasis.opendocument.presentation"
+    TYPE_ODS = "application/vnd.oasis.opendocument.spreadsheet"
+    TYPE_ODT = "application/vnd.oasis.opendocument.text"
+    TYPE_OGA = "audio/ogg"
+    TYPE_OGV = "video/ogg"
+    TYPE_OGX = "application/ogg"
+    TYPE_OPUS = "audio/opus"
+    TYPE_OTF = "font/otf"
+    TYPE_PNG = "image/png"
+    TYPE_PDF = "application/pdf"
+    TYPE_PHP = "application/x-httpd-php"
+    TYPE_PPT = "application/vnd.ms-powerpoint"
+    TYPE_PPTX = (
+        "application/vnd.openxmlformats-officedocument.presentationml.presentation"
+    )
+    TYPE_RAR = "application/vnd.rar"
+    TYPE_RTF = "application/rtf"
+    TYPE_SH = "application/x-sh"
+    TYPE_SVG = "image/svg+xml"
+    TYPE_SWF = "application/x-shockwave-flash"
+    TYPE_TAR = "application/x-tar"
+    TYPE_TIFF = "image/tiff"
+    TYPE_TIF = "image/tiff"
+    TYPE_TS = "video/mp2t"
+    TYPE_TTF = "font/ttf"
+    TYPE_TXT = "text/plain"
+    TYPE_VSD = "application/vnd.visio"
+    TYPE_WAV = "audio/wav"
+    TYPE_WEBA = "audio/webm"
+    TYPE_WEBM = "video/webm"
+    TYPE_WEBP = "image/webp"
+    TYPE_WOFF = "font/woff"
+    TYPE_WOFF2 = "font/woff2"
+    TYPE_XHTML = "application/xhtml+xml"
+    TYPE_XLS = "application/vnd.ms-excel"
+    TYPE_XLSX = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
+    TYPE_XML = "application/xml"
+    TYPE_XUL = "application/vnd.mozilla.xul+xml"
+    TYPE_ZIP = "application/zip"
+    TYPE_7Z = "application/x-7z-compressed"
 
     @staticmethod
     def from_file_name(filename: str):
         """Return the mime type for the given filename. If not known, return "text/plain"."""
-        attr_name = filename.split(".")[-1].upper()
-
-        if attr_name[0].isdigit():
-            attr_name = "_" + attr_name
+        attr_name = "TYPE_" + filename.split(".")[-1].upper()
 
-        return getattr(MIMEType, attr_name, MIMEType.TXT)
+        return getattr(MIMEType, attr_name, MIMEType.TYPE_TXT)

adafruit_httpserver/request.py

@@ -13,9 +13,10 @@
     pass
 
 
-class HTTPRequest:
+class HTTPRequest:  # pylint: disable=too-few-public-methods
     """
-    Incoming request, constructed from raw incoming bytes, that is passed as first argument to route handlers.
+    Incoming request, constructed from raw incoming bytes.
+    It is passed as first argument to route handlers.
     """
 
     method: str
@@ -56,10 +57,15 @@ def __init__(self, raw_request: bytes = None) -> None:
         empty_line_index = raw_request.find(b"\r\n\r\n")
 
         header_bytes = raw_request[:empty_line_index]
-        body_bytes = raw_request[empty_line_index + 4:]
+        body_bytes = raw_request[empty_line_index + 4 :]
 
         try:
-            self.method, self.path, self.query_params, self.http_version = self._parse_start_line(header_bytes)
+            (
+                self.method,
+                self.path,
+                self.query_params,
+                self.http_version,
+            ) = self._parse_start_line(header_bytes)
             self.headers = self._parse_headers(header_bytes)
             self.body = body_bytes
         except Exception as error:

adafruit_httpserver/response.py

@@ -35,20 +35,20 @@ class HTTPResponse:
 
     body: str
 
-    def __init__(
+    def __init__(  # pylint: disable=too-many-arguments
         self,
         status: HTTPStatus = CommonHTTPStatus.OK_200,
         body: str = "",
         headers: Dict[str, str] = None,
-        content_type: str = MIMEType.TXT,
+        content_type: str = MIMEType.TYPE_TXT,
         filename: Optional[str] = None,
         root_path: str = "",
         http_version: str = "HTTP/1.1",
     ) -> None:
         """
         Creates an HTTP response.
 
-        Returns `body` if `filename` is `None`, otherwise returns the contents of `filename`.
+        Returns ``body`` if ``filename`` is ``None``, otherwise returns contents of ``filename``.
         """
 
         self.status = status
@@ -60,10 +60,10 @@ def __init__(
         self.http_version = http_version
 
     @staticmethod
-    def _construct_response_bytes(
+    def _construct_response_bytes(  # pylint: disable=too-many-arguments
         http_version: str = "HTTP/1.1",
         status: HTTPStatus = CommonHTTPStatus.OK_200,
-        content_type: str = MIMEType.TXT,
+        content_type: str = MIMEType.TYPE_TXT,
         content_length: Union[int, None] = None,
         headers: Dict[str, str] = None,
         body: str = "",
@@ -104,7 +104,7 @@ def send(self, conn: Union["SocketPool.Socket", "socket.socket"]) -> None:
                 self._send_response(
                     conn,
                     status=CommonHTTPStatus.NOT_FOUND_404,
-                    content_type=MIMEType.TXT,
+                    content_type=MIMEType.TYPE_TXT,
                     body=f"{CommonHTTPStatus.NOT_FOUND_404} {self.filename}",
                 )
         else:
@@ -116,7 +116,7 @@ def send(self, conn: Union["SocketPool.Socket", "socket.socket"]) -> None:
                 body=self.body,
             )
 
-    def _send_response(
+    def _send_response(  # pylint: disable=too-many-arguments
         self,
         conn: Union["SocketPool.Socket", "socket.socket"],
         status: HTTPStatus,
@@ -134,7 +134,7 @@ def _send_response(
             ),
         )
 
-    def _send_file_response(
+    def _send_file_response(  # pylint: disable=too-many-arguments
         self,
         conn: Union["SocketPool.Socket", "socket.socket"],
         filename: str,

adafruit_httpserver/route.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: MIT
 """
-`adafruit_httpserver.route.HTTPRoute`
+`adafruit_httpserver.route._HTTPRoute`
 ====================================================
 * Author(s): Dan Halbert, Michał Pokusa
 """
@@ -11,7 +11,7 @@
 
 
 class _HTTPRoute:
-    """Route definition for different paths, see `HTTPServer.route`."""
+    """Route definition for different paths, see `adafruit_httpserver.server.HTTPServer.route`."""
 
     def __init__(self, path: str = "", method: HTTPMethod = HTTPMethod.GET) -> None:
 

adafruit_httpserver/server.py

@@ -120,9 +120,7 @@ def poll(self):
 
                 # If no handler exists and request method is not GET, return 400 Bad Request.
                 else:
-                    response = HTTPResponse(
-                        status=CommonHTTPStatus.BAD_REQUEST_400
-                    )
+                    response = HTTPResponse(status=CommonHTTPStatus.BAD_REQUEST_400)
 
                 response.send(conn)
         except OSError as ex:

adafruit_httpserver/status.py

@@ -7,6 +7,7 @@
 * Author(s): Dan Halbert, Michał Pokusa
 """
 
+
 class HTTPStatus:  # pylint: disable=too-few-public-methods
     """HTTP status codes."""
 
@@ -26,7 +27,8 @@ def __str__(self):
         return f"{self.code} {self.text}"
 
 
-class CommonHTTPStatus(HTTPStatus):
+class CommonHTTPStatus(HTTPStatus):  # pylint: disable=too-few-public-methods
+    """Common HTTP status codes."""
 
     OK_200 = HTTPStatus(200, "OK")
     """200 OK"""

docs/api.rst

@@ -19,9 +19,6 @@
 .. automodule:: adafruit_httpserver.response
     :members:
 
-.. automodule:: adafruit_httpserver.route
-    :private-members:
-
 .. automodule:: adafruit_httpserver.server
     :members: