@azure-tools/typespec-python 0.29.0 → 0.31.0

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

@@ -106,7 +106,7 @@ CredentialPolicyType = TypeVar(
 )
 
 
-class CredentialType(Generic[CredentialPolicyType], BaseType):  # pylint:disable=abstract-method
+class CredentialType(Generic[CredentialPolicyType], BaseType):
     """Store info about the type of the credential. Can be either an KeyCredential or a TokenCredential"""
 
     def __init__(
@@ -118,7 +118,7 @@ class CredentialType(Generic[CredentialPolicyType], BaseType):  # pylint:disable
         super().__init__(yaml_data, code_model)
         self.policy = policy
 
-    def description(self, *, is_operation_file: bool) -> str:  # pylint: disable=unused-argument
+    def description(self, *, is_operation_file: bool) -> str:
         return ""
 
     def get_json_template_representation(
@@ -146,11 +146,7 @@ class CredentialType(Generic[CredentialPolicyType], BaseType):  # pylint:disable
         )
 
 
-class TokenCredentialType(
-    CredentialType[  # pylint: disable=unsubscriptable-object
-        Union[BearerTokenCredentialPolicyType, ARMChallengeAuthenticationPolicyType]
-    ]
-):
+class TokenCredentialType(CredentialType[Union[BearerTokenCredentialPolicyType, ARMChallengeAuthenticationPolicyType]]):
     """Type of a token credential. Used by BearerAuth and ARMChallenge policies"""
 
     def type_annotation(self, **kwargs: Any) -> str:
@@ -194,23 +190,20 @@ class TokenCredentialType(
         return "hasattr({}, 'get_token')"
 
 
-class KeyCredentialType(
-    # pylint: disable=unsubscriptable-object
-    CredentialType[KeyCredentialPolicyType]
-):
+class KeyCredentialType(CredentialType[KeyCredentialPolicyType]):
     """Type for an KeyCredential"""
 
-    def docstring_type(self, **kwargs: Any) -> str:  # pylint: disable=unused-argument
+    def docstring_type(self, **kwargs: Any) -> str:
         return f"~{self.code_model.core_library}.credentials.{self.policy.credential_name}"
 
-    def type_annotation(self, **kwargs: Any) -> str:  # pylint: disable=unused-argument
+    def type_annotation(self, **kwargs: Any) -> str:
         return self.policy.credential_name
 
     @property
     def instance_check_template(self) -> str:
         return "isinstance({}, " + f"{self.policy.credential_name})"
 
-    def imports(self, **kwargs: Any) -> FileImport:  # pylint: disable=unused-argument
+    def imports(self, **kwargs: Any) -> FileImport:
         file_import = super().imports(**kwargs)
         file_import.add_submodule_import(
             "credentials",

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

@@ -137,7 +137,7 @@ class EnumType(BaseType):
         """
         return self.value_type.serialization_type
 
-    def description(self, *, is_operation_file: bool) -> str:  # pylint: disable=unused-argument
+    def description(self, *, is_operation_file: bool) -> str:
         possible_values = [self.get_declaration(v.value) for v in self.values]
         if not possible_values:
             return ""

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

@@ -1,4 +1,3 @@
-# pylint: disable=multiple-statements
 # -------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for

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

@@ -21,7 +21,7 @@ class LROPagingOperation(LROOperationBase[LROPagingResponse], PagingOperationBas
         return "lropaging"
 
     def cls_type_annotation(self, *, async_mode: bool) -> str:
-        return f"ClsType[{Response.type_annotation(self.responses[0], async_mode=async_mode)}]"  # pylint: disable=no-member
+        return f"ClsType[{Response.type_annotation(self.responses[0], async_mode=async_mode)}]"
 
     def imports(self, async_mode: bool, **kwargs: Any) -> FileImport:
         lro_imports = LROOperationBase.imports(self, async_mode, **kwargs)

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

@@ -17,9 +17,9 @@ from .property import Property
 from .imports import FileImport, ImportType, TypingSection
 
 if sys.version_info >= (3, 8):
-    from typing import Literal  # pylint: disable=no-name-in-module, ungrouped-imports
+    from typing import Literal
 else:
-    from typing_extensions import Literal  # type: ignore  # pylint: disable=ungrouped-imports
+    from typing_extensions import Literal  # type: ignore
 
 if TYPE_CHECKING:
     from .code_model import CodeModel
@@ -50,9 +50,7 @@ def _get_properties(type: "ModelType", properties: List[Property]) -> List[Prope
     return properties
 
 
-class ModelType(  # pylint: disable=abstract-method
-    BaseType
-):  # pylint: disable=too-many-instance-attributes, too-many-public-methods
+class ModelType(BaseType):  # pylint: disable=too-many-instance-attributes, too-many-public-methods
     """Represents a class ready to be serialized in Python.
 
     :param str name: The name of the class.
@@ -89,7 +87,7 @@ class ModelType(  # pylint: disable=abstract-method
 
     @property
     def is_usage_output(self) -> bool:
-        return self.usage & UsageFlags.Output.value
+        return bool(self.usage & UsageFlags.Output.value)
 
     @property
     def flattened_property(self) -> Optional[Property]:
@@ -284,7 +282,7 @@ class JSONModelType(ModelType):
         return file_import
 
 
-class GeneratedModelType(ModelType):  # pylint: disable=abstract-method
+class GeneratedModelType(ModelType):
     def type_annotation(self, **kwargs: Any) -> str:
         is_operation_file = kwargs.pop("is_operation_file", False)
         skip_quote = kwargs.get("skip_quote", False)

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

@@ -38,6 +38,7 @@ from .parameter_list import ParameterList
 from .model_type import ModelType
 from .base import BaseType
 from .request_builder import OverloadedRequestBuilder, RequestBuilder
+from ...utils import xml_serializable, json_serializable
 
 if TYPE_CHECKING:
     from .code_model import CodeModel
@@ -422,14 +423,24 @@ class OperationBase(  # pylint: disable=too-many-public-methods,too-many-instanc
             if self.parameters.has_body:
                 if self.has_form_data_body:
                     file_import.add_submodule_import(relative_path, "_model_base", ImportType.LOCAL)
-                else:
+                elif xml_serializable(self.parameters.body_parameter.default_content_type):
+                    file_import.add_submodule_import(
+                        f"{relative_path}_model_base",
+                        "_get_element",
+                        ImportType.LOCAL,
+                    )
+                elif json_serializable(self.parameters.body_parameter.default_content_type):
                     file_import.add_submodule_import(
                         f"{relative_path}_model_base",
                         "SdkJSONEncoder",
                         ImportType.LOCAL,
                     )
                     file_import.add_import("json", ImportType.STDLIB)
-            if (self.default_error_deserialization or any(r.type for r in self.responses)) or self.non_default_errors:
+            if any(xml_serializable(str(r.default_content_type)) for r in self.responses):
+                file_import.add_submodule_import(f"{relative_path}_model_base", "_deserialize_xml", ImportType.LOCAL)
+            elif any(r.type for r in self.responses):
+                file_import.add_submodule_import(f"{relative_path}_model_base", "_deserialize", ImportType.LOCAL)
+            if self.default_error_deserialization or self.non_default_errors:
                 file_import.add_submodule_import(f"{relative_path}_model_base", "_deserialize", ImportType.LOCAL)
         return file_import
 

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

@@ -1,4 +1,3 @@
-# pylint: disable=multiple-statements
 # -------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for

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

@@ -232,7 +232,11 @@ class BodyParameter(_ParameterBase):
     def is_form_data(self) -> bool:
         # hacky, but rn in legacy, there is no formdata model type, it's just a dict
         # with all of the entries splatted out
-        return self.type.is_form_data or bool(self.entries)
+        return (
+            self.type.is_form_data
+            or bool(self.entries)
+            or ("multipart/form-data" in self.content_types and self.code_model.options["from_typespec"])
+        )
 
     @property
     def is_partial_body(self) -> bool:

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

@@ -261,8 +261,7 @@ class _ParameterListBase(
         )
 
 
-class _ParameterList(_ParameterListBase[Parameter, BodyParameter]):  # pylint: disable=unsubscriptable-object
-    """Base Parameter class for the two operation ParameterLists"""
+class _ParameterList(_ParameterListBase[Parameter, BodyParameter]):
 
     @staticmethod
     def parameter_creator() -> Callable[[Dict[str, Any], "CodeModel"], Parameter]:
@@ -285,9 +284,7 @@ class ParameterList(_ParameterList):
     """ParameterList is the parameter list for Operation classes"""
 
 
-class _RequestBuilderParameterList(
-    _ParameterListBase[RequestBuilderParameter, RequestBuilderBodyParameter]  # pylint: disable=unsubscriptable-object
-):
+class _RequestBuilderParameterList(_ParameterListBase[RequestBuilderParameter, RequestBuilderBodyParameter]):
     """_RequestBuilderParameterList is base parameter list for RequestBuilder classes"""
 
     @staticmethod

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

@@ -22,8 +22,8 @@ class RawString(object):
         return "r'{}'".format(self.string.replace("'", "\\'"))
 
 
-class PrimitiveType(BaseType):  # pylint: disable=abstract-method
-    def description(self, *, is_operation_file: bool) -> str:  # pylint: disable=unused-argument
+class PrimitiveType(BaseType):
+    def description(self, *, is_operation_file: bool) -> str:
         return ""
 
     def type_annotation(self, **kwargs: Any) -> str:
@@ -188,7 +188,7 @@ class AnyObjectType(PrimitiveType):
         return "JSON"
 
 
-class NumberType(PrimitiveType):  # pylint: disable=abstract-method
+class NumberType(PrimitiveType):
     def __init__(self, yaml_data: Dict[str, Any], code_model: "CodeModel") -> None:
         super().__init__(yaml_data=yaml_data, code_model=code_model)
         self.precision: Optional[int] = yaml_data.get("precision")
@@ -233,6 +233,12 @@ class NumberType(PrimitiveType):  # pylint: disable=abstract-method
 
 
 class IntegerType(NumberType):
+
+    def __init__(self, yaml_data: Dict[str, Any], code_model: "CodeModel") -> None:
+        super().__init__(yaml_data=yaml_data, code_model=code_model)
+        if yaml_data.get("encode") == "string":
+            self.encode = "str"
+
     @property
     def serialization_type(self) -> str:
         return "int"
@@ -605,6 +611,7 @@ class SdkCoreType(PrimitiveType):
     def __init__(self, yaml_data: Dict[str, Any], code_model: "CodeModel") -> None:
         super().__init__(yaml_data=yaml_data, code_model=code_model)
         self.name = yaml_data.get("name", "")
+        self.submodule = yaml_data.get("submodule", "")
 
     def docstring_type(self, **kwargs: Any) -> str:
         return f"~{self.code_model.core_library}.{self.type_annotation(**kwargs)}"
@@ -614,7 +621,7 @@ class SdkCoreType(PrimitiveType):
 
     def imports(self, **kwargs: Any) -> FileImport:
         file_import = super().imports(**kwargs)
-        file_import.add_submodule_import("", self.name, ImportType.SDKCORE)
+        file_import.add_submodule_import(self.submodule, self.name, ImportType.SDKCORE)
         return file_import
 
     @property

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

@@ -3,7 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-from typing import Any, Dict, Optional, TYPE_CHECKING, List, cast
+from typing import Any, Dict, Optional, TYPE_CHECKING, List, cast, Union
 
 from .base import BaseModel
 from .constant_type import ConstantType
@@ -96,6 +96,10 @@ class Property(BaseModel):  # pylint: disable=too-many-instance-attributes
             return self.is_polymorphic and self.client_default_value is None
         return self.is_discriminator and self.is_polymorphic and cast(ConstantType, self.type).value is None
 
+    @property
+    def xml_metadata(self) -> Optional[Dict[str, Union[str, bool]]]:
+        return self.yaml_data.get("xmlMetadata")
+
     def type_annotation(self, *, is_operation_file: bool = False) -> str:
         if self.is_base_discriminator:
             return "str"

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

@@ -66,7 +66,7 @@ def _sample_output_path(source_file_path: str) -> Path:
     return Path("")
 
 
-class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
+class JinjaSerializer(ReaderAndWriter):
     def __init__(
         self,
         code_model: CodeModel,

package/generator/pygen/codegen/serializers/builder_serializer.py

@@ -1,4 +1,4 @@
-# pylint: disable=too-many-lines,multiple-statements
+# pylint: disable=too-many-lines
 # -------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for
@@ -23,7 +23,6 @@ from ..models import (
     BinaryType,
     BodyParameter,
     ParameterMethodLocation,
-    RequestBuilderBodyParameter,
     OverloadedRequestBuilder,
     Property,
     RequestBuilderType,
@@ -36,7 +35,7 @@ from ..models import (
 from .parameter_serializer import ParameterSerializer, PopKwargType
 from ..models.parameter_list import ParameterType
 from . import utils
-from ...utils import JSON_REGEXP
+from ...utils import xml_serializable, json_serializable
 
 T = TypeVar("T")
 OrderedSet = Dict[T, None]
@@ -62,10 +61,6 @@ def _all_same(data: List[List[str]]) -> bool:
     return len(data) > 1 and all(sorted(data[0]) == sorted(data[i]) for i in range(1, len(data)))
 
 
-def _json_serializable(content_type: str) -> bool:
-    return bool(JSON_REGEXP.match(content_type.split(";")[0].strip().lower()))
-
-
 def _need_type_ignore(builder: OperationType) -> bool:
     for excep in builder.non_default_errors:
         for status_code in excep.status_codes:
@@ -218,7 +213,7 @@ def is_json_model_type(parameters: ParameterListType) -> bool:
     )
 
 
-class _BuilderBaseSerializer(Generic[BuilderType]):  # pylint: disable=abstract-method
+class _BuilderBaseSerializer(Generic[BuilderType]):
     def __init__(self, code_model: CodeModel, async_mode: bool) -> None:
         self.code_model = code_model
         self.async_mode = async_mode
@@ -391,7 +386,7 @@ class _BuilderBaseSerializer(Generic[BuilderType]):  # pylint: disable=abstract-
 ############################## REQUEST BUILDERS ##############################
 
 
-class RequestBuilderSerializer(_BuilderBaseSerializer[RequestBuilderType]):  # pylint: disable=abstract-method
+class RequestBuilderSerializer(_BuilderBaseSerializer[RequestBuilderType]):
     def description_and_summary(self, builder: RequestBuilderType) -> List[str]:
         retval = super().description_and_summary(builder)
         retval += [
@@ -414,7 +409,9 @@ class RequestBuilderSerializer(_BuilderBaseSerializer[RequestBuilderType]):  # p
         return "response.json()"
 
     @staticmethod
-    def declare_non_inputtable_headers_queries(builder: RequestBuilderType) -> List[str]:
+    def declare_non_inputtable_headers_queries(
+        builder: RequestBuilderType,
+    ) -> List[str]:
         def _get_value(param):
             declaration = param.get_declaration() if param.constant else None
             if param.location in [ParameterLocation.HEADER, ParameterLocation.QUERY]:
@@ -517,7 +514,7 @@ class RequestBuilderSerializer(_BuilderBaseSerializer[RequestBuilderType]):  # p
 ############################## NORMAL OPERATIONS ##############################
 
 
-class _OperationSerializer(_BuilderBaseSerializer[OperationType]):  # pylint: disable=abstract-method
+class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
     def description_and_summary(self, builder: OperationType) -> List[str]:
         retval = super().description_and_summary(builder)
         if builder.deprecated:
@@ -689,7 +686,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):  # pylint: di
                 f"'{body_param.type.serialization_type}'{is_xml_cmd}{serialization_ctxt_cmd})"
             )
         elif self.code_model.options["models_mode"] == "dpg":
-            if _json_serializable(body_param.default_content_type):
+            if json_serializable(body_param.default_content_type):
                 if hasattr(body_param.type, "encode") and body_param.type.encode:  # type: ignore
                     create_body_call = (
                         f"_{body_kwarg_name} = json.dumps({body_param.client_name}, "
@@ -701,6 +698,8 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):  # pylint: di
                         f"_{body_kwarg_name} = json.dumps({body_param.client_name}, "
                         "cls=SdkJSONEncoder, exclude_readonly=True)  # type: ignore"
                     )
+            elif xml_serializable(body_param.default_content_type):
+                create_body_call = f"_{body_kwarg_name} = _get_element({body_param.client_name})"
             else:
                 create_body_call = f"_{body_kwarg_name} = {body_param.client_name}"
         else:
@@ -842,14 +841,14 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):  # pylint: di
         elif request_builder.overloads:
             seen_body_params = set()
             for overload in request_builder.overloads:
-                body_param = cast(RequestBuilderBodyParameter, overload.parameters.body_parameter)
+                body_param = overload.parameters.body_parameter
                 if body_param.client_name in seen_body_params:
                     continue
                 seen_body_params.add(body_param.client_name)
 
                 retval.append(f"    {body_param.client_name}={body_param.name_in_high_level_operation},")
         elif request_builder.parameters.has_body:
-            body_param = cast(RequestBuilderBodyParameter, request_builder.parameters.body_parameter)
+            body_param = request_builder.parameters.body_parameter
             retval.append(f"    {body_param.client_name}={body_param.name_in_high_level_operation},")
         retval.append("    headers=_headers,")
         retval.append("    params=_params,")
@@ -871,7 +870,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):  # pylint: di
         )
         return retval
 
-    def _call_request_builder_helper(  # pylint: disable=too-many-statements
+    def _call_request_builder_helper(
         self,
         builder: OperationType,
         request_builder: RequestBuilderType,
@@ -962,8 +961,11 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):  # pylint: di
                         and response.default_content_type == "application/json"
                         else ""
                     )
-                    response_attr = "json" if _json_serializable(str(response.default_content_type)) else "text"
-                    deserialize_code.append("deserialized = _deserialize(")
+                    response_attr = "json" if json_serializable(str(response.default_content_type)) else "text"
+                    deserialize_func = "_deserialize"
+                    if xml_serializable(str(response.default_content_type)):
+                        deserialize_func = "_deserialize_xml"
+                    deserialize_code.append(f"deserialized = {deserialize_func}(")
                     deserialize_code.append(
                         f"    {response.type.type_annotation(is_operation_file=True)},{pylint_disable}"
                     )
@@ -1031,7 +1033,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):  # pylint: di
             retval.append("deserialized = None")
         if builder.any_response_has_headers:
             retval.append("response_headers = {}")
-        if builder.has_response_body or builder.any_response_has_headers:
+        if builder.has_response_body or builder.any_response_has_headers:  # pylint: disable=too-many-nested-blocks
             if len(builder.responses) > 1:
                 status_codes, res_headers, res_deserialization = [], [], []
                 for status_code in builder.success_status_codes:
@@ -1173,7 +1175,7 @@ class OperationSerializer(_OperationSerializer[Operation]): ...
 PagingOperationType = TypeVar("PagingOperationType", bound=Union[PagingOperation, LROPagingOperation])
 
 
-class _PagingOperationSerializer(_OperationSerializer[PagingOperationType]):  # pylint: disable=abstract-method
+class _PagingOperationSerializer(_OperationSerializer[PagingOperationType]):
     def __init__(self, code_model: CodeModel, async_mode: bool) -> None:
         # for pylint reasons need to redefine init
         # probably because inheritance is going too deep
@@ -1458,7 +1460,7 @@ class LROOperationSerializer(_LROOperationSerializer[LROOperation]): ...
 class LROPagingOperationSerializer(
     _LROOperationSerializer[LROPagingOperation],
     _PagingOperationSerializer[LROPagingOperation],
-):  # pylint: disable=abstract-method
+):
     @property
     def _call_method(self) -> str:
         return "await " if self.async_mode else ""

package/generator/pygen/codegen/serializers/general_serializer.py

@@ -182,12 +182,13 @@ class GeneralSerializer(BaseSerializer):
     def serialize_cross_language_definition_file(self) -> str:
         cross_langauge_def_dict = {
             f"{self.code_model.namespace}.models.{model.name}": model.cross_language_definition_id
-            for model in self.code_model.model_types
+            for model in self.code_model.public_model_types
         }
         cross_langauge_def_dict.update(
             {
                 f"{self.code_model.namespace}.models.{enum.name}": enum.cross_language_definition_id
                 for enum in self.code_model.enums
+                if not enum.internal
             }
         )
         cross_langauge_def_dict.update(

package/generator/pygen/codegen/serializers/model_serializer.py

@@ -251,6 +251,9 @@ class DpgModelSerializer(_ModelSerializer):
         elif hasattr(prop.type, "encode") and prop.type.encode:  # type: ignore
             args.append(f'format="{prop.type.encode}"')  # type: ignore
 
+        if prop.xml_metadata:
+            args.append(f"xml={prop.xml_metadata}")
+
         field = "rest_discriminator" if prop.is_discriminator else "rest_field"
         type_ignore = prop.is_discriminator and isinstance(prop.type, (ConstantType, EnumValue)) and prop.type.value
         return (

package/generator/pygen/codegen/serializers/sample_serializer.py

@@ -1,4 +1,3 @@
-# pylint: disable=too-many-lines
 # -------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for
@@ -22,7 +21,6 @@ from ..models import (
     FileImport,
 )
 from .utils import get_namespace_config, get_namespace_from_package_name
-from ...utils import to_snake_case
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -152,7 +150,7 @@ class SampleSerializer(BaseSerializer):
         name = self.sample.get("x-ms-original-file", "")
         if "specification" in name:
             return "specification" + name.split("specification")[-1]
-        return ""
+        return name if self.code_model.options["from_typespec"] else ""
 
     def serialize(self) -> str:
         operation_result, return_var = self._operation_result()

package/generator/pygen/codegen/serializers/test_serializer.py

@@ -80,6 +80,12 @@ class TestCase:
         self.operation = operation
         self.is_async = is_async
 
+    @property
+    def name(self) -> str:
+        if self.operation_groups[-1].is_mixin:
+            return self.operation.name
+        return "_".join([og.property_name for og in self.operation_groups] + [self.operation.name])
+
     @property
     def operation_group_prefix(self) -> str:
         if self.operation_groups[-1].is_mixin: