@autorest/python 6.7.7 → 6.8.0

package/autorest/codegen/__init__.py

@@ -13,7 +13,7 @@ from .. import Plugin, PluginAutorest
 from .._utils import parse_args
 from .models.code_model import CodeModel
 from .serializers import JinjaSerializer, JinjaSerializerAutorest
-from ._utils import DEFAULT_HEADER_TEXT
+from ._utils import DEFAULT_HEADER_TEXT, VALID_PACKAGE_MODE, TYPESPEC_PACKAGE_MODE
 
 
 def _default_pprint(package_name: str) -> str:
@@ -55,11 +55,17 @@ def _validate_code_model_options(options: Dict[str, Any]) -> None:
 
     if options["package_mode"]:
         if (
-            options["package_mode"] not in ("mgmtplane", "dataplane")
-            and not Path(options["package_mode"]).exists()
-        ):
+            (
+                options["package_mode"] not in TYPESPEC_PACKAGE_MODE
+                and options["from_typespec"]
+            )
+            or (
+                options["package_mode"] not in VALID_PACKAGE_MODE
+                and not options["from_typespec"]
+            )
+        ) and not Path(options["package_mode"]).exists():
             raise ValueError(
-                "--package-mode can only be 'mgmtplane' or 'dataplane' or directory which contains template files"
+                f"--package-mode can only be {' or '.join(TYPESPEC_PACKAGE_MODE)} or directory which contains template files"  # pylint: disable=line-too-long
             )
 
     if options["multiapi"] and options["version_tolerant"]:
@@ -170,6 +176,7 @@ class CodeGenerator(Plugin):
             ),
             "generate_sample": self.options.get("generate-sample", False),
             "default_api_version": self.options.get("default-api-version"),
+            "from_typespec": self.options.get("from-typespec", False),
         }
 
         if options["builders_visibility"] is None:

package/autorest/codegen/_utils.py

@@ -10,3 +10,7 @@ DEFAULT_HEADER_TEXT = (
     "Code generated by Microsoft (R) Python Code Generator.\n"
     "Changes may cause incorrect behavior and will be lost if the code is regenerated."
 )
+
+SWAGGER_PACKAGE_MODE = ["mgmtplane", "dataplane"]  # for backward compatibility
+TYPESPEC_PACKAGE_MODE = ["azure-mgmt", "azure-dataplane", "generic"]
+VALID_PACKAGE_MODE = SWAGGER_PACKAGE_MODE + TYPESPEC_PACKAGE_MODE

package/autorest/codegen/models/dictionary_type.py

@@ -31,8 +31,8 @@ class DictionaryType(BaseType):
         self.element_type = element_type
 
     @property
-    def format(self) -> Optional[str]:
-        return self.element_type.format if hasattr(self.element_type, "format") else None  # type: ignore
+    def encode(self) -> Optional[str]:
+        return self.element_type.encode if hasattr(self.element_type, "encode") else None  # type: ignore
 
     @property
     def serialization_type(self) -> str:

package/autorest/codegen/models/list_type.py

@@ -26,8 +26,8 @@ class ListType(BaseType):
         self.unique_items: bool = yaml_data.get("uniqueItems", False)
 
     @property
-    def format(self) -> Optional[str]:
-        return self.element_type.format if hasattr(self.element_type, "format") else None  # type: ignore
+    def encode(self) -> Optional[str]:
+        return self.element_type.encode if hasattr(self.element_type, "encode") else None  # type: ignore
 
     @property
     def serialization_type(self) -> str:

package/autorest/codegen/models/parameter.py

@@ -92,6 +92,10 @@ class _ParameterBase(
         )
         self.hide_in_method: bool = self.yaml_data.get("hideInMethod", False)
 
+    @property
+    def hide_in_operation_signature(self) -> bool:
+        return False
+
     @property
     def constant(self) -> bool:
         """Returns whether a parameter is a constant or not.
@@ -341,6 +345,15 @@ class Parameter(_ParameterBase):
         self.delimiter: Optional[ParameterDelimeter] = self.yaml_data.get("delimiter")
         self._default_to_unset_sentinel: bool = False
 
+    @property
+    def hide_in_operation_signature(self) -> bool:
+        if (
+            self.code_model.options["version_tolerant"]
+            and self.client_name == "maxpagesize"
+        ):
+            return True
+        return False
+
     @property
     def in_method_signature(self) -> bool:
         return not (self.wire_name == "Accept" or self.grouped_by or self.flattened)

package/autorest/codegen/models/parameter_list.py

@@ -248,11 +248,12 @@ class _ParameterListBase(
 
     def method_signature_keyword_only(self, async_mode: bool) -> List[str]:
         """Signature for keyword only parameters"""
-        if not self.keyword_only:
-            return []
-        return ["*,"] + [
-            parameter.method_signature(async_mode) for parameter in self.keyword_only
+        result = [
+            parameter.method_signature(async_mode)
+            for parameter in self.keyword_only
+            if not parameter.hide_in_operation_signature
         ]
+        return ["*,"] + result if result else []
 
     @property
     def method_signature_kwargs(self) -> List[str]:
@@ -409,16 +410,6 @@ class RequestBuilderParameterList(_RequestBuilderParameterList):
 class OverloadedRequestBuilderParameterList(_RequestBuilderParameterList):
     """Parameter list for OverloadedRequestBuilder"""
 
-    def method_signature_keyword_only(self, async_mode: bool) -> List[str]:
-        """Signature for keyword only parameters"""
-        if not self.keyword_only:
-            return []
-        return ["*,"] + [
-            parameter.method_signature(async_mode)
-            for parameter in self.keyword_only
-            if parameter.location != ParameterLocation.BODY
-        ]
-
 
 class _ClientGlobalParameterList(  # pylint: disable=abstract-method
     _ParameterListBase[ParameterType, BodyParameter]

package/autorest/codegen/models/primitive_types.py

@@ -355,10 +355,10 @@ class StringType(PrimitiveType):
 class DatetimeType(PrimitiveType):
     def __init__(self, yaml_data: Dict[str, Any], code_model: "CodeModel") -> None:
         super().__init__(yaml_data=yaml_data, code_model=code_model)
-        self.format = (
+        self.encode = (
             "rfc3339"
-            if yaml_data.get("format", "date-time") == "date-time"
-            or yaml_data.get("format", "date-time") == "rfc3339"
+            if yaml_data.get("encode", "date-time") == "date-time"
+            or yaml_data.get("encode", "date-time") == "rfc3339"
             else "rfc7231"
         )
 
@@ -368,7 +368,7 @@ class DatetimeType(PrimitiveType):
             "rfc3339": "iso-8601",
             "rfc7231": "rfc-1123",
         }
-        return formats_to_attribute_type[self.format]
+        return formats_to_attribute_type[self.encode]
 
     def docstring_type(self, **kwargs: Any) -> str:
         return "~" + self.type_annotation()
@@ -455,7 +455,7 @@ class TimeType(PrimitiveType):
 
 class UnixTimeType(PrimitiveType):
     @property
-    def format(self) -> str:
+    def encode(self) -> str:
         return "unix-timestamp"
 
     @property
@@ -592,11 +592,11 @@ class DurationType(PrimitiveType):
 class ByteArraySchema(PrimitiveType):
     def __init__(self, yaml_data: Dict[str, Any], code_model: "CodeModel") -> None:
         super().__init__(yaml_data=yaml_data, code_model=code_model)
-        self.format = yaml_data.get("format", "base64")
+        self.encode = yaml_data.get("encode", "base64")
 
     @property
     def serialization_type(self) -> str:
-        if self.format == "base64url":
+        if self.encode == "base64url":
             return "base64"
         return "bytearray"
 

package/autorest/codegen/models/request_builder_parameter.py

@@ -110,6 +110,10 @@ class RequestBuilderParameter(Parameter):
             # we don't want hidden parameters for grouped by in request builders
             self.client_name = self.client_name[1:]
 
+    @property
+    def hide_in_operation_signature(self) -> bool:
+        return False
+
     @property
     def in_method_signature(self) -> bool:
         if self.grouped_by and not self.in_flattened_body:

package/autorest/codegen/serializers/__init__.py

@@ -29,6 +29,7 @@ from .patch_serializer import PatchSerializer
 from .sample_serializer import SampleSerializer
 from .types_serializer import TypesSerializer
 from ..._utils import to_snake_case
+from .._utils import VALID_PACKAGE_MODE
 from .utils import (
     extract_sample_name,
     get_namespace_from_package_name,
@@ -216,7 +217,7 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
 
     def _serialize_and_write_package_files(self, namespace_path: Path) -> None:
         root_of_sdk = self._package_root_folder(namespace_path)
-        if self.code_model.options["package_mode"] in ("dataplane", "mgmtplane"):
+        if self.code_model.options["package_mode"] in VALID_PACKAGE_MODE:
             env = Environment(
                 loader=PackageLoader(
                     "autorest.codegen", "templates/packaging_templates"

package/autorest/codegen/serializers/builder_serializer.py

@@ -32,6 +32,7 @@ from ..models import (
     RequestBuilderType,
     CombinedType,
     ParameterListType,
+    ByteArraySchema,
 )
 from .parameter_serializer import ParameterSerializer, PopKwargType
 from ..models.parameter_list import ParameterType
@@ -332,7 +333,7 @@ class _BuilderBaseSerializer(Generic[BuilderType]):  # pylint: disable=abstract-
     def param_description(self, builder: BuilderType) -> List[str]:
         description_list: List[str] = []
         for param in builder.parameters.method:
-            if not param.in_docstring:
+            if not param.in_docstring or param.hide_in_operation_signature:
                 continue
             description_list.extend(
                 f":{param.description_keyword} {param.client_name}: {param.description}".replace(
@@ -700,6 +701,9 @@ class _OperationSerializer(
             check_client_input=not self.code_model.options["multiapi"],
             operation_name=f"('{builder.name}')" if builder.group_name == "" else "",
         )
+        for p in builder.parameters.parameters:
+            if p.hide_in_operation_signature:
+                kwargs.append(f'{p.client_name} = kwargs.pop("{p.client_name}", None)')
         cls_annotation = builder.cls_type_annotation(async_mode=self.async_mode)
         pylint_disable = ""
         if any(x.startswith("_") for x in cls_annotation.split(".")):
@@ -749,10 +753,17 @@ class _OperationSerializer(
                 f"'{body_param.type.serialization_type}'{is_xml_cmd}{serialization_ctxt_cmd})"
             )
         elif self.code_model.options["models_mode"] == "dpg":
-            create_body_call = (
-                f"_{body_kwarg_name} = json.dumps({body_param.client_name}, "
-                "cls=AzureJSONEncoder, exclude_readonly=True)  # type: ignore"
-            )
+            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}, "
+                    "cls=AzureJSONEncoder, exclude_readonly=True, "
+                    f"format='{body_param.type.encode}')  # type: ignore"  # type: ignore
+                )
+            else:
+                create_body_call = (
+                    f"_{body_kwarg_name} = json.dumps({body_param.client_name}, "
+                    "cls=AzureJSONEncoder, exclude_readonly=True)  # type: ignore"
+                )
         else:
             create_body_call = f"_{body_kwarg_name} = {body_param.client_name}"
         if body_param.optional:
@@ -774,7 +785,11 @@ class _OperationSerializer(
         if hasattr(body_param, "entries"):
             return _serialize_multipart_body(builder)
         body_kwarg_name = builder.request_builder.parameters.body_parameter.client_name
-        if isinstance(body_param.type, BinaryType):
+        body_param_type = body_param.type
+        if isinstance(body_param_type, BinaryType) or (
+            isinstance(body_param.type, ByteArraySchema)
+            and body_param.default_content_type != "application/json"
+        ):
             retval.append(f"_{body_kwarg_name} = {body_param.client_name}")
             if (
                 not body_param.default_content_type

package/autorest/codegen/serializers/model_serializer.py

@@ -260,8 +260,8 @@ class DpgModelSerializer(_ModelSerializer):
             args.append(f"visibility=[{v_list}]")
         if prop.client_default_value is not None:
             args.append(f"default={prop.client_default_value_declaration}")
-        if hasattr(prop.type, "format") and prop.type.format:  # type: ignore
-            args.append(f'format="{prop.type.format}"')  # type: ignore
+        if hasattr(prop.type, "encode") and prop.type.encode:  # type: ignore
+            args.append(f'format="{prop.type.encode}"')  # type: ignore
 
         field = "rest_discriminator" if prop.is_discriminator else "rest_field"
         type_ignore = (

package/autorest/codegen/templates/model_base.py.jinja2

@@ -128,9 +128,10 @@ def _is_readonly(p):
 class AzureJSONEncoder(JSONEncoder):
     """A JSON encoder that's capable of serializing datetime objects and bytes."""
 
-    def __init__(self, *args, exclude_readonly: bool = False, **kwargs):
+    def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs):
         super().__init__(*args, **kwargs)
         self.exclude_readonly = exclude_readonly
+        self.format = format
 
     def default(self, o):  # pylint: disable=too-many-return-statements
         if _is_model(o):
@@ -138,18 +139,16 @@ class AzureJSONEncoder(JSONEncoder):
                 readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)]
                 return {k: v for k, v in o.items() if k not in readonly_props}
             return dict(o.items())
-        if isinstance(o, (bytes, bytearray)):
-            return base64.b64encode(o).decode()
-        if isinstance(o, _Null):
-            return None
         try:
             return super(AzureJSONEncoder, self).default(o)
         except TypeError:
+            if isinstance(o, _Null):
+                return None
             if isinstance(o, (bytes, bytearray)):
-                return _serialize_bytes(o)
+                return _serialize_bytes(o, self.format)
             try:
                 # First try datetime.datetime
-                return _serialize_datetime(o)
+                return _serialize_datetime(o, self.format)
             except AttributeError:
                 pass
             # Last, try datetime.timedelta

package/autorest/m4reformatter/__init__.py

@@ -232,11 +232,11 @@ def update_primitive(  # pylint: disable=too-many-return-statements
         return KNOWN_TYPES["binary"]
     if type_group == "date-time":
         base = _update_type_base("datetime", yaml_data)
-        base["format"] = yaml_data["format"]
+        base["encode"] = yaml_data["format"]
         return base
     if type_group == "byte-array":
         base = _update_type_base("bytes", yaml_data)
-        base["format"] = yaml_data["format"]
+        base["encode"] = yaml_data["format"]
         return base
     return _update_type_base(type_group, yaml_data)
 

package/autorest/preprocess/__init__.py

@@ -137,16 +137,6 @@ def add_overloads_for_body_param(yaml_data: Dict[str, Any]) -> None:
     content_type_param["optional"] = True
 
 
-def _remove_paging_maxpagesize(yaml_data: Dict[str, Any]) -> None:
-    # we don't expose maxpagesize for version tolerant generation
-    # users should be passing this into `by_page`
-    yaml_data["parameters"] = [
-        p
-        for p in yaml_data.get("parameters", [])
-        if p["wireName"].lower() not in ["maxpagesize", "$maxpagesize"]
-    ]
-
-
 def update_description(
     description: Optional[str], default_description: str = ""
 ) -> str:
@@ -494,13 +484,8 @@ class PreProcessPlugin(YamlUpdatePlugin):  # pylint: disable=abstract-method
             yaml_data["pagerSync"] = "azure.core.paging.ItemPaged"
         if not yaml_data.get("pagerAsync"):
             yaml_data["pagerAsync"] = "azure.core.async_paging.AsyncItemPaged"
-        if self.version_tolerant:
-            # if we're in version tolerant, hide the paging model
-            _remove_paging_maxpagesize(yaml_data)
         item_type = item_type or yaml_data["itemType"]["elementType"]
         if yaml_data.get("nextOperation"):
-            if self.version_tolerant:
-                _remove_paging_maxpagesize(yaml_data["nextOperation"])
             yaml_data["nextOperation"]["groupName"] = self.pad_reserved_words(
                 yaml_data["nextOperation"]["groupName"], PadType.OPERATION_GROUP
             )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autorest/python",
-  "version": "6.7.7",
+  "version": "6.8.0",
   "description": "The Python extension for generators in AutoRest.",
   "main": "index.js",
   "repository": {