Update ruff configuration: remove defaults and extend rules by ALL. (#24)

* Update `ruff` configuration: remove defaults and extend rules by `ALL`.

* Apply new rules.

Author: hasansezertasan

pyproject.toml

@@ -91,58 +91,25 @@ python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
 
 [tool.ruff]
-target-version = "py38"
 show-fixes = true
 fix = true
+
 [tool.ruff.lint]
-select = [
-  "A",
-  "ARG",
-  "B",   # flake8-bugbear
-  "B9",
-  "C",   # flake8-comprehensions
-  "C4",  # flake8-comprehensions
-  "C90", # mccabe
-  "DTZ",
-  "E",   # pycodestyle errors
-  "E4",
-  "E7",
-  "E9",
-  "EM",
-  "ERA", # eradicate
-  "F",   # pyflakes
-  "I",   # isort
-  "INT", # flake8-gettext
-  "ICN",
-  "N",   # pep8-naming
-  "PIE", # flake8-pie,
-  # "PLC", # pylint - convention
-  "PLE", # pylint - error
-  "PLR",
-  "PLW", # pylint - warning
-  "Q",   # flake8-quotes
-  "RET", # flake8-return,
-  "RUF", # Ruff-specific rules
-  "SIM", # flake8-simplify
-  # "S",
-  "T",
-  "TID",
-  "T20", # flake8-print
-  # "UP",  # pyupgrade
-  "W",   # pycodestyle warnings
-  "YTT",
+extend-select = ["ALL"]
+ignore = [
+  "ANN401",
+  "COM",
+  "S",
+  "UP",
+  "CPY",
+  "PLC0414",
+  "PLR6201",
+  "RUF029",
+  "D203",
+  "D213"
 ]
-# Allow fix for all enabled rules (when `--fix`) is provided.
-fixable = ["ALL"]
-[tool.ruff.format]
-# Like Black, use double quotes for strings.
-quote-style = "double"
-# Like Black, indent with spaces, rather than tabs.
-indent-style = "space"
-# Like Black, respect magic trailing commas.
-skip-magic-trailing-comma = false
-# Like Black, automatically detect the appropriate line ending.
-line-ending = "auto"
+preview = true
+
 [tool.ruff.lint.isort]
 known-first-party = ["asgi_user_agents"]
 

src/asgi_user_agents/__about__.py

@@ -1 +1,3 @@
+"""Package metadata."""
+
 __version__ = "0.2.0"

src/asgi_user_agents/__init__.py

@@ -1,3 +1,5 @@
+"""ASGI User Agents package initialization."""
+
 from contextlib import suppress
 
 from .datastructures import UADetails as UADetails

src/asgi_user_agents/datastructures.py

@@ -1,73 +1,93 @@
+"""Data structures for user-agent details."""
+
 from __future__ import annotations
 
-from typing import Optional
+from typing import TYPE_CHECKING, Optional
 from urllib.parse import unquote
 
 from user_agents.parsers import Browser, Device, OperatingSystem, UserAgent
 
-from asgi_user_agents.types import Scope
+if TYPE_CHECKING:
+    from asgi_user_agents.types import Scope
 
 
 class UADetails:
+    """User-Agent details object."""
+
     def __init__(self, scope: Scope) -> None:
+        """Initialize the user-agent details object."""
         self._scope = scope
         self._ua: UserAgent
 
     def _get_header(self, name: bytes) -> Optional[str]:
+        """Get header value."""
         return _get_header(self._scope, name)
 
     @property
     def _ua_string(self) -> Optional[str]:
+        """Extract user-agent string from the headers of the request and return it."""
         return self._get_header(b"User-Agent") or ""
 
     @property
     def ua(self) -> UserAgent:
+        """Return the user-agent object."""
         if not hasattr(self, "_ua"):
             self._ua = UserAgent(self._ua_string)
         return self._ua
 
     @property
     def ua_string(self) -> str:
+        """Return the user-agent string."""
         return self.ua.ua_string
 
     @property
     def is_provided(self) -> bool:
+        """Check if the user-agent string is provided."""
         return bool(self.ua_string)
 
     @property
     def os(self) -> OperatingSystem:
+        """Return the operating system."""
         return self.ua.os
 
     @property
     def browser(self) -> Browser:
+        """Return the browser."""
         return self.ua.browser
 
     @property
     def device(self) -> Device:
+        """Return the device."""
         return self.ua.device
 
     @property
     def is_tablet(self) -> bool:
+        """Check if the device is a tablet."""
         return self.ua.is_tablet
 
     @property
     def is_mobile(self) -> bool:
+        """Check if the device is a mobile."""
         return self.ua.is_mobile
 
     @property
     def is_touch_capable(self) -> bool:
+        """Check if the device is touch capable."""
         return self.ua.is_touch_capable
 
     @property
     def is_pc(self) -> bool:
+        """Check if the device is a PC."""
         return self.ua.is_pc
 
     @property
     def is_bot(self) -> bool:
+        """Check if the device is a bot."""
         return self.ua.is_bot
 
     @property
     def is_email_client(self) -> bool:
+        """Check if the device is an email client."""
         return self.ua.is_email_client
 
 

src/asgi_user_agents/middleware.py

@@ -1,12 +1,18 @@
+"""Middleware for ASGI applications."""
+
 from asgi_user_agents.datastructures import UADetails
 from asgi_user_agents.types import ASGIApp, Receive, Scope, Send
 
 
 class UAMiddleware:
+    """User Agent Middleware for ASGI applications."""
+
     def __init__(self, app: ASGIApp) -> None:
+        """Initialize the middleware."""
         self._app = app
 
     async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
+        """Call the middleware."""
         if scope["type"] in ("http", "websocket"):
             scope["ua"] = UADetails(scope)
 

src/asgi_user_agents/requests.py

@@ -1,3 +1,5 @@
+"""Request classes with `scope` attribute of type `UAScope` for type-checking."""
+
 from typing import Any, Literal, Protocol, overload
 
 from asgi_user_agents.datastructures import UADetails
@@ -10,18 +12,19 @@
 else:
 
     class UAScopeProtocol(Protocol):
+        """Protocol for `UAScope` class."""
+
         @overload
         def __getitem__(self, key: Literal["ua"]) -> UADetails: ...  # pragma: no cover
 
         @overload
         def __getitem__(self, key: str) -> Any: ...  # pragma: no cover
 
     class UAScope(UAScopeProtocol, Scope):
-        pass
+        """User-Agent scope object with `ua` attribute of type `UADetails`."""
 
     class UARequest(Request):
-        """
-        User-Agent request object with `scope` attribute of type `UAScope`.
+        """User-Agent request object with `scope` attribute of type `UAScope`.
 
         !!! note
             Use this class to make code editors type-check `request.scope["ua"]`.

src/asgi_user_agents/types.py

@@ -1,3 +1,5 @@
+"""Types for ASGI apps."""
+
 # Ripped from `starlette.types`.
 import typing
 

tests/__init__.py

@@ -1,3 +1 @@
-# SPDX-FileCopyrightText: 2024-present Hasan Sezer Taşan <[email protected]>
-#
-# SPDX-License-Identifier: MIT
+"""Entry point for tests."""

tests/test_fastapi.py

@@ -1,3 +1,5 @@
+"""Test usage of the middleware in FastAPI."""
+
 import httpx
 import parametrize_from_file as pff
 import pytest
@@ -13,6 +15,7 @@
 
 @app.get("/")
 async def index(request: Request) -> Response:
+    """Return user-agent data."""
     ua = request.scope["ua"]
     assert isinstance(ua, UADetails)
     data = {
@@ -40,9 +43,10 @@ async def index(request: Request) -> Response:
     return JSONResponse(data)
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 @pff.parametrize(path="assets/test_middleware.json")
 async def test_user_agent_data(ua_string: str, response_data: dict) -> None:
+    """Test user-agent data."""
     async with httpx.AsyncClient(app=app) as client:
         response = await client.get(
             "http://testserver/", headers={"User-Agent": ua_string}

tests/test_litestar.py

@@ -1,3 +1,7 @@
+"""Test usage of the middleware in Litestar."""
+
+from __future__ import annotations
+
 from typing import Any, Dict
 
 import httpx
@@ -11,6 +15,7 @@
 
 @get("/")
 async def index(request: Request) -> Dict[str, Any]:
+    """Return user-agent data."""
     ua = request.scope["ua"]
     assert isinstance(ua, UADetails)
     return {
@@ -40,9 +45,10 @@ async def index(request: Request) -> Dict[str, Any]:
 app = Litestar(route_handlers=[index], middleware=[UAMiddleware])
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 @pff.parametrize(path="assets/test_middleware.json")
 async def test_user_agent_data(ua_string: str, response_data: dict) -> None:
+    """Test user-agent data."""
     async with httpx.AsyncClient(app=app) as client:
         response = await client.get(
             "http://testserver/", headers={"User-Agent": ua_string}

tests/test_quart.py

@@ -1,3 +1,5 @@
+"""Test usage of the middleware in Quart."""
+
 from typing import cast
 
 import httpx
@@ -12,6 +14,7 @@
 
 @app.route("/")
 async def home() -> str:
+    """Return user-agent data."""
     ua = UADetails(cast(dict, request.scope))
     data = {
         "ua_string": ua.ua_string,
@@ -38,9 +41,10 @@ async def home() -> str:
     return jsonify(data)
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 @pff.parametrize(path="assets/test_middleware.json")
 async def test_user_agent_data(ua_string: str, response_data: dict) -> None:
+    """Test user-agent data."""
     async with httpx.AsyncClient(app=app) as client:
         response = await client.get(
             "http://testserver/", headers={"User-Agent": ua_string}

tests/test_starlette.py

@@ -1,3 +1,5 @@
+"""Test usage of the middleware in Starlette."""
+
 import httpx
 import parametrize_from_file as pff
 import pytest
@@ -11,6 +13,7 @@
 
 
 async def index(request: Request) -> Response:
+    """Return user-agent data."""
     ua = request.scope["ua"]
     assert isinstance(ua, UADetails)
     data = {
@@ -41,9 +44,10 @@ async def index(request: Request) -> Response:
 app = Starlette(routes=[Route("/", index)], middleware=[Middleware(UAMiddleware)])
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 @pff.parametrize(path="assets/test_middleware.json")
 async def test_user_agent_data(ua_string: str, response_data: dict) -> None:
+    """Test user-agent data."""
     async with httpx.AsyncClient(app=app) as client:
         response = await client.get(
             "http://testserver/", headers={"User-Agent": ua_string}