docs: fix python ast, run pre-commit, rebase on latest docs changes

docs/examples/application_state/injecting_application_state.py

@@ -3,4 +3,4 @@
 
 
 @get("/")
-def handler(state: State) -> None: ...
+def handler(state: State) -> None: ...

docs/examples/caching/caching_duration.py

@@ -2,4 +2,4 @@
 
 
 @get("/cached-path", cache=120)  # seconds
-def my_cached_handler() -> str: ...
+def my_cached_handler() -> str: ...

docs/examples/caching/caching_forever.py

@@ -3,4 +3,4 @@
 
 
 @get("/cached-path", cache=CACHE_FOREVER)  # seconds
-def my_cached_handler() -> str: ...
+def my_cached_handler() -> str: ...

docs/examples/caching/caching_key_builder_specific_route.py

@@ -1,9 +1,9 @@
-from litestar import Litestar, Request, get
+from litestar import Request, get
 
 
 def key_builder(request: Request) -> str:
     return request.url.path + request.headers.get("my-header", "")
 
 
 @get("/cached-path", cache=True, cache_key_builder=key_builder)
-def cached_handler() -> str: ...
+def cached_handler() -> str: ...

docs/examples/caching/caching_response.py

@@ -2,4 +2,4 @@
 
 
 @get("/cached-path", cache=True)
-def my_cached_handler() -> str: ...
+def my_cached_handler() -> str: ...

docs/examples/caching/caching_storage_redis.py

@@ -3,4 +3,4 @@
 
 redis_store = RedisStore(url="redis://localhost/", port=6379, db=0)
 
-cache_config = ResponseCacheConfig(store=redis_store)
+cache_config = ResponseCacheConfig(store=redis_store)

docs/examples/channels/allowing_arbitrary_channels.py

@@ -1,3 +1,3 @@
 from litestar.channels import ChannelsPlugin
 
-channels_plugin = ChannelsPlugin(..., arbitrary_channels_allowed=True)
+channels_plugin = ChannelsPlugin(..., arbitrary_channels_allowed=True)

docs/examples/channels/backoff_strategy.py

@@ -5,4 +5,4 @@
     backend=MemoryChannelsBackend(),
     max_backlog=1000,
     backlog_strategy="backoff",
-)
+)

docs/examples/channels/eviction_strategy.py

@@ -5,4 +5,4 @@
     backend=MemoryChannelsBackend(),
     max_backlog=1000,
     backlog_strategy="dropleft",
-)
+)

docs/examples/channels/passing_channels_explicitly.py

@@ -1,3 +1,3 @@
 from litestar.channels import ChannelsPlugin
 
-channels_plugin = ChannelsPlugin(..., channels=["foo", "bar"])
+channels_plugin = ChannelsPlugin(..., channels=["foo", "bar"])

docs/examples/channels/publish_data.py

@@ -1 +1 @@
-channels.publish({"message": "Hello"}, "general")
+channels.publish({"message": "Hello"}, "general")

docs/examples/channels/subscribe_method_context_manager.py

@@ -1,2 +1,2 @@
 async with channels.start_subscription(["foo", "bar"]) as subscriber:
-    ...  # do some stuff here
+    ...  # do some stuff here

docs/examples/channels/subscribe_method_manually.py

@@ -2,4 +2,4 @@
 try:
     ...  # do some stuff here
 finally:
-    await channels.unsubscribe(subscriber)
+    await channels.unsubscribe(subscriber)

docs/examples/channels/unsubscribe_method_context_manager.py

@@ -1,3 +1,3 @@
 async with channels.start_subscription(["foo", "bar"]) as subscriber:
-    ...  # do some stuff here
-    await channels.unsubscribe(subscriber, ["foo"])
+    # do some stuff here
+    await channels.unsubscribe(subscriber, ["foo"])

docs/examples/channels/unsubscribe_method_manually.py

@@ -1,3 +1,3 @@
 subscriber = await channels.subscribe(["foo", "bar"])
-...  # do some stuff here
-await channels.unsubscribe(subscriber, ["foo"])
+# do some stuff here
+await channels.unsubscribe(subscriber, ["foo"])

docs/examples/cli/app_instance.py

@@ -1,6 +1,7 @@
 import click
+
 from litestar import Litestar
 
 
 @click.command()
-def my_command(app: Litestar) -> None: ...
+def my_command(app: Litestar) -> None: ...

docs/examples/cli/entry_points.py

@@ -1,9 +1,9 @@
 from setuptools import setup
 
 setup(
-   name="my-litestar-plugin",
-   ...,
-   entry_points={
-       "litestar.commands": ["my_command=my_litestar_plugin.cli:main"],
-   },
-)
+    name="my-litestar-plugin",
+    # ..., other setup arguments
+    entry_points={
+        "litestar.commands": ["my_command=my_litestar_plugin.cli:main"],
+    },
+)

docs/examples/cli/info.sh

@@ -1 +1 @@
-litestar info
+litestar info

docs/examples/cli/plugin.py

@@ -1,6 +1,7 @@
+from click import Group
+
 from litestar import Litestar
 from litestar.plugins import CLIPluginProtocol
-from click import Group
 
 
 class CLIPlugin(CLIPluginProtocol):
@@ -10,4 +11,4 @@ def is_debug_mode(app: Litestar):
             print(app.debug)
 
 
-app = Litestar(plugins=[CLIPlugin()])
+app = Litestar(plugins=[CLIPlugin()])

docs/examples/cli/poetry.toml

@@ -1,2 +1,2 @@
 [tool.poetry.plugins."litestar.commands"]
-my_command = "my_litestar_plugin.cli:main"
+my_command = "my_litestar_plugin.cli:main"

docs/examples/cli/reload_dir.sh

@@ -1 +1 @@
-litestar run --reload-dir=. --reload-dir=../other-library/src
+litestar run --reload-dir=. --reload-dir=../other-library/src

docs/examples/cli/reload_dir_multiple_directories.sh

@@ -1 +1 @@
- LITESTAR_RELOAD_DIRS=.,../other-library/src
+ LITESTAR_RELOAD_DIRS=.,../other-library/src

docs/examples/cli/reload_exclude_multiple_directories.sh

@@ -1 +1 @@
-LITESTAR_RELOAD_EXCLUDES=*.py,*.yml
+LITESTAR_RELOAD_EXCLUDES=*.py,*.yml

docs/examples/cli/reload_include.sh

@@ -1 +1 @@
-litestar run --reload-include="*.rst" --reload-include="*.yml"
+litestar run --reload-include="*.rst" --reload-include="*.yml"

docs/examples/cli/reload_include_multiple_directories.sh

@@ -1 +1 @@
-LITESTAR_RELOAD_INCLUDES=*.rst,*.yml
+LITESTAR_RELOAD_INCLUDES=*.rst,*.yml

docs/examples/cli/routes.sh

@@ -1 +1 @@
-litestar routes
+litestar routes

docs/examples/cli/run.sh

@@ -1 +1 @@
-litestar run
+litestar run

docs/examples/cli/sessions_clear.sh

@@ -1 +1 @@
-litestar sessions clear
+litestar sessions clear

docs/examples/cli/ssl.sh

@@ -1 +1 @@
-litestar run --ssl-certfile=certs/cert.pem --ssl-keyfile=certs/key.pem
+litestar run --ssl-certfile=certs/cert.pem --ssl-keyfile=certs/key.pem

docs/examples/cli/typescript_schema.sh

@@ -1 +1 @@
-litestar schema typescript
+litestar schema typescript

docs/examples/cli/typescript_schema.ts

@@ -1,3 +1,3 @@
 export namespace API {
    // ...
-}
+}

docs/examples/cli/typescript_schema_namespace.ts

@@ -1,3 +1,3 @@
 export namespace MyNamespace {
    // ...
-}
+}

docs/examples/data_transfer_objects/define_dto_from_dataclass.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass
 
 from litestar import get
-from litestar.dto import DTOConfig, DataclassDTO
+from litestar.dto import DataclassDTO, DTOConfig
 
 
 @dataclass
@@ -16,4 +16,4 @@ class MyDTO(DataclassDTO[MyType]):
 
 @get(dto=MyDTO)
 async def handler() -> MyType:
-    return MyType(some_field="some value", another_field=42)
+    return MyType(some_field="some value", another_field=42)

docs/examples/data_transfer_objects/disable_backend_selectively.py

@@ -1,5 +1,6 @@
 from dataclasses import dataclass
-from litestar.dto import DTOConfig, DataclassDTO
+
+from litestar.dto import DataclassDTO, DTOConfig
 
 
 @dataclass
@@ -8,4 +9,4 @@ class Foo:
 
 
 class FooDTO(DataclassDTO[Foo]):
-    config = DTOConfig(experimental_codegen_backend=False)
+    config = DTOConfig(experimental_codegen_backend=False)

docs/examples/data_transfer_objects/enabling_backend.py

@@ -1,4 +1,4 @@
 from litestar import Litestar
 from litestar.config.app import ExperimentalFeatures
 
-app = Litestar(experimental_features=[ExperimentalFeatures.DTO_CODEGEN])
+app = Litestar(experimental_features=[ExperimentalFeatures.DTO_CODEGEN])

docs/examples/data_transfer_objects/factory/enveloping_return_data_1.py

@@ -7,4 +7,4 @@
 @dataclass
 class WithCount(Generic[T]):
     count: int
-    data: List[T]
+    data: List[T]

docs/examples/data_transfer_objects/factory/enveloping_return_data_2.py

@@ -1,6 +1,7 @@
 from advanced_alchemy.dto import SQLAlchemyDTO
+
 from litestar.dto import DTOConfig
 
 
 class UserDTO(SQLAlchemyDTO[User]):
-    config = DTOConfig(exclude={"password", "created_at"})
+    config = DTOConfig(exclude={"password", "created_at"})

docs/examples/data_transfer_objects/factory/enveloping_return_data_3.py

@@ -13,4 +13,4 @@ def get_users() -> WithCount[User]:
                 created_at=datetime.now(),
             ),
         ],
-    )
+    )

docs/examples/data_transfer_objects/factory/excluding_fields_2.py

@@ -6,4 +6,4 @@
         "pets.0.id",
         "pets.0.user_id",
     }
-)
+)

docs/examples/data_transfer_objects/factory/paginated_return_data_1.py

@@ -1,6 +1,7 @@
 from advanced_alchemy.dto import SQLAlchemyDTO
+
 from litestar.dto import DTOConfig
 
 
 class UserDTO(SQLAlchemyDTO[User]):
-    config = DTOConfig(exclude={"password", "created_at"})
+    config = DTOConfig(exclude={"password", "created_at"})

docs/examples/data_transfer_objects/factory/paginated_return_data_2.py

@@ -16,4 +16,4 @@ def get_users() -> ClassicPagination[User]:
                 created_at=datetime.now(),
             ),
         ],
-    )
+    )

docs/examples/data_transfer_objects/factory/response_return_data_1.py

@@ -1,6 +1,7 @@
 from advanced_alchemy.dto import SQLAlchemyDTO
+
 from litestar.dto import DTOConfig
 
 
 class UserDTO(SQLAlchemyDTO[User]):
-    config = DTOConfig(exclude={"password", "created_at"})
+    config = DTOConfig(exclude={"password", "created_at"})

docs/examples/data_transfer_objects/factory/response_return_data_2.py

@@ -1,4 +1,4 @@
-from litestar import get, Response
+from litestar import Response, get
 
 
 @get("/users", dto=UserDTO, sync_to_thread=False)
@@ -11,4 +11,4 @@ def get_users() -> Response[User]:
             created_at=datetime.now(),
         ),
         headers={"X-Total-Count": "1"},
-    )
+    )

docs/examples/data_transfer_objects/individual_dto.py

@@ -1,5 +1,6 @@
 from dataclasses import dataclass
-from litestar.dto import DTOConfig, DataclassDTO
+
+from litestar.dto import DataclassDTO, DTOConfig
 
 
 @dataclass
@@ -8,4 +9,4 @@ class Foo:
 
 
 class FooDTO(DataclassDTO[Foo]):
-    config = DTOConfig(experimental_codegen_backend=True)
+    config = DTOConfig(experimental_codegen_backend=True)

docs/examples/debugging/running_litestar_with_pdb_on_exception.py

@@ -1 +1 @@
-app = Litestar(pdb_on_exception=True)
+app = Litestar(pdb_on_exception=True)

docs/examples/dependency_injection/dependency_base.py

@@ -1,4 +1,4 @@
-from litestar import Controller, Router, Litestar, get
+from litestar import Controller, Litestar, Router, get
 from litestar.di import Provide
 
 
@@ -15,30 +15,28 @@ async def int_fn() -> int: ...
 
 
 class MyController(Controller):
-   path = "/controller"
-   # on the controller
-   dependencies = {"controller_dependency": Provide(list_fn)}
+    path = "/controller"
+    # on the controller
+    dependencies = {"controller_dependency": Provide(list_fn)}
 
-   # on the route handler
-   @get(path="/handler", dependencies={"local_dependency": Provide(int_fn)})
-   def my_route_handler(
-       self,
-       app_dependency: bool,
-       router_dependency: dict,
-       controller_dependency: list,
-       local_dependency: int,
-   ) -> None: ...
+    # on the route handler
+    @get(path="/handler", dependencies={"local_dependency": Provide(int_fn)})
+    def my_route_handler(
+        self,
+        app_dependency: bool,
+        router_dependency: dict,
+        controller_dependency: list,
+        local_dependency: int,
+    ) -> None: ...
 
-   # on the router
+    # on the router
 
 
 my_router = Router(
-   path="/router",
-   dependencies={"router_dependency": Provide(dict_fn)},
-   route_handlers=[MyController],
+    path="/router",
+    dependencies={"router_dependency": Provide(dict_fn)},
+    route_handlers=[MyController],
 )
 
 # on the app
-app = Litestar(
-   route_handlers=[my_router], dependencies={"app_dependency": Provide(bool_fn)}
-)
+app = Litestar(route_handlers=[my_router], dependencies={"app_dependency": Provide(bool_fn)})