Removed HTTP... prefix from class names

Author: michalpokusa

adafruit_httpserver/authentication.py

@@ -15,7 +15,7 @@
 from binascii import b2a_base64
 
 from .exceptions import AuthenticationError
-from .request import HTTPRequest
+from .request import Request
 
 
 class Basic:
@@ -38,9 +38,7 @@ def __str__(self) -> str:
         return f"Bearer {self._value}"
 
 
-def check_authentication(
-    request: HTTPRequest, auths: List[Union[Basic, Bearer]]
-) -> bool:
+def check_authentication(request: Request, auths: List[Union[Basic, Bearer]]) -> bool:
     """
     Returns ``True`` if request is authorized by any of the authentications, ``False`` otherwise.
     """
@@ -53,9 +51,7 @@ def check_authentication(
     return any(auth_header == str(auth) for auth in auths)
 
 
-def require_authentication(
-    request: HTTPRequest, auths: List[Union[Basic, Bearer]]
-) -> None:
+def require_authentication(request: Request, auths: List[Union[Basic, Bearer]]) -> None:
     """
     Checks if the request is authorized and raises ``AuthenticationError`` if not.
 

adafruit_httpserver/exceptions.py

@@ -10,7 +10,7 @@
 
 class AuthenticationError(Exception):
     """
-    Raised by ``require_authentication`` when the ``HTTPRequest`` is not authorized.
+    Raised by ``require_authentication`` when the ``Request`` is not authorized.
     """
 
 
@@ -42,7 +42,7 @@ def __init__(self, path: str) -> None:
 
 class ResponseAlreadySentError(Exception):
     """
-    Another ``HTTPResponse`` has already been sent. There can only be one per ``HTTPRequest``.
+    Another ``Response`` has already been sent. There can only be one per ``Request``.
     """
 
 

adafruit_httpserver/headers.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: MIT
 """
-`adafruit_httpserver.headers.HTTPHeaders`
+`adafruit_httpserver.headers`
 ====================================================
 * Author(s): Michał Pokusa
 """
@@ -13,7 +13,7 @@
     pass
 
 
-class HTTPHeaders:
+class Headers:
     """
     A dict-like class for storing HTTP headers.
 
@@ -23,7 +23,7 @@ class HTTPHeaders:
 
     Examples::
 
-        headers = HTTPHeaders({"Content-Type": "text/html", "Content-Length": "1024"})
+        headers = Headers({"Content-Type": "text/html", "Content-Length": "1024"})
 
         len(headers)
         # 2
@@ -48,7 +48,6 @@ class HTTPHeaders:
     _storage: Dict[str, Tuple[str, str]]
 
     def __init__(self, headers: Dict[str, str] = None) -> None:
-
         headers = headers or {}
 
         self._storage = {key.lower(): [key, value] for key, value in headers.items()}
@@ -81,7 +80,7 @@ def update(self, headers: Dict[str, str]):
 
     def copy(self):
         """Returns a copy of the headers."""
-        return HTTPHeaders(dict(self._storage.values()))
+        return Headers(dict(self._storage.values()))
 
     def __getitem__(self, name: str):
         return self._storage[name.lower()][1]

adafruit_httpserver/methods.py

@@ -2,38 +2,35 @@
 #
 # SPDX-License-Identifier: MIT
 """
-`adafruit_httpserver.methods.HTTPMethod`
+`adafruit_httpserver.methods`
 ====================================================
 * Author(s): Michał Pokusa
 """
 
 
-class HTTPMethod:  # pylint: disable=too-few-public-methods
-    """Enum with HTTP methods."""
+GET = "GET"
+"""GET method."""
 
-    GET = "GET"
-    """GET method."""
+POST = "POST"
+"""POST method."""
 
-    POST = "POST"
-    """POST method."""
+PUT = "PUT"
+"""PUT method"""
 
-    PUT = "PUT"
-    """PUT method"""
+DELETE = "DELETE"
+"""DELETE method"""
 
-    DELETE = "DELETE"
-    """DELETE method"""
+PATCH = "PATCH"
+"""PATCH method"""
 
-    PATCH = "PATCH"
-    """PATCH method"""
+HEAD = "HEAD"
+"""HEAD method"""
 
-    HEAD = "HEAD"
-    """HEAD method"""
+OPTIONS = "OPTIONS"
+"""OPTIONS method"""
 
-    OPTIONS = "OPTIONS"
-    """OPTIONS method"""
+TRACE = "TRACE"
+"""TRACE method"""
 
-    TRACE = "TRACE"
-    """TRACE method"""
-
-    CONNECT = "CONNECT"
-    """CONNECT method"""
+CONNECT = "CONNECT"
+"""CONNECT method"""

adafruit_httpserver/request.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: MIT
 """
-`adafruit_httpserver.request.HTTPRequest`
+`adafruit_httpserver.request`
 ====================================================
 * Author(s): Dan Halbert, Michał Pokusa
 """
@@ -14,10 +14,10 @@
 except ImportError:
     pass
 
-from .headers import HTTPHeaders
+from .headers import Headers
 
 
-class HTTPRequest:
+class Request:
     """
     Incoming request, constructed from raw incoming bytes.
     It is passed as first argument to route handlers.
@@ -50,15 +50,15 @@ class HTTPRequest:
 
     Example::
 
-            request  = HTTPRequest(raw_request=b"GET /?foo=bar HTTP/1.1...")
+            request  = Request(raw_request=b"GET /?foo=bar HTTP/1.1...")
             request.query_params
             # {"foo": "bar"}
     """
 
     http_version: str
     """HTTP version, e.g. "HTTP/1.1"."""
 
-    headers: HTTPHeaders
+    headers: Headers
     """
     Headers from the request.
     """
@@ -143,11 +143,11 @@ def _parse_start_line(header_bytes: bytes) -> Tuple[str, str, Dict[str, str], st
         return method, path, query_params, http_version
 
     @staticmethod
-    def _parse_headers(header_bytes: bytes) -> HTTPHeaders:
+    def _parse_headers(header_bytes: bytes) -> Headers:
         """Parse HTTP headers from raw request."""
         header_lines = header_bytes.decode("utf8").splitlines()[1:]
 
-        return HTTPHeaders(
+        return Headers(
             {
                 name: value
                 for header_line in header_lines

adafruit_httpserver/response.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: MIT
 """
-`adafruit_httpserver.response.HTTPResponse`
+`adafruit_httpserver.response`
 ====================================================
 * Author(s): Dan Halbert, Michał Pokusa
 """
@@ -24,17 +24,17 @@
     ResponseAlreadySentError,
 )
 from .mime_type import MIMEType
-from .request import HTTPRequest
-from .status import HTTPStatus, CommonHTTPStatus
-from .headers import HTTPHeaders
+from .request import Request
+from .status import Status, CommonHTTPStatus
+from .headers import Headers
 
 
 def _prevent_multiple_send_calls(function: Callable):
     """
     Decorator that prevents calling ``send`` or ``send_file`` more than once.
     """
 
-    def wrapper(self: "HTTPResponse", *args, **kwargs):
+    def wrapper(self: "Response", *args, **kwargs):
         if self._response_already_sent:  # pylint: disable=protected-access
             raise ResponseAlreadySentError
 
@@ -44,52 +44,52 @@ def wrapper(self: "HTTPResponse", *args, **kwargs):
     return wrapper
 
 
-class HTTPResponse:
+class Response:
     """
-    Response to a given `HTTPRequest`. Use in `HTTPServer.route` decorator functions.
+    Response to a given `Request`. Use in `Server.route` handler functions.
 
     Example::
 
         # Response with 'Content-Length' header
         @server.route(path, method)
         def route_func(request):
 
-            response = HTTPResponse(request)
+            response = Response(request)
             response.send("Some content", content_type="text/plain")
 
             # or
 
-            response = HTTPResponse(request)
+            response = Response(request)
             with response:
                 response.send(body='Some content', content_type="text/plain")
 
             # or
 
-            with HTTPResponse(request) as response:
+            with Response(request) as response:
                 response.send("Some content", content_type="text/plain")
 
         # Response with 'Transfer-Encoding: chunked' header
         @server.route(path, method)
         def route_func(request):
 
-            response = HTTPResponse(request, content_type="text/plain", chunked=True)
+            response = Response(request, content_type="text/plain", chunked=True)
             with response:
                 response.send_chunk("Some content")
                 response.send_chunk("Some more content")
 
             # or
 
-            with HTTPResponse(request, content_type="text/plain", chunked=True) as response:
+            with Response(request, content_type="text/plain", chunked=True) as response:
                 response.send_chunk("Some content")
                 response.send_chunk("Some more content")
     """
 
-    request: HTTPRequest
+    request: Request
     """The request that this is a response to."""
 
     http_version: str
-    status: HTTPStatus
-    headers: HTTPHeaders
+    status: Status
+    headers: Headers
     content_type: str
     """
     Defaults to ``text/plain`` if not set.
@@ -102,9 +102,9 @@ def route_func(request):
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
-        request: HTTPRequest,
-        status: Union[HTTPStatus, Tuple[int, str]] = CommonHTTPStatus.OK_200,
-        headers: Union[HTTPHeaders, Dict[str, str]] = None,
+        request: Request,
+        status: Union[Status, Tuple[int, str]] = CommonHTTPStatus.OK_200,
+        headers: Union[Headers, Dict[str, str]] = None,
         content_type: str = None,
         http_version: str = "HTTP/1.1",
         chunked: bool = False,
@@ -117,12 +117,12 @@ def __init__(  # pylint: disable=too-many-arguments
 
         To send the response, call ``send`` or ``send_file``.
         For chunked response use
-        ``with HTTPRequest(request, content_type=..., chunked=True) as r:`` and `send_chunk`.
+        ``with Response(request, content_type=..., chunked=True) as r:`` and `send_chunk`.
         """
         self.request = request
-        self.status = status if isinstance(status, HTTPStatus) else HTTPStatus(*status)
+        self.status = status if isinstance(status, Status) else Status(*status)
         self.headers = (
-            headers.copy() if isinstance(headers, HTTPHeaders) else HTTPHeaders(headers)
+            headers.copy() if isinstance(headers, Headers) else Headers(headers)
         )
         self.content_type = content_type
         self.http_version = http_version
@@ -137,7 +137,7 @@ def _send_headers(
         """
         Sends headers.
         Implicitly called by ``send`` and ``send_file`` and in
-        ``with HTTPResponse(request, chunked=True) as response:`` context manager.
+        ``with Response(request, chunked=True) as response:`` context manager.
         """
         headers = self.headers.copy()
 
@@ -259,7 +259,7 @@ def send_chunk(self, chunk: str = "") -> None:
         Sends chunk of response.
 
         Should be used **only** inside
-        ``with HTTPResponse(request, chunked=True) as response:`` context manager.
+        ``with Response(request, chunked=True) as response:`` context manager.
 
         :param str chunk: String data to be sent.
         """