clientwright 0.4.0__tar.gz → 0.5.0__tar.gz

{clientwright-0.4.0 → clientwright-0.5.0}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.5.0](https://github.com/bedrock-python/clientwright/compare/clientwright-v0.4.1...clientwright-v0.5.0) (2026-09-15)
+
+
+### Features
+
+* clientwright.contrib.servicewright behind a [servicewright] extra ([777c5f3](https://github.com/bedrock-python/clientwright/commit/777c5f3d0fb3cf35f2c3d08ede87058fa022b4f2)), closes [#41](https://github.com/bedrock-python/clientwright/issues/41)
+
+## [0.4.1](https://github.com/bedrock-python/clientwright/compare/clientwright-v0.4.0...clientwright-v0.4.1) (2026-09-14)
+
+
+### Bug Fixes
+
+* client_config_from_settings passes a BaseClientSettings through to to_config ([fc3af5e](https://github.com/bedrock-python/clientwright/commit/fc3af5e21821c8c506f10c43733aa4d66c563c39)), closes [#38](https://github.com/bedrock-python/clientwright/issues/38)
+
 ## [0.4.0](https://github.com/bedrock-python/clientwright/compare/clientwright-v0.3.0...clientwright-v0.4.0) (2026-09-14)
 
 

{clientwright-0.4.0 → clientwright-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: clientwright
-Version: 0.4.0
+Version: 0.5.0
 Summary: HTTP client platform: one resilience and observability core with adapters for httpx, aiohttp, requests, urllib3 and friends
 Project-URL: Repository, https://github.com/bedrock-python/clientwright
 Project-URL: Documentation, https://bedrock-python.github.io/clientwright/
@@ -35,6 +35,7 @@ Requires-Dist: prometheus-client>=0.20; extra == 'all'
 Requires-Dist: pydantic-settings<3,>=2.3; extra == 'all'
 Requires-Dist: pydantic<3,>=2; extra == 'all'
 Requires-Dist: requests<3,>=2.32; extra == 'all'
+Requires-Dist: servicewright<1,>=0.1; extra == 'all'
 Requires-Dist: urllib3<3,>=2.2; extra == 'all'
 Provides-Extra: deadline
 Requires-Dist: deadline-budget<1,>=0.1; extra == 'deadline'
@@ -51,6 +52,8 @@ Requires-Dist: opentelemetry-api>=1.26; extra == 'observability'
 Requires-Dist: prometheus-client>=0.20; extra == 'observability'
 Provides-Extra: requests
 Requires-Dist: requests<3,>=2.32; extra == 'requests'
+Provides-Extra: servicewright
+Requires-Dist: servicewright<1,>=0.1; extra == 'servicewright'
 Provides-Extra: settings
 Requires-Dist: pydantic-settings<3,>=2.3; extra == 'settings'
 Requires-Dist: pydantic<3,>=2; extra == 'settings'
@@ -211,6 +214,17 @@ with use_budget(BudgetContext.create(total_seconds=5.0)):
     await client.get("/users")  # runs with what is left of those 5 seconds
 ```
 
+## Request context
+
+With `clientwright[servicewright]`, the ids servicewright bound for the unit of
+work being served travel to the upstream as headers:
+
+```python
+from clientwright.contrib.servicewright import servicewright_headers
+
+deps = AdapterDeps(header_providers=servicewright_headers())  # x-request-id, x-user-id, ...
+```
+
 ## From the environment
 
 With `clientwright[settings]`, `ClientConfig` and every sub-config exist as pydantic

{clientwright-0.4.0 → clientwright-0.5.0}/README.md

@@ -149,6 +149,17 @@ with use_budget(BudgetContext.create(total_seconds=5.0)):
     await client.get("/users")  # runs with what is left of those 5 seconds
 ```
 
+## Request context
+
+With `clientwright[servicewright]`, the ids servicewright bound for the unit of
+work being served travel to the upstream as headers:
+
+```python
+from clientwright.contrib.servicewright import servicewright_headers
+
+deps = AdapterDeps(header_providers=servicewright_headers())  # x-request-id, x-user-id, ...
+```
+
 ## From the environment
 
 With `clientwright[settings]`, `ClientConfig` and every sub-config exist as pydantic

{clientwright-0.4.0 → clientwright-0.5.0}/clientwright/__init__.py

@@ -55,6 +55,7 @@ from .core.contracts import (
     MaskerProtocol,
     RetrySettingsProtocol,
     SpanProtocol,
+    SupportsToConfig,
     TracerProtocol,
 )
 from .core.contracts.adapter import default_deps
@@ -158,6 +159,7 @@ __all__ = [
     "SeamGranularity",
     "SpanProtocol",
     "Support",
+    "SupportsToConfig",
     "TimeoutConfig",
     "TlsConfig",
     "TooManyRedirectsError",

clientwright-0.5.0/clientwright/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.5.0"  # x-release-please-version

clientwright-0.5.0/clientwright/contrib/servicewright.py

@@ -0,0 +1,47 @@
+"""servicewright integration (``[servicewright]`` extra).
+
+servicewright binds the ids of the unit of work being served (``request_id``,
+``user_id``, ``tenant_id``, ``trace_id``) into its request context, and
+``servicewright.propagation_metadata`` reads them back as outbound headers.
+That function already satisfies clientwright's ``HeaderProvider`` protocol
+bare; this module names the join so no service writes it by hand::
+
+    from clientwright.contrib.servicewright import servicewright_headers
+
+    deps = AdapterDeps(header_providers=servicewright_headers())
+    client = build("httpx", config, deps)
+
+    await client.get("/users")  # carries x-request-id and friends, when bound
+
+Outside a bound context the provider returns nothing and the request goes out
+as before. The helper returns the providers tuple rather than a whole
+``AdapterDeps`` so it composes with everything else injected there -
+``contrib.deadline`` included - instead of competing with it.
+
+Unlike ``contrib.deadline`` there is nothing structural to type here; the real
+function is the point, so servicewright is imported at module import time and
+a missing extra fails right here with an install hint.
+"""
+
+from __future__ import annotations
+
+try:
+    from servicewright import propagation_metadata
+except ImportError as exc:  # pragma: no cover - exercised only without the extra
+    raise ImportError("servicewright integration requires clientwright[servicewright]; install it.") from exc
+
+from ..core.contracts.context import HeaderProvider
+
+
+def servicewright_headers() -> tuple[HeaderProvider, ...]:
+    """The header providers carrying servicewright's request context upstream.
+
+    ``(propagation_metadata,)`` under servicewright's standard mapping - the
+    request, user, tenant and trace ids as ``x-request-id``, ``x-user-id``,
+    ``x-tenant-id`` and ``x-trace-id``. For a different mapping build the tuple
+    yourself: ``(partial(propagation_metadata, keys),)``.
+    """
+    return (propagation_metadata,)
+
+
+__all__ = ["servicewright_headers"]

{clientwright-0.4.0 → clientwright-0.5.0}/clientwright/contrib/settings.py

@@ -283,7 +283,11 @@ class BaseClientSettings(BaseModel):
     )
 
     def to_config(self, service_name: str) -> ClientConfig:
-        """The ``ClientConfig`` these settings describe, labelled ``service_name``."""
+        """The ``ClientConfig`` these settings describe, labelled ``service_name``.
+
+        The one translation for the shipped models. ``client_config_from_settings``
+        is the flat legacy route and passes a ``BaseClientSettings`` straight here.
+        """
         return ClientConfig(
             service_name=service_name,
             base_url=self.base_url,

{clientwright-0.4.0 → clientwright-0.5.0}/clientwright/core/contracts/__init__.py

@@ -15,6 +15,7 @@ from .observability import TracerProtocol as TracerProtocol
 from .settings import CircuitBreakerSettingsProtocol as CircuitBreakerSettingsProtocol
 from .settings import ClientSettingsProtocol as ClientSettingsProtocol
 from .settings import RetrySettingsProtocol as RetrySettingsProtocol
+from .settings import SupportsToConfig as SupportsToConfig
 
 __all__ = [
     "AdapterDeps",
@@ -30,6 +31,7 @@ __all__ = [
     "ResponseView",
     "RetrySettingsProtocol",
     "SpanProtocol",
+    "SupportsToConfig",
     "SyncNormalizer",
     "TracerProtocol",
 ]

{clientwright-0.4.0 → clientwright-0.5.0}/clientwright/core/contracts/settings.py

@@ -4,6 +4,12 @@ Services keep their own settings models (pydantic or otherwise); anything with
 these read-only properties satisfies the contract - the org convention set by
 grpc-client-kit. ``client_config_from_settings`` converts the structural shape
 into a ``ClientConfig``.
+
+This is the flat, legacy shape. The shipped models in
+``clientwright.contrib.settings`` are the nested one and carry their own
+translation, ``BaseClientSettings.to_config(service_name)``; the converter
+passes anything with a ``to_config`` through to it, so either call builds
+the same config.
 """
 
 from __future__ import annotations
@@ -50,7 +56,12 @@ class CircuitBreakerSettingsProtocol(Protocol):
 
 @runtime_checkable
 class ClientSettingsProtocol(Protocol):
-    """Mirror of the legacy ``RestClientSettingsProtocol`` reachable surface."""
+    """Mirror of the legacy ``RestClientSettingsProtocol`` reachable surface.
+
+    Flat names for a settings model of your own. The shipped nested models
+    (``clientwright.contrib.settings.BaseClientSettings``) do not satisfy this
+    protocol; they carry ``to_config(service_name)`` instead.
+    """
 
     @property
     def base_url(self) -> str: ...
@@ -89,8 +100,26 @@ class ClientSettingsProtocol(Protocol):
     def circuit_breaker(self) -> CircuitBreakerSettingsProtocol | None: ...
 
 
-def client_config_from_settings(settings: ClientSettingsProtocol, service_name: str) -> ClientConfig:
-    """Build a ClientConfig from the structural settings shape used by services."""
+@runtime_checkable
+class SupportsToConfig(Protocol):
+    """Settings that build their own ``ClientConfig`` - the shape of ``BaseClientSettings``."""
+
+    def to_config(self, service_name: str) -> ClientConfig: ...
+
+
+def client_config_from_settings(settings: ClientSettingsProtocol | SupportsToConfig, service_name: str) -> ClientConfig:
+    """Build a ClientConfig from the structural settings shape used by services.
+
+    For a settings object that builds its own config - the shipped
+    ``clientwright.contrib.settings.BaseClientSettings`` - this is
+    ``settings.to_config(service_name)``, and that is what it returns: the
+    nested sections (pool, tls, proxy, headers, redirects, observability, ...)
+    all reach the config. Call ``to_config`` directly where you can; the flat
+    ``ClientSettingsProtocol`` route is for a model of your own that predates
+    the shipped ones.
+    """
+    if isinstance(settings, SupportsToConfig):
+        return settings.to_config(service_name)
     retry_settings = settings.retry
     retry = (
         RetryConfig(
@@ -136,5 +165,6 @@ __all__ = [
     "CircuitBreakerSettingsProtocol",
     "ClientSettingsProtocol",
     "RetrySettingsProtocol",
+    "SupportsToConfig",
     "client_config_from_settings",
 ]

{clientwright-0.4.0 → clientwright-0.5.0}/pyproject.toml

@@ -58,7 +58,8 @@ observability = ["clientwright[metrics,tracing]"]
 deadline = ["deadline-budget>=0.1,<1"]
 dishka = ["dishka>=1.4"]
 settings = ["pydantic>=2,<3", "pydantic-settings>=2.3,<3"]
-all = ["clientwright[httpx,httpx2,aiohttp,requests,urllib3,observability,deadline,dishka,settings]"]
+servicewright = ["servicewright>=0.1,<1"]
+all = ["clientwright[httpx,httpx2,aiohttp,requests,urllib3,observability,deadline,dishka,settings,servicewright]"]
 
 [dependency-groups]
 test = [
@@ -180,7 +181,7 @@ source_modules = ["clientwright.core"]
 forbidden_modules = [
     "httpx", "httpx2", "aiohttp", "requests", "urllib3", "niquests",
     "tornado", "aiosonic", "pydantic", "dishka", "prometheus_client",
-    "opentelemetry", "structlog", "sentry_sdk",
+    "opentelemetry", "structlog", "sentry_sdk", "servicewright",
 ]
 
 # _httpx_shared is deliberately OUTSIDE this list: it is the one sanctioned

clientwright-0.5.0/tests/integration/contrib/test_servicewright.py

@@ -0,0 +1,29 @@
+"""servicewright's request context flowing through the engine against a real origin."""
+
+from __future__ import annotations
+
+import pytest
+
+httpx = pytest.importorskip("httpx", reason="requires the [httpx] extra")
+servicewright = pytest.importorskip("servicewright", reason="requires the [servicewright] extra")
+
+import clientwright  # noqa: E402
+from clientwright import AdapterDeps  # noqa: E402
+from clientwright.contrib.servicewright import servicewright_headers  # noqa: E402
+from clientwright.core.testing import OriginServer  # noqa: E402
+
+from ..conftest import base_config  # noqa: E402
+
+
+async def test__bound_context__travels_as_headers_and_only_while_bound(origin: OriginServer) -> None:
+    wired = AdapterDeps(header_providers=servicewright_headers())
+    client = clientwright.build("httpx", base_config(origin), wired)
+    assert isinstance(client, httpx.AsyncClient)
+    with servicewright.bind_context(request_id="rid-1", tenant_id="acme"):
+        bound = (await client.get("/echo")).json()["headers"]
+    outside = (await client.get("/echo")).json()["headers"]
+    await client.aclose()
+    assert bound["x-request-id"] == "rid-1"
+    assert bound["x-tenant-id"] == "acme"
+    assert "x-request-id" not in outside
+    assert "x-tenant-id" not in outside

{clientwright-0.4.0 → clientwright-0.5.0}/tests/unit/adapters/test_bare_install.py

@@ -25,6 +25,7 @@ BLOCKED = (
     "deadline_budget",
     "pydantic",
     "pydantic_settings",
+    "servicewright",
 )
 
 BLOCKER = """
@@ -163,3 +164,17 @@ def test__settings_models_without_the_extra__fail_with_the_install_hint() -> Non
         """
     )
     assert "clientwright[settings]" in output
+
+
+def test__contrib_servicewright_without_the_extra__fails_with_the_install_hint() -> None:
+    output = run_probe(
+        """
+        try:
+            import clientwright.contrib.servicewright
+        except ImportError as error:
+            print(error)
+        else:
+            print("NO ERROR")
+        """
+    )
+    assert "clientwright[servicewright]" in output

clientwright-0.5.0/tests/unit/contrib/test_servicewright.py

@@ -0,0 +1,23 @@
+"""contrib units: the servicewright header providers."""
+
+from __future__ import annotations
+
+import pytest
+
+servicewright = pytest.importorskip("servicewright", reason="requires the [servicewright] extra")
+
+from clientwright import HeaderProvider  # noqa: E402
+from clientwright.contrib.servicewright import servicewright_headers  # noqa: E402
+
+
+def test__providers__are_the_bare_function_and_satisfy_the_protocol() -> None:
+    providers = servicewright_headers()
+    assert providers == (servicewright.propagation_metadata,)
+    assert all(isinstance(provider, HeaderProvider) for provider in providers)
+
+
+def test__provider__reads_the_bound_context_and_nothing_outside_it() -> None:
+    (provider,) = servicewright_headers()
+    with servicewright.bind_context(request_id="rid-1", user_id="u-9"):
+        assert provider() == {"x-request-id": "rid-1", "x-user-id": "u-9"}
+    assert provider() == {}

{clientwright-0.4.0 → clientwright-0.5.0}/tests/unit/contrib/test_settings.py

@@ -27,6 +27,7 @@ from clientwright import (
     TlsConfig,
     UnsupportedPolicy,
     build_sync,
+    client_config_from_settings,
 )
 from clientwright.contrib import settings as settings_module
 from clientwright.contrib.settings import (
@@ -203,6 +204,27 @@ def test__bad_values__fail_at_load_with_the_field_path() -> None:
         BaseProxySettings(url="http://proxy:3128", from_env=True)
 
 
+# --- the legacy converter ---
+
+
+def test__the_legacy_converter__passes_a_base_client_settings_through_to_to_config() -> None:
+    settings = BaseClientSettings(
+        base_url="https://auth.example.com",
+        pool={"max_connections": 7},
+        retry={"multiplier": 3.0},
+        tls={"verify": False},
+        proxy={"url": "http://proxy:3128"},
+    )
+
+    config = client_config_from_settings(settings, "auth-orchestrator")
+
+    assert config == settings.to_config("auth-orchestrator")
+    assert config.pool.max_connections == 7
+    assert config.retry is not None and config.retry.multiplier == 3.0
+    assert config.tls == TlsConfig(verify=False)
+    assert config.proxy == ProxyConfig(url="http://proxy:3128")
+
+
 def test__a_config_from_settings__builds_the_native_client() -> None:
     httpx = pytest.importorskip("httpx", reason="requires the [httpx] extra")
     config = BaseClientSettings(base_url="https://api.example.com", pool={"http2": False}).to_config("api")

{clientwright-0.4.0 → clientwright-0.5.0}/tests/unit/core/test_settings.py

@@ -32,3 +32,13 @@ def test__structural_settings__mapped_into_config() -> None:
     assert config.retry is not None and config.retry.max_attempts == 5
     assert config.circuit_breaker is None
     assert config.observability.tracing is False
+
+
+def test__settings_with_to_config__are_passed_through_to_it() -> None:
+    class Settings:
+        def to_config(self, service_name: str) -> clientwright.ClientConfig:
+            return clientwright.ClientConfig(service_name=service_name, base_url="https://api.example.com")
+
+    config = clientwright.client_config_from_settings(Settings(), "svc")
+    assert config == clientwright.ClientConfig(service_name="svc", base_url="https://api.example.com")
+    assert isinstance(Settings(), clientwright.SupportsToConfig)

{clientwright-0.4.0 → clientwright-0.5.0}/tests/unit/test_sdk_imports_are_guarded.py

@@ -28,6 +28,7 @@ SDK_ROOTS = frozenset(
         "deadline_budget",
         "pydantic",
         "pydantic_settings",
+        "servicewright",
     }
 )
 

clientwright-0.4.0/clientwright/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.4.0"  # x-release-please-version