chore(python): Upgrade to IRv57 (#6476)

Author: amckinney

fern/pages/changelogs/cli/2025-03-18.mdx

@@ -0,0 +1,4 @@
+## 0.56.25
+**`(internal):`** The CLI now recognizes that the latest Python SDK uses IRv57.
+
+

fern/pages/changelogs/fastapi/2025-03-18.mdx

@@ -0,0 +1,4 @@
+## 1.6.3
+**`(internal):`** Update the IR to v57.
+
+

fern/pages/changelogs/pydantic/2025-03-18.mdx

@@ -0,0 +1,4 @@
+## 1.4.8
+**`(internal):`** Update the IR to v57.
+
+

fern/pages/changelogs/python-sdk/2025-03-18.mdx

@@ -0,0 +1,4 @@
+## 4.3.19
+**`(internal):`** Update the IR to v57.
+
+

generators/python/fastapi/versions.yml

@@ -1,4 +1,11 @@
 # For unreleased changes, use unreleased.yml
+- version: 1.6.3
+  irVersion: 57
+  changelogEntry:
+    - type: internal
+      summary: |
+        Update the IR to v57.
+
 - version: 1.6.2
   irVersion: 53
   changelogEntry:

generators/python/poetry.lock

@@ -1,4 +1,11 @@
 # For unreleased changes, use unreleased.yml
+- version: 1.4.8
+  irVersion: 57
+  changelogEntry:
+    - type: internal
+      summary: |
+        Update the IR to v57.
+
 - version: 1.4.7
   irVersion: 53
   changelogEntry:

generators/python/pydantic/versions.yml

@@ -13,7 +13,7 @@ ordered-set = "^4.1.0"
 pydantic-core = "^2.18.2"
 fern-fern-fdr-sdk = { version = "0.98.20", source = "fern-prod" }
 fern-fern-generator-cli-sdk = { version = "0.0.18", source = "fern-prod" }
-fern_fern_ir_v53 = "53.12.0"
+fern_fern_ir_v57 = "57.0.0"
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.4.2"

generators/python/pyproject.toml

@@ -1,4 +1,11 @@
 # For unreleased changes, use unreleased.yml
+- version: 4.3.19
+  irVersion: 57
+  changelogEntry:
+    - type: internal
+      summary: |
+        Update the IR to v57.
+
 - version: 4.3.18
   irVersion: 53
   changelogEntry:

generators/python/sdk/versions.yml

@@ -51,6 +51,7 @@ def _visit_type_reference(self, type_reference: ir_types.TypeReference) -> Optio
                 list_=lambda tr: self._visit_type_reference(tr),
                 map_=lambda _: None,
                 optional=lambda tr: self._visit_type_reference(tr),
+                nullable=lambda tr: self._visit_type_reference(tr),
                 set_=lambda tr: self._visit_type_reference(tr),
                 literal=lambda _: None,
             ),

generators/python/src/fern_python/generator_cli/reference_config_builder.py

@@ -144,6 +144,7 @@ def get_initializer_for_type_reference(
                 set_=lambda _: None,
                 # Ignore literal defaults when the wrapping type is optional
                 optional=lambda opt: self.get_initializer_for_type_reference(opt, ignore_literals=True),
+                nullable=lambda nullable: self.get_initializer_for_type_reference(nullable, ignore_literals=True),
                 map_=lambda _: None,
             )
 
@@ -247,6 +248,7 @@ def get_referenced_types_of_type_reference(self, type_reference: ir_types.TypeRe
                 list_=lambda item_type: self.get_referenced_types_of_type_reference(item_type),
                 set_=lambda item_type: self.get_referenced_types_of_type_reference(item_type),
                 optional=lambda item_type: self.get_referenced_types_of_type_reference(item_type),
+                nullable=lambda item_type: self.get_referenced_types_of_type_reference(item_type),
                 map_=lambda map_type: (
                     self.get_referenced_types_of_type_reference(map_type.key_type).union(
                         self.get_referenced_types_of_type_reference(map_type.value_type)
@@ -267,6 +269,7 @@ def get_type_names_in_type_reference(self, type_reference: ir_types.TypeReferenc
                 list_=lambda item_type: self.get_referenced_types_of_type_reference(item_type),
                 set_=lambda item_type: self.get_referenced_types_of_type_reference(item_type),
                 optional=lambda item_type: self.get_referenced_types_of_type_reference(item_type),
+                nullable=lambda item_type: self.get_referenced_types_of_type_reference(item_type),
                 map_=lambda map_type: (
                     self.get_referenced_types_of_type_reference(map_type.key_type).union(
                         self.get_referenced_types_of_type_reference(map_type.value_type)
@@ -288,6 +291,7 @@ def maybe_get_type_ids_for_type_reference(
                 map_=lambda mt: (self.maybe_get_type_ids_for_type_reference(mt.key_type) or []).extend(
                     self.maybe_get_type_ids_for_type_reference(mt.value_type) or []
                 ),
+                nullable=lambda nullable_tr: self.maybe_get_type_ids_for_type_reference(nullable_tr),
                 optional=lambda optional_tr: self.maybe_get_type_ids_for_type_reference(optional_tr),
                 set_=lambda set_tr: self.maybe_get_type_ids_for_type_reference(set_tr),
                 literal=lambda _: None,
@@ -316,6 +320,9 @@ def unwrap_example_type_reference(
                 optional=lambda optional: self.unwrap_example_type_reference(optional.optional)
                 if optional.optional is not None
                 else example_type_reference,
+                nullable=lambda nullable: self.unwrap_example_type_reference(nullable.nullable)
+                if nullable.nullable is not None
+                else example_type_reference,
                 map_=lambda _: example_type_reference,
                 literal=lambda _: example_type_reference,
             ),

generators/python/src/fern_python/generators/context/pydantic_generator_context_impl.py

@@ -147,14 +147,33 @@ def _get_type_hint_for_container(
                 ),
                 unknown=lambda: AST.TypeHint.list(AST.TypeHint.any()),
             ),
-            optional=lambda wrapped_type: AST.TypeHint.optional(
+            nullable=lambda wrapped_type: AST.TypeHint.optional(
+                self.get_type_hint_for_type_reference(
+                    type_reference=self._unbox_type_reference(wrapped_type),
+                    must_import_after_current_declaration=must_import_after_current_declaration,
+                    as_if_type_checking_import=as_if_type_checking_import,
+                    in_endpoint=in_endpoint,
+                    for_typeddict=for_typeddict,
+                )
+            )
+            if not for_typeddict
+            else AST.TypeHint.not_required(
                 self.get_type_hint_for_type_reference(
                     type_reference=wrapped_type,
                     must_import_after_current_declaration=must_import_after_current_declaration,
                     as_if_type_checking_import=as_if_type_checking_import,
                     in_endpoint=in_endpoint,
                     for_typeddict=for_typeddict,
                 )
+            ),
+            optional=lambda wrapped_type: AST.TypeHint.optional(
+                self.get_type_hint_for_type_reference(
+                    type_reference=self._unbox_type_reference(wrapped_type),
+                    must_import_after_current_declaration=must_import_after_current_declaration,
+                    as_if_type_checking_import=as_if_type_checking_import,
+                    in_endpoint=in_endpoint,
+                    for_typeddict=for_typeddict,
+                )
             )
             if not for_typeddict
             else AST.TypeHint.not_required(
@@ -209,3 +228,26 @@ def _get_type_hint_for_primitive(self, primitive: ir_types.PrimitiveType) -> AST
             float_=AST.TypeHint.float_,
         )
         return to_return
+
+    def _unbox_type_reference(self, type_reference: ir_types.TypeReference) -> ir_types.TypeReference:
+        return type_reference.visit(
+            container=lambda container: self._unbox_type_reference_container(
+                type_reference=type_reference,
+                container=container,
+            ),
+            named=lambda _: type_reference,
+            primitive=lambda _: type_reference,
+            unknown=lambda: type_reference,
+        )
+
+    def _unbox_type_reference_container(
+        self, type_reference: ir_types.TypeReference, container: ir_types.ContainerType
+    ) -> ir_types.TypeReference:
+        return container.visit(
+            list_=lambda _: type_reference,
+            map_=lambda _: type_reference,
+            set_=lambda _: type_reference,
+            nullable=lambda nullable: self._unbox_type_reference(type_reference=nullable),
+            optional=lambda optional: self._unbox_type_reference(type_reference=optional),
+            literal=lambda _: type_reference,
+        )

generators/python/src/fern_python/generators/context/type_reference_to_type_hint_converter.py

@@ -105,6 +105,7 @@ def _get_is_return_type_pydantic_model(self) -> bool:
             json=lambda json_response: True,
             streaming=lambda _: True,
             stream_parameter=lambda _: True,
+            bytes=lambda _: False,
         )
 
     def _get_return_type(self) -> AST.TypeHint:
@@ -368,6 +369,7 @@ def _get_response_body_type(self, response_body: ir_types.HttpResponseBody) -> A
             text=lambda _: AST.TypeHint.str_(),
             streaming=lambda _: raise_streaming_unsupported(),
             stream_parameter=lambda _: raise_stream_parameter_unsupported(),
+            bytes=lambda _: raise_bytes_response_unsupported(),
         )
 
     def _get_json_response_body_type(
@@ -405,5 +407,9 @@ def raise_bytes_unsupported() -> Never:
     raise RuntimeError("bytes request is not supported")
 
 
+def raise_bytes_response_unsupported() -> Never:
+    raise RuntimeError("bytes response is not supported")
+
+
 def raise_json_nested_property_as_response_unsupported() -> Never:
     raise RuntimeError("nested property json response is unsupported")

generators/python/src/fern_python/generators/fastapi/service_generator/endpoint_generator.py

@@ -15,7 +15,13 @@ def convert_to_singular_type(context: FastApiGeneratorContext, type: ir_types.Ty
     elif union.type == "container":
         container_union = union.container.get_as_union()
         if container_union.type == "optional":
-            return AST.TypeHint.optional(wrapped_type=convert_to_singular_type(context, container_union.optional))
+            return AST.TypeHint.optional(
+                wrapped_type=convert_to_singular_type(context, _unbox_type_reference(container_union.optional))
+            )
+        elif container_union.type == "nullable":
+            return AST.TypeHint.optional(
+                wrapped_type=convert_to_singular_type(context, _unbox_type_reference(container_union.nullable))
+            )
     elif union.type == "named":
         declaration = context.pydantic_generator_context.get_declaration_for_type_id(union.type_id)
         shape_union = declaration.shape.get_as_union()
@@ -46,3 +52,28 @@ def convert_to_singular_type(context: FastApiGeneratorContext, type: ir_types.Ty
     elif union.type != "void":
         assert_never(union)
     raise ValueError(f"Provided type is not a singular type: {type}")
+
+
+def _unbox_type_reference(type_reference: ir_types.TypeReference) -> ir_types.TypeReference:
+    return type_reference.visit(
+        container=lambda container: _unbox_type_reference_container(
+            type_reference=type_reference,
+            container=container,
+        ),
+        named=lambda _: type_reference,
+        primitive=lambda _: type_reference,
+        unknown=lambda: type_reference,
+    )
+
+
+def _unbox_type_reference_container(
+    type_reference: ir_types.TypeReference, container: ir_types.ContainerType
+) -> ir_types.TypeReference:
+    return container.visit(
+        list_=lambda _: type_reference,
+        map_=lambda _: type_reference,
+        set_=lambda _: type_reference,
+        nullable=lambda nullable: _unbox_type_reference(type_reference=nullable),
+        optional=lambda optional: _unbox_type_reference(type_reference=optional),
+        literal=lambda _: type_reference,
+    )

generators/python/src/fern_python/generators/fastapi/service_generator/endpoint_parameters/convert_to_singular_type.py

@@ -21,7 +21,10 @@ def get_type(self) -> AST.TypeHint:
 
     def get_default(self) -> AST.Expression:
         value_type = self._header.value_type.get_as_union()
-        is_optional = value_type.type == "container" and value_type.container.get_as_union().type == "optional"
+        is_optional = value_type.type == "container" and (
+            value_type.container.get_as_union().type == "optional"
+            or value_type.container.get_as_union().type == "nullable"
+        )
         return FastAPI.Header(is_optional=is_optional, wire_value=self._header.name.wire_value)
 
     @staticmethod

generators/python/src/fern_python/generators/fastapi/service_generator/endpoint_parameters/header_endpoint_parameter.py

@@ -23,7 +23,10 @@ def get_type(self) -> AST.TypeHint:
 
     def get_default(self) -> AST.Expression:
         value_type = self._query_parameter.value_type.get_as_union()
-        is_optional = value_type.type == "container" and value_type.container.get_as_union().type == "optional"
+        is_optional = value_type.type == "container" and (
+            value_type.container.get_as_union().type == "optional"
+            or value_type.container.get_as_union().type == "nullable"
+        )
         default = None
         if is_optional:
             default = AST.Expression(AST.TypeHint.none())

generators/python/src/fern_python/generators/fastapi/service_generator/endpoint_parameters/query_endpoint_parameter.py

@@ -10,6 +10,7 @@ def can_tr_be_fern_model(tr: ir_types.TypeReference, types: Dict[ir_types.TypeId
             list_=lambda list_tr: can_tr_be_fern_model(list_tr, types),
             map_=lambda mt: can_tr_be_fern_model(mt.key_type, types) or can_tr_be_fern_model(mt.value_type, types),
             optional=lambda optional_tr: can_tr_be_fern_model(optional_tr, types),
+            nullable=lambda nullable_tr: can_tr_be_fern_model(nullable_tr, types),
             set_=lambda set_tr: can_tr_be_fern_model(set_tr, types),
             literal=lambda _: False,
         ),
@@ -31,6 +32,7 @@ def can_be_fern_model(type_: ir_types.Type, types: Dict[ir_types.TypeId, ir_type
                 list_=lambda list_tr: can_tr_be_fern_model(list_tr, types),
                 map_=lambda mt: can_tr_be_fern_model(mt.key_type, types) or can_tr_be_fern_model(mt.value_type, types),
                 optional=lambda optional_tr: can_tr_be_fern_model(optional_tr, types),
+                nullable=lambda nullable_tr: can_tr_be_fern_model(nullable_tr, types),
                 set_=lambda set_tr: can_tr_be_fern_model(set_tr, types),
                 literal=lambda _: False,
             ),

generators/python/src/fern_python/generators/pydantic_model/model_utilities.py

@@ -250,6 +250,7 @@ def _get_type_id(self, tr: ir_types.TypeReference) -> List[Union[ir_types.TypeId
                 list_=lambda lt: self._get_type_id(lt),
                 map_=lambda mt: self._get_type_id(mt.key_type) + self._get_type_id(mt.value_type),
                 optional=lambda ot: self._get_type_id(ot),
+                nullable=lambda nt: self._get_type_id(nt),
                 set_=lambda st: self._get_type_id(st),
                 literal=lambda _: [],
             )

generators/python/src/fern_python/generators/pydantic_model/type_declaration_handler/discriminated_union/simple_discriminated_union_generator.py

@@ -84,6 +84,7 @@ def _get_builder_name(self, alias_of: ir_types.TypeReference) -> str:
                 map_=lambda _: "from_map",
                 set_=lambda _: "from_set",
                 optional=self._get_builder_name,
+                nullable=self._get_builder_name,
                 literal=lambda _: "from_string",
             ),
             named=lambda type_name: "from_" + type_name.name.snake_case.unsafe_name,
@@ -112,6 +113,7 @@ def _get_getter_name(self, alias_of: ir_types.TypeReference) -> str:
                 map_=lambda _: "get_as_map",
                 set_=lambda _: "get_as_set",
                 optional=self._get_getter_name,
+                nullable=self._get_getter_name,
                 literal=lambda _: "get_as_string",
             ),
             named=lambda type_name: "get_as_" + type_name.name.snake_case.unsafe_name,

generators/python/src/fern_python/generators/pydantic_model/type_declaration_handler/pydantic_models/pydantic_model_alias_generator.py

@@ -158,6 +158,9 @@ def add_field(
             if container_reference_unioned.type == "optional":
                 type_reference = container_reference_unioned.optional
                 is_optional = True
+            if container_reference_unioned.type == "nullable":
+                type_reference = container_reference_unioned.nullable
+                is_optional = True
 
         type_hint = self._get_type_hint_for_type_reference(type_reference, as_if_type_checking)
         if json_field_name != name: