@typespec/http-client-python 0.20.3 → 0.22.0

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

@@ -0,0 +1,251 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+import datetime
+from typing import (
+    Any,
+    Mapping,
+    Optional,
+    overload,
+)
+
+from specs.azure.clientgenerator.core.flattenproperty._utils.model_base import (
+    Model,
+    rest_field,
+)
+from azure.core.serialization import attribute_list
+
+
+class ModelProperty(Model):
+    """This is a test model."""
+
+    value: str = rest_field()
+    """Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        value: str,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class ChildModel(Model):
+    """This is the child model to be flattened.
+
+    :ivar description: Required.
+    :vartype description: str
+    :ivar age: Required.
+    :vartype age: int
+    """
+
+    description: str = rest_field()
+    """Required."""
+    age: int = rest_field()
+    """Required."""
+    model_property: "ModelProperty" = rest_field(name="modelProperty")
+    """Required."""
+    datetime_default: datetime.datetime = rest_field(name="datetimeDefault")
+    datetime_rfc3339: datetime.datetime = rest_field(name="datetimeRfc3339", format="rfc3339")
+    datetime_rfc7231: datetime.datetime = rest_field(name="datetimeRfc7231", format="rfc7231")
+    datetime_unix_timestamp: datetime.datetime = rest_field(name="datetimeUnixTimestamp", format="unix-timestamp")
+
+    @overload
+    def __init__(
+        self,
+        *,
+        description: str,
+        age: int,
+        model_property: "ModelProperty",
+        datetime_default: datetime.datetime,
+        datetime_rfc3339: datetime.datetime,
+        datetime_rfc7231: datetime.datetime,
+        datetime_unix_timestamp: datetime.datetime,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class FlattenModel(Model):
+    """This is the model with one level of flattening."""
+
+    name: str = rest_field()
+    """Required."""
+    properties: "ChildModel" = rest_field()
+    """Required."""
+
+    __flattened_items = [
+        "description",
+        "age",
+        "model_property",
+        "datetime_default",
+        "datetime_rfc3339",
+        "datetime_rfc7231",
+        "datetime_unix_timestamp",
+    ]
+
+    @overload
+    def __init__(
+        self,
+        *,
+        name: str,
+        properties: "ChildModel",
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        _flattened_input = {k: kwargs.pop(k) for k in kwargs.keys() & self.__flattened_items}
+        super().__init__(*args, **kwargs)
+        for k, v in _flattened_input.items():
+            setattr(self, k, v)
+
+    def __getattr__(self, name: str) -> Any:
+        if name in self.__flattened_items:
+            if self.properties is None:
+                return None
+            return getattr(self.properties, name)
+        raise AttributeError(f"'{self.__class__.__name__}' object has no attribute '{name}'")
+
+    def __setattr__(self, key: str, value: Any) -> None:
+        if key in self.__flattened_items:
+            if self.properties is None:
+                self.properties = self._attr_to_rest_field["properties"]._class_type()
+            setattr(self.properties, key, value)
+        else:
+            super().__setattr__(key, value)
+
+
+def test_model_initialization():
+    model = FlattenModel(
+        name="test",
+        description="a description",
+        age=30,
+        model_property=ModelProperty(value="test value"),
+        datetime_default=datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc),
+        datetime_rfc3339=datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc),
+        datetime_rfc7231=datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc),
+        datetime_unix_timestamp=datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc),
+    )
+
+    assert model.name == "test"
+
+    assert model.description == "a description"
+    assert model.properties.description == "a description"
+
+    assert model.age == 30
+    assert model.properties.age == 30
+
+    assert model.model_property.value == "test value"
+    assert model.properties.model_property == ModelProperty(value="test value")
+    assert model.properties.model_property.value == "test value"
+
+    assert model.datetime_default == datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc)
+    assert model.properties.datetime_default == datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc)
+    assert model.properties["datetimeDefault"] == "2023-01-12T00:00:00Z"
+
+    assert model.datetime_rfc3339 == datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc)
+    assert model.properties.datetime_rfc3339 == datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc)
+    assert model.properties["datetimeRfc3339"] == "2023-01-12T00:00:00Z"
+
+    assert model.datetime_rfc7231 == datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc)
+    assert model.properties.datetime_rfc7231 == datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc)
+    assert model.properties["datetimeRfc7231"] == "Thu, 12 Jan 2023 00:00:00 GMT"
+
+    assert model.datetime_unix_timestamp == datetime.datetime(2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc)
+    assert model.properties.datetime_unix_timestamp == datetime.datetime(
+        2023, 1, 12, 0, 0, 0, tzinfo=datetime.timezone.utc
+    )
+    assert model.properties["datetimeUnixTimestamp"] == 1673481600
+
+
+class FlattenModelWithOptionalProperties(Model):
+    """This is the model with one level of flattening and optional properties."""
+
+    name: str = rest_field()
+    """Required."""
+    properties: Optional["ModelProperty"] = rest_field()
+    """Optional."""
+
+    __flattened_items = ["value"]
+
+    @overload
+    def __init__(
+        self,
+        *,
+        name: str,
+        properties: Optional["ModelProperty"],
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        _flattened_input = {k: kwargs.pop(k) for k in kwargs.keys() & self.__flattened_items}
+        super().__init__(*args, **kwargs)
+        for k, v in _flattened_input.items():
+            setattr(self, k, v)
+
+    def __getattr__(self, name: str) -> Any:
+        if name in self.__flattened_items:
+            if self.properties is None:
+                return None
+            return getattr(self.properties, name)
+        raise AttributeError(f"'{self.__class__.__name__}' object has no attribute '{name}'")
+
+    def __setattr__(self, key: str, value: Any) -> None:
+        if key in self.__flattened_items:
+            if self.properties is None:
+                self.properties = self._attr_to_rest_field["properties"]._class_type()
+            setattr(self.properties, key, value)
+        else:
+            super().__setattr__(key, value)
+
+
+def test_model_with_optional_properties_initialization():
+    model = FlattenModelWithOptionalProperties(
+        name="test",
+        value="test value",
+    )
+
+    assert model.name == "test"
+
+    assert model.value == "test value"
+    assert model.properties.value == "test value"
+
+
+def test_model_with_optional_properties_attribute_list():
+    model = FlattenModelWithOptionalProperties(
+        name="test",
+    )
+
+    attrs = attribute_list(model)
+    assert sorted(attrs) == sorted(["name", "value"])

package/generator/test/azure/requirements.txt

@@ -14,6 +14,8 @@ azure-mgmt-core==1.6.0
 -e ./generated/azure-client-generator-core-usage
 -e ./generated/azure-client-generator-core-override
 -e ./generated/azure-client-generator-core-client-location
+-e ./generated/azure-client-generator-core-alternate-type
+-e ./generated/azure-client-generator-core-next-link-verb
 -e ./generated/azure-core-basic
 -e ./generated/azure-core-scalar
 -e ./generated/azure-core-lro-rpc
@@ -52,6 +54,7 @@ azure-mgmt-core==1.6.0
 -e ./generated/setuppy-authentication-union
 -e ./generated/encode-duration
 -e ./generated/encode-numeric
+-e ./generated/encode-array
 -e ./generated/parameters-basic
 -e ./generated/parameters-collection-format
 -e ./generated/parameters-path

package/generator/test/unbranded/requirements.txt

@@ -9,6 +9,7 @@
 -e ./generated/setuppy-authentication-union
 -e ./generated/encode-duration
 -e ./generated/encode-numeric
+-e ./generated/encode-array
 -e ./generated/parameters-basic
 -e ./generated/parameters-collection-format
 -e ./generated/parameters-path

package/generator/test/unittests/test_name_converter.py

@@ -8,7 +8,7 @@ from pygen.preprocess.python_mappings import PadType
 
 
 def pad_reserved_words(name: str, pad_type: PadType) -> str:
-    return PreProcessPlugin(output_folder="").pad_reserved_words(name, pad_type)
+    return PreProcessPlugin(output_folder="").pad_reserved_words(name, pad_type, {})
 
 
 def test_escaped_reserved_words():

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.20.3",
+  "version": "0.22.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",
@@ -54,20 +54,20 @@
     "emitter"
   ],
   "peerDependencies": {
-    "@azure-tools/typespec-autorest": ">=0.62.0 <1.0.0",
-    "@azure-tools/typespec-azure-core": ">=0.62.0 <1.0.0",
-    "@azure-tools/typespec-azure-resource-manager": ">=0.62.0 <1.0.0",
-    "@azure-tools/typespec-azure-rulesets": ">=0.62.0 <1.0.0",
-    "@azure-tools/typespec-client-generator-core": ">=0.62.0 <1.0.0",
-    "@typespec/compiler": "^1.6.0",
-    "@typespec/http": "^1.6.0",
-    "@typespec/openapi": "^1.6.0",
-    "@typespec/rest": ">=0.76.0 <1.0.0",
-    "@typespec/versioning": ">=0.76.0 <1.0.0",
-    "@typespec/events": ">=0.76.0 <1.0.0",
-    "@typespec/sse": ">=0.76.0 <1.0.0",
-    "@typespec/streams": ">=0.76.0 <1.0.0",
-    "@typespec/xml": ">=0.76.0 <1.0.0"
+    "@azure-tools/typespec-autorest": ">=0.63.0 <1.0.0",
+    "@azure-tools/typespec-azure-core": ">=0.63.0 <1.0.0",
+    "@azure-tools/typespec-azure-resource-manager": ">=0.63.0 <1.0.0",
+    "@azure-tools/typespec-azure-rulesets": ">=0.63.0 <1.0.0",
+    "@azure-tools/typespec-client-generator-core": ">=0.63.0 <1.0.0",
+    "@typespec/compiler": "^1.7.0",
+    "@typespec/http": "^1.7.0",
+    "@typespec/openapi": "^1.7.0",
+    "@typespec/rest": ">=0.77.0 <1.0.0",
+    "@typespec/versioning": ">=0.77.0 <1.0.0",
+    "@typespec/events": ">=0.77.0 <1.0.0",
+    "@typespec/sse": ">=0.77.0 <1.0.0",
+    "@typespec/streams": ">=0.77.0 <1.0.0",
+    "@typespec/xml": ">=0.77.0 <1.0.0"
   },
   "dependencies": {
     "js-yaml": "~4.1.0",
@@ -77,24 +77,24 @@
     "tsx": "~4.19.1"
   },
   "devDependencies": {
-    "@azure-tools/typespec-autorest": "~0.62.0",
-    "@azure-tools/typespec-azure-core": "~0.62.0",
-    "@azure-tools/typespec-azure-resource-manager": "~0.62.0",
-    "@azure-tools/typespec-azure-rulesets": "~0.62.0",
-    "@azure-tools/typespec-client-generator-core": "~0.62.0",
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.32",
-    "@typespec/compiler": "^1.6.0",
-    "@typespec/http": "^1.6.0",
-    "@typespec/openapi": "^1.6.0",
-    "@typespec/rest": "~0.76.0",
-    "@typespec/versioning": "~0.76.0",
-    "@typespec/events": "~0.76.0",
-    "@typespec/spector": "0.1.0-alpha.20",
-    "@typespec/spec-api": "0.1.0-alpha.10",
-    "@typespec/sse": "~0.76.0",
-    "@typespec/streams": "~0.76.0",
-    "@typespec/xml": "~0.76.0",
-    "@typespec/http-specs": "0.1.0-alpha.28",
+    "@azure-tools/typespec-autorest": "~0.63.0",
+    "@azure-tools/typespec-azure-core": "~0.63.0",
+    "@azure-tools/typespec-azure-resource-manager": "~0.63.0",
+    "@azure-tools/typespec-azure-rulesets": "~0.63.0",
+    "@azure-tools/typespec-client-generator-core": "~0.63.0",
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.33",
+    "@typespec/compiler": "^1.7.0",
+    "@typespec/http": "^1.7.0",
+    "@typespec/openapi": "^1.7.0",
+    "@typespec/rest": "~0.77.0",
+    "@typespec/versioning": "~0.77.0",
+    "@typespec/events": "~0.77.0",
+    "@typespec/spector": "0.1.0-alpha.21",
+    "@typespec/spec-api": "0.1.0-alpha.11",
+    "@typespec/sse": "~0.77.0",
+    "@typespec/streams": "~0.77.0",
+    "@typespec/xml": "~0.77.0",
+    "@typespec/http-specs": "0.1.0-alpha.29",
     "@types/js-yaml": "~4.0.5",
     "@types/node": "~24.1.0",
     "@types/semver": "7.5.8",