refractor: update docs + lint code

Author: shreyas-dev

docs/middleware.md

@@ -230,9 +230,27 @@ The following arguments are supported:
 
 * `minimum_size` - Do not GZip responses that are smaller than this minimum size in bytes. Defaults to `500`.
 * `compresslevel` - Used during GZip compression. It is an integer ranging from 1 to 9. Defaults to `9`. Lower value results in faster compression but larger file sizes, while higher value results in slower compression but smaller file sizes.
+* `excluded_content_types` - A tuple of content type prefixes that should not be compressed. Defaults to `("text/event-stream", "application/zip", "application/gzip", "application/x-gzip", "image/", "video/", "audio/")`. You can customize this to add or remove content types as needed.
 
-The middleware won't GZip responses that already have either a `Content-Encoding` set, to prevent them from
-being encoded twice, or a `Content-Type` set to `text/event-stream`, to avoid compressing server-sent events.
+The middleware won't GZip responses that:
+
+* Already have a `Content-Encoding` set, to prevent them from being encoded twice
+* Have a `Content-Type` that starts with any of the prefixes in `excluded_content_types`
+
+By default, the following content types are excluded:
+
+* `text/event-stream` - Server-sent events should not be compressed
+* Already compressed formats: `application/zip`, `application/gzip`, `application/x-gzip`
+* Media files: `image/*`, `video/*`, `audio/*` (any image, video, or audio format)
+
+### Customizing excluded content types
+
+You can provide your own list of excluded content types:
+```python
+middleware = [
+    Middleware(GZipMiddleware, minimum_size=1000, compresslevel=9, excluded_content_types=("text/event-stream", "image/"))
+]
+```
 
 ## BaseHTTPMiddleware
 

starlette/middleware/gzip.py

@@ -7,15 +7,21 @@
 
 
 class GZipMiddleware:
-    def __init__(self, app: ASGIApp, minimum_size: int = 500, compresslevel: int = 9, excluded_content_types: tuple[str, ...] = (
+    def __init__(
+        self,
+        app: ASGIApp,
+        minimum_size: int = 500,
+        compresslevel: int = 9,
+        excluded_content_types: tuple[str, ...] = (
             "text/event-stream",
             "application/zip",
             "application/gzip",
             "application/x-gzip",
             "image/",
             "video/",
             "audio/",
-        )) -> None:
+        ),
+    ) -> None:
         self.app = app
         self.minimum_size = minimum_size
         self.compresslevel = compresslevel
@@ -29,7 +35,9 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
         headers = Headers(scope=scope)
         responder: ASGIApp
         if "gzip" in headers.get("Accept-Encoding", ""):
-            responder = GZipResponder(self.app, self.minimum_size, self.excluded_content_types, compresslevel=self.compresslevel)
+            responder = GZipResponder(
+                self.app, self.minimum_size, self.excluded_content_types, compresslevel=self.compresslevel
+            )
         else:
             responder = IdentityResponder(self.app, self.minimum_size, self.excluded_content_types)
 
@@ -39,7 +47,12 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
 class IdentityResponder:
     content_encoding: str
 
-    def __init__(self, app: ASGIApp, minimum_size: int, excluded_content_types: tuple[str, ...],) -> None:
+    def __init__(
+        self,
+        app: ASGIApp,
+        minimum_size: int,
+        excluded_content_types: tuple[str, ...],
+    ) -> None:
         self.app = app
         self.minimum_size = minimum_size
         self.send: Send = unattached_send
@@ -62,8 +75,7 @@ async def send_with_compression(self, message: Message) -> None:
             headers = Headers(raw=self.initial_message["headers"])
             self.content_encoding_set = "content-encoding" in headers
             self.content_type_is_excluded = any(
-                headers.get("content-type", "").startswith(ct)
-                for ct in self.excluded_content_types
+                headers.get("content-type", "").startswith(ct) for ct in self.excluded_content_types
             )
         elif message_type == "http.response.body" and (self.content_encoding_set or self.content_type_is_excluded):
             if not self.started:
@@ -130,7 +142,9 @@ def apply_compression(self, body: bytes, *, more_body: bool) -> bytes:
 class GZipResponder(IdentityResponder):
     content_encoding = "gzip"
 
-    def __init__(self, app: ASGIApp, minimum_size: int, excluded_content_types: tuple[str, ...], compresslevel: int = 9) -> None:
+    def __init__(
+        self, app: ASGIApp, minimum_size: int, excluded_content_types: tuple[str, ...], compresslevel: int = 9
+    ) -> None:
         super().__init__(app, minimum_size, excluded_content_types)
 
         self.gzip_buffer = io.BytesIO()

tests/middleware/test_gzip.py

@@ -8,7 +8,7 @@
 from starlette.middleware import Middleware
 from starlette.middleware.gzip import GZipMiddleware
 from starlette.requests import Request
-from starlette.responses import ContentStream, FileResponse, PlainTextResponse, StreamingResponse, Response
+from starlette.responses import ContentStream, FileResponse, PlainTextResponse, Response, StreamingResponse
 from starlette.routing import Route
 from starlette.types import Message
 from tests.types import TestClientFactory