@@ -21,13 +21,15 @@ groups:
2121## SDK Configuration Options
2222
2323<ParamField path="additional_init_exports" type="array" default="null" required={false} toc={true}>
24+ Additional items to export in the package's __init__.py file.
2425</ParamField>
2526
2627<ParamField path="default_bytes_stream_chunk_size" type="number" default="null" required={false} toc={true}>
2728 The chunk size to use (if any) when processing a response bytes stream within ` iter_bytes` or `aiter_bytes` results in: `for chunk in response.iter_bytes(chunk_size=<default_bytes_stream_chunk_size>):`
2829</ParamField>
2930
3031<ParamField path="exclude_types_from_init_exports" type="bool" default="false" required={false} toc={true}>
32+ When enabled, types will not be exported in the package's __init__.py file.
3133</ParamField>
3234
3335<ParamField path="extra_dependencies" type="object" default="{}" required={false} toc={true}>
@@ -40,27 +42,31 @@ groups:
4042</ParamField>
4143
4244<ParamField path="extra_dev_dependencies" type="object" default="{}" required={false} toc={true}>
45+ Additional development dependencies to include in the generated package.
4346</ParamField>
4447
4548<ParamField path="extras" type="object" default="{}" required={false} toc={true}>
49+ Optional package extras/features to include in setup.py.
4650</ParamField>
4751
4852<ParamField path="flat_layout" type="bool" default="false" required={false} toc={true}>
53+ When enabled, generates a flatter package structure without nested directories.
4954</ParamField>
5055
5156<ParamField path="follow_redirects_by_default" type="bool" default="true" required={false} toc={true}>
5257 Whether to follow redirects by default in HTTP requests.
5358</ParamField>
5459
5560<ParamField path="improved_imports" type="bool" default="true" required={false} toc={true}>
56- Feature flag that improves imports in the Python SDK by removing nested `resources` directory
61+ Feature flag that improves imports in the Python SDK by removing nested `resources` directory.
5762</ParamField>
5863
5964<ParamField path="include_legacy_wire_tests" type="bool" default="false" required={false} toc={true}>
60- Whether or not to include legacy wire tests in the generated SDK
65+ Whether or not to include legacy wire tests in the generated SDK.
6166</ParamField>
6267
6368<ParamField path="include_union_utils" type="bool" default="false" required={false} toc={true}>
69+ When enabled, generates additional utilities for union types.
6470</ParamField>
6571
6672<ParamField path="inline_path_params" type="bool" default="false" required={false} toc={true}>
@@ -72,12 +78,9 @@ groups:
7278</ParamField>
7379
7480<ParamField path="package_name" type="string" default="null" required={false} toc={true}>
75-
76- Specifies the Python package name that users will import your generated client
77- from.
81+ Specifies the Python package name that users will import your generated client from.
7882
79- For example, setting `package_name : " my_custom_package" ` enables users to use
80- ` my_custom_package import Client` to import your client:
83+ For example, setting `package_name : " my_custom_package" ` enables users to use ` from my_custom_package import Client` to import your client:
8184
8285` ` ` yaml {7-10}
8386default-group: local
@@ -92,6 +95,7 @@ groups:
9295</ParamField>
9396
9497<ParamField path="pydantic_config" type="SdkPydanticModelCustomConfig" default="SdkPydanticModelCustomConfig()" required={false} toc={true}>
98+ Configuration options for Pydantic model generation.
9599</ParamField>
96100
97101<ParamField path="pydantic_config.include_union_utils" type="bool" default="false" required={false} toc={true}>
@@ -112,12 +116,10 @@ groups:
112116 # Visit every case in the union
113117 shape = get_shape()
114118 shape.visit(
115- circle: lambda circle: do_something_with_circle(circle),
116- triangle: lambda triangle: do_something_with_triangle(triangle),
119+ circle= lambda circle: do_something_with_circle(circle),
120+ triangle= lambda triangle: do_something_with_triangle(triangle),
117121 )
118122 ```
119-
120- When enabled, the python generator will not run Black formatting in the generated code. Black is slow so this can potentially speed up code generation quite a bit.
121123</ParamField >
122124
123125<ParamField path = " pydantic_config.version" type = " 'v1' | 'v2' | 'both' | 'v1_on_v2'" default = " both" required = { false } toc = { true } >
@@ -140,20 +142,39 @@ groups:
140142</ParamField>
141143
142144<ParamField path="pyproject_toml" type="string" default="null" required={false} toc={true}>
145+ Custom pyproject.toml content to include in the generated package.
146+ </ParamField>
147+
148+ <ParamField path="sdk_variables" type="object" default="{}" required={false} toc={true}>
149+ Variables that can be set once when instantiating the client and used across multiple requests. For OpenAPI specs, these are defined using the ` x-fern-sdk-variables` extension. Example:
150+
151+ ` ` ` yaml
152+ x-fern-sdk-variables:
153+ project_id:
154+ type: string
155+ description: The project ID to use for all requests
156+ ` ` `
157+
158+ This allows setting the variable once when creating the client :
159+ ` ` ` python
160+ client = Client(project_id="proj_123")
161+ ` ` `
143162</ParamField>
144163
145164<ParamField path="should_generate_websocket_clients" type="bool" default="false" required={false} toc={true}>
146165 Feature flag that enables generation of Python websocket clients.
147166</ParamField>
148167
149168<ParamField path="skip_formatting" type="bool" default="false" required={false} toc={true}>
169+ When true, skips code formatting of the generated SDK.
150170</ParamField>
151171
152172<ParamField path="timeout_in_seconds" type="number | 'infinity'" default="60" required={false} toc={true}>
153173 By default, the generator generates a client that times out after 60 seconds. You can customize this value by providing a different number or setting to `infinity` to get rid of timeouts.
154174</ParamField>
155175
156176<ParamField path="use_api_name_in_package" type="bool" default="false" required={false} toc={true}>
177+ When true, includes the API name in the generated package name.
157178</ParamField>
158179
159180<ParamField path="use_inheritance_for_extended_models" type="bool" default="true" required={false} toc={true}>
0 commit comments