Skip to content

docs(sdks): document python tcp_keepalive generator config option #6306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(sdks): document python tcp_keepalive generator config option #6306

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions fern/products/sdks/generators/python/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,33 @@ Allow specifying arbitrary configuration to your packages `pyproject.toml` by ad
When enabled, skips code formatting (like black) on the generated Python code.
</ParamField>

<ParamField path="tcp_keepalive" type="object" default="{}" required={false} toc={true}>
Opt in to platform-guarded TCP keepalive on the generated default `httpx` transport. Disabled by default, so existing generated SDKs are unchanged. When enabled, the transport applies `SO_KEEPALIVE` plus best-effort per-platform idle, interval, and probe-count settings, so long, non-streaming requests survive idle-connection reaping by a firewall or load balancer.

```yaml
config:
tcp_keepalive:
enabled: true
idle_seconds: 60
interval_seconds: 30
count: 5
```

Requires `httpx>=0.25`. A user-supplied `httpx_client`, or a `custom_transport` `http_client`, always takes precedence over the keepalive default, which only affects the generated default transport.
</ParamField>
<ParamField path="tcp_keepalive.enabled" type="bool" default="false" required={false}>
Whether to enable TCP keepalive on the generated default transport.
</ParamField>
<ParamField path="tcp_keepalive.idle_seconds" type="number" default="60" required={false}>
Seconds a connection is idle before the first keepalive probe.
</ParamField>
<ParamField path="tcp_keepalive.interval_seconds" type="number" default="30" required={false}>
Seconds between keepalive probes.
</ParamField>
<ParamField path="tcp_keepalive.count" type="number" default="5" required={false}>
Number of failed probes before the connection is dropped.
</ParamField>

<ParamField path="timeout" type="number | 'infinity'" default="60" required={false} toc={true}>
Sets the client timeout in seconds, or `infinity` to disable timeouts.
</ParamField>
Expand Down
Loading