@typespec/http-client-python 0.33.0 → 0.34.0

package/generator/build/lib/pygen/preprocess/__init__.py

@@ -36,18 +36,14 @@ def update_overload_section(
             if overload_s.get("type"):
                 overload_s["type"] = original_s["type"]
             if overload_s.get("headers"):
-                for overload_h, original_h in zip(
-                    overload_s["headers"], original_s["headers"]
-                ):
+                for overload_h, original_h in zip(overload_s["headers"], original_s["headers"]):
                     if overload_h.get("type"):
                         overload_h["type"] = original_h["type"]
     except KeyError as exc:
         raise ValueError(overload["name"]) from exc
 
 
-def add_overload(
-    yaml_data: dict[str, Any], body_type: dict[str, Any], for_flatten_params=False
-):
+def add_overload(yaml_data: dict[str, Any], body_type: dict[str, Any], for_flatten_params=False):
     overload = copy.deepcopy(yaml_data)
     overload["isOverload"] = True
     overload["bodyParameter"]["type"] = body_type
@@ -59,9 +55,7 @@ def add_overload(
     if for_flatten_params:
         overload["bodyParameter"]["flattened"] = True
     else:
-        overload["parameters"] = [
-            p for p in overload["parameters"] if not p.get("inFlattenedBody")
-        ]
+        overload["parameters"] = [p for p in overload["parameters"] if not p.get("inFlattenedBody")]
     # for yaml sync, we need to make sure all of the responses, parameters, and exceptions' types have the same yaml id
     for overload_p, original_p in zip(overload["parameters"], yaml_data["parameters"]):
         overload_p["type"] = original_p["type"]
@@ -69,9 +63,7 @@ def add_overload(
     update_overload_section(overload, yaml_data, "exceptions")
 
     # update content type to be an overloads content type
-    content_type_param = next(
-        p for p in overload["parameters"] if p["wireName"].lower() == "content-type"
-    )
+    content_type_param = next(p for p in overload["parameters"] if p["wireName"].lower() == "content-type")
     content_type_param["inOverload"] = True
     content_type_param["inDocstring"] = True
     body_type_description = get_body_type_for_description(overload["bodyParameter"])
@@ -94,25 +86,18 @@ def add_overloads_for_body_param(yaml_data: dict[str, Any]) -> None:
     body_parameter = yaml_data["bodyParameter"]
     if not (
         body_parameter["type"]["type"] == "combined"
-        and len(yaml_data["bodyParameter"]["type"]["types"])
-        > len(yaml_data["overloads"])
+        and len(yaml_data["bodyParameter"]["type"]["types"]) > len(yaml_data["overloads"])
     ):
         return
     for body_type in body_parameter["type"]["types"]:
-        if any(
-            o
-            for o in yaml_data["overloads"]
-            if id(o["bodyParameter"]["type"]) == id(body_type)
-        ):
+        if any(o for o in yaml_data["overloads"] if id(o["bodyParameter"]["type"]) == id(body_type)):
             continue
         if body_type.get("type") == "model" and body_type.get("base") == "json":
-            yaml_data["overloads"].append(
-                add_overload(yaml_data, body_type, for_flatten_params=True)
-            )
+            yaml_data["overloads"].append(add_overload(yaml_data, body_type, for_flatten_params=True))
+            # Skip single-body JSON overload; the TypedDict overload replaces it
+            continue
         yaml_data["overloads"].append(add_overload(yaml_data, body_type))
-    content_type_param = next(
-        p for p in yaml_data["parameters"] if p["wireName"].lower() == "content-type"
-    )
+    content_type_param = next(p for p in yaml_data["parameters"] if p["wireName"].lower() == "content-type")
     content_type_param["inOverload"] = False
     content_type_param["inOverridden"] = True
     content_type_param["inDocstring"] = True
@@ -122,19 +107,13 @@ def add_overloads_for_body_param(yaml_data: dict[str, Any]) -> None:
     content_type_param["optional"] = True
 
 
-def update_description(
-    description: Optional[str], default_description: str = ""
-) -> str:
+def update_description(description: Optional[str], default_description: str = "") -> str:
     if not description:
         description = default_description
     description.rstrip(" ")
     # Don't append a trailing period when the description ends with a code block: the
     # period would land inside the rendered literal block (e.g. "]." ) and break Sphinx.
-    if (
-        description
-        and description[-1] != "."
-        and not description_ends_with_code_block(description)
-    ):
+    if description and description[-1] != "." and not description_ends_with_code_block(description):
         description += "."
     return description
 
@@ -197,9 +176,7 @@ def _get_etag_role(parameter: dict[str, Any]) -> Optional[str]:
     return parameter.get("etagRole")
 
 
-def _pick_etag_slot(
-    candidates: list[dict[str, Any]], standard_wire_name: str
-) -> Optional[dict[str, Any]]:
+def _pick_etag_slot(candidates: list[dict[str, Any]], standard_wire_name: str) -> Optional[dict[str, Any]]:
     """Choose which etag-typed header should be promoted to the etag/match_condition slot.
 
     When more than one etag-typed header is present in an operation, prefer the
@@ -227,25 +204,16 @@ def _resolve_etag_pair(
     Returns (property_if_match, property_if_none_match) — both None when
     there are no etag candidates.
     """
-    property_if_match = _pick_etag_slot(
-        if_match_candidates, STANDARD_IF_MATCH_WIRE_NAME
-    )
-    property_if_none_match = _pick_etag_slot(
-        if_none_match_candidates, STANDARD_IF_NONE_MATCH_WIRE_NAME
-    )
+    property_if_match = _pick_etag_slot(if_match_candidates, STANDARD_IF_MATCH_WIRE_NAME)
+    property_if_none_match = _pick_etag_slot(if_none_match_candidates, STANDARD_IF_NONE_MATCH_WIRE_NAME)
 
     # Ensure the promoted pair come from the same family.  When one slot is
     # standard and the other custom (cross-family), replace the custom slot
     # with a synthetic standard partner.  Also synthesize the missing partner
     # when only one side is present.
     if property_if_match and property_if_none_match:
-        match_is_std = (
-            get_wire_name_lower(property_if_match) == STANDARD_IF_MATCH_WIRE_NAME
-        )
-        none_match_is_std = (
-            get_wire_name_lower(property_if_none_match)
-            == STANDARD_IF_NONE_MATCH_WIRE_NAME
-        )
+        match_is_std = get_wire_name_lower(property_if_match) == STANDARD_IF_MATCH_WIRE_NAME
+        none_match_is_std = get_wire_name_lower(property_if_none_match) == STANDARD_IF_NONE_MATCH_WIRE_NAME
         if match_is_std and not none_match_is_std:
             property_if_none_match = property_if_match.copy()
             property_if_none_match["wireName"] = STANDARD_IF_NONE_MATCH_WIRE_NAME
@@ -293,15 +261,11 @@ def _process_operation_etag_headers(
             elif role == "ifNoneMatch":
                 if_none_match_candidates.append(p)
 
-    property_if_match, property_if_none_match = _resolve_etag_pair(
-        if_match_candidates, if_none_match_candidates
-    )
+    property_if_match, property_if_none_match = _resolve_etag_pair(if_match_candidates, if_none_match_candidates)
 
     if property_if_match and property_if_none_match:
         etag_params = {id(property_if_match), id(property_if_none_match)}
-        operation["parameters"] = [
-            item for item in operation["parameters"] if id(item) not in etag_params
-        ] + [
+        operation["parameters"] = [item for item in operation["parameters"] if id(item) not in etag_params] + [
             property_if_match,
             property_if_none_match,
         ]
@@ -320,9 +284,7 @@ def has_json_content_type(yaml_data: dict[str, Any]) -> bool:
 
 
 def has_multi_part_content_type(yaml_data: dict[str, Any]) -> bool:
-    return any(
-        ct for ct in yaml_data.get("contentTypes", []) if ct == "multipart/form-data"
-    )
+    return any(ct for ct in yaml_data.get("contentTypes", []) if ct == "multipart/form-data")
 
 
 class PreProcessPlugin(YamlUpdatePlugin):
@@ -344,6 +306,44 @@ class PreProcessPlugin(YamlUpdatePlugin):
     def is_tsp(self) -> bool:
         return self.options.get("tsp_file", False)
 
+    @staticmethod
+    def _find_existing_typeddict(code_model: dict[str, Any], cross_lang_id: Optional[str]) -> Optional[dict[str, Any]]:
+        """Find an existing typeddict copy with the given crossLanguageDefinitionId."""
+        if not cross_lang_id:
+            return None
+        return next(
+            (
+                t
+                for t in code_model["types"]
+                if t.get("type") == "model"
+                and t.get("base") == "typeddict"
+                and t.get("crossLanguageDefinitionId") == cross_lang_id
+            ),
+            None,
+        )
+
+    @staticmethod
+    def _insert_typeddict_overload(
+        code_model: dict[str, Any],
+        body_parameter: dict[str, Any],
+        source: dict[str, Any],
+        origin_type: str,
+        existing_td: Optional[dict[str, Any]],
+    ) -> None:
+        """Insert a typeddict type into the body parameter's combined types."""
+        if origin_type == "model":
+            td_type = existing_td or {**source, "base": "typeddict"}
+            body_parameter["type"]["types"].insert(1, td_type)
+            if not existing_td:
+                code_model["types"].append(td_type)
+        else:
+            td_list_or_dict = copy.deepcopy(body_parameter["type"]["types"][0])
+            td_elem = existing_td or {**source, "base": "typeddict"}
+            td_list_or_dict["elementType"] = td_elem
+            body_parameter["type"]["types"].insert(1, td_list_or_dict)
+            if not existing_td:
+                code_model["types"].append(td_elem)
+
     def add_body_param_type(
         self,
         code_model: dict[str, Any],
@@ -353,54 +353,82 @@ class PreProcessPlugin(YamlUpdatePlugin):
         if (  # pylint: disable=too-many-boolean-expressions
             body_parameter
             and body_parameter["type"]["type"] in ("model", "dict", "list")
-            and (
-                has_json_content_type(body_parameter)
-                or (self.is_tsp and has_multi_part_content_type(body_parameter))
-            )
+            and (has_json_content_type(body_parameter) or (self.is_tsp and has_multi_part_content_type(body_parameter)))
             and not body_parameter["type"].get("xmlMetadata")
             and not any(t for t in ["flattened", "groupedBy"] if body_parameter.get(t))
         ):
             origin_type = body_parameter["type"]["type"]
             model_type = (
-                body_parameter["type"]
-                if origin_type == "model"
-                else body_parameter["type"].get("elementType", {})
+                body_parameter["type"] if origin_type == "model" else body_parameter["type"].get("elementType", {})
             )
             is_dpg_model = model_type.get("base") == "dpg"
+            is_json_model = model_type.get("base") == "json"
+            is_typeddict_only = self.options["models-mode"] == "typeddict"
+
             body_parameter["type"] = {
                 "type": "combined",
                 "types": [body_parameter["type"]],
             }
-            # don't add binary overload for multipart content type
-            if not (self.is_tsp and has_multi_part_content_type(body_parameter)):
+            # don't add binary overload for multipart content type or typeddict-only mode
+            if not (self.is_tsp and has_multi_part_content_type(body_parameter)) and not is_typeddict_only:
                 body_parameter["type"]["types"].append(KNOWN_TYPES["binary"])
 
+            # Add typeddict overload for non-spread dpg models
             if self.options["models-mode"] == "dpg" and is_dpg_model:
-                if origin_type == "model":
-                    body_parameter["type"]["types"].insert(1, KNOWN_TYPES["any-object"])
-                else:
-                    # dict or list
-                    # copy the original dict / list type
-                    any_obj_list_or_dict = copy.deepcopy(
-                        body_parameter["type"]["types"][0]
+                cross_lang_id = model_type.get("crossLanguageDefinitionId")
+                existing_td = self._find_existing_typeddict(code_model, cross_lang_id)
+                self._insert_typeddict_overload(code_model, body_parameter, model_type, origin_type, existing_td)
+
+            # For spread bodies (json base), add a typeddict overload that references
+            # the original model. This replaces the JSON single-body overload.
+            if is_json_model:
+                cross_lang_id = model_type.get("crossLanguageDefinitionId")
+                original = None
+                if cross_lang_id:
+                    original = next(
+                        (
+                            t
+                            for t in code_model["types"]
+                            if t.get("type") == "model"
+                            and t.get("crossLanguageDefinitionId") == cross_lang_id
+                            and t is not model_type
+                        ),
+                        None,
                     )
-                    any_obj_list_or_dict["elementType"] = KNOWN_TYPES["any-object"]
-                    body_parameter["type"]["types"].insert(1, any_obj_list_or_dict)
+
+                if is_typeddict_only and original:
+                    # In typeddict-only mode, the original dpg model already renders
+                    # as a TypedDict — reference it directly, no copy needed.
+                    if origin_type == "model":
+                        body_parameter["type"]["types"].insert(1, original)
+                    else:
+                        td_list_or_dict = copy.deepcopy(body_parameter["type"]["types"][0])
+                        td_list_or_dict["elementType"] = original
+                        body_parameter["type"]["types"].insert(1, td_list_or_dict)
+                else:
+                    source = original or model_type
+                    existing_td = self._find_existing_typeddict(code_model, cross_lang_id)
+                    self._insert_typeddict_overload(code_model, body_parameter, source, origin_type, existing_td)
+
+            if len(body_parameter["type"]["types"]) == 1:
+                # Only one body variant remains (e.g. typeddict-only mode where the
+                # binary and JSON overloads are omitted). Collapse the combined
+                # wrapper back to the single type so we don't emit a lone
+                # ``@overload`` (mypy rejects a single overload definition).
+                body_parameter["type"] = body_parameter["type"]["types"][0]
+                return
+
             code_model["types"].append(body_parameter["type"])
 
-    def pad_reserved_words(
-        self, name: str, pad_type: PadType, yaml_type: dict[str, Any]
-    ) -> str:
+
+    def pad_reserved_words(self, name: str, pad_type: PadType, yaml_type: dict[str, Any]) -> str:
         # we want to pad hidden variables as well
         if not name:
             # we'll pass in empty operation groups sometime etc.
             return name
 
         if self.is_tsp:
-            reserved_words = {
-                k: (v + TSP_RESERVED_WORDS.get(k, []))
-                for k, v in RESERVED_WORDS.items()
-            }
+            reserved_words = {k: (v + TSP_RESERVED_WORDS.get(k, [])) for k, v in RESERVED_WORDS.items()}
         else:
             reserved_words = RESERVED_WORDS
         name = pad_special_chars(name)
@@ -417,24 +445,18 @@ class PreProcessPlugin(YamlUpdatePlugin):
     def update_types(self, yaml_data: list[dict[str, Any]]) -> None:
         for type in yaml_data:
             for property in type.get("properties", []):
-                property["description"] = update_description(
-                    property.get("description", "")
-                )
+                property["description"] = update_description(property.get("description", ""))
                 if not property.get("isExactName", False):
                     property["clientName"] = self.pad_reserved_words(
                         property["clientName"].lower(), PadType.PROPERTY, property
                     )
                 add_redefined_builtin_info(property["clientName"], property)
             if type.get("name"):
-                pad_type = (
-                    PadType.MODEL if type["type"] == "model" else PadType.ENUM_CLASS
-                )
+                pad_type = PadType.MODEL if type["type"] == "model" else PadType.ENUM_CLASS
                 if type["type"] != "enumvalue":
                     name = self.pad_reserved_words(type["name"], pad_type, type)
                     type["name"] = name[0].upper() + name[1:]
-                type["description"] = update_description(
-                    type.get("description", ""), type["name"]
-                )
+                type["description"] = update_description(type.get("description", ""), type["name"])
                 type["snakeCaseName"] = to_snake_case(type["name"])
             if type.get("values"):
                 # we're enums - enum values are UPPER_CASE so no padding needed for reserved words
@@ -452,24 +474,16 @@ class PreProcessPlugin(YamlUpdatePlugin):
         yaml_data.append(CLOUD_SETTING["type"])  # type: ignore
 
     def update_client(self, yaml_data: dict[str, Any]) -> None:
-        yaml_data["description"] = update_description(
-            yaml_data["description"], default_description=yaml_data["name"]
-        )
+        yaml_data["description"] = update_description(yaml_data["description"], default_description=yaml_data["name"])
         yaml_data["legacyFilename"] = to_snake_case(yaml_data["name"].replace(" ", "_"))
         parameters = yaml_data["parameters"]
         for parameter in parameters:
             self.update_parameter(parameter)
             if parameter["clientName"] == "credential":
                 policy = parameter["type"].get("policy")
-                if (
-                    policy
-                    and policy["type"] == "BearerTokenCredentialPolicy"
-                    and self.azure_arm
-                ):
+                if policy and policy["type"] == "BearerTokenCredentialPolicy" and self.azure_arm:
                     policy["type"] = "ARMChallengeAuthenticationPolicy"
-                    policy["credentialScopes"] = [
-                        "https://management.azure.com/.default"
-                    ]
+                    policy["credentialScopes"] = ["https://management.azure.com/.default"]
         if (
             (not self.version_tolerant or self.azure_arm)
             and parameters
@@ -489,9 +503,7 @@ class PreProcessPlugin(YamlUpdatePlugin):
         if self.azure_arm and yaml_data["parameters"]:
             yaml_data["parameters"].append(CLOUD_SETTING)
 
-    def get_operation_updater(
-        self, yaml_data: dict[str, Any]
-    ) -> Callable[[dict[str, Any], dict[str, Any]], None]:
+    def get_operation_updater(self, yaml_data: dict[str, Any]) -> Callable[[dict[str, Any], dict[str, Any]], None]:
         if yaml_data["discriminator"] == "lropaging":
             return self.update_lro_paging_operation
         if yaml_data["discriminator"] == "lro":
@@ -503,8 +515,7 @@ class PreProcessPlugin(YamlUpdatePlugin):
     def update_parameter(self, yaml_data: dict[str, Any]) -> None:
         yaml_data["description"] = update_description(yaml_data.get("description", ""))
         if not yaml_data.get("isExactName", False) and not (
-            yaml_data["location"] == "header"
-            and yaml_data["clientName"] in ("content_type", "accept")
+            yaml_data["location"] == "header" and yaml_data["clientName"] in ("content_type", "accept")
         ):
             yaml_data["clientName"] = self.pad_reserved_words(
                 yaml_data["clientName"].lower(), PadType.PARAMETER, yaml_data
@@ -520,16 +531,13 @@ class PreProcessPlugin(YamlUpdatePlugin):
                 prop: (
                     param_name
                     if prop in exact_name_props
-                    else self.pad_reserved_words(
-                        param_name, PadType.PARAMETER, yaml_data
-                    ).lower()
+                    else self.pad_reserved_words(param_name, PadType.PARAMETER, yaml_data).lower()
                 )
                 for prop, param_name in yaml_data["propertyToParameterName"].items()
             }
         wire_name_lower = (yaml_data.get("wireName") or "").lower()
         if yaml_data["location"] == "header" and (
-            wire_name_lower in HEADERS_HIDE_IN_METHOD
-            or yaml_data.get("clientDefaultValue") == "multipart/form-data"
+            wire_name_lower in HEADERS_HIDE_IN_METHOD or yaml_data.get("clientDefaultValue") == "multipart/form-data"
         ):
             yaml_data["hideInMethod"] = True
         if self.version_tolerant and yaml_data["location"] == "header":
@@ -538,10 +546,7 @@ class PreProcessPlugin(YamlUpdatePlugin):
                 headers_convert(yaml_data, ETAG_MATCH_DATA)
             elif role == "ifNoneMatch":
                 headers_convert(yaml_data, ETAG_NONE_MATCH_DATA)
-        if (
-            wire_name_lower in ["$host", "content-type", "accept"]
-            and yaml_data["type"]["type"] == "constant"
-        ):
+        if wire_name_lower in ["$host", "content-type", "accept"] and yaml_data["type"]["type"] == "constant":
             yaml_data["clientDefaultValue"] = yaml_data["type"]["value"]
 
     def update_operation(
@@ -551,17 +556,13 @@ class PreProcessPlugin(YamlUpdatePlugin):
         *,
         is_overload: bool = False,
     ) -> None:
-        yaml_data["groupName"] = self.pad_reserved_words(
-            yaml_data["groupName"], PadType.OPERATION_GROUP, yaml_data
-        )
+        yaml_data["groupName"] = self.pad_reserved_words(yaml_data["groupName"], PadType.OPERATION_GROUP, yaml_data)
         yaml_data["groupName"] = to_snake_case(yaml_data["groupName"])
         if yaml_data.get("isExactName", False):
             # exact() client name: keep the operation name as-is without lowercasing,
             # snake-casing, or padding reserved words.
             if yaml_data.get("isLroInitialOperation") is True:
-                yaml_data["name"] = (
-                    "_" + extract_original_name(yaml_data["name"]) + "_initial"
-                )
+                yaml_data["name"] = "_" + extract_original_name(yaml_data["name"]) + "_initial"
         else:
             yaml_data["name"] = yaml_data["name"].lower()
             if yaml_data.get("isLroInitialOperation") is True:
@@ -575,12 +576,8 @@ class PreProcessPlugin(YamlUpdatePlugin):
                     + "_initial"
                 )
             else:
-                yaml_data["name"] = self.pad_reserved_words(
-                    yaml_data["name"], PadType.METHOD, yaml_data
-                )
-        yaml_data["description"] = update_description(
-            yaml_data["description"], yaml_data["name"]
-        )
+                yaml_data["name"] = self.pad_reserved_words(yaml_data["name"], PadType.METHOD, yaml_data)
+        yaml_data["description"] = update_description(yaml_data["description"], yaml_data["name"])
         yaml_data["summary"] = update_description(yaml_data.get("summary", ""))
         body_parameter = yaml_data.get("bodyParameter")
         for parameter in yaml_data["parameters"]:
@@ -601,12 +598,8 @@ class PreProcessPlugin(YamlUpdatePlugin):
     def _update_lro_operation_helper(self, yaml_data: dict[str, Any]) -> None:
         for response in yaml_data.get("responses", []):
             response["discriminator"] = "lro"
-            response["pollerSync"] = (
-                response.get("pollerSync") or "azure.core.polling.LROPoller"
-            )
-            response["pollerAsync"] = (
-                response.get("pollerAsync") or "azure.core.polling.AsyncLROPoller"
-            )
+            response["pollerSync"] = response.get("pollerSync") or "azure.core.polling.LROPoller"
+            response["pollerAsync"] = response.get("pollerAsync") or "azure.core.polling.AsyncLROPoller"
             if not response.get("pollingMethodSync"):
                 response["pollingMethodSync"] = (
                     "azure.mgmt.core.polling.arm_polling.ARMPolling"
@@ -628,9 +621,7 @@ class PreProcessPlugin(YamlUpdatePlugin):
         item_type: Optional[dict[str, Any]] = None,
     ) -> None:
         self.update_lro_operation(code_model, yaml_data, is_overload=is_overload)
-        self.update_paging_operation(
-            code_model, yaml_data, is_overload=is_overload, item_type=item_type
-        )
+        self.update_paging_operation(code_model, yaml_data, is_overload=is_overload, item_type=item_type)
         yaml_data["discriminator"] = "lropaging"
         for response in yaml_data.get("responses", []):
             response["discriminator"] = "lropaging"
@@ -653,16 +644,12 @@ class PreProcessPlugin(YamlUpdatePlugin):
                 response["type"] = KNOWN_TYPES["binary"]
 
         self.update_operation(code_model, yaml_data, is_overload=is_overload)
-        self.update_operation(
-            code_model, yaml_data["initialOperation"], is_overload=is_overload
-        )
+        self.update_operation(code_model, yaml_data["initialOperation"], is_overload=is_overload)
         convert_initial_operation_response_type(yaml_data["initialOperation"])
         self._update_lro_operation_helper(yaml_data)
         for overload in yaml_data.get("overloads", []):
             self._update_lro_operation_helper(overload)
-            self.update_operation(
-                code_model, overload["initialOperation"], is_overload=True
-            )
+            self.update_operation(code_model, overload["initialOperation"], is_overload=True)
             convert_initial_operation_response_type(overload["initialOperation"])
 
     def update_paging_operation(
@@ -680,9 +667,7 @@ class PreProcessPlugin(YamlUpdatePlugin):
                 PadType.OPERATION_GROUP,
                 yaml_data["nextOperation"],
             )
-            yaml_data["nextOperation"]["groupName"] = to_snake_case(
-                yaml_data["nextOperation"]["groupName"]
-            )
+            yaml_data["nextOperation"]["groupName"] = to_snake_case(yaml_data["nextOperation"]["groupName"])
             for response in yaml_data["nextOperation"].get("responses", []):
                 update_paging_response(response)
                 response["itemType"] = item_type
@@ -690,13 +675,9 @@ class PreProcessPlugin(YamlUpdatePlugin):
             update_paging_response(response)
             response["itemType"] = item_type
         for overload in yaml_data.get("overloads", []):
-            self.update_paging_operation(
-                code_model, overload, is_overload=True, item_type=item_type
-            )
+            self.update_paging_operation(code_model, overload, is_overload=True, item_type=item_type)
 
-    def update_operation_groups(
-        self, code_model: dict[str, Any], client: dict[str, Any]
-    ) -> None:
+    def update_operation_groups(self, code_model: dict[str, Any], client: dict[str, Any]) -> None:
         operation_groups_yaml_data = client.get("operationGroups", [])
         for operation_group in operation_groups_yaml_data:
             operation_group["identifyName"] = self.pad_reserved_words(
@@ -704,17 +685,13 @@ class PreProcessPlugin(YamlUpdatePlugin):
                 PadType.OPERATION_GROUP,
                 operation_group,
             )
-            operation_group["identifyName"] = to_snake_case(
-                operation_group["identifyName"]
-            )
+            operation_group["identifyName"] = to_snake_case(operation_group["identifyName"])
             operation_group["propertyName"] = self.pad_reserved_words(
                 operation_group["propertyName"],
                 PadType.OPERATION_GROUP,
                 operation_group,
             )
-            operation_group["propertyName"] = to_snake_case(
-                operation_group["propertyName"]
-            )
+            operation_group["propertyName"] = to_snake_case(operation_group["propertyName"])
             operation_group["className"] = update_operation_group_class_name(
                 client["name"], operation_group["className"]
             )
@@ -738,6 +715,4 @@ class PreProcessPlugin(YamlUpdatePlugin):
 if __name__ == "__main__":
     # TSP pipeline will call this
     args, unknown_args = parse_args()
-    PreProcessPlugin(
-        output_folder=args.output_folder, tsp_file=args.tsp_file, **unknown_args
-    ).process()
+    PreProcessPlugin(output_folder=args.output_folder, tsp_file=args.tsp_file, **unknown_args).process()

package/generator/build/lib/pygen/utils.py

@@ -22,20 +22,13 @@ def description_ends_with_code_block(description: str) -> bool:
     block runs to the end of the description.
     """
     lines = description.rstrip().splitlines()
-    directives = [
-        i for i, line in enumerate(lines) if line.lstrip().startswith(CODE_BLOCK_MARKER)
-    ]
+    directives = [i for i, line in enumerate(lines) if line.lstrip().startswith(CODE_BLOCK_MARKER)]
     if not directives:
         return False
-    return all(
-        not line.strip() or line.startswith((" ", "\t"))
-        for line in lines[directives[-1] + 1 :]
-    )
+    return all(not line.strip() or line.startswith((" ", "\t")) for line in lines[directives[-1] + 1 :])
 
 
-def update_enum_value(
-    name: str, value: Any, description: str, enum_type: dict[str, Any]
-) -> dict[str, Any]:
+def update_enum_value(name: str, value: Any, description: str, enum_type: dict[str, Any]) -> dict[str, Any]:
     return {
         "name": name,
         "type": "enumvalue",
@@ -62,12 +55,7 @@ def to_snake_case(name: str) -> str:
             and len(name) - next_non_upper_case_char_location > 1
             and name[next_non_upper_case_char_location].isalpha()
         ):
-            return (
-                prefix
-                + match_str[: len(match_str) - 1]
-                + "_"
-                + match_str[len(match_str) - 1]
-            )
+            return prefix + match_str[: len(match_str) - 1] + "_" + match_str[len(match_str) - 1]
 
         return prefix + match_str
 
@@ -114,9 +102,7 @@ def parse_args(
         return value
 
     unknown_args_ret = {
-        ua.strip("--").split("=", maxsplit=1)[0]: _get_value(
-            ua.strip("--").split("=", maxsplit=1)[1]
-        )
+        ua.strip("--").split("=", maxsplit=1)[0]: _get_value(ua.strip("--").split("=", maxsplit=1)[1])
         for ua in unknown_args
     }
     return args, unknown_args_ret
@@ -158,11 +144,7 @@ def build_policies(
             "self._config.user_agent_policy",
             "self._config.proxy_policy",
             "policies.ContentDecodePolicy(**kwargs)",
-            (
-                f"{async_prefix}ARMAutoResourceProviderRegistrationPolicy()"
-                if is_arm
-                else None
-            ),
+            (f"{async_prefix}ARMAutoResourceProviderRegistrationPolicy()" if is_arm else None),
             "self._config.redirect_policy",
             "self._config.retry_policy",
             "self._config.authentication_policy",

package/generator/pygen/__init__.py

@@ -168,10 +168,10 @@ class OptionsDict(MutableMapping):
         if key == "models-mode" and value == "none":
             value = False  # switch to falsy value for easier code writing
 
-        if key == "models-mode" and value not in ["msrest", "dpg", False]:
+        if key == "models-mode" and value not in ["msrest", "dpg", "typeddict", False]:
             raise ValueError(
-                "--models-mode can only be 'msrest', 'dpg' or 'none'. "
-                "Pass in 'msrest' if you want msrest models, or "
+                "--models-mode can only be 'msrest', 'dpg', 'typeddict', or 'none'. "
+                "Pass in 'msrest' if you want msrest models, 'typeddict' for TypedDict models, or "
                 "'none' if you don't want any."
             )
         if key == "package-mode":

package/generator/pygen/codegen/models/__init__.py

@@ -9,7 +9,7 @@ from .base import BaseModel
 from .base_builder import BaseBuilder, ParameterListType
 from .code_model import CodeModel
 from .client import Client
-from .model_type import ModelType, JSONModelType, DPGModelType, MsrestModelType
+from .model_type import ModelType, JSONModelType, DPGModelType, MsrestModelType, TypedDictModelType
 from .dictionary_type import DictionaryType
 from .list_type import ListType
 from .combined_type import CombinedType
@@ -167,7 +167,9 @@ def build_type(yaml_data: dict[str, Any], code_model: CodeModel) -> BaseType:
     response: Optional[BaseType] = None
     if yaml_data["type"] == "model":
         # need to special case model to avoid recursion
-        if yaml_data["base"] == "json" or not code_model.options["models-mode"]:
+        if yaml_data["base"] == "typeddict":
+            model_type = TypedDictModelType  # type: ignore
+        elif yaml_data["base"] == "json" or not code_model.options["models-mode"]:
             model_type = JSONModelType
         elif yaml_data["base"] == "dpg":
             model_type = DPGModelType  # type: ignore