CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[2.5.3] - 2024-05-24

• Fix: Stop specifying custom licenses manually, let poetry handle adding them.

[2.5.2] - 2024-05-23

• Fix: Support list SDK method names instead of defaulting to list_.

[2.5.1-rc0] - 2024-05-23

• Fix: Literal parameters are added back to the request body.

[2.5.0-rc2] - 2024-05-23

• Fix: Do not attempt to run fern test in CI until the command is more widely rolled out.

[2.5.0-rc1] - 2024-05-22

• Fix: Address propogate -> propagate typo in python codegen.

[2.5.0-rc0] - 2024-05-22

• Fix: This version addresses issues in unit test generation and reenables the creation of unit tests.

[2.4.0-rc0] - 2024-05-21

• Fix: The Python SDK generator now uses safe names wherever string concat is not used (like in client generation naming), so this will update module and parameter names.

[2.3.4] - 2024-05-21

• Fix: Snippets and unit tests now correctly write optional request bodies when inline_request_params is set to True. Previously the generator wrote snippets that inlined these parameters, which does not match the generated SDK itself.

[2.3.3] - 2024-05-21

• Fix: Inlined body parameters now deconflict in naming with header and query parameters by prefixing the request objects name.

[2.3.2] - 2024-05-21

• Fix: The pyproject.toml generator now writes authors in a valid format for tool.poetry, not just project

• Fix: The query encoder now correctly handles none values

[2.3.1] - 2024-05-21

• Fix: The pyproject.toml generator now includes project URLs when specified.

[2.3.0] - 2024-05-21

• Improvement: Users can now specify information that will appear in their pypi record.

generators:
  - name: fernapi/fern-python-sdk
    metadata:
      description: this is the desc for my package
      keywords:
        - science
        - data analysis
      documentationLink: "https://buildwithfern.com/learn"
      homepageLink: "https://buildwithfern.com/"
      authors:
        - email: support@buildwithfern.com
          name: Armando

[2.2.2] - 2024-05-20

• Fix: Inline request parameters now deconflict in naming with the unnamed path parameter arguments. Previously, when inlining request parameters into the method signature, we would not deconflict naming with the unnamed args preceeding them. Now, conflicting unnamed parameters are post-fixed with an "_".

Before:

def method_name(id: str, *, id: str) -> None:
  ...

After:

def method_name(id_: str, *, id: str) -> None:
  ...

[2.2.1] - 2024-05-17

• Internal: The generator now uses the latest FDR SDK.

[2.2.0] - 2024-05-16

• Improvement: The generated SDK will now correctly encode deep object query parameters. For example, if you have an object {"test": {"nested": "object"}} as a query parameter, we will now encode it as test[nested]=object.

[2.1.1] - 2024-05-15

• Chore: add enhanced snippet support for streaming endpoints.

  Before:

  from seed.client import SeedStreaming
  
  client = SeedStreaming(
      base_url="https://yourhost.com/path/to/api",
  )
  client.dummy.generate_stream(
      num_events=1,
  )

  After:

  from seed.client import SeedStreaming
  
  client = SeedStreaming(
      base_url="https://yourhost.com/path/to/api",
  )
  response = client.dummy.generate_stream(
      num_events=1,
  )
  for chunk in response:
      yield chunk

[2.1.0] - 2024-05-14

• Feature: Add support for cursor and offset pagination.

  For example, consider the following endpoint /users endpoint:

  types:
    User:
      properties:
        name: string
  
    ListUserResponse:
      properties:
        next: optional<string>
        data: list<User>
  
  service:
    auth: false
    base-path: /users
    endpoints:
      list:
        path: ""
        method: GET
        pagination:
          cursor: $request.starting_after
          next_cursor: $response.next
          results: $response.data
        request:
          name: ListUsersRequest
          query-parameters:
            starting_after: optional<string>
        response: ListUsersResponse

  The generated client.Users.List can then be used as a User generator (effectively the "default"):

  for user in client.users.list(...):
    print user

  a page-by-page generator:

  for page in client.users.list(...).iter_pages():
    print(page.items)

  or statically calling next_page to perform the pagination manually:

  pager = client.users.list(...)
  # First page
  print(pager.items)
  # Second page
  pager = pager.next_page()
  print(pager.items)

[2.0.1] - 2024-05-14

• Fix: the python generator previously used exclude_unset on pydantic models, however this would remove defaulted values. This change updates this to only exclude none fields that were not required.

[2.0.0] - 2024-05-09

• Break: the python SDK is now on major version 2, there are no substantial logic changes, however default configuration has changed. To take this upgrade without any breaks, please add the below configuration to your generators.yml file:

  generators:
    - name: fernapi/fern-python-sdk
      config:
        inline_request_params: false

[1.7.0-rc0] - 2024-05-09

• Improvement: you can now declare a new python version range for your pyproject.toml, which will declare a new version range for your pip package.

  generators:
    - name: fernapi/fern-python-sdk
      config:
        pyproject_python_version: ^3.8.1

[1.6.0-rc0] - 2024-05-09

• Improvement: you can now specify dev dependencies from your generators.yml file:

  generators:
    - name: fernapi/fern-python-sdk
      config:
        extra_dev_dependencies:
          requests_mock: 1.12.1
          boto3: 1.28.57

  These will then populare your pyproject.toml automatically:

  ...
  [tool.poetry.dev-dependencies]
  requests_mock = "1.12.1"
  boto3 = "1.28.57"
  ...

[1.5.3-rc0] - 2024-05-02

• Fix: the unchecked basemodel no longer tries to dereference an object if it's null.

[1.5.2-rc0] - 2024-05-02

• Improvement: The python generator now produces sync snippet templates, as opposed to just async templates as it was before

[1.5.1-rc5] - 2024-05-01

• Fix: Snippet templates now generate the correct imports for object types.

[1.5.1-rc4] - 2024-05-01

• Fix: The SDK now generates discriminated union snippet templates correctly.

[1.5.1-rc3] - 2024-05-01

• Improvement: Union types leverage the fern aware base model to include JSON and Dict function overrides.

[1.5.1-rc2] - 2024-05-01

• Fix: The vanilla pydantic base model now respects the require_optional_fields, this became a regression in 1.5.1-rc0 when we started to inline union properties which leverages the vanilla base model.

[1.5.1-rc1] - 2024-05-01

• Fix: Address formatting issues with snippet templates, we now strip newlines off OG snippets as well as plumb through indentation metadata to places that were previously missing it.

[1.5.1-rc0] - 2024-04-26

• Fix: Discriminated union variants that are objects now have inlined properties instead of extending a base type.

  Circle_Shape(pydantic_v1.BaseModel):
    type: typing.Literal["circle"]
    radius: integer
  
  Square_Shape(pydantic_v1.BaseModel):
    type: typing.Literal["circle"]
    side: integer

  instead of

  Circle_Shape(Circle):
    type: typing.Literal["circle"]
  
  Square_Shape(Square):
    type: typing.Literal["circle"]

[1.5.0-rc0] - 2024-04-30

• Feat: The generator now supports inlining top-level request parameters instead of requiring users create a request object.

  Config:

  generators:
    - name: fernapi/fern-python-sdk
      config:
        inline_request_params: true

  Before:

  def get_and_return_with_optional_field(
    self,
    *,
    request: ObjectWithOptionalField,
    request_options: typing.Optional[RequestOptions] = None
  ) -> ObjectWithOptionalField:
    ...

  After:

  def get_and_return_with_optional_field(
    self,
    *,
    string: typing.Optional[str] = OMIT,
    integer: typing.Optional[int] = OMIT,
    long: typing.Optional[int] = OMIT,
    double: typing.Optional[float] = OMIT,
    bool: typing.Optional[bool] = OMIT,
    request_options: typing.Optional[RequestOptions] = None
  ) -> ObjectWithOptionalField:
    ...

[1.4.0] - 2024-04-29

• Improvement: keyword arguments are now ordered such that required params are ordered before optional params. Note that since these are kwargs, this is a non-breaking change.
• Improvement: docstrings now match numpydoc/PEP257 format

[1.4.0-rc3] - 2024-04-24

• Fix: Set mypy dev depenency in generated pyproject.toml to 1.9.0. This prevents upstream mypy bugs from affecting user builds. Note that this is only a dev dependency, so it does not affect the behavior of the SDK.
• Fix: Temporarily disable unit test generation.
• Improvement: Use named parameters for all httpx request params.

[1.4.0-rc2] - 2024-04-23

• Fix: Initialize the OAuth token provider member variables to their default values before they are set.

[1.4.0-rc1] - 2024-04-22

• Feature: The python SDK generator now supports OAuth client generation for the client-credentials flow.

[1.4.0-rc0] - 2024-04-22

• Chore: default generated clients to follow redirects by default, this effectively flips the follow_redirects_by_default flag to True and can be reverted with the following configuration:

  generators:
    - name: fernapi/fern-python-sdk
      config:
        follow_redirects_by_default: false

[1.3.1-rc0] - 2024-04-22

• Fix: the python SDK generator now checks to make sure a header is not null before casting it to a string.

[1.3.0-rc1] - 2024-04-22

• Internal: add logging for python snippet template generation.

[1.3.0-rc0] - 2024-04-21

• Beta, feature: The generator now registers snippet templates which can be used for dynamic SDK code snippet generation.

  Note: You must be on the enterprise tier to enable this mode.

[1.2.0-rc2] - 2024-04-10

• Fix: The generator now correctly imports json when deserializing server sent events.

[1.2.0-rc0] - 2024-04-10

• Feature: The generator now depends on v38 of Intermediate Representation which requires the latest CLI. As part of this, the generator now supports server sent events using httpx-sse.

[1.1.0-rc3] - 2024-04-04

• Fix: There are a number of fixes to the skip validation code as well as tests to reflect those updates.

[1.1.0-rc2] - 2024-04-04

• Fix: The generator now writes the skipped-validation cast with a suffixing new line so that the code compiles.

[1.1.0-rc1] - 2024-04-04

• Fix: The generator no longer attempts to create a version file if Fern does not own generating the full package (e.g. in local generation). It's too confusing for to make the relevant changes to the package set up, and is also arguably not even needed in local generation.

[1.1.0-rc0] - 2024-04-03

• [EXPERIMENTAL] Feature: The python SDK now includes a configuration option to skip pydantic validation. This ensures that Pydantic does not immediately fail if the model being returned from an API does not exactly match the Pydantic model. This is meant to add flexibility, should your SDK fall behind your API, but should be used sparringly, as the type-hinting for users will still reflect the Pydantic model exactly.

  generators:
    - name: fernapi/fern-python-sdk
      ...
      config:
        pydantic_config:
          skip_validation: true

[1.0.1] - 2024-04-03

• Fix: Pydantic introduced a "break" to their 1.x libs by adding in a .v1 submodule that does not mirror the one that comes with pydantic v2. To get around this we now force the usage of the v1 submodule only if the pydantic version is v2.

[1.0.0] - 2024-04-02

• Break: The python SDK now defaults new (breaking configuration) to introduce general improvements.

  In order to revert to the previous configuration flags and avoid the break, please leverage the below configuration:

  generators:
    - name: fernapi/fern-python-sdk
      config:
        improved_imports: false
        pydantic_config:
          require_optional_fields: true
          use_str_enums: false
          extra_fields: "forbid"

• Improvement: The python SDK now supports specifying whether or not to follow redirects in requests by default, and exposes an option to override that functionality for consumers.

  generators:
    - name: fernapi/fern-python-sdk
      config:
        follow_redirects_by_default: true

  which then just instantiates the client like so:

  client = SeedExhaustive(
        token="YOUR_TOKEN",
        follow_redirects=True  # This is defaulted to the value passed into follow_redirects_by_default, and ignored if not specified
  )

[0.13.4] - 2024-04-03

• Fix: revert the change from 0.13.2, the stream call returns a context manager, which is not awaited. The issue that this was meant to solve was actually fixed in version 0.12.2.

[0.13.3] - 2024-03-28

• Fix: Github workflows for publishing now work again (previously the trigger was incorrect).

[0.13.2] - 2024-03-28

• Fix: Asynchronous calls to httpx.stream are now awaited. This is applicable to any file download or JSON streaming (chat completion) endpoints.

  # Before
  async with httpx.stream
  
  # After
  async with await httpx.stream

[0.13.1] - 2024-03-26

• Improvement: discriminant values in unions are now defaulted such that callers no longer need to specify the discriminant:

  # Before
  shape = Circle(discriminant="circle", radius=2.0)
  
  # After
  shape = Circle(radius=2.0)

[0.13.0] - 2024-03-25

• Improvement: the python SDK now exposes it's version through __version__ to match module standards and expectations.

import seed

print(seed.__version__)  # prints 0.0.1 or whatever version is contained within the pyproject.toml

[0.12.5] - 2024-03-22

• Fix: the python SDK uses the timeout provided to the top level client as the default per-request, previously if there was no timeout override in the RequestOptions, we'd default to 60s, even if a timeout was provided at the client level.

[0.12.4] - 2024-03-19

• Improvement: Allow full forward compat with enums while keeping intellisense by unioning enum literals with typing.AnyStr.

  Before:

  Operand = typing.Union[typing.AnyStr, typing.Literal[">", "=", "less_than"]]

  After:

  Operand = typing.Literal[">", "=", "less_than"]

[0.12.3] - 2024-03-18

• Improvement: Allow bytes requests to take in iterators of bytes, mirroring the types allowed by HTTPX.

[0.12.2] - 2024-03-18

• Fix: Fix the returned type and value contained within the retrying wrapper for the HTTPX client (http_client.py).

[0.12.1] - 2024-03-14

• Improves example generation and snippets for union types, as well as multi-url environments.
• Fix: Stringifies header arguments, HTTPX was previously hard failing for certain types

[0.12.0] - 2024-03-11

• Beta, feature: The SDK now generates tests leveraging auto-generated data to test typing, as well as wire-formatting (e.g. the SDKs are sending and receiving data as expected). This comes out of the box within the generated github workflow, as well as through the fern cli: fern test --command "your test command". Note: You must be on the enterprise tier to enable this mode.

[0.11.10] - 2024-03-08

• feature: Expose a feature flag to pass through additional properties not specified within your pydantic model from your SDK. This allows for easier forward compatibility should your SDK drift behind your spec.

  Config:

  generators:
    - name: fernapi/fern-python-sdk
      ...
      config:
        pydantic_config:
          extra_fields: "allow"

  Example generated code:

  # my_object.py
  class MyObject(pydantic.BaseModel):
      string: typing.Optional[str] = None
      ...
  
  # main.py
  o = pydantic.parse_obj_as(MyObject, {"string": "string", "my_new_property": "custom_value"})
  
  print(o.my_new_property) # <--- "custom_value"

[0.11.9] - 2024-03-04

• chore: Use docstrings instead of Pydantic field descriptions. This is meant to be a cleanliness change. This goes from:

  field: Optional[str] = pydantic.Field(default=None, description="This is the description.")

  to:

  field: Optional[str] = pydantic.Field(default=None)
  """This is the description."""

[0.11.8-rc1] - 2024-03-02

• Beta, Improvement: Introduces a max_retries parameter to the RequestOptions dict accepted by all requests. This parameter will retry requests automatically, with exponential backoff and a jitter. The client will automatically retry requests of a 5XX status code, or certain 4XX codes (429, 408, 409).

    client\
      .imdb\
      .create_movie(
        request=CreateMovieRequest(title="title", rating=4.3),
        request_options={
          "max_retries": 5,
        }
      )

[0.11.8-rc0] - 2024-02-27

• Beta: Introduce a client custom config that allows you to specify class_name and filename for the client. This configuration can be used in several ways:

  1. Rename your client class:

     config:
       client:
         class_name: Imdb

  2. Add custom functions to your generated SDK:

     config:
       client:
         class_name: BaseImdb
         filename: base_client.py
         exported_class_name: Imdb
         exported_filename: client.py

     Often times you may want to add additional methods or utilites to the generated client. The easiest way to do this is to configure Fern to write the autogenerated client in another file and extend it on your own.

     With the configuration above, Fern's Python SDK generator will create a class called BaseImdb and AsyncBaseImdb and put them in a file called base_client.py. As a user, you can extend both these classes with custom utilities.

     To make sure the code snippets in the generated SDK are accurate you can specify exported_class_name and exported_filename.

[0.11.7] - 2024-02-27

• Improvement: Introduces a flag use_str_enums to swap from using proper Enum classes to using Literals to represent enums. This change allows for forward compatibility of enums, since the user will receive the string back.

  config:
    pydantic_config:
      use_str_enums: true
  

  generates enums as:

  Operand = typing.Literal[">", "=", "less_than"]
  

[0.11.6] - 2024-02-26

• Improvement: You can now specify envvars to scan for headers, not just auth scheme headers.

  # OpenAPI
  x-fern-global-headers:
   - header: x-api-key
     name: api_key
     optional: true
     env: MY_API_KEY
  

  ... or ...

  # Fern Definition
  getAllUsers:
    method: GET
    path: /all
    request:
      name: GetAllUsersRequest
      headers:
        X-API-KEY: string
        env: MY_API_KEY
  

  the generated client will look like

  import os
  
  class Client:
  
    def __init__(self, *, apiKey: str = os.getenv("MY_API_KEY"))

[0.11.5] - 2024-02-23

• Fix: Fix the usage of ApiError when leveraging auth envvars, when the schema for ApiError was changed, this usage was missed in the update.

[0.11.4] - 2024-02-23

• Fix: We now grab enum values appropriately when enums are within unions.

[0.11.3] - 2024-02-22

• Fix: Transition from lists to sequences within function calls, this is a fix as a result of how mypy handles type variance. This fix is only for function calls as testing shows that we do not hit the same issue within mypy with list[union[*]] fields on pydantic objects. This issue outlines it well: https://stackoverflow.com/questions/76138438/incompatible-types-in-assignment-expression-has-type-liststr-variable-has

• Improvement: The Python SDK generator now defaults to require_optional_fields = False. This means that any requests that have optional fields no longer require a user to input data (or a None value) in. Example:

  # Previously:
  def my_function(my_parameter: typing.Optional[str]):
    pass
  
  my_function()  # <--- This fails mypy
  my_function(None)  # <--- This is necessary
  my_function("I work in both cases!")
  ...
  # Now:
  def my_function():
    pass
  
  my_function()  # <--- I no longer fail mypy
  my_function(None)  # <--- I still work
  my_function("I work in both cases!")

[0.11.2] - 2024-02-21

• Improvement (Beta): The Python generator now supports a configuration option called improved_imports. To enable this configuration, just add the following to your generators.yml

  generators:
    - name: fernapi/fern-python-sdk
      ...
      config:
        improved_imports: true

  Enabling improved imports will remove the verbose resources directory in the SDK and make the imports shorter. This will also improve the imports from Pylance and Pyright that are automaticaly generated

  # Before
  from sdk.resources.fhir import Paient
  
  # After
  from sdk.fhir import Patient

[0.11.1] - 2024-02-20

• Improvement: Python now supports specifying files to auto-export from the root __init__.py file, this means you can export custom classes and functions from your package for users to access like so:

  from my_package import custom_function

  the configuration for this is:

  # generators.yml
  python-sdk:
    generators:
      - name: fernapi/fern-python-sdk
        version: 0.11.1
        config:
          additional_init_exports:
            - from: file_with_custom_function
              imports:
                - custom_function

• Chore: Add a docstring for base clients to explain usage, example:

  class SeedTest:
    """
    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
    ---
    from seed.client import SeedTest
  
    client = SeedTest(
        token="YOUR_TOKEN",
        base_url="https://yourhost.com/path/to/api",
    )
    """

[0.11.0] - 2024-02-19

• Improvement: Python now supports a wider range of types for file upload, mirroring the httpx library used under the hood, these are grouped under a new type File:

  # core/file.py
  FileContent = typing.Union[typing.IO[bytes], bytes, str]
  File = typing.Union[
      # file (or bytes)
      FileContent,
      # (filename, file (or bytes))
      typing.Tuple[typing.Optional[str], FileContent],
      # (filename, file (or bytes), content_type)
      typing.Tuple[typing.Optional[str], FileContent, typing.Optional[str]],
      # (filename, file (or bytes), content_type, headers)
      typing.Tuple[typing.Optional[str], FileContent, typing.Optional[str], typing.Mapping[str, str]],
  ]
  
  ...
  
  # service.py
  def post(
      self,
      *,
      file: core.File,
      request_options: typing.Optional[RequestOptions] = None,
  ) -> None:
      """
      Parameters:
          - file: core.File. See core.File for more documentation
          - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
      """
  ...
  
  # main.py
  f = open('report.xls', 'rb')
  service.post(file=f)
  
  # Or leveraging a tuple
  with open('largefile.zip', 'rb') as f:
    service.post(file=('largefile.zip', f))
  ...

• Fix: Python now supports API specifications that leverage lists for file upload. Previously, Fern incorrectly made all list<file> type requests simply file.

  # service.py
  def post(
      self,
      *,
      file_list: typing.List[core.File],
      request_options: typing.Optional[RequestOptions] = None,
  ) -> None:
      """
      Parameters:
          - file_list: typing.List[core.File]. See core.File for more documentation
          - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
      """
  ...
  
  # main.py
  f1 = open('report.xls', 'rb')
  f2 = open('page.docx', 'rb')
  service.post(file_list=[f1, f2])

[0.10.3] - 2024-02-19

• Fix: Several bugfixes were made to related to literal properties. If a literal is used as a query parameeter, header, path parameter, or request parameter, the user no longer has to explicitly pass it in.

  For example, the following endpoint

  endpoints:
    chat_stream:
      request:
        name: ListUsersRequest
        headers:
          X_API_VERSION: literal<"2022-02-02">
        body:
          properties:
            stream: literal<true>
            query: string

  would generate the following signature in Python

  class Client:
  
    # The user does not have to pass in api version or stream since
    # they are literals and always the same
    def chat_stream(self, *, query: str) -> None:

[0.10.2] - 2024-02-18

• Fix: The SDK always sends the enum wire value instead of the name of the enum. For example, for the following enum,

  class Operand(str, enum.Enum):
    GREATER_THAN = ">"
    EQUAL_TO = "="

  the SDK should always be sending > and = when making a request.

  This affected enums used in path parameters, query parameters and any request body parameters at the first level. To fix, the SDK sends the .value attribute of the enum.

• Fix: Revert #2719 which introduced additional issues with circular references within our Python types.

[0.10.1] - 2024-02-14

• Improvement: Add support for a RequestOptions object for each generated function within Python SDKs. This parameter is an optional final parameter that allows for configuring timeout, as well as pass in arbitrary data through to the request. RequestOptions is a TypedDict, with optional fields, so there's no need to instantiate an object, just pass in the relevant keys within a dict!

  • timeout_in_seconds overrides the timeout for this specific request

  • additional_body_parameters are expanded into the JSON request body

  • additional_query_parameters are expanded into the JSON query parameters map

  • additional_headers are expanded into the request's header map

  • Here's an example:

    client\
      .imdb\
      .create_movie(
        request=CreateMovieRequest(title="title", rating=4.3),
        request_options={
          "timeout_in_seconds": 99,
          "additional_body_parameters": {"another": "body parameter"},
          "additional_headers": {"another": "header"},
        }
      )

[0.10.0] - 2024-02-13

• Improvement: Remove support for Python 3.7. In order to support newer versions of libraries we depend on (such as typing and typing-extensions), we must move on to Python 3.8. With this change we are also able to:
  • Remove the backports dependency, as cached_property is now included within functools
  • Remove the upper bound dependency on Pydantic which had dropped support for Python 3.7

[0.9.1] - 2024-02-11

• Fix: Remove literals from SDK function signatures, as they are not modifiable for end users.

  Before:

  def get_options(self, *, dry_run: typing_extensions.Literal[True]) -> Options:
    ...
    json=jsonable_encoder({"dryRun": dry_run}),
    ...

  After:

  def get_options(self, *) -> Options:
    ...
    json=jsonable_encoder({"dryRun": "true"}),

• Fix: Acknowledge the optionality of a File property, previously we were requiring all File type inputs, even if they were specified as optional within the OpenAPI or Fern definition. Now, we check if the parameter is required and make the parameter optional if it is not.

[0.9.0] - 2024-02-11

• Feature: The SDK generator now supports whitelabelling. When this is turned on, there will be no mention of Fern in the generated code.

  Note: You must be on the enterprise tier to enable this mode.

[0.8.3-rc0] - 2024-01-29

• Fix: Increase recursion depth to allow for highly nested and complex examples, this is a temporary solution while the example datamodel is further refined.

[0.8.2-rc0] - 2024-01-28

• Fix: The Python SDK better handles cyclical references. In particular, cyclical references are tracked for undiscriminated unions, and update_forward_refs is always called with object references.

[0.8.1] - 2024-01-26

• Feature: If the auth scheme has environment variables specified, the generated python client will scan those environment variables.

  For example, for the following Fern Definition

  auth: APIKey
  auth-schemes:
    APIKey:
      header: X-FERN-API-KEY
      type: string
      env: FERN_API_KEY
  

  the generated client will look like

  import os
  
  class Client:
  
    def __init__(self, *, apiKey: str = os.getenv("FERN_API_KEY"))

[0.8.0] - 2024-01-25

• Fix: Enums in inlined requests send the appropriate value.

  class Operand(str, Enum):
    greater_than = ">"
    equal_to = "="
  
  # Previously the SDK would just send the operand directly
  def endpoint(self, *, operand: Operand):
    httpx.post(json={"operand": operand})
  
  # Now, the SDK will send the value of the enum
  def endpoint(self, *, operand: Operand):
    httpx.post(json={"operand": operand.value})

[0.7.7] - 2024-01-21

• Chore: Intialize this changelog