@autorest/python 5.16.0 → 5.19.0

package/autorest/codegen/models/enum_type.py

@@ -0,0 +1,195 @@
+# -------------------------------------------------------------------------
+# 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 Any, Dict, List, TYPE_CHECKING, Optional
+
+from .base_type import BaseType
+from .imports import FileImport, ImportType, TypingSection
+from .base_model import BaseModel
+
+if TYPE_CHECKING:
+    from .code_model import CodeModel
+
+
+class EnumValue(BaseModel):
+    """Model containing necessary information for a single value of an enum.
+
+    :param str name: The name of this enum value
+    :param str value: The value of this enum value
+    :param str description: Optional. The description for this enum value
+    """
+
+    def __init__(self, yaml_data: Dict[str, Any], code_model: "CodeModel") -> None:
+        super().__init__(yaml_data=yaml_data, code_model=code_model)
+        self.name: str = self.yaml_data["name"]
+        self.value: str = self.yaml_data["value"]
+        self.description: Optional[str] = self.yaml_data.get("description")
+
+    @classmethod
+    def from_yaml(
+        cls, yaml_data: Dict[str, Any], code_model: "CodeModel"
+    ) -> "EnumValue":
+        """Constructs an EnumValue from yaml data.
+
+        :param yaml_data: the yaml data from which we will construct this object
+        :type yaml_data: dict[str, Any]
+
+        :return: A created EnumValue
+        :rtype: ~autorest.models.EnumValue
+        """
+        return cls(
+            yaml_data=yaml_data,
+            code_model=code_model,
+        )
+
+
+class EnumType(BaseType):
+    """Schema for enums that will be serialized.
+
+    :param yaml_data: the yaml data for this schema
+    :type yaml_data: dict[str, Any]
+    :param str description: The description of this enum
+    :param str name: The name of the enum.
+    :type element_type: ~autorest.models.PrimitiveType
+    :param values: List of the values for this enum
+    :type values: list[~autorest.models.EnumValue]
+    """
+
+    def __init__(
+        self,
+        yaml_data: Dict[str, Any],
+        code_model: "CodeModel",
+        values: List["EnumValue"],
+        value_type: BaseType,
+    ) -> None:
+        super().__init__(yaml_data=yaml_data, code_model=code_model)
+        self.name: str = yaml_data["name"]
+        self.values = values
+        self.value_type = value_type
+
+    def __lt__(self, other):
+        return self.name.lower() < other.name.lower()
+
+    @property
+    def serialization_type(self) -> str:
+        """Returns the serialization value for msrest.
+
+        :return: The serialization value for msrest
+        :rtype: str
+        """
+        return self.value_type.serialization_type
+
+    def description(
+        self, *, is_operation_file: bool  # pylint: disable=unused-argument
+    ) -> str:
+        possible_values = [self.get_declaration(v.value) for v in self.values]
+        if not possible_values:
+            return ""
+        if len(possible_values) == 1:
+            return possible_values[0]
+        if len(possible_values) == 2:
+            possible_values_str = " and ".join(possible_values)
+        else:
+            possible_values_str = (
+                ", ".join(possible_values[: len(possible_values) - 1])
+                + f", and {possible_values[-1]}"
+            )
+
+        enum_description = f"Known values are: {possible_values_str}."
+        return enum_description
+
+    def type_annotation(self, **kwargs: Any) -> str:
+        """The python type used for type annotation
+
+        :return: The type annotation for this schema
+        :rtype: str
+        """
+        if self.code_model.options["models_mode"]:
+            return (
+                f"Union[{self.value_type.type_annotation(**kwargs)},"
+                f' "_models.{self.name}"]'
+            )
+        return self.value_type.type_annotation(**kwargs)
+
+    def get_declaration(self, value: Any) -> str:
+        return self.value_type.get_declaration(value)
+
+    def docstring_text(self, **kwargs: Any) -> str:
+        if self.code_model.options["models_mode"]:
+            return self.name
+        return self.value_type.type_annotation(**kwargs)
+
+    def docstring_type(self, **kwargs: Any) -> str:
+        """The python type used for RST syntax input and type annotation."""
+        if self.code_model.options["models_mode"]:
+            return f"{self.value_type.type_annotation(**kwargs)} or ~{self.code_model.namespace}.models.{self.name}"
+        return self.value_type.type_annotation(**kwargs)
+
+    def get_json_template_representation(
+        self,
+        *,
+        optional: bool = True,
+        client_default_value_declaration: Optional[str] = None,
+        description: Optional[str] = None,
+    ) -> Any:
+        # for better display effect, use the only value instead of var type
+        return self.value_type.get_json_template_representation(
+            optional=optional,
+            client_default_value_declaration=client_default_value_declaration,
+            description=description,
+        )
+
+    @property
+    def instance_check_template(self) -> str:
+        return self.value_type.instance_check_template
+
+    @classmethod
+    def from_yaml(
+        cls, yaml_data: Dict[str, Any], code_model: "CodeModel"
+    ) -> "EnumType":
+        """Constructs an EnumType from yaml data.
+
+        :param yaml_data: the yaml data from which we will construct this schema
+        :type yaml_data: dict[str, Any]
+
+        :return: A created EnumType
+        :rtype: ~autorest.models.EnumType
+        """
+        from . import build_type
+
+        return cls(
+            yaml_data=yaml_data,
+            code_model=code_model,
+            value_type=build_type(yaml_data["valueType"], code_model),
+            values=[
+                EnumValue.from_yaml(value, code_model) for value in yaml_data["values"]
+            ],
+        )
+
+    def imports(self, **kwargs: Any) -> FileImport:
+        is_operation_file = kwargs.pop("is_operation_file", False)
+        file_import = FileImport()
+        if self.code_model.options["models_mode"]:
+            file_import.add_submodule_import(
+                "typing", "Union", ImportType.STDLIB, TypingSection.CONDITIONAL
+            )
+            if not is_operation_file:
+                file_import.add_submodule_import(
+                    "..",
+                    "models",
+                    ImportType.LOCAL,
+                    TypingSection.TYPING,
+                    alias="_models",
+                )
+        file_import.merge(
+            self.value_type.imports(is_operation_file=is_operation_file, **kwargs)
+        )
+        relative_path = kwargs.pop("relative_path", None)
+        if self.code_model.options["models_mode"] and relative_path:
+            # add import for enums in operations file
+            file_import.add_submodule_import(
+                relative_path, "models", ImportType.LOCAL, alias="_models"
+            )
+        return file_import

package/autorest/codegen/models/imports.py

@@ -3,8 +3,11 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-from enum import Enum
-from typing import Dict, List, Optional, Tuple, Union, Set, Mapping
+from enum import Enum, auto
+from typing import Dict, List, Optional, Tuple, Union, Set, Mapping, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .code_model import CodeModel
 
 
 class ImportType(str, Enum):
@@ -20,6 +23,16 @@ class TypingSection(str, Enum):
     TYPING = "typing"  # never a typing import
 
 
+class MsrestImportType(Enum):
+    Module = auto()  # import _serialization.py or msrest.serialization as Module
+    Serializer = (
+        auto()
+    )  # from _serialization.py or msrest.serialization import Serializer
+    SerializerDeserializer = (
+        auto()
+    )  # from _serialization.py or msrest.serialization import Serializer and Deserializer
+
+
 class ImportModel:
     def __init__(
         self,
@@ -147,6 +160,29 @@ class FileImport:
             self._append_import(i)
         self.type_definitions.update(file_import.type_definitions)
 
+    def define_mutable_mapping_type(self) -> None:
+        """Helper function for defining the mutable mapping type"""
+        self.define_mypy_type(
+            "JSON",
+            "MutableMapping[str, Any] # pylint: disable=unsubscriptable-object",
+            None,
+            {
+                (3, 9): ImportModel(
+                    TypingSection.CONDITIONAL,
+                    ImportType.STDLIB,
+                    "collections.abc",
+                    submodule_name="MutableMapping",
+                ),
+                None: ImportModel(
+                    TypingSection.CONDITIONAL,
+                    ImportType.STDLIB,
+                    "typing",
+                    submodule_name="MutableMapping",
+                ),
+            },
+        )
+        self.add_submodule_import("typing", "Any", ImportType.STDLIB)
+
     def to_dict(
         self,
     ) -> Dict[
@@ -167,3 +203,45 @@ class FileImport:
                 i.import_type, dict()
             ).setdefault(i.module_name, set()).add(name_import)
         return retval
+
+    def add_msrest_import(
+        self,
+        code_model: "CodeModel",
+        relative_path: str,
+        msrest_import_type: MsrestImportType,
+        typing_section: TypingSection,
+    ):
+        if code_model.options["client_side_validation"]:
+            if msrest_import_type == MsrestImportType.Module:
+                self.add_import(
+                    "msrest.serialization", ImportType.AZURECORE, typing_section
+                )
+            else:
+                self.add_submodule_import(
+                    "msrest", "Serializer", ImportType.THIRDPARTY, typing_section
+                )
+                if msrest_import_type == MsrestImportType.SerializerDeserializer:
+                    self.add_submodule_import(
+                        "msrest", "Deserializer", ImportType.THIRDPARTY, typing_section
+                    )
+        else:
+            if code_model.options["multiapi"]:
+                relative_path += "."
+            if msrest_import_type == MsrestImportType.Module:
+                self.add_submodule_import(
+                    relative_path, "_serialization", ImportType.LOCAL, typing_section
+                )
+            else:
+                self.add_submodule_import(
+                    f"{relative_path}_serialization",
+                    "Serializer",
+                    ImportType.LOCAL,
+                    typing_section,
+                )
+                if msrest_import_type == MsrestImportType.SerializerDeserializer:
+                    self.add_submodule_import(
+                        f"{relative_path}_serialization",
+                        "Deserializer",
+                        ImportType.LOCAL,
+                        typing_section,
+                    )

package/autorest/codegen/models/list_type.py

@@ -0,0 +1,149 @@
+# -------------------------------------------------------------------------
+# 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 Any, Dict, Optional, Union, TYPE_CHECKING, List
+from .base_type import BaseType
+from .imports import FileImport, ImportType, TypingSection
+
+if TYPE_CHECKING:
+    from .code_model import CodeModel
+    from .model_type import ModelType
+
+
+class ListType(BaseType):
+    def __init__(
+        self,
+        yaml_data: Dict[str, Any],
+        code_model: "CodeModel",
+        element_type: BaseType,
+    ) -> None:
+        super().__init__(yaml_data=yaml_data, code_model=code_model)
+        self.element_type = element_type
+        self.max_items: Optional[int] = yaml_data.get("maxItems")
+        self.min_items: Optional[int] = yaml_data.get("minItems")
+        self.unique_items: bool = yaml_data.get("uniqueItems", False)
+
+    @property
+    def serialization_type(self) -> str:
+        return f"[{self.element_type.serialization_type}]"
+
+    def type_annotation(self, **kwargs: Any) -> str:
+        if self.code_model.options["version_tolerant"] and self.element_type.is_xml:
+            # this means we're version tolerant XML, we just return the XML element
+            return self.element_type.type_annotation(**kwargs)
+        return f"List[{self.element_type.type_annotation(**kwargs)}]"
+
+    def description(self, *, is_operation_file: bool) -> str:
+        return "" if is_operation_file else self.yaml_data.get("description", "")
+
+    @property
+    def xml_serialization_ctxt(self) -> Optional[str]:
+        attrs_list = []
+        base_xml_map = super().xml_serialization_ctxt
+        if base_xml_map:
+            attrs_list.append(base_xml_map)
+
+        # Attribute at the list level
+        if self.xml_metadata.get("wrapped", False):
+            attrs_list.append("'wrapped': True")
+
+        # Attributes of the items
+        item_xml_metadata = self.element_type.xml_metadata
+        if item_xml_metadata.get("name"):
+            attrs_list.append(f"'itemsName': '{item_xml_metadata['name']}'")
+        if item_xml_metadata.get("prefix", False):
+            attrs_list.append(f"'itemsPrefix': '{item_xml_metadata['prefix']}'")
+        if item_xml_metadata.get("namespace", False):
+            attrs_list.append(f"'itemsNs': '{item_xml_metadata['namespace']}'")
+
+        return ", ".join(attrs_list)
+
+    def docstring_type(self, **kwargs: Any) -> str:
+        if (
+            self.code_model.options["version_tolerant"]
+            and self.element_type.xml_metadata
+        ):
+            # this means we're version tolerant XML, we just return the XML element
+            return self.element_type.docstring_type(**kwargs)
+        return f"list[{self.element_type.docstring_type(**kwargs)}]"
+
+    def docstring_text(self, **kwargs: Any) -> str:
+        if (
+            self.code_model.options["version_tolerant"]
+            and self.element_type.xml_metadata
+        ):
+            # this means we're version tolerant XML, we just return the XML element
+            return self.element_type.docstring_text(**kwargs)
+        return f"list of {self.element_type.docstring_text(**kwargs)}"
+
+    @property
+    def validation(self) -> Optional[Dict[str, Union[bool, int, str]]]:
+        validation: Dict[str, Union[bool, int, str]] = {}
+        if self.max_items:
+            validation["max_items"] = self.max_items
+            validation["min_items"] = self.min_items or 0
+        if self.min_items:
+            validation["min_items"] = self.min_items
+        if self.unique_items:
+            validation["unique"] = True
+        return validation or None
+
+    def get_json_template_representation(
+        self,
+        *,
+        optional: bool = True,
+        client_default_value_declaration: Optional[str] = None,
+        description: Optional[str] = None,
+    ) -> Any:
+        return [
+            self.element_type.get_json_template_representation(
+                optional=optional,
+                client_default_value_declaration=client_default_value_declaration,
+                description=description,
+            )
+        ]
+
+    def get_polymorphic_subtypes(self, polymorphic_subtypes: List["ModelType"]) -> None:
+        from .model_type import ModelType
+
+        if isinstance(self.element_type, ModelType):
+            is_polymorphic_subtype = (
+                self.element_type.discriminator_value
+                and not self.element_type.discriminated_subtypes
+            )
+            if (
+                self.element_type.name not in (m.name for m in polymorphic_subtypes)
+                and is_polymorphic_subtype
+            ):
+                polymorphic_subtypes.append(self.element_type)
+
+    @property
+    def instance_check_template(self) -> str:
+        return "isinstance({}, list)"
+
+    @classmethod
+    def from_yaml(
+        cls, yaml_data: Dict[str, Any], code_model: "CodeModel"
+    ) -> "ListType":
+        from . import build_type
+
+        return cls(
+            yaml_data=yaml_data,
+            code_model=code_model,
+            element_type=build_type(
+                yaml_data=yaml_data["elementType"], code_model=code_model
+            ),
+        )
+
+    def imports(self, **kwargs: Any) -> FileImport:
+        file_import = FileImport()
+        if not (
+            self.code_model.options["version_tolerant"] and self.element_type.is_xml
+        ):
+            file_import.add_submodule_import(
+                "typing", "List", ImportType.STDLIB, TypingSection.CONDITIONAL
+            )
+        file_import.merge(self.element_type.imports(**kwargs))
+        return file_import