@typespec/http-client-python 0.27.1 → 0.28.0

package/generator/test/unittests/test_model_base_serialization.py

@@ -4743,3 +4743,164 @@ def test_dictionary_set_datetime():
     assert dict_ref1 is dict_ref2
     assert isinstance(dict_ref1["start"], datetime)
     assert isinstance(dict_ref2["start"], datetime)
+
+
+def test_eq_same_model_instances():
+    """Two model instances with the same data should be equal."""
+    model1 = BasicResource(
+        platform_update_domain_count=5,
+        platform_fault_domain_count=3,
+        virtual_machines=[],
+    )
+    model2 = BasicResource(
+        platform_update_domain_count=5,
+        platform_fault_domain_count=3,
+        virtual_machines=[],
+    )
+    assert model1 == model2
+
+
+def test_eq_different_model_data():
+    """Two model instances with different data should not be equal."""
+    model1 = BasicResource(
+        platform_update_domain_count=5,
+        platform_fault_domain_count=3,
+        virtual_machines=[],
+    )
+    model2 = BasicResource(
+        platform_update_domain_count=10,
+        platform_fault_domain_count=3,
+        virtual_machines=[],
+    )
+    assert model1 != model2
+
+
+def test_eq_model_constructed_from_dict():
+    """A model created via kwargs and a model created from a dict should be equal."""
+    dict_response = {
+        "platformUpdateDomainCount": 5,
+        "platformFaultDomainCount": 3,
+        "virtualMachines": [],
+    }
+    model_from_kwargs = BasicResource(
+        platform_update_domain_count=5,
+        platform_fault_domain_count=3,
+        virtual_machines=[],
+    )
+    model_from_dict = BasicResource(dict_response)
+    assert model_from_kwargs == model_from_dict
+
+
+def test_eq_model_equal_to_plain_dict():
+    """A model should be equal to a plain dict with matching data (backward compat)."""
+    dict_response = {
+        "platformUpdateDomainCount": 5,
+        "platformFaultDomainCount": 3,
+        "virtualMachines": [],
+    }
+    model = BasicResource(
+        platform_update_domain_count=5,
+        platform_fault_domain_count=3,
+        virtual_machines=[],
+    )
+    assert model == dict_response
+
+
+def test_eq_model_not_equal_to_non_model_types():
+    """A model should not be equal to strings, ints, None, or lists."""
+    model = BasicResource(
+        platform_update_domain_count=5,
+        platform_fault_domain_count=3,
+        virtual_machines=[],
+    )
+    assert model != "some string"
+    assert model != 42
+    assert model != None  # noqa: E711
+    assert model != []
+    assert model != True  # noqa: E712
+
+
+def test_eq_different_model_types_same_data():
+    """Two different model types with the same underlying _data should be equal
+    since isinstance checks against _MyMutableMapping, not the specific subclass."""
+    model1 = Pet(name="test", species="dog")
+
+    class AnotherModel(Model):
+        name: str = rest_field()
+        species: str = rest_field()
+
+        @overload
+        def __init__(self, *, name: str, species: str): ...
+
+        @overload
+        def __init__(self, mapping: Mapping[str, Any], /): ...
+
+        def __init__(self, *args, **kwargs):
+            super().__init__(*args, **kwargs)
+
+    model2 = AnotherModel(name="test", species="dog")
+    assert model1 == model2
+
+
+def test_ne_is_inverse_of_eq():
+    """__ne__ should return the inverse of __eq__."""
+    model1 = BasicResource(
+        platform_update_domain_count=5,
+        platform_fault_domain_count=3,
+        virtual_machines=[],
+    )
+    model2 = BasicResource(
+        platform_update_domain_count=5,
+        platform_fault_domain_count=3,
+        virtual_machines=[],
+    )
+    model3 = BasicResource(
+        platform_update_domain_count=10,
+        platform_fault_domain_count=3,
+        virtual_machines=[],
+    )
+    assert not (model1 != model2)
+    assert model1 != model3
+
+
+def test_eq_nested_models():
+    """Two models with identical nested model children should be equal."""
+    model1 = OptionalModel(
+        optional_str="hello",
+        optional_time=datetime.time(11, 34, 56),
+        optional_dict={
+            "buddy": Pet(name="Buddy", species="Dog"),
+        },
+        optional_myself=OptionalModel(optional_str="inner"),
+    )
+    model2 = OptionalModel(
+        optional_str="hello",
+        optional_time=datetime.time(11, 34, 56),
+        optional_dict={
+            "buddy": Pet(name="Buddy", species="Dog"),
+        },
+        optional_myself=OptionalModel(optional_str="inner"),
+    )
+    assert model1 == model2
+
+    # Change the nested model's data — they should no longer be equal
+    model2_different_inner = OptionalModel(
+        optional_str="hello",
+        optional_time=datetime.time(11, 34, 56),
+        optional_dict={
+            "buddy": Pet(name="Buddy", species="Dog"),
+        },
+        optional_myself=OptionalModel(optional_str="different"),
+    )
+    assert model1 != model2_different_inner
+
+    # Change the nested Pet — they should no longer be equal
+    model2_different_pet = OptionalModel(
+        optional_str="hello",
+        optional_time=datetime.time(11, 34, 56),
+        optional_dict={
+            "buddy": Pet(name="Max", species="Cat"),
+        },
+        optional_myself=OptionalModel(optional_str="inner"),
+    )
+    assert model1 != model2_different_pet

package/generator/test/unittests/test_model_base_xml_serialization.py

@@ -4,7 +4,7 @@
 # ------------------------------------
 import xml.etree.ElementTree as ET
 
-from typing import Literal
+from typing import Literal, Optional
 
 from specialwords._utils.model_base import (
     _get_element,
@@ -165,7 +165,7 @@ class TestXmlDeserialization:
             _xml = {"name": "Data"}
 
         result = _deserialize_xml(XmlModel, basic_xml)
-        assert result.age is None
+        assert result.age == []
 
     def test_list_wrapped_items_name_basic_types(self):
         """Test XML list and wrap, items is basic type and there is itemsName."""
@@ -515,6 +515,248 @@ class TestXmlDeserialization:
         assert isinstance(result.filter, CorrelationFilter)
         assert result.filter.correlation_id == 12
 
+    def test_enumeration_results(self):
+        """Test deserializing an Azure Blob Storage EnumerationResults XML payload."""
+        xml_payload = '<?xml version="1.0" encoding="utf-8"?><EnumerationResults ServiceEndpoint="https://service.blob.core.windows.net/" ContainerName="my-container-108f32e8"><Delimiter>/</Delimiter><Blobs /><NextMarker /></EnumerationResults>'
+
+        class EnumerationResults(Model):
+            service_endpoint: str = rest_field(
+                name="ServiceEndpoint", xml={"name": "ServiceEndpoint", "attribute": True}
+            )
+            container_name: str = rest_field(name="ContainerName", xml={"name": "ContainerName", "attribute": True})
+            delimiter: str = rest_field(name="Delimiter", xml={"name": "Delimiter"})
+            blobs: list[str] = rest_field(name="Blobs", xml={"name": "Blobs"})
+            next_marker: str = rest_field(name="NextMarker", xml={"name": "NextMarker"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "EnumerationResults"}
+
+        result = _deserialize_xml(EnumerationResults, xml_payload)
+
+        assert result.service_endpoint == "https://service.blob.core.windows.net/"
+        assert result.container_name == "my-container-108f32e8"
+        assert result.delimiter == "/"
+        assert result.blobs == []
+        assert result.next_marker == ""
+
+    def test_enumeration_results_nested_empty_list(self):
+        """Test deserializing XML where a container element holds a nested empty list (e.g. Blobs/BlobPrefixes)."""
+        xml_payload = '<?xml version="1.0" encoding="utf-8"?><EnumerationResults ServiceEndpoint="https://service.blob.core.windows.net/" ContainerName="my-container"><Delimiter>/</Delimiter><Blobs><BlobPrefixes /></Blobs><NextMarker /></EnumerationResults>'
+
+        class BlobPrefix(Model):
+            name: str = rest_field(name="Name", xml={"name": "Name"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "BlobPrefix"}
+
+        class BlobsSegment(Model):
+            blob_prefixes: list[BlobPrefix] = rest_field(
+                name="BlobPrefixes", xml={"name": "BlobPrefixes", "itemsName": "BlobPrefix"}
+            )
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "Blobs"}
+
+        class EnumerationResults(Model):
+            service_endpoint: str = rest_field(
+                name="ServiceEndpoint", xml={"name": "ServiceEndpoint", "attribute": True}
+            )
+            container_name: str = rest_field(name="ContainerName", xml={"name": "ContainerName", "attribute": True})
+            delimiter: str = rest_field(name="Delimiter", xml={"name": "Delimiter"})
+            blobs: BlobsSegment = rest_field(name="Blobs", xml={"name": "Blobs"})
+            next_marker: str = rest_field(name="NextMarker", xml={"name": "NextMarker"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "EnumerationResults"}
+
+        result = _deserialize_xml(EnumerationResults, xml_payload)
+
+        assert result.service_endpoint == "https://service.blob.core.windows.net/"
+        assert result.container_name == "my-container"
+        assert result.delimiter == "/"
+        assert result.blobs.blob_prefixes == []
+        assert result.next_marker == ""
+
+    def test_enumeration_results_azure_sdk_pattern(self):
+        """Test the real Azure SDK model pattern where BlobsSegment has two unwrapped list fields."""
+        # Both blob_prefixes and blob_items are unwrapped lists (items appear directly in <Blobs>).
+        # With <Blobs />, no matching children are found so both are None.
+        xml_payload = '<?xml version="1.0" encoding="utf-8"?><EnumerationResults ServiceEndpoint="https://service.blob.core.windows.net/" ContainerName="my-container"><Delimiter>/</Delimiter><Blobs /><NextMarker /></EnumerationResults>'
+
+        class BlobPrefix(Model):
+            name: str = rest_field(name="Name", xml={"name": "Name"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "BlobPrefix"}
+
+        class BlobItem(Model):
+            name: str = rest_field(name="Name", xml={"name": "Name"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "Blob"}
+
+        class BlobsSegment(Model):
+            blob_prefixes: list[BlobPrefix] = rest_field(
+                name="blob_prefixes", xml={"name": "BlobPrefix", "unwrapped": True}
+            )
+            blob_items: list[BlobItem] = rest_field(name="blob_items", xml={"name": "Blob", "unwrapped": True})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "Blobs"}
+
+        class EnumerationResults(Model):
+            service_endpoint: str = rest_field(
+                name="ServiceEndpoint", xml={"name": "ServiceEndpoint", "attribute": True}
+            )
+            container_name: str = rest_field(name="ContainerName", xml={"name": "ContainerName", "attribute": True})
+            delimiter: str = rest_field(name="Delimiter", xml={"name": "Delimiter"})
+            blobs: BlobsSegment = rest_field(name="Blobs", xml={"name": "Blobs"})
+            next_marker: str = rest_field(name="NextMarker", xml={"name": "NextMarker"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "EnumerationResults"}
+
+        result = _deserialize_xml(EnumerationResults, xml_payload)
+
+        assert result.service_endpoint == "https://service.blob.core.windows.net/"
+        assert result.container_name == "my-container"
+        assert result.delimiter == "/"
+        assert isinstance(result.blobs, BlobsSegment)
+        # With <Blobs />, no <BlobPrefix> or <Blob> children exist → unwrapped non-optional lists default to []
+        assert result.blobs.blob_prefixes == []
+        assert result.blobs.blob_items == []
+        assert result.next_marker == ""
+
+    def test_enumeration_results_azure_sdk_pattern_optional(self):
+        """Test the Azure SDK pattern where unwrapped list fields are Optional[list[X]].
+
+        When the type is Optional[list[X]], empty unwrapped lists should stay None
+        (the element is absent, and None is a valid value for the optional type).
+        """
+        xml_payload = '<?xml version="1.0" encoding="utf-8"?><EnumerationResults ServiceEndpoint="https://service.blob.core.windows.net/" ContainerName="my-container"><Delimiter>/</Delimiter><Blobs /><NextMarker /></EnumerationResults>'
+
+        class BlobPrefix(Model):
+            name: str = rest_field(name="Name", xml={"name": "Name"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "BlobPrefix"}
+
+        class BlobItem(Model):
+            name: str = rest_field(name="Name", xml={"name": "Name"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "Blob"}
+
+        class BlobsSegment(Model):
+            blob_prefixes: Optional[list[BlobPrefix]] = rest_field(
+                name="blob_prefixes", xml={"name": "BlobPrefix", "unwrapped": True}
+            )
+            blob_items: Optional[list[BlobItem]] = rest_field(
+                name="blob_items", xml={"name": "Blob", "unwrapped": True}
+            )
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "Blobs"}
+
+        class EnumerationResults(Model):
+            service_endpoint: str = rest_field(
+                name="ServiceEndpoint", xml={"name": "ServiceEndpoint", "attribute": True}
+            )
+            container_name: str = rest_field(name="ContainerName", xml={"name": "ContainerName", "attribute": True})
+            delimiter: str = rest_field(name="Delimiter", xml={"name": "Delimiter"})
+            blobs: BlobsSegment = rest_field(name="Blobs", xml={"name": "Blobs"})
+            next_marker: str = rest_field(name="NextMarker", xml={"name": "NextMarker"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "EnumerationResults"}
+
+        result = _deserialize_xml(EnumerationResults, xml_payload)
+
+        assert result.service_endpoint == "https://service.blob.core.windows.net/"
+        assert result.container_name == "my-container"
+        assert result.delimiter == "/"
+        assert isinstance(result.blobs, BlobsSegment)
+        # With <Blobs />, no <BlobPrefix> or <Blob> children exist → Optional lists stay None
+        assert result.blobs.blob_prefixes is None
+        assert result.blobs.blob_items is None
+        assert result.next_marker == ""
+
+    def test_enumeration_results_blobs_unwrapped(self):
+        """Test what happens when the blobs field itself is declared with unwrapped=True."""
+        # When a non-list model field uses unwrapped=True, the matching XML elements are collected
+        # as a list and stored as-is (the field receives a list of ET.Element objects).
+        xml_payload = '<?xml version="1.0" encoding="utf-8"?><EnumerationResults ServiceEndpoint="https://service.blob.core.windows.net/" ContainerName="my-container"><Delimiter>/</Delimiter><Blobs /><NextMarker /></EnumerationResults>'
+
+        class BlobPrefix(Model):
+            name: str = rest_field(name="Name", xml={"name": "Name"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "BlobPrefix"}
+
+        class BlobsSegment(Model):
+            blob_prefixes: list[BlobPrefix] = rest_field(
+                name="BlobPrefixes", xml={"name": "BlobPrefixes", "itemsName": "BlobPrefix"}
+            )
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "Blobs"}
+
+        class EnumerationResults(Model):
+            service_endpoint: str = rest_field(
+                name="ServiceEndpoint", xml={"name": "ServiceEndpoint", "attribute": True}
+            )
+            container_name: str = rest_field(name="ContainerName", xml={"name": "ContainerName", "attribute": True})
+            delimiter: str = rest_field(name="Delimiter", xml={"name": "Delimiter"})
+            # unwrapped=True on a model-typed field: the deserialization collects matching XML
+            # elements as a list (rather than deserializing them into the model).
+            blobs: BlobsSegment = rest_field(name="Blobs", xml={"name": "Blobs", "unwrapped": True})
+            next_marker: str = rest_field(name="NextMarker", xml={"name": "NextMarker"})
+
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+
+            _xml = {"name": "EnumerationResults"}
+
+        result = _deserialize_xml(EnumerationResults, xml_payload)
+
+        assert result.service_endpoint == "https://service.blob.core.windows.net/"
+        assert result.container_name == "my-container"
+        assert result.delimiter == "/"
+        # unwrapped=True on a model field collects matching elements; <Blobs /> is found so it
+        # returns a list containing the raw ET.Element instead of a deserialized BlobsSegment.
+        assert isinstance(result.blobs, list)
+        assert len(result.blobs) == 1
+        assert isinstance(result.blobs[0], ET.Element)
+        assert result.next_marker == ""
+
 
 class TestXmlSerialization:
     def test_basic(self):

package/generator/test/unittests/test_name_converter.py

@@ -33,11 +33,3 @@ def test_escaped_reserved_words():
     }
     for name in expected_conversion_parameter:
         assert pad_reserved_words(name, pad_type=PadType.PARAMETER) == expected_conversion_parameter[name]
-
-    expected_conversion_enum = {
-        "self": "self",
-        "mro": "mro_enum",
-        "continuation_token": "continuation_token",
-    }
-    for name in expected_conversion_enum:
-        assert pad_reserved_words(name, pad_type=PadType.ENUM_VALUE) == expected_conversion_enum[name]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.27.1",
+  "version": "0.28.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",
@@ -54,55 +54,55 @@
     "emitter"
   ],
   "peerDependencies": {
-    "@azure-tools/typespec-autorest": ">=0.65.0 <1.0.0",
-    "@azure-tools/typespec-azure-core": ">=0.65.0 <1.0.0",
-    "@azure-tools/typespec-azure-resource-manager": ">=0.65.0 <1.0.0",
-    "@azure-tools/typespec-azure-rulesets": ">=0.65.0 <1.0.0",
-    "@azure-tools/typespec-client-generator-core": ">=0.65.0 <1.0.0",
-    "@typespec/compiler": "^1.9.0",
-    "@typespec/http": "^1.9.0",
-    "@typespec/openapi": "^1.9.0",
-    "@typespec/rest": ">=0.79.0 <1.0.0",
-    "@typespec/versioning": ">=0.79.0 <1.0.0",
-    "@typespec/events": ">=0.79.0 <1.0.0",
-    "@typespec/sse": ">=0.79.0 <1.0.0",
-    "@typespec/streams": ">=0.79.0 <1.0.0",
-    "@typespec/xml": ">=0.79.0 <1.0.0"
+    "@azure-tools/typespec-autorest": ">=0.66.0 <1.0.0",
+    "@azure-tools/typespec-azure-core": ">=0.66.0 <1.0.0",
+    "@azure-tools/typespec-azure-resource-manager": ">=0.66.0 <1.0.0",
+    "@azure-tools/typespec-azure-rulesets": ">=0.65.1 <1.0.0",
+    "@azure-tools/typespec-client-generator-core": ">=0.66.1 <1.0.0",
+    "@typespec/compiler": "^1.10.0",
+    "@typespec/http": "^1.10.0",
+    "@typespec/openapi": "^1.10.0",
+    "@typespec/rest": ">=0.80.0 <1.0.0",
+    "@typespec/versioning": ">=0.80.0 <1.0.0",
+    "@typespec/events": ">=0.80.0 <1.0.0",
+    "@typespec/sse": ">=0.80.0 <1.0.0",
+    "@typespec/streams": ">=0.80.0 <1.0.0",
+    "@typespec/xml": ">=0.80.0 <1.0.0"
   },
   "dependencies": {
     "js-yaml": "~4.1.0",
     "marked": "^15.0.6",
     "pyodide": "0.26.2",
     "semver": "~7.6.2",
-    "tsx": "~4.19.1"
+    "tsx": "^4.21.0"
   },
   "devDependencies": {
-    "@azure-tools/typespec-autorest": "~0.65.0",
-    "@azure-tools/typespec-azure-core": "~0.65.0",
-    "@azure-tools/typespec-azure-resource-manager": "~0.65.0",
-    "@azure-tools/typespec-azure-rulesets": "~0.65.0",
-    "@azure-tools/typespec-client-generator-core": "~0.65.0",
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.37",
-    "@typespec/compiler": "^1.9.0",
-    "@typespec/http": "^1.9.0",
-    "@typespec/openapi": "^1.9.0",
-    "@typespec/rest": "~0.79.0",
-    "@typespec/versioning": "~0.79.0",
-    "@typespec/events": "~0.79.0",
-    "@typespec/spector": "0.1.0-alpha.23",
-    "@typespec/spec-api": "0.1.0-alpha.12",
-    "@typespec/sse": "~0.79.0",
-    "@typespec/streams": "~0.79.0",
-    "@typespec/xml": "~0.79.0",
-    "@typespec/http-specs": "0.1.0-alpha.32",
+    "@azure-tools/typespec-autorest": "~0.66.0",
+    "@azure-tools/typespec-azure-core": "~0.66.0",
+    "@azure-tools/typespec-azure-resource-manager": "~0.66.0",
+    "@azure-tools/typespec-azure-rulesets": "~0.65.1",
+    "@azure-tools/typespec-client-generator-core": "~0.66.1",
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.38",
+    "@typespec/compiler": "^1.10.0",
+    "@typespec/http": "^1.10.0",
+    "@typespec/openapi": "^1.10.0",
+    "@typespec/rest": "~0.80.0",
+    "@typespec/versioning": "~0.80.0",
+    "@typespec/events": "~0.80.0",
+    "@typespec/spector": "0.1.0-alpha.24",
+    "@typespec/spec-api": "0.1.0-alpha.13",
+    "@typespec/sse": "~0.80.0",
+    "@typespec/streams": "~0.80.0",
+    "@typespec/xml": "~0.80.0",
+    "@typespec/http-specs": "0.1.0-alpha.34",
     "@types/js-yaml": "~4.0.5",
-    "@types/node": "~24.1.0",
+    "@types/node": "~25.0.2",
     "@types/semver": "7.5.8",
     "c8": "^10.1.3",
     "chalk": "5.3.0",
-    "rimraf": "~6.0.1",
-    "typescript": "~5.8.2",
-    "typescript-eslint": "^8.21.0",
-    "vitest": "^3.1.2"
+    "rimraf": "~6.1.2",
+    "typescript": "~5.9.2",
+    "typescript-eslint": "^8.49.0",
+    "vitest": "^4.0.15"
   }
 }