@typespec/http-client-python 0.23.1 → 0.24.1

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

@@ -781,8 +781,14 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
         client_names = [
             overload.request_builder.parameters.body_parameter.client_name for overload in builder.overloads
         ]
-        for v in sorted(set(client_names), key=client_names.index):
-            retval.append(f"_{v} = None")
+        all_dpg_model_overloads = False
+        if self.code_model.options["models-mode"] == "dpg" and builder.overloads:
+            all_dpg_model_overloads = all(
+                isinstance(o.parameters.body_parameter.type, DPGModelType) for o in builder.overloads
+            )
+        if not all_dpg_model_overloads:
+            for v in sorted(set(client_names), key=client_names.index):
+                retval.append(f"_{v} = None")
         try:
             # if there is a binary overload, we do a binary check first.
             binary_overload = cast(
@@ -808,17 +814,20 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                     f'"{other_overload.parameters.body_parameter.default_content_type}"{check_body_suffix}'
                 )
         except StopIteration:
-            for idx, overload in enumerate(builder.overloads):
-                if_statement = "if" if idx == 0 else "elif"
-                body_param = overload.parameters.body_parameter
-                retval.append(
-                    f"{if_statement} {body_param.type.instance_check_template.format(body_param.client_name)}:"
-                )
-                if body_param.default_content_type and not same_content_type:
+            if all_dpg_model_overloads:
+                retval.extend(f"{l}" for l in self._create_body_parameter(cast(OperationType, builder.overloads[0])))
+            else:
+                for idx, overload in enumerate(builder.overloads):
+                    if_statement = "if" if idx == 0 else "elif"
+                    body_param = overload.parameters.body_parameter
                     retval.append(
-                        f'    content_type = content_type or "{body_param.default_content_type}"{check_body_suffix}'
+                        f"{if_statement} {body_param.type.instance_check_template.format(body_param.client_name)}:"
                     )
-                retval.extend(f"    {l}" for l in self._create_body_parameter(cast(OperationType, overload)))
+                    if body_param.default_content_type and not same_content_type:
+                        retval.append(
+                            f'    content_type = content_type or "{body_param.default_content_type}"{check_body_suffix}'
+                        )
+                    retval.extend(f"    {l}" for l in self._create_body_parameter(cast(OperationType, overload)))
         return retval
 
     def _create_request_builder_call(

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

@@ -182,11 +182,10 @@ class ClientSerializer:
             retval.append("self._serialize.client_side_validation = False")
         operation_groups = [og for og in self.client.operation_groups if not og.is_mixin]
         for og in operation_groups:
-            api_version = ""
             retval.extend(
                 [
                     f"self.{og.property_name} = {og.class_name}(",
-                    f"    self._client, self._config, self._serialize, self._deserialize{api_version}",
+                    "    self._client, self._config, self._serialize, self._deserialize",
                     ")",
                 ]
             )

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

@@ -23,7 +23,7 @@ VERSION_MAP = {
     "msrest": "0.7.1",
     "isodate": "0.6.1",
     "azure-mgmt-core": "1.6.0",
-    "azure-core": "1.36.0",
+    "azure-core": "1.37.0",
     "typing-extensions": "4.6.0",
     "corehttp": "1.0.0b6",
 }

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

@@ -285,6 +285,9 @@ class DpgModelSerializer(_ModelSerializer):
                 file_import.add_submodule_import("typing", "overload", ImportType.STDLIB)
                 file_import.add_submodule_import("typing", "Mapping", ImportType.STDLIB)
                 file_import.add_submodule_import("typing", "Any", ImportType.STDLIB)
+        # if there is a property named `list` we have to make sure there's no conflict with the built-in `list`
+        if self.code_model.has_property_named_list:
+            file_import.define_mypy_type("List", "list")
         return file_import
 
     def declare_model(self, model: ModelType) -> str:

package/generator/pygen/codegen/templates/enum.py.jinja2

@@ -1,5 +1,7 @@
 
-class {{ enum.name }}({{ enum.value_type.type_annotation(is_operation_file=False) }}, Enum, metaclass=CaseInsensitiveEnumMeta):
+class {{ enum.name }}({{enum.pylint_disable()}}
+  {{ enum.value_type.type_annotation(is_operation_file=False) }}, Enum, metaclass=CaseInsensitiveEnumMeta
+):
     {% if enum.yaml_data.get("description") %}
     """{{ op_tools.wrap_string(enum.yaml_data["description"], "\n    ") }}
     """

package/generator/pygen/codegen/templates/model_base.py.jinja2

@@ -36,6 +36,7 @@ __all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"]
 
 TZ_UTC = timezone.utc
 _T = typing.TypeVar("_T")
+_NONE_TYPE = type(None)
 
 {% if code_model.has_external_type %}
 TYPE_HANDLER_REGISTRY = TypeHandlerRegistry()
@@ -223,7 +224,7 @@ def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime:
     test_utc = date_obj.utctimetuple()
     if test_utc.tm_year > 9999 or test_utc.tm_year < 1:
         raise OverflowError("Hit max or min date")
-    return date_obj
+    return date_obj  # type: ignore[no-any-return]
 
 
 def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime:
@@ -277,7 +278,7 @@ def _deserialize_time(attr: typing.Union[str, time]) -> time:
     """
     if isinstance(attr, time):
         return attr
-    return isodate.parse_time(attr)
+    return isodate.parse_time(attr)  # type: ignore[no-any-return]
 
 
 def _deserialize_bytes(attr):
@@ -916,16 +917,16 @@ def _get_deserialize_callable_from_annotation(  # pylint: disable=too-many-retur
 
     # is it optional?
     try:
-        if any(a for a in annotation.__args__ if a == type(None)):  # pyright: ignore
+        if any(a is _NONE_TYPE for a in annotation.__args__):  # pyright: ignore
             if len(annotation.__args__) <= 2:  # pyright: ignore
                 if_obj_deserializer = _get_deserialize_callable_from_annotation(
-                    next(a for a in annotation.__args__ if a != type(None)), module, rf  # pyright: ignore
+                    next(a for a in annotation.__args__ if a is not _NONE_TYPE), module, rf  # pyright: ignore
                 )
 
                 return functools.partial(_deserialize_with_optional, if_obj_deserializer)
             # the type is Optional[Union[...]], we need to remove the None type from the Union
             annotation_copy = copy.copy(annotation)
-            annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a != type(None)]  # pyright: ignore
+            annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a is not _NONE_TYPE]  # pyright: ignore
             return _get_deserialize_callable_from_annotation(annotation_copy, module, rf)
     except AttributeError:
         pass
@@ -1327,7 +1328,7 @@ def _get_wrapped_element(
         _get_element(v, exclude_readonly, meta, wrapped_element)
     else:
         wrapped_element.text = _get_primitive_type_value(v)
-    return wrapped_element
+    return wrapped_element  # type: ignore[no-any-return]
 
 
 def _get_primitive_type_value(v) -> str:
@@ -1340,7 +1341,9 @@ def _get_primitive_type_value(v) -> str:
     return str(v)
 
 
-def _create_xml_element(tag, prefix=None, ns=None):
+def _create_xml_element(
+  tag: typing.Any, prefix: typing.Optional[str] = None, ns: typing.Optional[str] = None
+) -> ET.Element:
     if prefix and ns:
         ET.register_namespace(prefix, ns)
     if ns:

package/generator/test/azure/mock_api_tests/asynctests/test_azure_arm_operationtemplates_async.py

@@ -174,3 +174,20 @@ async def test_optional_body_provider_post_with_body(client):
     )
     assert result.total_allowed == 100
     assert result.status == "Changed to requested allowance"
+
+
+@pytest.mark.asyncio
+async def test_lro_paging_begin_post_paging_lro(client):
+    poller = await client.lro_paging.begin_post_paging_lro(
+        resource_group_name=RESOURCE_GROUP_NAME,
+        product_name="default",
+    )
+    result = await poller.result()
+    items = [item async for item in result]
+    assert len(items) == 2
+    assert items[0].name == "product1"
+    assert items[0].properties.product_id == "product1"
+    assert items[0].properties.provisioning_state == "Succeeded"
+    assert items[1].name == "product2"
+    assert items[1].properties.product_id == "product2"
+    assert items[1].properties.provisioning_state == "Succeeded"

package/generator/test/azure/mock_api_tests/asynctests/test_azure_client_generator_core_client_default_value_async.py

@@ -0,0 +1,46 @@
+# -------------------------------------------------------------------------
+# 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 specs.azure.clientgenerator.core.clientdefaultvalue.aio import ClientDefaultValueClient
+from specs.azure.clientgenerator.core.clientdefaultvalue.models import ModelWithDefaultValues
+
+
+@pytest.fixture
+async def client():
+    async with ClientDefaultValueClient() as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async def test_put_model_property(client: ClientDefaultValueClient):
+    """Test case 1: @clientDefaultValue for model property."""
+    body = ModelWithDefaultValues(name="test")
+    result = await client.put_model_property(body=body)
+    assert result.name == "test"
+    assert result.timeout == 30
+    assert result.tier == "standard"
+    assert result.retry is True
+
+
+@pytest.mark.asyncio
+async def test_get_operation_parameter(client: ClientDefaultValueClient):
+    """Test case 2: @clientDefaultValue for operation parameter."""
+    # Test with only required parameter (name), defaults should be applied
+    await client.get_operation_parameter(name="test")
+
+
+@pytest.mark.asyncio
+async def test_get_path_parameter(client: ClientDefaultValueClient):
+    """Test case 3: @clientDefaultValue for first path segment."""
+    # Test with only required segment2, segment1 should use default
+    await client.get_path_parameter(segment2="segment2")
+
+
+@pytest.mark.asyncio
+async def test_get_header_parameter(client: ClientDefaultValueClient):
+    """Test case 4: @clientDefaultValue for header parameters."""
+    # Test with default header values
+    await client.get_header_parameter()

package/generator/test/azure/mock_api_tests/asynctests/test_azure_client_generator_core_client_location_async.py

@@ -4,52 +4,79 @@
 # license information.
 # --------------------------------------------------------------------------
 import pytest
-from specs.azure.clientgenerator.core.clientlocation.aio import ClientLocationClient
+from specs.azure.clientgenerator.core.clientlocation.parameter.aio import MoveMethodParameterToClient
+from specs.azure.clientgenerator.core.clientlocation.subclient.aio import MoveToExistingSubClient
+from specs.azure.clientgenerator.core.clientlocation.newsubclient.aio import MoveToNewSubClient
+from specs.azure.clientgenerator.core.clientlocation.rootclient.aio import MoveToRootClient
 
 
 @pytest.fixture
-async def client():
-    async with ClientLocationClient(storage_account="testaccount") as client:
+async def move_method_parameter_to_client():
+    async with MoveMethodParameterToClient(storage_account="testaccount") as client:
+        yield client
+
+
+@pytest.fixture
+async def move_to_existing_sub_client():
+    async with MoveToExistingSubClient() as client:
+        yield client
+
+
+@pytest.fixture
+async def move_to_new_sub_client():
+    async with MoveToNewSubClient() as client:
+        yield client
+
+
+@pytest.fixture
+async def move_to_root_client():
+    async with MoveToRootClient() as client:
         yield client
 
 
 @pytest.mark.asyncio
-async def test_get_health_status(client: ClientLocationClient):
-    await client.get_health_status()
+async def test_move_method_parameter_to_client_blob_operations_get_blob(
+    move_method_parameter_to_client: MoveMethodParameterToClient,
+):
+    await move_method_parameter_to_client.blob_operations.get_blob(container="testcontainer", blob="testblob.txt")
 
 
 @pytest.mark.asyncio
-async def test_archive_operations_archive_product(client: ClientLocationClient):
-    await client.archive_operations.archive_product()
+async def test_move_to_existing_sub_client_user_operations_get_user(
+    move_to_existing_sub_client: MoveToExistingSubClient,
+):
+    await move_to_existing_sub_client.user_operations.get_user()
 
 
 @pytest.mark.asyncio
-async def test_move_to_existing_sub_client_admin_operations_get_admin_info(client: ClientLocationClient):
-    await client.move_to_existing_sub_client.admin_operations.get_admin_info()
+async def test_move_to_existing_sub_client_admin_operations_delete_user(
+    move_to_existing_sub_client: MoveToExistingSubClient,
+):
+    await move_to_existing_sub_client.admin_operations.delete_user()
 
 
 @pytest.mark.asyncio
-async def test_move_to_existing_sub_client_admin_operations_delete_user(client: ClientLocationClient):
-    await client.move_to_existing_sub_client.admin_operations.delete_user()
+async def test_move_to_existing_sub_client_admin_operations_get_admin_info(
+    move_to_existing_sub_client: MoveToExistingSubClient,
+):
+    await move_to_existing_sub_client.admin_operations.get_admin_info()
 
 
 @pytest.mark.asyncio
-async def test_move_to_existing_sub_client_user_operations_get_user(client: ClientLocationClient):
-    await client.move_to_existing_sub_client.user_operations.get_user()
+async def test_move_to_new_sub_client_product_operations_list_products(move_to_new_sub_client: MoveToNewSubClient):
+    await move_to_new_sub_client.product_operations.list_products()
 
 
 @pytest.mark.asyncio
-async def test_move_to_new_sub_client_product_operations_list_products(client: ClientLocationClient):
-    await client.move_to_new_sub_client.product_operations.list_products()
+async def test_move_to_new_sub_client_archive_operations_archive_product(move_to_new_sub_client: MoveToNewSubClient):
+    await move_to_new_sub_client.archive_operations.archive_product()
 
 
 @pytest.mark.asyncio
-async def test_move_to_root_client_resource_operations_get_resource(client: ClientLocationClient):
-    await client.move_to_root_client.resource_operations.get_resource()
+async def test_move_to_root_client_resource_operations_get_resource(move_to_root_client: MoveToRootClient):
+    await move_to_root_client.resource_operations.get_resource()
 
 
 @pytest.mark.asyncio
-async def test_move_method_parameter_to_client_blob_operations_get_blob(client: ClientLocationClient):
-    await client.move_method_parameter_to_client.blob_operations.get_blob(
-        container="testcontainer", blob="testblob.txt"
-    )
+async def test_move_to_root_client_get_health_status(move_to_root_client: MoveToRootClient):
+    await move_to_root_client.get_health_status()

package/generator/test/azure/mock_api_tests/asynctests/test_azure_resource_manager_multi_service_async.py

@@ -0,0 +1,110 @@
+# -------------------------------------------------------------------------
+# 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 azure.core.exceptions import HttpResponseError
+from azure.resourcemanager.multiservice.combined.aio import CombinedClient
+from azure.resourcemanager.multiservice.combined.models import VirtualMachine, Disk
+
+
+@pytest.fixture
+async def client(credential, authentication_policy):
+    """Create a Combined async client for testing."""
+    return CombinedClient(
+        credential=credential,
+        subscription_id="00000000-0000-0000-0000-000000000000",
+        base_url="http://localhost:3000",
+        authentication_policy=authentication_policy,
+        polling_interval=0.1,  # Speed up tests by reducing polling interval
+    )
+
+
+@pytest.mark.asyncio
+async def test_virtual_machines_get(client):
+    resource_group_name = "test-rg"
+    vm_name = "vm1"
+
+    with pytest.raises(HttpResponseError):
+        await client.virtual_machines.get(
+            resource_group_name=resource_group_name,
+            vm_name=vm_name,
+            api_version="av1",  # invalid api version shall raise error
+        )
+
+    result = await client.virtual_machines.get(resource_group_name=resource_group_name, vm_name=vm_name)
+
+    assert result is not None
+    assert isinstance(result, VirtualMachine)
+    assert result.name == vm_name
+
+
+@pytest.mark.asyncio
+async def test_virtual_machines_create_or_update(client):
+    resource_group_name = "test-rg"
+    vm_name = "vm1"
+
+    vm_resource = VirtualMachine(location="eastus", properties={})
+
+    with pytest.raises(HttpResponseError):
+        poller = await client.virtual_machines.begin_create_or_update(
+            resource_group_name=resource_group_name,
+            vm_name=vm_name,
+            resource=vm_resource,
+            api_version="av1",  # invalid api version shall raise error
+        )
+        await poller.result()
+
+    poller = await client.virtual_machines.begin_create_or_update(
+        resource_group_name=resource_group_name, vm_name=vm_name, resource=vm_resource
+    )
+
+    result = await poller.result()
+    assert result is not None
+    assert isinstance(result, VirtualMachine)
+    assert result.location == "eastus"
+
+
+@pytest.mark.asyncio
+async def test_disks_get(client):
+    resource_group_name = "test-rg"
+    disk_name = "disk1"
+    with pytest.raises(HttpResponseError):
+        await client.disks.get(
+            resource_group_name=resource_group_name,
+            disk_name=disk_name,
+            api_version="av1",  # invalid api version shall raise error
+        )
+
+    result = await client.disks.get(resource_group_name=resource_group_name, disk_name=disk_name)
+
+    assert result is not None
+    assert isinstance(result, Disk)
+    assert result.name == disk_name
+
+
+@pytest.mark.asyncio
+async def test_disks_create_or_update(client):
+    resource_group_name = "test-rg"
+    disk_name = "disk1"
+
+    disk_resource = Disk(location="eastus", properties={})
+
+    with pytest.raises(HttpResponseError):
+        poller = await client.disks.begin_create_or_update(
+            resource_group_name=resource_group_name,
+            disk_name=disk_name,
+            resource=disk_resource,
+            api_version="av1",  # invalid api version shall raise error
+        )
+        await poller.result()
+
+    poller = await client.disks.begin_create_or_update(
+        resource_group_name=resource_group_name, disk_name=disk_name, resource=disk_resource
+    )
+
+    result = await poller.result()
+    assert result is not None
+    assert isinstance(result, Disk)
+    assert result.location == "eastus"

package/generator/test/azure/mock_api_tests/asynctests/test_payload_multipart_async.py

@@ -151,3 +151,36 @@ async def test_complex_with_http_part(client: MultiPartClient):
 @pytest.mark.asyncio
 async def test_http_parts_non_string_float(client: MultiPartClient):
     await client.form_data.http_parts.non_string.float(models.FloatRequest(temperature=0.5))
+
+
+@pytest.mark.asyncio
+async def test_with_wire_name(client: MultiPartClient):
+    await client.form_data.with_wire_name(
+        models.MultiPartRequestWithWireName(
+            identifier="123",
+            image=open(str(JPG), "rb"),
+        )
+    )
+
+
+@pytest.mark.asyncio
+async def test_optional_parts(client: MultiPartClient):
+    # First time with only id
+    await client.form_data.optional_parts(
+        models.MultiPartOptionalRequest(
+            id="123",
+        )
+    )
+    # Second time with only profileImage
+    await client.form_data.optional_parts(
+        models.MultiPartOptionalRequest(
+            profile_image=open(str(JPG), "rb"),
+        )
+    )
+    # Third time with both id and profileImage
+    await client.form_data.optional_parts(
+        models.MultiPartOptionalRequest(
+            id="123",
+            profile_image=open(str(JPG), "rb"),
+        )
+    )

package/generator/test/azure/mock_api_tests/asynctests/test_service_multi_service_async.py

@@ -0,0 +1,31 @@
+# -------------------------------------------------------------------------
+# 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 azure.core.exceptions import HttpResponseError
+from service.multiservice.aio import CombinedClient
+from service.multiservice.models import VersionsA, VersionsB
+
+
+@pytest.fixture
+def client():
+    """Fixture that creates a CombinedClient for testing."""
+    return CombinedClient(endpoint="http://localhost:3000")
+
+
+@pytest.mark.asyncio
+async def test_service_multi_service_foo(client):
+    with pytest.raises(HttpResponseError):
+        await client.foo.test(api_version=VersionsA.AV1)
+
+    await client.foo.test()
+
+
+@pytest.mark.asyncio
+async def test_service_multi_service_bar(client):
+    with pytest.raises(HttpResponseError):
+        await client.bar.test(api_version=VersionsB.BV1)
+
+    await client.bar.test()

package/generator/test/azure/mock_api_tests/asynctests/test_special_words_async.py

@@ -40,3 +40,21 @@ async def test_model(client: SpecialWordsClient, special_words):
 @pytest.mark.asyncio
 async def test_model_properties(client: SpecialWordsClient):
     await client.model_properties.same_as_model(models.SameAsModel(same_as_model="ok"))
+
+
+@pytest.mark.asyncio
+async def test_model_properties_dict_methods(client: SpecialWordsClient):
+    await client.model_properties.dict_methods(
+        body=models.DictMethods(
+            keys_property="ok",
+            items_property="ok",
+            values_property="ok",
+            popitem_property="ok",
+            clear_property="ok",
+            update_property="ok",
+            setdefault_property="ok",
+            pop_property="ok",
+            get_property="ok",
+            copy_property="ok",
+        )
+    )

package/generator/test/azure/mock_api_tests/test_azure_arm_operationtemplates.py

@@ -154,3 +154,18 @@ def test_optional_body_provider_post_with_body(client):
     )
     assert result.total_allowed == 100
     assert result.status == "Changed to requested allowance"
+
+
+def test_lro_paging_begin_post_paging_lro(client):
+    result = client.lro_paging.begin_post_paging_lro(
+        resource_group_name=RESOURCE_GROUP_NAME,
+        product_name="default",
+    ).result()
+    items = list(result)
+    assert len(items) == 2
+    assert items[0].name == "product1"
+    assert items[0].properties.product_id == "product1"
+    assert items[0].properties.provisioning_state == "Succeeded"
+    assert items[1].name == "product2"
+    assert items[1].properties.product_id == "product2"
+    assert items[1].properties.provisioning_state == "Succeeded"

package/generator/test/azure/mock_api_tests/test_azure_client_generator_core_client_default_value.py

@@ -0,0 +1,42 @@
+# -------------------------------------------------------------------------
+# 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 specs.azure.clientgenerator.core.clientdefaultvalue import ClientDefaultValueClient
+from specs.azure.clientgenerator.core.clientdefaultvalue.models import ModelWithDefaultValues
+
+
+@pytest.fixture
+def client():
+    with ClientDefaultValueClient() as client:
+        yield client
+
+
+def test_put_model_property(client: ClientDefaultValueClient):
+    """Test case 1: @clientDefaultValue for model property."""
+    body = ModelWithDefaultValues(name="test")
+    result = client.put_model_property(body=body)
+    assert result.name == "test"
+    assert result.timeout == 30
+    assert result.tier == "standard"
+    assert result.retry is True
+
+
+def test_get_operation_parameter(client: ClientDefaultValueClient):
+    """Test case 2: @clientDefaultValue for operation parameter."""
+    # Test with only required parameter (name), defaults should be applied
+    client.get_operation_parameter(name="test")
+
+
+def test_get_path_parameter(client: ClientDefaultValueClient):
+    """Test case 3: @clientDefaultValue for first path segment."""
+    # Test with only required segment2, segment1 should use default
+    client.get_path_parameter(segment2="segment2")
+
+
+def test_get_header_parameter(client: ClientDefaultValueClient):
+    """Test case 4: @clientDefaultValue for header parameters."""
+    # Test with default header values
+    client.get_header_parameter()