docs: make code examples run and fix factual errors (#260)

- context-resources: add default_scope to the quick-start container, pass a
  context item where container_context/DIContextMiddleware had no arguments,
  use the real sync-context error message, list only global_context and scope
  as middleware arguments
- scopes: ContextScopes.APP, return val, nested-scope example no longer
  re-enters p in REQUEST, default_scope caveat
- fastapi: scoped middleware example uses MyScopedContainer with
  scope=REQUEST, sync override helpers, missing imports
- factories: call provider/provider_sync, import ContextScopes from
  that_depends, context example uses a Factory, drop closing sentence
- injection, generator-injection, ioc-container, object, index, lazy:
  syntax and name errors
- multiple-containers, faststream, litestar: inline definitions instead of
  importing the repo's tests package; Litestar lifespan type
- README, resources, provider-overriding, contributing: wording fixes

Author: lesnik512

README.md

@@ -21,11 +21,11 @@
 
 Simple, typed dependency injection framework for Python.
 
-It is production-ready and gives you the following:
+Features:
 - Simple async-first DI framework with IOC-container.
 - Python 3.10+ support.
 - Full coverage by types annotations (mypy in strict mode, pyrefly).
-- Inbuilt FastAPI, FastStream and LiteStar compatibility.
+- Built-in FastAPI, FastStream and Litestar integrations.
 - Dependency context management with scopes.
 - Overriding dependencies for tests.
 - Injecting dependencies in functions and coroutines without wiring.

docs/dev/contributing.md

@@ -1,11 +1,11 @@
 # Contributing
-`that-depends` is an opensource project, and we are opened to new contributors.
+`that-depends` is an opensource project, and we are open to new contributors.
 
 ## Getting started
 1. Make sure that you have [uv](https://docs.astral.sh/uv/) and [just](https://just.systems/) installed.
 2. Clone project:
 ```
-git@github.com:modern-python/that-depends.git
+git clone git@github.com:modern-python/that-depends.git
 cd that-depends
 ```
 3. Install dependencies running `just install`

docs/experimental/lazy.md

@@ -29,9 +29,11 @@ You can use the lazy provider in exactly the same way as you would use the refer
 
 ```python
 # first_container.py
+import typing
+
 from that_depends import BaseContainer, providers, ContextScopes
 
-def my_creator() -> int:
+def my_creator() -> typing.Iterator[int]:
     yield 42
 
 class FirstContainer(BaseContainer):

docs/index.md

@@ -36,6 +36,11 @@ supports the following:
 
 ### Define a creator
 ```python
+import logging
+
+logger = logging.getLogger(__name__)
+
+
 async def create_async_resource():
     logger.debug("Async resource initiated")
     try:

docs/integrations/fastapi.md

@@ -93,7 +93,9 @@ This will enable you to use dependency injection in your `FastAPI` endpoints:
 If you wish to initialize the container context you can simply pass arguments to `create_fastapi_route_class()`:
 
 ```python
-my_route_class = create_fastapi_route_class(Container, global_context={"key": "value"}, scope=ContextScopes.REQUEST)
+from that_depends import ContextScopes
+
+my_route_class = create_fastapi_route_class(MyContainer, global_context={"key": "value"}, scope=ContextScopes.REQUEST)
 ```
 
 In the above example, all `ContextResources` in our container that are `REQUEST` scoped will be initialized
@@ -220,13 +222,14 @@ Then in your FastAPI app:
 ```python
 # main.py
 from fastapi import FastAPI, Depends
-from that_depends.providers.context_resources import DIContextMiddleware
+from that_depends.providers.context_resources import ContextScopes, DIContextMiddleware
 from mycontainer import MyScopedContainer
 
 app = FastAPI()
 app.add_middleware(
     DIContextMiddleware,
-    MyContainer,
+    MyScopedContainer,
+    scope=ContextScopes.REQUEST,
 )
 
 @app.get("/")
@@ -269,9 +272,9 @@ def test_read_db(client: TestClient):
 
 1. **Global vs. Request Context**: Decide whether your container’s dependencies should be globally shared (e.g., singletons) or created anew per request (e.g., database or session).  
 2. **Combining with FastAPI’s `Depends`**: Generally, you can pass `Depends(MyContainer.some_provider)` to route handlers. Under the hood, that-depends will be invoked.  
-3. **Overriding**: You can override a provider in tests by calling `MyContainer.some_provider.override(...)` or using the context manager `with MyContainer.some_provider.override_context(...):`.
+3. **Overriding**: You can override a provider in tests by calling `MyContainer.some_provider.override_sync(...)` or using the context manager `with MyContainer.some_provider.override_context_sync(...):`.
 4. **Performance**: If you have expensive creation logic (like a DB engine that can be reused globally), prefer using a `Singleton` or `Object` provider. If you need ephemeral resources, use `ContextResource` with the `DIContextMiddleware`.
-5. **Custom Context**: If you do not want to rely on the middleware, you can manually create a context in any async function by calling `async with container_context():`. 
+5. **Custom Context**: If you do not want to rely on the middleware, you can manually create a context in any async function by calling `async with container_context(MyContainer):`. 
 6. **Multiple Containers**: You can define multiple containers and connect them (e.g., `ContainerA.connect_containers(ContainerB)`), or add them all to the `DIContextMiddleware`. For advanced usage, see the that-depends documentation on “container connection.”
 
 
@@ -285,7 +288,7 @@ Sometimes you want to pass the `fastapi.Request` (or other request-scoped data)
 # request_deps.py
 from fastapi import Request
 from typing import AsyncIterator
-from that_depends import container_context, fetch_context_item
+from that_depends import container_context
 
 async def init_di_context(request: Request) -> AsyncIterator[None]:
     # We store the request in a that_depends global context
@@ -299,6 +302,7 @@ Then in your `FastAPI` route:
 # main.py (extended)
 from fastapi import FastAPI, Request, Depends
 from starlette.responses import JSONResponse
+from that_depends import fetch_context_item
 
 from request_deps import init_di_context
 from mycontainer import MyContainer

docs/integrations/faststream.md

@@ -56,22 +56,37 @@ broker = RabbitBroker(middlewares=[DIContextMiddleware(Container, scope=ContextS
 Here is an example that includes life-cycle events:
 
 ```python
-import datetime
 import contextlib
+import dataclasses
+import datetime
 import typing
 
 from faststream import FastStream, Depends, Logger
 from faststream.rabbit import RabbitBroker
 
-from tests import container
+from that_depends import BaseContainer, providers
+
+
+async def create_async_resource() -> typing.AsyncIterator[datetime.datetime]:
+    yield datetime.datetime.now(tz=datetime.timezone.utc)
+
+
+@dataclasses.dataclass(kw_only=True, slots=True)
+class DependentFactory:
+    async_resource: datetime.datetime
+
+
+class DIContainer(BaseContainer):
+    async_resource = providers.Resource(create_async_resource)
+    dependent_factory = providers.Factory(DependentFactory, async_resource=async_resource.cast)
 
 
 @contextlib.asynccontextmanager
 async def lifespan_manager() -> typing.AsyncIterator[None]:
     try:
         yield
     finally:
-        await container.DIContainer.tear_down()
+        await DIContainer.tear_down()
 
 
 broker = RabbitBroker()
@@ -82,8 +97,8 @@ app = FastStream(broker, lifespan=lifespan_manager)
 async def read_root(
     logger: Logger,
     some_dependency: typing.Annotated[
-        container.DependentFactory,
-        Depends(container.DIContainer.dependent_factory)
+        DependentFactory,
+        Depends(DIContainer.dependent_factory)
     ],
 ) -> datetime.datetime:
     startup_time = some_dependency.async_resource

docs/integrations/litestar.md

@@ -6,15 +6,23 @@
     sibling DI framework.
 
 ```python
-import typing
-import fastapi
 import contextlib
+import typing
+
 from litestar import Litestar, get
 from litestar.di import Provide
 from litestar.status_codes import HTTP_200_OK
 from litestar.testing import TestClient
 
-from tests import container
+from that_depends import BaseContainer, providers
+
+
+async def create_async_resource() -> typing.AsyncIterator[str]:
+    yield "async resource"
+
+
+class DIContainer(BaseContainer):
+    async_resource = providers.Resource(create_async_resource)
 
 
 @get("/")
@@ -23,16 +31,16 @@ async def index(injected: str) -> str:
 
 
 @contextlib.asynccontextmanager
-async def lifespan_manager(_: fastapi.FastAPI) -> typing.AsyncIterator[None]:
+async def lifespan_manager(_: Litestar) -> typing.AsyncIterator[None]:
     try:
         yield
     finally:
-        await container.DIContainer.tear_down()
+        await DIContainer.tear_down()
 
 
 app = Litestar(
     route_handlers=[index],
-    dependencies={"injected": Provide(container.DIContainer.async_resource)},
+    dependencies={"injected": Provide(DIContainer.async_resource)},
     lifespan=[lifespan_manager],
 )
 

docs/introduction/generator-injection.md

@@ -109,7 +109,7 @@ def injected(val: float = Provide[Container.dependent_provider]) -> typing.Gener
     yield val 
 
 # This will raise a `ContextProviderError`!
-next(_injected())
+next(injected())
 ```
 
 1. Matches context scope of `sync_provider` provider, which is a dependency of the `dependent_provider` provider.
@@ -136,7 +136,7 @@ def injected(val: float = Provide[Container.dependent_provider]) -> typing.Gener
 
 with container_context(scope=ContextScopes.REQUEST):
     # This will resolve as expected
-    next(_injected())
+    next(injected())
 ```
 
 Since no context initialization was needed, the generator will work as expected.

docs/introduction/injection.md

@@ -84,7 +84,7 @@ def greet_user_direct(
     return f"Greeting: {greeting}"
 ```
 
-1. Notice that although `greeting` is a `str`, `mypy` and you IDE will not complain.
+1. Notice that although `greeting` is a `str`, `mypy` and your IDE will not complain.
 
 ---
 
@@ -123,7 +123,7 @@ For more details regarding scopes and context management, see the [Context Resou
 
 ## Overriding Providers
 
-In tests or specialized scenarios, you may want to override a provider’s value temporarily. You can do so with the container’s `override_providers()` method or the provider’s own `override_context()`:
+In tests or specialized scenarios, you may want to override a provider’s value temporarily. You can do so with the container’s `override_providers_sync()` method or the provider’s own `override_context_sync()`:
 
 ```python
 def test_greet_override():
@@ -135,7 +135,7 @@ def test_greet_override():
 
 This is especially helpful for unit tests where you want to substitute real dependencies (e.g., database connections) with mocks or stubs.
 
-For more details on overring providers, see the [Overriding Providers](../testing/provider-overriding.md) documentation.
+For more details on overriding providers, see the [Overriding Providers](../testing/provider-overriding.md) documentation.
 
 ---
 

docs/introduction/ioc-container.md

@@ -15,6 +15,7 @@ from that_depends import BaseContainer
 
 class Container(BaseContainer):
     # define your providers here
+    ...
 ```
 
 Then you can build your dependency graph within the container:
@@ -27,9 +28,9 @@ class Container(BaseContainer):
     session = providers.Factory(create_db_session, config=config.db) # (1)!
 
     user_repository = providers.Factory(
-        UserRepository, 
+        UserRepository,
+        config.users,
         session=session.cast, # (3)!
-        config.users
     ) # (2)!