Python Configuration

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>):

If you want to add custom dependencies to your generated SDK, you can specify them using this configuration. For example, to add a dependency on boto3, your config would look like:

config:
  extra_dependencies:
    boto3: 1.28.15

Whether to follow redirects by default in HTTP requests.

Feature flag that improves imports in the Python SDK by removing nested resources directory

Whether or not to include legacy wire tests in the generated SDK

If true, treats path parameters as named parameters in endpoint functions.

Feature flag that removes the usage of request objects, and instead uses parameters in function signatures where possible.

When enabled, the generator will output a Pydantic __root__ class that will contain utilities to visit the union. For example, for the following union type:

types:
Shape:
  union:
    circle: Circle
    triangle: Triangle

you will get a generated Shape class that has a factory and visitor:

1
# Use a factory to instantiate the union
2
Shape.factory.circle(Circle(...))
3
4
# Visit every case in the union
5
shape = get_shape()
6
shape.visit(
7
  circle: lambda circle: do_something_with_circle(circle),
8
  triangle: lambda triangle: do_something_with_triangle(triangle),
9
)

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.

By default, the generator generates pydantic models that are v1 and v2 compatible. However you can override them to:

• v1: strictly use Pydantic v1
• v2: strictly use Pydantic v2
• both: maintain compatibility with both versions
• v1_on_v2: use Pydantic v1 compatibility layer on v2

Example:

1
config:
2
  pydantic_config:
3
    version: v1 # or v2 or "both"

Feature flag that enables generation of Python websocket clients.

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.

Whether to generate Pydantic models that implement inheritance when a model utilizes the Fern extends keyword.

Whether or not to generate TypedDicts instead of Pydantic Models for request objects.

Whether or not to generate TypedDicts instead of Pydantic Models for file upload request objects. Note that this flag was only introduced due to an oversight in the use_typeddict_requests flag implementation; it should be removed in the future.