diff --git a/.chronus/changes/python-addTypedDict-2026-3-21-17-47-3.md b/.chronus/changes/python-addTypedDict-2026-3-21-17-47-3.md new file mode 100644 index 00000000000..c629da91ce2 --- /dev/null +++ b/.chronus/changes/python-addTypedDict-2026-3-21-17-47-3.md @@ -0,0 +1,8 @@ +--- +# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking +changeKind: feature +packages: + - "@typespec/http-client-python" +--- + +[python] Always generate `TypedDict` typing hints for input models in the `_types.py` file diff --git a/packages/http-client-python/eng/scripts/ci/regenerate.ts b/packages/http-client-python/eng/scripts/ci/regenerate.ts index a65230db578..bf6a8457b74 100644 --- a/packages/http-client-python/eng/scripts/ci/regenerate.ts +++ b/packages/http-client-python/eng/scripts/ci/regenerate.ts @@ -307,10 +307,18 @@ const EMITTER_OPTIONS: Record | Record Any: 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": @@ -181,6 +181,8 @@ def _validate_and_transform(self, key: str, value: Any) -> Any: raise ValueError( f"--package-mode can only be {' or '.join(TYPESPEC_PACKAGE_MODE)} or directory which contains template files" # pylint: disable=line-too-long ) + if key == "typed-dict-only-models" and isinstance(value, str): + value = [v.strip() for v in value.split(",") if v.strip()] return value def setdefault(self, key: str, default: Any, /) -> Any: # type: ignore # pylint: disable=arguments-differ diff --git a/packages/http-client-python/generator/pygen/codegen/models/code_model.py b/packages/http-client-python/generator/pygen/codegen/models/code_model.py index b6c3b2dda0d..884072a831f 100644 --- a/packages/http-client-python/generator/pygen/codegen/models/code_model.py +++ b/packages/http-client-python/generator/pygen/codegen/models/code_model.py @@ -349,7 +349,7 @@ def model_types(self, val: list[ModelType]) -> None: @staticmethod def get_public_model_types(models: list[ModelType]) -> list[ModelType]: - return [m for m in models if not m.internal and not m.base == "json"] + return [m for m in models if not m.internal and not m.base == "json" and not m.is_typed_dict_only] @property def public_model_types(self) -> list[ModelType]: diff --git a/packages/http-client-python/generator/pygen/codegen/models/combined_type.py b/packages/http-client-python/generator/pygen/codegen/models/combined_type.py index 249b7474dcd..1014482f5e0 100644 --- a/packages/http-client-python/generator/pygen/codegen/models/combined_type.py +++ b/packages/http-client-python/generator/pygen/codegen/models/combined_type.py @@ -66,7 +66,7 @@ def docstring_type(self, **kwargs: Any) -> str: def type_annotation(self, **kwargs: Any) -> str: if self.name: - return f'"_types.{self.name}"' + return f'"_unions.{self.name}"' return self.type_definition(**kwargs) def type_definition(self, **kwargs: Any) -> str: @@ -116,10 +116,10 @@ def imports(self, **kwargs: Any) -> FileImport: file_import = FileImport(self.code_model) serialize_namespace = kwargs.get("serialize_namespace", self.code_model.namespace) serialize_namespace_type = kwargs.get("serialize_namespace_type") - if self.name and serialize_namespace_type != NamespaceType.TYPES_FILE: + if self.name and serialize_namespace_type != NamespaceType.UNIONS_FILE: file_import.add_submodule_import( self.code_model.get_relative_import_path(serialize_namespace), - "_types", + "_unions", ImportType.LOCAL, TypingSection.TYPING, ) diff --git a/packages/http-client-python/generator/pygen/codegen/models/enum_type.py b/packages/http-client-python/generator/pygen/codegen/models/enum_type.py index 9cbec3d1b30..671a8c64d5b 100644 --- a/packages/http-client-python/generator/pygen/codegen/models/enum_type.py +++ b/packages/http-client-python/generator/pygen/codegen/models/enum_type.py @@ -255,7 +255,7 @@ def imports(self, **kwargs: Any) -> FileImport: alias=alias, typing_section=TypingSection.REGULAR, ) - elif serialize_namespace_type == NamespaceType.TYPES_FILE or ( + elif serialize_namespace_type in [NamespaceType.TYPES_FILE, NamespaceType.UNIONS_FILE] or ( serialize_namespace_type == NamespaceType.MODEL and called_by_property ): file_import.add_submodule_import( diff --git a/packages/http-client-python/generator/pygen/codegen/models/model_type.py b/packages/http-client-python/generator/pygen/codegen/models/model_type.py index 76ef6e8be8d..803bcade644 100644 --- a/packages/http-client-python/generator/pygen/codegen/models/model_type.py +++ b/packages/http-client-python/generator/pygen/codegen/models/model_type.py @@ -77,6 +77,9 @@ def __init__( self.cross_language_definition_id: Optional[str] = self.yaml_data.get("crossLanguageDefinitionId") self.usage: int = self.yaml_data.get("usage", UsageFlags.Input.value | UsageFlags.Output.value) self.client_namespace: str = self.yaml_data.get("clientNamespace", code_model.namespace) + self.is_typed_dict_only: bool = self.yaml_data.get( + "typedDictOnly", False + ) or self.name in code_model.options.get("typed-dict-only-models", []) @property def is_usage_output(self) -> bool: @@ -305,7 +308,7 @@ def imports(self, **kwargs: Any) -> FileImport: alias = self.code_model.get_unique_models_alias(serialize_namespace, self.client_namespace) serialize_namespace_type = kwargs.get("serialize_namespace_type") called_by_property = kwargs.get("called_by_property", False) - # add import for models in operations or _types file + # add import for models in operations, types, or unions file if serialize_namespace_type in [NamespaceType.OPERATION, NamespaceType.CLIENT]: file_import.add_submodule_import( relative_path, @@ -320,7 +323,7 @@ def imports(self, **kwargs: Any) -> FileImport: ImportType.LOCAL, alias="_Model", ) - elif serialize_namespace_type == NamespaceType.TYPES_FILE or ( + elif serialize_namespace_type in [NamespaceType.TYPES_FILE, NamespaceType.UNIONS_FILE] or ( serialize_namespace_type == NamespaceType.MODEL and called_by_property ): file_import.add_submodule_import( @@ -352,6 +355,22 @@ def imports(self, **kwargs: Any) -> FileImport: class DPGModelType(GeneratedModelType): base = "dpg" + def type_annotation(self, **kwargs: Any) -> str: + if self.is_typed_dict_only: + is_operation_file = kwargs.pop("is_operation_file", False) + skip_quote = kwargs.get("skip_quote", False) + retval = f"types.{self.name}" + return retval if is_operation_file or skip_quote else f'"{retval}"' + return super().type_annotation(**kwargs) + + def docstring_type(self, **kwargs: Any) -> str: + if self.is_typed_dict_only: + client_namespace = self.client_namespace + if self.code_model.options.get("generation-subdir"): + client_namespace += f".{self.code_model.options['generation-subdir']}" + return f"~{client_namespace}.types.{self.name}" + return super().docstring_type(**kwargs) + def serialization_type(self, **kwargs: Any) -> str: return ( self.type_annotation(skip_quote=True, **kwargs) @@ -364,7 +383,48 @@ def instance_check_template(self) -> str: return "isinstance({}, " + f"_models.{self.name})" def imports(self, **kwargs: Any) -> FileImport: + if self.is_typed_dict_only: + file_import = FileImport(self.code_model) + serialize_namespace_type = kwargs.get("serialize_namespace_type") + serialize_namespace = kwargs.get("serialize_namespace", self.code_model.namespace) + relative_path = self.code_model.get_relative_import_path(serialize_namespace, self.client_namespace) + if serialize_namespace_type in [NamespaceType.OPERATION, NamespaceType.CLIENT]: + file_import.add_submodule_import( + relative_path, + "types", + ImportType.LOCAL, + ) + elif serialize_namespace_type in [NamespaceType.TYPES_FILE, NamespaceType.UNIONS_FILE] or ( + serialize_namespace_type == NamespaceType.MODEL and kwargs.get("called_by_property", False) + ): + file_import.add_submodule_import( + relative_path, + "types", + ImportType.LOCAL, + typing_section=TypingSection.TYPING, + ) + return file_import file_import = super().imports(**kwargs) if self.flattened_property: file_import.add_submodule_import("typing", "Any", ImportType.STDLIB) return file_import + + +class TypedDictModelType(DPGModelType): + base = "typeddict" + + def type_annotation(self, **kwargs: Any) -> str: + kwargs.pop("is_response", None) + return super().type_annotation(**kwargs) + + def docstring_type(self, **kwargs: Any) -> str: + kwargs.pop("is_response", None) + return super().docstring_type(**kwargs) + + def docstring_text(self, **kwargs: Any) -> str: + kwargs.pop("is_response", None) + return super().docstring_text(**kwargs) + + def imports(self, **kwargs: Any) -> FileImport: + kwargs.pop("is_response", None) + return super().imports(**kwargs) diff --git a/packages/http-client-python/generator/pygen/codegen/models/parameter.py b/packages/http-client-python/generator/pygen/codegen/models/parameter.py index 5abf03a5e73..6dbb81f9c95 100644 --- a/packages/http-client-python/generator/pygen/codegen/models/parameter.py +++ b/packages/http-client-python/generator/pygen/codegen/models/parameter.py @@ -179,7 +179,7 @@ def imports(self, async_mode: bool, **kwargs: Any) -> FileImport: if isinstance(self.type, CombinedType) and self.type.name: file_import.add_submodule_import( self.code_model.get_relative_import_path(serialize_namespace), - "_types", + "_unions", ImportType.LOCAL, TypingSection.TYPING, ) diff --git a/packages/http-client-python/generator/pygen/codegen/models/response.py b/packages/http-client-python/generator/pygen/codegen/models/response.py index d93d46bd897..a2bb431c44d 100644 --- a/packages/http-client-python/generator/pygen/codegen/models/response.py +++ b/packages/http-client-python/generator/pygen/codegen/models/response.py @@ -95,6 +95,7 @@ def serialization_type(self, **kwargs: Any) -> str: def type_annotation(self, **kwargs: Any) -> str: if self.type: kwargs["is_operation_file"] = True + kwargs["is_response"] = True type_annotation = self.type.type_annotation(**kwargs) if self.nullable: return f"Optional[{type_annotation}]" @@ -102,11 +103,13 @@ def type_annotation(self, **kwargs: Any) -> str: return "None" def docstring_text(self, **kwargs: Any) -> str: + kwargs["is_response"] = True if self.nullable and self.type: return f"{self.type.docstring_text(**kwargs)} or None" return self.type.docstring_text(**kwargs) if self.type else "None" def docstring_type(self, **kwargs: Any) -> str: + kwargs["is_response"] = True if self.nullable and self.type: return f"{self.type.docstring_type(**kwargs)} or None" return self.type.docstring_type(**kwargs) if self.type else "None" @@ -121,7 +124,7 @@ def imports(self, **kwargs: Any) -> FileImport: serialize_namespace = kwargs.get("serialize_namespace", self.code_model.namespace) file_import.add_submodule_import( self.code_model.get_relative_import_path(serialize_namespace), - "_types", + "_unions", ImportType.LOCAL, TypingSection.TYPING, ) diff --git a/packages/http-client-python/generator/pygen/codegen/models/utils.py b/packages/http-client-python/generator/pygen/codegen/models/utils.py index 82e80b85577..b6722fcd3f0 100644 --- a/packages/http-client-python/generator/pygen/codegen/models/utils.py +++ b/packages/http-client-python/generator/pygen/codegen/models/utils.py @@ -30,6 +30,7 @@ class NamespaceType(str, Enum): OPERATION = "operation" CLIENT = "client" TYPES_FILE = "types_file" + UNIONS_FILE = "unions_file" LOCALS_LENGTH_LIMIT = 25 diff --git a/packages/http-client-python/generator/pygen/codegen/serializers/__init__.py b/packages/http-client-python/generator/pygen/codegen/serializers/__init__.py index b949242ba54..b131b8d1622 100644 --- a/packages/http-client-python/generator/pygen/codegen/serializers/__init__.py +++ b/packages/http-client-python/generator/pygen/codegen/serializers/__init__.py @@ -33,6 +33,7 @@ from .sample_serializer import SampleSerializer from .test_serializer import TestSerializer, TestGeneralSerializer from .types_serializer import TypesSerializer +from .unions_serializer import UnionsSerializer from ...utils import to_snake_case, VALID_PACKAGE_MODE from .utils import extract_sample_name, get_namespace_from_package_name, get_namespace_config, hash_file_import @@ -200,7 +201,7 @@ def serialize(self) -> None: general_serializer.serialize_pkgutil_init_file(), ) - # _utils/py.typed/_types.py/_validation.py + # _utils/py.typed/_unions.py/types.py/_validation.py # is always put in top level namespace if self.code_model.is_top_namespace(client_namespace): self._serialize_and_write_top_level_folder(env=env, namespace=client_namespace) @@ -298,11 +299,19 @@ def _serialize_and_write_models_folder( ) -> None: # Write the models folder models_path = self.code_model.get_generation_dir(namespace) / "models" - serializer = DpgModelSerializer if self.code_model.options["models-mode"] == "dpg" else MsrestModelSerializer - if self.code_model.has_non_json_models(models): + models_mode = self.code_model.options["models-mode"] + if models_mode in ("dpg", "typeddict"): + serializer = DpgModelSerializer + else: + serializer = MsrestModelSerializer + # Filter out typed-dict-only models — they only appear in types.py, not as model classes + class_models = [m for m in models if not m.is_typed_dict_only] + if self.code_model.has_non_json_models(class_models): self.write_file( models_path / Path(f"{self.code_model.models_filename}.py"), - serializer(code_model=self.code_model, env=env, client_namespace=namespace, models=models).serialize(), + serializer( + code_model=self.code_model, env=env, client_namespace=namespace, models=class_models + ).serialize(), ) if enums: self.write_file( @@ -313,7 +322,7 @@ def _serialize_and_write_models_folder( ) self.write_file( models_path / Path("__init__.py"), - ModelInitSerializer(code_model=self.code_model, env=env, models=models, enums=enums).serialize(), + ModelInitSerializer(code_model=self.code_model, env=env, models=class_models, enums=enums).serialize(), ) self._keep_patch_file(models_path / Path("_patch.py"), env) @@ -519,11 +528,29 @@ def _serialize_and_write_top_level_folder(self, env: Environment, namespace: str general_serializer.serialize_validation_file(), ) - # write _types.py - if self.code_model.named_unions: + # write _unions.py + has_discriminated_bases = any( + m for m in self.code_model.model_types if m.base != "json" and m.discriminated_subtypes + ) + if self.code_model.named_unions or has_discriminated_bases: + self.write_file( + generation_dir / Path("_unions.py"), + UnionsSerializer( + code_model=self.code_model, + env=env, + models=self.code_model.model_types, + ).serialize(), + ) + + # write types.py + if self.code_model.model_types: self.write_file( - generation_dir / Path("_types.py"), - TypesSerializer(code_model=self.code_model, env=env).serialize(), + generation_dir / Path("types.py"), + TypesSerializer( + code_model=self.code_model, + env=env, + models=self.code_model.model_types, + ).serialize(), ) # pylint: disable=line-too-long diff --git a/packages/http-client-python/generator/pygen/codegen/serializers/builder_serializer.py b/packages/http-client-python/generator/pygen/codegen/serializers/builder_serializer.py index e43dcd916eb..3f60558523f 100644 --- a/packages/http-client-python/generator/pygen/codegen/serializers/builder_serializer.py +++ b/packages/http-client-python/generator/pygen/codegen/serializers/builder_serializer.py @@ -1000,6 +1000,12 @@ def response_deserialization( # pylint: disable=too-many-statements elif self.code_model.options["models-mode"] == "dpg": if builder.has_stream_response: deserialize_code.append("deserialized = response.content") + elif isinstance(response.type, ModelType) and response.type.is_typed_dict_only: + # Typed-dict-only models skip deserialization — return raw JSON + deserialize_code.append("if response.content:") + deserialize_code.append(" deserialized = response.json()") + deserialize_code.append("else:") + deserialize_code.append(" deserialized = None") else: format_filed = ( f', format="{response.type.encode}"' @@ -1429,18 +1435,23 @@ def _extract_data_callback( # pylint: disable=too-many-statements,too-many-bran ) pylint_disable = "" if self.code_model.options["models-mode"] == "dpg": - item_type = builder.item_type.type_annotation( - is_operation_file=True, serialize_namespace=self.serialize_namespace - ) - pylint_disable = ( - " # pylint: disable=protected-access" if getattr(builder.item_type, "internal", False) else "" - ) - list_of_elem_deserialized = [ - "_deserialize(", - f"{item_type},{pylint_disable}", - f"deserialized{access},", - ")", - ] + is_item_typed_dict_only = isinstance(builder.item_type, ModelType) and builder.item_type.is_typed_dict_only + if is_item_typed_dict_only: + # Typed-dict-only models skip deserialization — return raw JSON items + list_of_elem_deserialized = [f"deserialized{access}"] + else: + item_type = builder.item_type.type_annotation( + is_operation_file=True, serialize_namespace=self.serialize_namespace + ) + pylint_disable = ( + " # pylint: disable=protected-access" if getattr(builder.item_type, "internal", False) else "" + ) + list_of_elem_deserialized = [ + "_deserialize(", + f"{item_type},{pylint_disable}", + f"deserialized{access},", + ")", + ] else: list_of_elem_deserialized = [f"deserialized{access}"] list_of_elem_deserialized_str = "\n ".join(list_of_elem_deserialized) diff --git a/packages/http-client-python/generator/pygen/codegen/serializers/model_serializer.py b/packages/http-client-python/generator/pygen/codegen/serializers/model_serializer.py index d428a113e5e..27d4451ae2f 100644 --- a/packages/http-client-python/generator/pygen/codegen/serializers/model_serializer.py +++ b/packages/http-client-python/generator/pygen/codegen/serializers/model_serializer.py @@ -382,3 +382,120 @@ def global_pylint_disables(self) -> str: if final_result: return "# pylint: disable=" + ", ".join(final_result) return "" + + +class TypedDictModelSerializer(_ModelSerializer): + def _is_parent_discriminated_base(self, model: ModelType) -> bool: + """Check if any parent of this model is a discriminated base (has discriminated_subtypes).""" + return any(p.discriminated_subtypes for p in model.parents) + + def _reorder_models(self, models: list[ModelType]) -> list[ModelType]: + """Reorder so discriminated base Union aliases come after all their subtypes.""" + bases = [m for m in models if m.discriminated_subtypes] + non_bases = [m for m in models if not m.discriminated_subtypes] + return non_bases + bases + + def serialize(self) -> str: + template = self.env.get_template("model_container.py.jinja2") + return template.render( + code_model=self.code_model, + imports=FileImportSerializer(self.imports()), + str=str, + serializer=self, + models=self._reorder_models(self.models), + ) + + def imports(self) -> FileImport: + file_import = FileImport(self.code_model) + has_required = False + has_discriminated_union = False + for model in self.models: + if model.base == "json": + continue + if model.discriminated_subtypes: + has_discriminated_union = True + file_import.merge( + model.imports( + is_operation_file=False, + serialize_namespace=self.serialize_namespace, + serialize_namespace_type=NamespaceType.MODEL, + ) + ) + for prop in model.properties: + file_import.merge( + prop.imports( + serialize_namespace=self.serialize_namespace, + serialize_namespace_type=NamespaceType.MODEL, + called_by_property=True, + ) + ) + if not (prop.optional or prop.client_default_value is not None): + has_required = True + for parent in model.parents: + if parent.client_namespace != model.client_namespace and not parent.discriminated_subtypes: + file_import.add_submodule_import( + self.code_model.get_relative_import_path( + self.serialize_namespace, + self.code_model.get_imported_namespace_for_model(parent.client_namespace), + ), + parent.name, + ImportType.LOCAL, + ) + file_import.add_submodule_import("typing_extensions", "TypedDict", ImportType.STDLIB) + if has_required: + file_import.add_submodule_import("typing_extensions", "Required", ImportType.STDLIB) + if has_discriminated_union: + file_import.add_submodule_import("typing", "Union", ImportType.STDLIB) + return file_import + + def declare_model(self, model: ModelType) -> str: + # If the model's parent is a discriminated base, don't inherit from it + non_discriminated_parents = [p for p in model.parents if not p.discriminated_subtypes] + if non_discriminated_parents: + basename = ", ".join([m.name for m in non_discriminated_parents]) + return f"class {model.name}({basename}):{model.pylint_disable()}" + return f"class {model.name}(TypedDict, total=False):{model.pylint_disable()}" + + @staticmethod + def get_properties_to_declare(model: ModelType) -> list[Property]: + # Only exclude inherited properties from non-discriminated parents + non_discriminated_parents = [p for p in model.parents if not p.discriminated_subtypes] + if non_discriminated_parents: + parent_properties = [p for bm in non_discriminated_parents for p in bm.properties] + properties_to_declare = [ + p + for p in model.properties + if not any( + p.client_name == pp.client_name + and p.type_annotation() == pp.type_annotation() + and not p.is_base_discriminator + for pp in parent_properties + ) + ] + else: + properties_to_declare = model.properties + return properties_to_declare + + def declare_property(self, prop: Property) -> str: + type_annotation = prop.type_annotation(serialize_namespace=self.serialize_namespace) + is_optional = prop.optional or prop.client_default_value is not None + if is_optional: + return f"{prop.wire_name}: {type_annotation}" + return f"{prop.wire_name}: Required[{type_annotation}]" + + def initialize_properties(self, model: ModelType) -> list[str]: + return [] + + def need_init(self, model: ModelType) -> bool: + return False + + def discriminated_subtypes_union(self, model: ModelType) -> str: + subtypes = list(model.discriminated_subtypes.values()) + subtype_names = [s.name for s in subtypes] + return f"{model.name} = Union[{', '.join(subtype_names)}]" + + def is_discriminated_base(self, model: ModelType) -> bool: + return bool(model.discriminated_subtypes) + + def global_pylint_disables(self) -> str: + return "" diff --git a/packages/http-client-python/generator/pygen/codegen/serializers/types_serializer.py b/packages/http-client-python/generator/pygen/codegen/serializers/types_serializer.py index 749d8ca240c..7fa07f72029 100644 --- a/packages/http-client-python/generator/pygen/codegen/serializers/types_serializer.py +++ b/packages/http-client-python/generator/pygen/codegen/serializers/types_serializer.py @@ -3,34 +3,114 @@ # Licensed under the MIT License. See License.txt in the project root for # license information. # -------------------------------------------------------------------------- +from typing import Optional +from ..models import ModelType, CodeModel from ..models.imports import FileImport, ImportType from ..models.utils import NamespaceType +from ..models.property import Property +from .model_serializer import _documentation_string from .import_serializer import FileImportSerializer from .base_serializer import BaseSerializer class TypesSerializer(BaseSerializer): + def __init__( + self, + code_model: CodeModel, + env, + client_namespace: Optional[str] = None, + models: Optional[list[ModelType]] = None, + ): + super().__init__(code_model=code_model, env=env) + self._client_namespace = client_namespace + self._models = models or [] + + @property + def typeddict_models(self) -> list[ModelType]: + """Models that should be rendered as TypedDicts (excluding discriminated bases which become unions).""" + return [m for m in self._models if m.base != "json" and not m.discriminated_subtypes] + def imports(self) -> FileImport: file_import = FileImport(self.code_model) - if self.code_model.named_unions: - file_import.add_submodule_import( - "typing", - "Union", - ImportType.STDLIB, - ) - for nu in self.code_model.named_unions: - file_import.merge( - nu.imports( - serialize_namespace=self.serialize_namespace, serialize_namespace_type=NamespaceType.TYPES_FILE + + td_models = self.typeddict_models + if td_models: + file_import.add_submodule_import("typing_extensions", "TypedDict", ImportType.STDLIB) + has_required = False + for model in td_models: + file_import.merge( + model.imports( + is_operation_file=False, + serialize_namespace=self.serialize_namespace, + serialize_namespace_type=NamespaceType.TYPES_FILE, + ) ) - ) + for prop in model.properties: + file_import.merge( + prop.imports( + serialize_namespace=self.serialize_namespace, + serialize_namespace_type=NamespaceType.TYPES_FILE, + called_by_property=True, + ) + ) + if not (prop.optional or prop.client_default_value is not None): + has_required = True + for parent in model.parents: + if parent.client_namespace != model.client_namespace and not parent.discriminated_subtypes: + file_import.add_submodule_import( + self.code_model.get_relative_import_path( + self.serialize_namespace, + self.code_model.get_imported_namespace_for_model(parent.client_namespace), + ), + parent.name, + ImportType.LOCAL, + ) + if has_required: + file_import.add_submodule_import("typing_extensions", "Required", ImportType.STDLIB) return file_import + def declare_model(self, model: ModelType) -> str: + non_discriminated_parents = [p for p in model.parents if not p.discriminated_subtypes] + if non_discriminated_parents: + basename = ", ".join([m.name for m in non_discriminated_parents]) + return f"class {model.name}({basename}):{model.pylint_disable()}" + return f"class {model.name}(TypedDict, total=False):{model.pylint_disable()}" + + @staticmethod + def get_properties_to_declare(model: ModelType) -> list[Property]: + non_discriminated_parents = [p for p in model.parents if not p.discriminated_subtypes] + if non_discriminated_parents: + parent_properties = [p for bm in non_discriminated_parents for p in bm.properties] + properties_to_declare = [ + p + for p in model.properties + if not any( + p.client_name == pp.client_name + and p.type_annotation() == pp.type_annotation() + and not p.is_base_discriminator + for pp in parent_properties + ) + ] + else: + properties_to_declare = model.properties + return properties_to_declare + + def declare_property(self, prop: Property) -> str: + type_annotation = prop.type_annotation(serialize_namespace=self.serialize_namespace) + is_optional = prop.optional or prop.client_default_value is not None + if is_optional: + return f"{prop.wire_name}: {type_annotation}" + return f"{prop.wire_name}: Required[{type_annotation}]" + + @staticmethod + def variable_documentation_string(prop: Property) -> list[str]: + return _documentation_string(prop, "ivar", "vartype") + def serialize(self) -> str: - # Generate the models template = self.env.get_template("types.py.jinja2") return template.render( code_model=self.code_model, imports=FileImportSerializer(self.imports()), serializer=self, + models=self.typeddict_models, ) diff --git a/packages/http-client-python/generator/pygen/codegen/serializers/unions_serializer.py b/packages/http-client-python/generator/pygen/codegen/serializers/unions_serializer.py new file mode 100644 index 00000000000..66a61503aa4 --- /dev/null +++ b/packages/http-client-python/generator/pygen/codegen/serializers/unions_serializer.py @@ -0,0 +1,68 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +from typing import Optional + +from ..models import CodeModel, ModelType +from ..models.imports import FileImport, ImportType +from ..models.utils import NamespaceType +from .import_serializer import FileImportSerializer +from .base_serializer import BaseSerializer + + +class UnionsSerializer(BaseSerializer): + def __init__( + self, + code_model: CodeModel, + env, + models: Optional[list[ModelType]] = None, + ): + super().__init__(code_model=code_model, env=env) + self._models = models or [] + + @property + def discriminated_base_models(self) -> list[ModelType]: + """Models that are discriminated bases, rendered as Union aliases.""" + return [m for m in self._models if m.base != "json" and m.discriminated_subtypes] + + def imports(self) -> FileImport: + file_import = FileImport(self.code_model) + has_unions = bool(self.code_model.named_unions) or bool(self.discriminated_base_models) + if has_unions: + file_import.add_submodule_import( + "typing", + "Union", + ImportType.STDLIB, + ) + for nu in self.code_model.named_unions: + file_import.merge( + nu.imports( + serialize_namespace=self.serialize_namespace, + serialize_namespace_type=NamespaceType.UNIONS_FILE, + ) + ) + for model in self.discriminated_base_models: + for subtype in model.discriminated_subtypes.values(): + file_import.merge( + subtype.imports( + serialize_namespace=self.serialize_namespace, + serialize_namespace_type=NamespaceType.UNIONS_FILE, + ) + ) + return file_import + + def discriminated_subtypes_union(self, model: ModelType) -> str: + subtypes = list(model.discriminated_subtypes.values()) + subtype_names = [s.type_annotation(skip_quote=True) for s in subtypes] + return f"{model.name} = Union[{', '.join(subtype_names)}]" + + def serialize(self) -> str: + template = self.env.get_template("unions.py.jinja2") + return template.render( + code_model=self.code_model, + imports=FileImportSerializer(self.imports()), + serializer=self, + discriminated_bases=self.discriminated_base_models, + ) diff --git a/packages/http-client-python/generator/pygen/codegen/templates/model_container.py.jinja2 b/packages/http-client-python/generator/pygen/codegen/templates/model_container.py.jinja2 index dc98f999c45..d91228cbdd8 100644 --- a/packages/http-client-python/generator/pygen/codegen/templates/model_container.py.jinja2 +++ b/packages/http-client-python/generator/pygen/codegen/templates/model_container.py.jinja2 @@ -9,7 +9,7 @@ {{ imports }} {% for model in models %} -{% if model.base == "dpg" %} +{% if model.base == "dpg" or model.base == "typeddict" %} {% include "model_dpg.py.jinja2" %} {% elif model.base == "msrest" %} {% include "model_msrest.py.jinja2" %} diff --git a/packages/http-client-python/generator/pygen/codegen/templates/model_typeddict.py.jinja2 b/packages/http-client-python/generator/pygen/codegen/templates/model_typeddict.py.jinja2 new file mode 100644 index 00000000000..8176626fe3f --- /dev/null +++ b/packages/http-client-python/generator/pygen/codegen/templates/model_typeddict.py.jinja2 @@ -0,0 +1,28 @@ +{# actual template starts here #} +{% import "macros.jinja2" as macros %} + +{% if serializer.is_discriminated_base(model) %} +{{ serializer.discriminated_subtypes_union(model) }} +{% else %} + +{{ serializer.declare_model(model) }} + """{{ op_tools.wrap_string(model.description(is_operation_file=False), "\n ") }} + + {% if model.properties != None %} + {% for p in model.properties %} + {% for line in serializer.variable_documentation_string(p) %} + {{ macros.wrap_model_string(line, '\n ') -}} + {% endfor %} + {% endfor %} + {% endif %} + """ + + {% for p in serializer.get_properties_to_declare(model)%} + {{ serializer.declare_property(p) }} + {% set prop_description = p.description(is_operation_file=False).replace('"', '\\"') %} + {% if prop_description %} + """{{ macros.wrap_model_string(prop_description, '\n ', '\"\"\"') -}} + {% endif %} + {% endfor %} +{% endif %} + diff --git a/packages/http-client-python/generator/pygen/codegen/templates/types.py.jinja2 b/packages/http-client-python/generator/pygen/codegen/templates/types.py.jinja2 index 19435f14e88..8ff3e618aca 100644 --- a/packages/http-client-python/generator/pygen/codegen/templates/types.py.jinja2 +++ b/packages/http-client-python/generator/pygen/codegen/templates/types.py.jinja2 @@ -4,6 +4,28 @@ {% endif %} {{ imports }} -{% for nu in code_model.named_unions %} -{{nu.name}} = {{nu.type_definition()}} +{% import 'operation_tools.jinja2' as op_tools %} +{% import "macros.jinja2" as macros %} +{% for model in models %} + + +{{ serializer.declare_model(model) }} + """{{ op_tools.wrap_string(model.description(is_operation_file=False), "\n ") }} + + {% if model.properties != None %} + {% for p in model.properties %} + {% for line in serializer.variable_documentation_string(p) %} + {{ macros.wrap_model_string(line, '\n ') -}} + {% endfor %} + {% endfor %} + {% endif %} + """ + + {% for p in serializer.get_properties_to_declare(model)%} + {{ serializer.declare_property(p) }} + {% set prop_description = p.description(is_operation_file=False).replace('"', '\\"') %} + {% if prop_description %} + """{{ macros.wrap_model_string(prop_description, '\n ', '\"\"\"') -}} + {% endif %} + {% endfor %} {% endfor %} diff --git a/packages/http-client-python/generator/pygen/codegen/templates/unions.py.jinja2 b/packages/http-client-python/generator/pygen/codegen/templates/unions.py.jinja2 new file mode 100644 index 00000000000..e57874df349 --- /dev/null +++ b/packages/http-client-python/generator/pygen/codegen/templates/unions.py.jinja2 @@ -0,0 +1,12 @@ +# coding=utf-8 +{% if code_model.license_header %} +{{ code_model.license_header }} +{% endif %} + +{{ imports }} +{% for nu in code_model.named_unions %} +{{nu.name}} = {{nu.type_definition()}} +{% endfor %} +{% for model in discriminated_bases %} +{{ serializer.discriminated_subtypes_union(model) }} +{% endfor %} diff --git a/packages/http-client-python/tests/mock_api/azure/test_client_naming_typeddict.py b/packages/http-client-python/tests/mock_api/azure/test_client_naming_typeddict.py new file mode 100644 index 00000000000..40786f16e39 --- /dev/null +++ b/packages/http-client-python/tests/mock_api/azure/test_client_naming_typeddict.py @@ -0,0 +1,64 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +import pytest +from client.naming.typeddict import NamingClient, models + + +@pytest.fixture +def client(): + with NamingClient() as client: + yield client + + +def test_client(client: NamingClient): + """TypedDict uses wire name 'defaultName', not client name 'client_name'.""" + client.property.client(models.ClientNameModel(defaultName=True)) + + +def test_language(client: NamingClient): + """TypedDict uses wire name 'defaultName', not language-specific name 'python_name'.""" + client.property.language(models.LanguageClientNameModel(defaultName=True)) + + +def test_compatible_with_encoded_name(client: NamingClient): + """TypedDict uses encoded wire name 'wireName', not client name 'client_name'.""" + client.property.compatible_with_encoded_name( + models.ClientNameAndJsonEncodedNameModel(wireName=True) + ) + + +def test_operation(client: NamingClient): + client.client_name() + + +def test_parameter(client: NamingClient): + client.parameter(client_name="true") + + +def test_header_request(client: NamingClient): + client.header.request(client_name="true") + + +def test_header_response(client: NamingClient): + assert client.header.response(cls=lambda x, y, z: z)["default-name"] == "true" + + +def test_model_client(client: NamingClient): + """TypedDict uses wire name 'defaultName', not client name 'default_name'.""" + client.model_client.client(models.ClientModel(defaultName=True)) + + +def test_model_language(client: NamingClient): + """TypedDict uses wire name 'defaultName', not client name 'default_name'.""" + client.model_client.language(models.PythonModel(defaultName=True)) + + +def test_union_enum_member_name(client: NamingClient): + client.union_enum.union_enum_member_name(models.ExtensibleEnum.CLIENT_ENUM_VALUE1) + + +def test_union_enum_name(client: NamingClient): + client.union_enum.union_enum_name(models.ClientExtensibleEnum.ENUM_VALUE1) diff --git a/packages/http-client-python/tests/mock_api/shared/test_typetest_model_inheritance_not_discriminated_typeddict.py b/packages/http-client-python/tests/mock_api/shared/test_typetest_model_inheritance_not_discriminated_typeddict.py new file mode 100644 index 00000000000..782791ab1e7 --- /dev/null +++ b/packages/http-client-python/tests/mock_api/shared/test_typetest_model_inheritance_not_discriminated_typeddict.py @@ -0,0 +1,37 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +import pytest +from typetest.model.notdiscriminated.typeddict import NotDiscriminatedClient +from typetest.model.notdiscriminated.typeddict.models import Siamese + + +@pytest.fixture +def client(): + with NotDiscriminatedClient() as client: + yield client + + +@pytest.fixture +def valid_body(): + return Siamese(name="abc", age=32, smart=True) + + +def test_get_valid(client, valid_body): + result = client.get_valid() + assert result["name"] == "abc" + assert result["age"] == 32 + assert result["smart"] is True + + +def test_post_valid(client, valid_body): + client.post_valid(valid_body) + + +def test_put_valid(client, valid_body): + result = client.put_valid(valid_body) + assert result["name"] == "abc" + assert result["age"] == 32 + assert result["smart"] is True diff --git a/packages/http-client-python/tests/mock_api/shared/test_typetest_model_inheritance_single_discriminator_typeddict.py b/packages/http-client-python/tests/mock_api/shared/test_typetest_model_inheritance_single_discriminator_typeddict.py new file mode 100644 index 00000000000..19335d1bc69 --- /dev/null +++ b/packages/http-client-python/tests/mock_api/shared/test_typetest_model_inheritance_single_discriminator_typeddict.py @@ -0,0 +1,70 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +import pytest +from typetest.model.singlediscriminator.typeddict import SingleDiscriminatorClient +from typetest.model.singlediscriminator.typeddict.models import Sparrow, Eagle + + +@pytest.fixture +def client(): + with SingleDiscriminatorClient() as client: + yield client + + +@pytest.fixture +def valid_body(): + return Sparrow(wingspan=1, kind="sparrow") + + +def test_get_model(client): + result = client.get_model() + assert result["wingspan"] == 1 + assert result["kind"] == "sparrow" + + +def test_put_model(client, valid_body): + client.put_model(valid_body) + + +@pytest.fixture +def recursive_body(): + return Eagle( + wingspan=5, + kind="eagle", + partner={"wingspan": 2, "kind": "goose"}, + friends=[{"wingspan": 2, "kind": "seagull"}], + hate={"key3": {"wingspan": 1, "kind": "sparrow"}}, + ) + + +def test_get_recursive_model(client): + result = client.get_recursive_model() + assert result["wingspan"] == 5 + assert result["kind"] == "eagle" + assert result["partner"]["kind"] == "goose" + assert result["friends"][0]["kind"] == "seagull" + assert result["hate"]["key3"]["kind"] == "sparrow" + + +def test_put_recursive_model(client, recursive_body): + client.put_recursive_model(recursive_body) + + +def test_get_missing_discriminator(client): + result = client.get_missing_discriminator() + assert result["wingspan"] == 1 + + +def test_get_wrong_discriminator(client): + result = client.get_wrong_discriminator() + assert result["wingspan"] == 1 + assert result["kind"] == "wrongKind" + + +def test_get_legacy_model(client): + result = client.get_legacy_model() + assert result["size"] == 20 + assert result["kind"] == "t-rex" diff --git a/packages/http-client-python/tests/mock_api/shared/test_typetest_model_usage_typeddictonly.py b/packages/http-client-python/tests/mock_api/shared/test_typetest_model_usage_typeddictonly.py new file mode 100644 index 00000000000..586eb7be791 --- /dev/null +++ b/packages/http-client-python/tests/mock_api/shared/test_typetest_model_usage_typeddictonly.py @@ -0,0 +1,44 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +import pytest +from typetest.model.usage.typeddictonly import UsageClient +from typetest.model.usage.typeddictonly.types import InputRecord, OutputRecord, InputOutputRecord + + +@pytest.fixture +def client(): + with UsageClient() as client: + yield client + + +def test_input(client: UsageClient): + # TypedDict-only: pass a plain dict matching the TypedDict schema + result = client.input({"requiredProp": "example-value"}) + assert result is None + + +def test_output(client: UsageClient): + # TypedDict-only: output should be a plain dict (no model deserialization) + output = client.output() + assert isinstance(output, dict) + assert output["requiredProp"] == "example-value" + + +def test_input_and_output(client: UsageClient): + # TypedDict-only: input a dict, get a dict back + result = client.input_and_output({"requiredProp": "example-value"}) + assert isinstance(result, dict) + assert result["requiredProp"] == "example-value" + + +def test_no_model_classes(): + """Verify that typed-dict-only models don't generate model classes.""" + from typetest.model.usage.typeddictonly import models + + # models.__all__ should be empty — no model classes exported + assert models.__all__ == [] + # The TypedDicts should only exist in the types module + assert hasattr(InputRecord, "__required_keys__") or hasattr(InputRecord, "__annotations__") diff --git a/packages/http-client-python/tests/unit/test_typeddict.py b/packages/http-client-python/tests/unit/test_typeddict.py new file mode 100644 index 00000000000..c35db047b0f --- /dev/null +++ b/packages/http-client-python/tests/unit/test_typeddict.py @@ -0,0 +1,246 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +"""Tests for TypedDict generation, unions generation, and models-mode interactions.""" + +from jinja2 import PackageLoader, Environment + +from pygen.codegen.models import CodeModel, JSONModelType, DPGModelType +from pygen.codegen.models.model_type import TypedDictModelType +from pygen.codegen.serializers.types_serializer import TypesSerializer +from pygen.codegen.serializers.unions_serializer import UnionsSerializer + + +def _make_code_model(models_mode="dpg"): + return CodeModel( + { + "clients": [ + { + "name": "client", + "namespace": "blah", + "moduleName": "blah", + "parameters": [], + "url": "", + "operationGroups": [], + } + ], + "namespace": "namespace", + }, + options={ + "show-send-request": True, + "builders-visibility": "public", + "show-operations": True, + "models-mode": models_mode, + "flavor": "unbranded", + "client-side-validation": False, + }, + ) + + +def _make_model(code_model, name, model_cls=None, properties=None): + """Create a model of the given class attached to code_model.""" + if model_cls is None: + if code_model.options["models-mode"] == "typeddict": + model_cls = TypedDictModelType + elif code_model.options["models-mode"] == "dpg": + model_cls = DPGModelType + else: + model_cls = JSONModelType + return model_cls( + yaml_data={ + "name": name, + "type": "model", + "snakeCaseName": name.lower(), + "usage": 2, + }, + code_model=code_model, + properties=properties or [], + ) + + +def _make_env(): + return Environment( + loader=PackageLoader("pygen.codegen", "templates"), + trim_blocks=True, + lstrip_blocks=True, + ) + + +# ---------- models-mode=none ---------- + + +def test_models_mode_none_produces_json_model_type(): + """When models-mode is none (False), all models should be JSONModelType.""" + code_model = _make_code_model(models_mode=False) + model = _make_model(code_model, "Foo", model_cls=JSONModelType) + assert model.base == "json" + + +def test_models_mode_none_no_typeddict_models(): + """TypesSerializer.typeddict_models should be empty when models-mode=none.""" + code_model = _make_code_model(models_mode=False) + m1 = _make_model(code_model, "Foo", model_cls=JSONModelType) + m2 = _make_model(code_model, "Bar", model_cls=JSONModelType) + + env = _make_env() + ts = TypesSerializer(code_model=code_model, env=env, models=[m1, m2]) + assert ts.typeddict_models == [] + + +def test_models_mode_none_types_file_has_no_typeddict_imports(): + """When models-mode=none, the types.py should not import TypedDict.""" + code_model = _make_code_model(models_mode=False) + m1 = _make_model(code_model, "Foo", model_cls=JSONModelType) + code_model.model_types = [m1] + + env = _make_env() + ts = TypesSerializer(code_model=code_model, env=env, models=[m1]) + output = ts.serialize() + assert "TypedDict" not in output + assert "Required" not in output + + +# ---------- models-mode=dpg ---------- + + +def test_models_mode_dpg_no_typeddict_models(): + """DPG models have base='dpg', not 'typeddict', so should not appear as typeddict_models.""" + code_model = _make_code_model(models_mode="dpg") + m1 = _make_model(code_model, "Foo", model_cls=DPGModelType) + + env = _make_env() + ts = TypesSerializer(code_model=code_model, env=env, models=[m1]) + # DPG models have base != "json" so they DO appear in typeddict_models + assert len(ts.typeddict_models) == 1 + + +# ---------- models-mode=typeddict ---------- + + +def test_models_mode_typeddict_models_included(): + """TypedDictModelType models should appear in typeddict_models.""" + code_model = _make_code_model(models_mode="typeddict") + m1 = _make_model(code_model, "Foo", model_cls=TypedDictModelType) + m2 = _make_model(code_model, "Bar", model_cls=TypedDictModelType) + + env = _make_env() + ts = TypesSerializer(code_model=code_model, env=env, models=[m1, m2]) + assert len(ts.typeddict_models) == 2 + + +def test_models_mode_typeddict_serialize_contains_class(): + """Serialized types.py output should contain TypedDict class definitions.""" + code_model = _make_code_model(models_mode="typeddict") + m1 = _make_model(code_model, "Foo", model_cls=TypedDictModelType) + code_model.model_types = [m1] + + env = _make_env() + ts = TypesSerializer(code_model=code_model, env=env, models=[m1]) + output = ts.serialize() + assert "class Foo(TypedDict, total=False):" in output + assert "TypedDict" in output + + +def test_types_file_has_no_named_unions(): + """Serialized types.py should not contain named union definitions.""" + code_model = _make_code_model(models_mode="dpg") + m1 = _make_model(code_model, "Foo", model_cls=DPGModelType) + code_model.model_types = [m1] + + env = _make_env() + ts = TypesSerializer(code_model=code_model, env=env, models=[m1]) + output = ts.serialize() + # Named unions should be in _unions.py, not types.py + assert "named_unions" not in output + + +# ---------- unions serializer ---------- + + +def test_unions_serializer_no_unions(): + """UnionsSerializer with no named unions should produce minimal output.""" + code_model = _make_code_model(models_mode="dpg") + + env = _make_env() + us = UnionsSerializer(code_model=code_model, env=env) + output = us.serialize() + assert "TypedDict" not in output + assert "Union" not in output + + +# ---------- typed-dict-only ---------- + + +def _make_typed_dict_only_model(code_model, name, **extra_yaml): + """Create a TypedDictModelType with typedDictOnly=True.""" + yaml_data = { + "name": name, + "type": "model", + "snakeCaseName": name.lower(), + "usage": 2, + "typedDictOnly": True, + **extra_yaml, + } + return TypedDictModelType( + yaml_data=yaml_data, + code_model=code_model, + properties=[], + ) + + +def test_typed_dict_only_property(): + """is_typed_dict_only should be True when yaml_data has typedDictOnly=True.""" + code_model = _make_code_model(models_mode="typeddict") + model = _make_typed_dict_only_model(code_model, "Foo") + assert model.is_typed_dict_only is True + + normal_model = _make_model(code_model, "Bar", model_cls=TypedDictModelType) + assert normal_model.is_typed_dict_only is False + + +def test_typed_dict_only_excluded_from_public_model_types(): + """Typed-dict-only models should not appear in public_model_types.""" + code_model = _make_code_model(models_mode="typeddict") + normal = _make_model(code_model, "Normal", model_cls=TypedDictModelType) + td_only = _make_typed_dict_only_model(code_model, "TdOnly") + code_model.model_types = [normal, td_only] + + public = code_model.public_model_types + assert normal in public + assert td_only not in public + + +def test_typed_dict_only_still_in_types_file(): + """Typed-dict-only models should still appear in types.py as TypedDicts.""" + code_model = _make_code_model(models_mode="typeddict") + td_only = _make_typed_dict_only_model(code_model, "MyModel") + code_model.model_types = [td_only] + + env = _make_env() + ts = TypesSerializer(code_model=code_model, env=env, models=[td_only]) + output = ts.serialize() + assert "class MyModel(TypedDict, total=False):" in output + + +def test_typed_dict_only_type_annotation(): + """Typed-dict-only models should use types.Name, not _models.Name.""" + code_model = _make_code_model(models_mode="typeddict") + model = _make_typed_dict_only_model(code_model, "Foo") + + # In operation files, should be types.Name + annotation = model.type_annotation(is_operation_file=True) + assert annotation == "types.Foo" + assert "_models" not in annotation + + +def test_typed_dict_only_docstring_type(): + """Typed-dict-only models should reference types module, not models.""" + code_model = _make_code_model(models_mode="typeddict") + model = _make_typed_dict_only_model(code_model, "Foo") + + docstring = model.docstring_type() + assert "types.Foo" in docstring + assert "models.Foo" not in docstring