refactor: use typos (#4080)

Author: adhtruong

.pre-commit-config.yaml

@@ -29,13 +29,10 @@ repos:
       - id: ruff
         args: ["--fix"]
       - id: ruff-format
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.30.3
     hooks:
-      - id: codespell
-        exclude: "tests/openapi/typescript_converter/test_converter|README.md"
-        additional_dependencies:
-          - tomli
+      - id: typos
   - repo: https://github.com/python-formate/flake8-dunder-all
     rev: v0.4.1
     hooks:

litestar/dto/_backend.py

@@ -137,10 +137,10 @@ def parse_model(
         Fields for data transfer.
         """
         defined_fields = []
-        generic_field_definitons = list(FieldDefinition.from_annotation(model_type).generic_types or ())
+        generic_field_definitions = list(FieldDefinition.from_annotation(model_type).generic_types or ())
         for field_definition in self.dto_factory.generate_field_definitions(model_type):
             if field_definition.is_type_var:
-                base_arg_field = generic_field_definitons.pop()
+                base_arg_field = generic_field_definitions.pop()
                 field_definition = replace(
                     field_definition, annotation=base_arg_field.annotation, raw=base_arg_field.raw
                 )

litestar/dto/dataclass_dto.py

@@ -38,7 +38,7 @@ def generate_field_definitions(
 
             default = dc_field.default if dc_field.default is not MISSING else Empty
             default_factory = dc_field.default_factory if dc_field.default_factory is not MISSING else None
-            field_defintion = replace(
+            field_definition = replace(
                 DTOFieldDefinition.from_field_definition(
                     field_definition=field_definition,
                     default_factory=default_factory,
@@ -50,9 +50,9 @@ def generate_field_definitions(
             )
 
             yield (
-                replace(field_defintion, default=Empty, kwarg_definition=default)
+                replace(field_definition, default=Empty, kwarg_definition=default)
                 if isinstance(default, (KwargDefinition, DependencyKwarg))
-                else field_defintion
+                else field_definition
             )
 
         for key, property_field in properties.items():

litestar/handlers/websocket_handlers/_utils.py

@@ -99,14 +99,14 @@ async def __call__(
         connection_lifespan_dependencies: Dict[str, Any],  # noqa: UP006
         **kwargs: Any,
     ) -> None:
-        lifespan_mananger = self._listener._connection_lifespan or self._listener.default_connection_lifespan
+        lifespan_manager = self._listener._connection_lifespan or self._listener.default_connection_lifespan
         handle_send = self._listener.resolve_send_handler() if self._can_send_data else None
         handle_receive = self._listener.resolve_receive_handler()
 
         if self._pass_socket:
             kwargs["socket"] = socket
 
-        async with lifespan_mananger(**connection_lifespan_dependencies):
+        async with lifespan_manager(**connection_lifespan_dependencies):
             while True:
                 received_data = await handle_receive(socket)
                 data = await self._fn(*args, data=received_data, **kwargs)

litestar/router.py

@@ -264,7 +264,7 @@ def register(self, value: ControllerRouterHandler) -> list[BaseRoute]:
 
     @property
     def route_handler_method_map(self) -> dict[str, RouteHandlerMapItem]:
-        """Map route paths to :class:`RouteHandlerMapItem <litestar.types.internal_typ es.RouteHandlerMapItem>`
+        """Map route paths to :class:`RouteHandlerMapItem <litestar.types.internal_types es.RouteHandlerMapItem>`
 
         Returns:
              A dictionary mapping paths to route handlers

pyproject.toml

@@ -192,10 +192,6 @@ test = [
 build-backend = "hatchling.build"
 requires = ["hatchling"]
 
-[tool.codespell]
-ignore-words-list = "selectin, documen"
-skip = 'uv.lock,docs/examples/contrib/sqlalchemy/us_state_lookup.json'
-
 [tool.coverage.run]
 concurrency = ["multiprocessing", "thread"]
 omit = ["*/tests/*", "*/litestar/plugins/sqlalchemy.py", "*/litestar/_kwargs/types.py"]

test_apps/debugging/main.py

@@ -16,7 +16,7 @@
 async def zero_division_error() -> Dict[str, str]:
     """Handler function that returns a greeting dictionary."""
     1 / 0  # pyright: ignore # noqa: B018
-    return {"message": "ZeroDevisionError didn't occur."}
+    return {"message": "ZeroDivisionError didn't occur."}
 
 
 pdb_app = Litestar(route_handlers=[zero_division_error], pdb_on_exception=True, debugger_module=pdb)

tests/unit/test_kwargs/test_layered_params.py

@@ -174,7 +174,7 @@ async def route(self) -> None:
             # included at controller layer
             return None
 
-    class ExlcudedAtController(Controller):
+    class ExcludedAtController(Controller):
         path = "excluded_controller"
         include_in_schema = False
 
@@ -215,14 +215,14 @@ async def route() -> None:
         route_handlers=common_routes,
         include_in_schema=True,
     )
-    ExlcudedAtRouter = Router(
+    ExcludedAtRouter = Router(
         "excluded_router",
         route_handlers=common_routes,
         include_in_schema=False,
     )
 
     with create_test_client(
-        [IncludedAtController, ExlcudedAtController, IncludedAtRouter, ExlcudedAtRouter, *common_routes],
+        [IncludedAtController, ExcludedAtController, IncludedAtRouter, ExcludedAtRouter, *common_routes],
         include_in_schema=False,
     ) as client:
         app = client.app

tests/unit/test_middleware/test_session/test_client_side_backend.py

@@ -204,7 +204,7 @@ def handler(request: Request) -> dict:
 
 
 def test_load_data_should_raise_invalid_tag_if_tampered_aad(cookie_session_backend: ClientSideSessionBackend) -> None:
-    """If AAD has been tampered with, the integrity of the data cannot be verified and InavlidTag exception is
+    """If AAD has been tampered with, the integrity of the data cannot be verified and InvalidTag exception is
     raised.
     """
     encrypted_session = cookie_session_backend.dump_data(create_session())

tests/unit/test_params.py

@@ -274,7 +274,7 @@ def handle_default_annotated(
         yield client
 
 
-def test_optional_query_parameter_consistency_wiht_default_queried_without_param(
+def test_optional_query_parameter_consistency_with_default_queried_without_param(
     optional_default_client: TestClient,
 ) -> None:
     assert optional_default_client.get("/optional-default", params={}).json() == {"key": None}

tests/unit/test_response/test_base_response.py

@@ -41,11 +41,17 @@ def test_response_headers_do_not_lowercase_values() -> None:
 
     @get("/")
     def handler() -> Response:
-        return Response(content="hello world", media_type=MediaType.TEXT, headers={"foo": "BaR"})
+        return Response(
+            content="hello world",
+            media_type=MediaType.TEXT,
+            headers={
+                "foo": "BaR"  # codespell:ignore
+            },
+        )
 
     with create_test_client(handler) as client:
         response = client.get("/")
-        assert response.headers["foo"] == "BaR"
+        assert response.headers["foo"] == "BaR"  # codespell:ignore
 
 
 @pytest.mark.parametrize("as_instance", [True, False])

tests/unit/test_response/test_file_response.py

@@ -399,7 +399,14 @@ def file(tmpdir: Path) -> Path:
     return path
 
 
-@pytest.mark.parametrize("header_name", ["content-length", "Content-Length", "contenT-leNgTh"])
+@pytest.mark.parametrize(
+    "header_name",
+    [
+        "content-length",
+        "Content-Length",
+        "contenT-leNgTh",  # codespell:ignore
+    ],
+)
 def test_does_not_override_existing_content_length_header(header_name: str, file: Path) -> None:
     @get("/")
     def handler() -> File:

typos.toml

@@ -0,0 +1,14 @@
+[default]
+extend-ignore-re = ["(?Rm)^.*(#|//)\\s*codespell:ignore\\s*$"]
+
+[default.extend-words]
+selectin = 'selectin'
+odf = 'odf'
+splitted = 'splitted'
+
+[files]
+extend-exclude = [
+    "docs/changelog.rst",
+    "docs/release-notes/changelog.rst",
+    "/docs/examples/contrib/sqlalchemy/us_state_lookup.json",
+]