@typespec/http-client-python 0.10.0 → 0.11.0

package/generator/build/lib/pygen/codegen/models/parameter.py

@@ -357,6 +357,9 @@ class Parameter(_ParameterBase):
         )
         if self.code_model.options["only_path_and_body_params_positional"] and query_or_header:
             return ParameterMethodLocation.KEYWORD_ONLY
+        # for optional path parameter, we need to use keyword only
+        if self.location == ParameterLocation.PATH and self.optional:
+            return ParameterMethodLocation.KEYWORD_ONLY
         return ParameterMethodLocation.POSITIONAL
 
     @classmethod

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

@@ -225,19 +225,33 @@ class GeneralSerializer(BaseSerializer):
                 if not enum.internal
             }
         )
-        cross_langauge_def_dict.update(
-            {
-                (
-                    f"{self.code_model.namespace}.{client.name}."
-                    + ("" if operation_group.is_mixin else f"{operation_group.property_name}.")
-                    + f"{operation.name}"
-                ): operation.cross_language_definition_id
-                for client in self.code_model.clients
-                for operation_group in client.operation_groups
-                for operation in operation_group.operations
-                if not operation.name.startswith("_")
-            }
-        )
+        for client in self.code_model.clients:
+            for operation_group in client.operation_groups:
+                for operation in operation_group.operations:
+                    if operation.name.startswith("_"):
+                        continue
+                    cross_langauge_def_dict.update(
+                        {
+                            f"{self.code_model.namespace}."
+                            + (
+                                f"{client.name}."
+                                if operation_group.is_mixin
+                                else f"operations.{operation_group.class_name}."
+                            )
+                            + f"{operation.name}": operation.cross_language_definition_id
+                        }
+                    )
+                    cross_langauge_def_dict.update(
+                        {
+                            f"{self.code_model.namespace}.aio."
+                            + (
+                                f"{client.name}."
+                                if operation_group.is_mixin
+                                else f"operations.{operation_group.class_name}."
+                            )
+                            + f"{operation.name}": operation.cross_language_definition_id
+                        }
+                    )
         return json.dumps(
             {
                 "CrossLanguagePackageId": self.code_model.cross_language_package_id,

package/generator/build/lib/pygen/codegen/serializers/parameter_serializer.py

@@ -109,6 +109,7 @@ class ParameterSerializer:
             return f"[{serialize_line} if q is not None else '' for q in {origin_name}]"
         return serialize_line
 
+    # pylint: disable=line-too-long
     def serialize_path(
         self,
         parameters: Union[
@@ -124,7 +125,11 @@ class ParameterSerializer:
             [
                 '    "{}": {},'.format(
                     path_parameter.wire_name,
-                    self.serialize_parameter(path_parameter, serializer_name),
+                    (
+                        f'"" if {path_parameter.full_client_name} is None else "/" + {self.serialize_parameter(path_parameter, serializer_name)}'
+                        if path_parameter.optional and isinstance(path_parameter, RequestBuilderParameter)
+                        else self.serialize_parameter(path_parameter, serializer_name)
+                    ),
                 )
                 for path_parameter in parameters
             ]

package/generator/component-detection-pip-report.json

@@ -4,11 +4,11 @@
   "install": [
     {
       "download_info": {
-        "url": "https://files.pythonhosted.org/packages/54/21/f43f0a1fa8b06b32812e0975981f4677d28e0f3271601dc88ac5a5b83220/setuptools-78.1.0-py3-none-any.whl",
+        "url": "https://files.pythonhosted.org/packages/cc/ea/d53f2f8897c46a36df085964d07761ea4c2d1f2cf92019693b6742b7aabb/setuptools-79.0.0-py3-none-any.whl",
         "archive_info": {
-          "hash": "sha256=3e386e96793c8702ae83d17b853fb93d3e09ef82ec62722e61da5cd22376dcd8",
+          "hash": "sha256=b9ab3a104bedb292323f53797b00864e10e434a3ab3906813a7169e4745b912a",
           "hashes": {
-            "sha256": "3e386e96793c8702ae83d17b853fb93d3e09ef82ec62722e61da5cd22376dcd8"
+            "sha256": "b9ab3a104bedb292323f53797b00864e10e434a3ab3906813a7169e4745b912a"
           }
         }
       },
@@ -18,7 +18,7 @@
       "metadata": {
         "metadata_version": "2.4",
         "name": "setuptools",
-        "version": "78.1.0",
+        "version": "79.0.0",
         "dynamic": [
           "license-file"
         ],
@@ -39,7 +39,6 @@
         "classifier": [
           "Development Status :: 5 - Production/Stable",
           "Intended Audience :: Developers",
-          "License :: OSI Approved :: MIT License",
           "Programming Language :: Python :: 3",
           "Programming Language :: Python :: 3 :: Only",
           "Topic :: Software Development :: Libraries :: Python Modules",

package/generator/pygen/codegen/models/parameter.py

@@ -357,6 +357,9 @@ class Parameter(_ParameterBase):
         )
         if self.code_model.options["only_path_and_body_params_positional"] and query_or_header:
             return ParameterMethodLocation.KEYWORD_ONLY
+        # for optional path parameter, we need to use keyword only
+        if self.location == ParameterLocation.PATH and self.optional:
+            return ParameterMethodLocation.KEYWORD_ONLY
         return ParameterMethodLocation.POSITIONAL
 
     @classmethod

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

@@ -225,19 +225,33 @@ class GeneralSerializer(BaseSerializer):
                 if not enum.internal
             }
         )
-        cross_langauge_def_dict.update(
-            {
-                (
-                    f"{self.code_model.namespace}.{client.name}."
-                    + ("" if operation_group.is_mixin else f"{operation_group.property_name}.")
-                    + f"{operation.name}"
-                ): operation.cross_language_definition_id
-                for client in self.code_model.clients
-                for operation_group in client.operation_groups
-                for operation in operation_group.operations
-                if not operation.name.startswith("_")
-            }
-        )
+        for client in self.code_model.clients:
+            for operation_group in client.operation_groups:
+                for operation in operation_group.operations:
+                    if operation.name.startswith("_"):
+                        continue
+                    cross_langauge_def_dict.update(
+                        {
+                            f"{self.code_model.namespace}."
+                            + (
+                                f"{client.name}."
+                                if operation_group.is_mixin
+                                else f"operations.{operation_group.class_name}."
+                            )
+                            + f"{operation.name}": operation.cross_language_definition_id
+                        }
+                    )
+                    cross_langauge_def_dict.update(
+                        {
+                            f"{self.code_model.namespace}.aio."
+                            + (
+                                f"{client.name}."
+                                if operation_group.is_mixin
+                                else f"operations.{operation_group.class_name}."
+                            )
+                            + f"{operation.name}": operation.cross_language_definition_id
+                        }
+                    )
         return json.dumps(
             {
                 "CrossLanguagePackageId": self.code_model.cross_language_package_id,

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

@@ -109,6 +109,7 @@ class ParameterSerializer:
             return f"[{serialize_line} if q is not None else '' for q in {origin_name}]"
         return serialize_line
 
+    # pylint: disable=line-too-long
     def serialize_path(
         self,
         parameters: Union[
@@ -124,7 +125,11 @@ class ParameterSerializer:
             [
                 '    "{}": {},'.format(
                     path_parameter.wire_name,
-                    self.serialize_parameter(path_parameter, serializer_name),
+                    (
+                        f'"" if {path_parameter.full_client_name} is None else "/" + {self.serialize_parameter(path_parameter, serializer_name)}'
+                        if path_parameter.optional and isinstance(path_parameter, RequestBuilderParameter)
+                        else self.serialize_parameter(path_parameter, serializer_name)
+                    ),
                 )
                 for path_parameter in parameters
             ]

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

@@ -0,0 +1,50 @@
+# -------------------------------------------------------------------------
+# 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.clientinitialization.aio import (
+    HeaderParamClient,
+    MultipleParamsClient,
+    MixedParamsClient,
+    PathParamClient,
+    ParamAliasClient,
+)
+from specs.azure.clientgenerator.core.clientinitialization.models import Input
+
+
+@pytest.mark.asyncio
+async def test_header_param_client():
+    async with HeaderParamClient("test-name-value") as client:
+        await client.with_query(id="test-id")
+        await client.with_body(Input(name="test-name"))
+
+
+@pytest.mark.asyncio
+async def test_multiple_params_client():
+    async with MultipleParamsClient("test-name-value", "us-west") as client:
+        await client.with_query(id="test-id")
+        await client.with_body(Input(name="test-name"))
+
+
+@pytest.mark.asyncio
+async def test_mixed_params_client():
+    async with MixedParamsClient("test-name-value") as client:
+        await client.with_query(region="us-west", id="test-id")
+        await client.with_body(Input(name="test-name"), region="us-west")
+
+
+@pytest.mark.asyncio
+async def test_path_param_client():
+    async with PathParamClient("sample-blob") as client:
+        await client.with_query(format="text")
+        await client.get_standalone()
+        await client.delete_standalone()
+
+
+@pytest.mark.asyncio
+async def test_param_alias_client():
+    async with ParamAliasClient("sample-blob") as client:
+        await client.with_aliased_name()
+        await client.with_original_name()

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

@@ -0,0 +1,44 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from specs.azure.clientgenerator.core.clientinitialization import (
+    HeaderParamClient,
+    MultipleParamsClient,
+    MixedParamsClient,
+    PathParamClient,
+    ParamAliasClient,
+)
+from specs.azure.clientgenerator.core.clientinitialization.models import Input
+
+
+def test_header_param_client():
+    with HeaderParamClient("test-name-value") as client:
+        client.with_query(id="test-id")
+        client.with_body(Input(name="test-name"))
+
+
+def test_multiple_params_client():
+    with MultipleParamsClient("test-name-value", "us-west") as client:
+        client.with_query(id="test-id")
+        client.with_body(Input(name="test-name"))
+
+
+def test_mixed_params_client():
+    with MixedParamsClient("test-name-value") as client:
+        client.with_query(region="us-west", id="test-id")
+        client.with_body(Input(name="test-name"), region="us-west")
+
+
+def test_path_param_client():
+    with PathParamClient("sample-blob") as client:
+        client.with_query(format="text")
+        client.get_standalone()
+        client.delete_standalone()
+
+
+def test_param_alias_client():
+    with ParamAliasClient("sample-blob") as client:
+        client.with_aliased_name()
+        client.with_original_name()

package/generator/test/azure/requirements.txt

@@ -4,8 +4,9 @@ azure-mgmt-core==1.5.0
 
 # only for azure
 -e ./generated/azure-client-generator-core-access
--e ./generated/azure-client-generator-core-usage
+-e ./generated/azure-client-generator-core-client-initialization
 -e ./generated/azure-client-generator-core-flatten-property
+-e ./generated/azure-client-generator-core-usage
 -e ./generated/azure-core-basic
 -e ./generated/azure-core-scalar
 -e ./generated/azure-core-lro-rpc
@@ -37,6 +38,7 @@ azure-mgmt-core==1.5.0
 -e ./generated/encode-numeric
 -e ./generated/parameters-basic
 -e ./generated/parameters-collection-format
+-e ./generated/parameters-path
 -e ./generated/parameters-spread
 -e ./generated/serialization-encoded-name-json
 -e ./generated/server-endpoint-not-defined

package/generator/test/generic_mock_api_tests/asynctests/test_parameters_path_async.py

@@ -0,0 +1,24 @@
+# -------------------------------------------------------------------------
+# 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 parameters.path.aio import PathClient
+
+
+@pytest.fixture
+async def client():
+    async with PathClient() as client:
+        yield client
+
+
+@pytest.mark.asyncio
+async def test_normal(client: PathClient):
+    await client.normal("foo")
+
+
+@pytest.mark.asyncio
+async def test_optional(client: PathClient):
+    await client.optional()
+    await client.optional(name="foo")

package/generator/test/generic_mock_api_tests/asynctests/test_payload_json_merge_patch_async.py

@@ -28,7 +28,7 @@ async def test_create_resource(client: JsonMergePatchClient):
         map={"key": inner_madge},
         array=[inner_madge],
         int_value=1,
-        float_value=1.1,
+        float_value=1.25,
         inner_model=inner_madge,
         int_array=[1, 2, 3],
     )

package/generator/test/generic_mock_api_tests/test_parameters_path.py

@@ -0,0 +1,22 @@
+# -------------------------------------------------------------------------
+# 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 parameters.path import PathClient
+
+
+@pytest.fixture
+def client():
+    with PathClient() as client:
+        yield client
+
+
+def test_normal(client: PathClient):
+    client.normal("foo")
+
+
+def test_optional(client: PathClient):
+    client.optional()
+    client.optional(name="foo")

package/generator/test/generic_mock_api_tests/test_payload_json_merge_patch.py

@@ -27,7 +27,7 @@ def test_create_resource(client: JsonMergePatchClient):
         map={"key": inner_madge},
         array=[inner_madge],
         int_value=1,
-        float_value=1.1,
+        float_value=1.25,
         inner_model=inner_madge,
         int_array=[1, 2, 3],
     )

package/generator/test/unbranded/requirements.txt

@@ -10,6 +10,7 @@
 -e ./generated/encode-numeric
 -e ./generated/parameters-basic
 -e ./generated/parameters-collection-format
+-e ./generated/parameters-path
 -e ./generated/parameters-spread
 -e ./generated/serialization-encoded-name-json
 -e ./generated/server-endpoint-not-defined

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",
@@ -58,7 +58,7 @@
     "@azure-tools/typespec-azure-core": ">=0.54.0 <1.0.0",
     "@azure-tools/typespec-azure-resource-manager": ">=0.54.0 <1.0.0",
     "@azure-tools/typespec-azure-rulesets": ">=0.54.0 <1.0.0",
-    "@azure-tools/typespec-client-generator-core": ">=0.54.0 <1.0.0",
+    "@azure-tools/typespec-client-generator-core": ">=0.54.2 <1.0.0",
     "@typespec/compiler": "^1.0.0-0",
     "@typespec/http": "^1.0.0-0",
     "@typespec/openapi": "^1.0.0-0",
@@ -81,8 +81,8 @@
     "@azure-tools/typespec-azure-core": "~0.54.0",
     "@azure-tools/typespec-azure-resource-manager": "~0.54.0",
     "@azure-tools/typespec-azure-rulesets": "~0.54.0",
-    "@azure-tools/typespec-client-generator-core": "~0.54.0",
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.13",
+    "@azure-tools/typespec-client-generator-core": "~0.54.2",
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.14",
     "@typespec/compiler": "^1.0.0-0",
     "@typespec/http": "^1.0.0-0",
     "@typespec/openapi": "^1.0.0-0",
@@ -92,7 +92,7 @@
     "@typespec/sse": "~0.68.0",
     "@typespec/streams": "~0.68.0",
     "@typespec/xml": "~0.68.0",
-    "@typespec/http-specs": "0.1.0-alpha.17",
+    "@typespec/http-specs": "0.1.0-alpha.19",
     "@types/js-yaml": "~4.0.5",
     "@types/node": "~22.13.14",
     "@types/semver": "7.5.8",