@typespec/http-client-python 0.18.1 → 0.19.0

package/eng/scripts/Build-Packages.ps1

@@ -67,6 +67,9 @@ try {
     Invoke-LoggedCommand "npm pack"
     Copy-Item "typespec-http-client-python-$emitterVersion.tgz" -Destination "$outputPath/packages"
 
+    # install packed emitter to check dependencies
+    Invoke-LoggedCommand "npm install typespec-http-client-python-$emitterVersion.tgz" -GroupOutput
+
     Write-PackageInfo -packageName "typespec-http-client-python" -directoryPath "packages/http-client-python/emitter/src" -version $emitterVersion
 }
 finally {

package/eng/scripts/ci/regenerate.ts

@@ -22,7 +22,7 @@ const argv = parseArgs({
 });
 
 // Add this near the top with other constants
-const SKIP_SPECS = ["type/union/discriminated", "client-operation-group"];
+const SKIP_SPECS = ["type/union/discriminated"];
 
 // Get the directory of the current file
 const PLUGIN_DIR = argv.values.pluginDir
@@ -97,9 +97,16 @@ const AZURE_EMITTER_OPTIONS: Record<string, Record<string, string> | Record<stri
   "azure/payload/pageable": {
     namespace: "specs.azure.payload.pageable",
   },
+  "azure/versioning/previewVersion": {
+    namespace: "specs.azure.versioning.previewversion",
+  },
   "client/structure/default": {
     namespace: "client.structure.service",
   },
+  "client/structure/client-operation-group": {
+    "package-name": "client-structure-clientoperationgroup",
+    namespace: "client.structure.clientoperationgroup",
+  },
   "client/structure/multi-client": {
     "package-name": "client-structure-multiclient",
     namespace: "client.structure.multiclient",

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

@@ -198,7 +198,11 @@ class OperationBase(  # pylint: disable=too-many-public-methods,too-many-instanc
             return None
         exception_schema = default_exceptions[0].type
         if isinstance(exception_schema, ModelType):
-            return exception_schema.type_annotation(skip_quote=True, serialize_namespace=serialize_namespace)
+            pylint_disable = "  # pylint: disable=protected-access" if exception_schema.internal else ""
+            return (
+                exception_schema.type_annotation(skip_quote=True, serialize_namespace=serialize_namespace)
+                + pylint_disable
+            )
         return None if self.code_model.options["models-mode"] == "dpg" else "'object'"
 
     @property

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

@@ -1014,7 +1014,9 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                 retval.extend(deserialize_code)
         return retval
 
-    def handle_error_response(self, builder: OperationType) -> list[str]:
+    def handle_error_response(  # pylint: disable=too-many-statements, too-many-branches
+        self, builder: OperationType
+    ) -> list[str]:
         async_await = "await " if self.async_mode else ""
         retval = [f"if response.status_code not in {str(builder.success_status_codes)}:"]
         response_read = [
@@ -1036,6 +1038,10 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
             retval.append("    error = None")
             for e in builder.non_default_errors:
                 # single status code
+                if isinstance(e.type, ModelType) and e.type.internal:
+                    pylint_disable = "  # pylint: disable=protected-access"
+                else:
+                    pylint_disable = ""
                 if isinstance(e.status_codes[0], int):
                     for status_code in e.status_codes:
                         retval.append(f"    {condition} response.status_code == {status_code}:")
@@ -1043,10 +1049,13 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                             is_operation_file=True, skip_quote=True, serialize_namespace=self.serialize_namespace
                         )
                         if self.code_model.options["models-mode"] == "dpg":
-                            retval.append(f"        error = _failsafe_deserialize({type_annotation},  response)")
+                            retval.append(
+                                f"        error = _failsafe_deserialize({type_annotation},{pylint_disable}\n  response)"
+                            )
                         else:
                             retval.append(
-                                f"        error = self._deserialize.failsafe_deserialize({type_annotation}, "
+                                "        error = self._deserialize.failsafe_deserialize("
+                                f"{type_annotation},{pylint_disable}\n "
                                 "pipeline_response)"
                             )
                         # add build-in error type
@@ -1078,12 +1087,19 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                     )
                     if self.code_model.options["models-mode"] == "dpg":
                         if xml_serializable(str(e.default_content_type)):
-                            retval.append(f"        error = _failsafe_deserialize_xml({type_annotation}, response)")
+                            retval.append(
+                                "        error = _failsafe_deserialize_xml("
+                                f"{type_annotation},{pylint_disable}\n  response)"
+                            )
                         else:
-                            retval.append(f"        error = _failsafe_deserialize({type_annotation}, response)")
+                            retval.append(
+                                "        error = _failsafe_deserialize("
+                                f"{type_annotation},{pylint_disable}\n  response)"
+                            )
                     else:
                         retval.append(
-                            f"        error = self._deserialize.failsafe_deserialize({type_annotation}, "
+                            "        error = self._deserialize.failsafe_deserialize("
+                            f"{type_annotation},{pylint_disable}\n  "
                             "pipeline_response)"
                         )
                     condition = "elif"

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

@@ -32,6 +32,9 @@ class ModelInitSerializer:
                         ", ".join(model_enum_name_intersection)
                     )
                 )
-
+        has_models = self.models
+        has_enums = self.enums
         template = self.env.get_template("model_init.py.jinja2")
-        return template.render(code_model=self.code_model, schemas=schemas, enums=enums)
+        return template.render(
+            code_model=self.code_model, schemas=schemas, enums=enums, has_models=has_models, has_enums=has_enums
+        )

package/generator/build/lib/pygen/codegen/templates/model_init.py.jinja2

@@ -11,6 +11,9 @@ from .{{ code_model.models_filename }} import (  # type: ignore
     {{ schema }},
     {% endfor %}
 )
+{% elif has_models %}
+
+from . import _models
 {% endif %}
 {% if enums %}
 
@@ -19,6 +22,9 @@ from .{{ code_model.enums_filename }} import (  # type: ignore
     {{ enum }},
 {% endfor %}
 )
+{% elif has_enums %}
+
+from . import _enums
 {% endif %}
 {{ keywords.patch_imports() }}
 __all__ = [

package/generator/build/lib/pygen/codegen/templates/operation_tools.jinja2

@@ -19,7 +19,8 @@
     {% endfor %}
     {% for description in param_description_and_response_docstring %}
         {% if description %}
-{{ wrap_string(description, wrapstring='\n ') }}
+{% set description = wrap_string(description, wrapstring='\n ') %}
+{{ " " if description[0] != ":" and description[0] != " " else "" }}{{ description}}
         {% else %}
 
         {% endif %}

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

@@ -198,7 +198,11 @@ class OperationBase(  # pylint: disable=too-many-public-methods,too-many-instanc
             return None
         exception_schema = default_exceptions[0].type
         if isinstance(exception_schema, ModelType):
-            return exception_schema.type_annotation(skip_quote=True, serialize_namespace=serialize_namespace)
+            pylint_disable = "  # pylint: disable=protected-access" if exception_schema.internal else ""
+            return (
+                exception_schema.type_annotation(skip_quote=True, serialize_namespace=serialize_namespace)
+                + pylint_disable
+            )
         return None if self.code_model.options["models-mode"] == "dpg" else "'object'"
 
     @property

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

@@ -1014,7 +1014,9 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                 retval.extend(deserialize_code)
         return retval
 
-    def handle_error_response(self, builder: OperationType) -> list[str]:
+    def handle_error_response(  # pylint: disable=too-many-statements, too-many-branches
+        self, builder: OperationType
+    ) -> list[str]:
         async_await = "await " if self.async_mode else ""
         retval = [f"if response.status_code not in {str(builder.success_status_codes)}:"]
         response_read = [
@@ -1036,6 +1038,10 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
             retval.append("    error = None")
             for e in builder.non_default_errors:
                 # single status code
+                if isinstance(e.type, ModelType) and e.type.internal:
+                    pylint_disable = "  # pylint: disable=protected-access"
+                else:
+                    pylint_disable = ""
                 if isinstance(e.status_codes[0], int):
                     for status_code in e.status_codes:
                         retval.append(f"    {condition} response.status_code == {status_code}:")
@@ -1043,10 +1049,13 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                             is_operation_file=True, skip_quote=True, serialize_namespace=self.serialize_namespace
                         )
                         if self.code_model.options["models-mode"] == "dpg":
-                            retval.append(f"        error = _failsafe_deserialize({type_annotation},  response)")
+                            retval.append(
+                                f"        error = _failsafe_deserialize({type_annotation},{pylint_disable}\n  response)"
+                            )
                         else:
                             retval.append(
-                                f"        error = self._deserialize.failsafe_deserialize({type_annotation}, "
+                                "        error = self._deserialize.failsafe_deserialize("
+                                f"{type_annotation},{pylint_disable}\n "
                                 "pipeline_response)"
                             )
                         # add build-in error type
@@ -1078,12 +1087,19 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                     )
                     if self.code_model.options["models-mode"] == "dpg":
                         if xml_serializable(str(e.default_content_type)):
-                            retval.append(f"        error = _failsafe_deserialize_xml({type_annotation}, response)")
+                            retval.append(
+                                "        error = _failsafe_deserialize_xml("
+                                f"{type_annotation},{pylint_disable}\n  response)"
+                            )
                         else:
-                            retval.append(f"        error = _failsafe_deserialize({type_annotation}, response)")
+                            retval.append(
+                                "        error = _failsafe_deserialize("
+                                f"{type_annotation},{pylint_disable}\n  response)"
+                            )
                     else:
                         retval.append(
-                            f"        error = self._deserialize.failsafe_deserialize({type_annotation}, "
+                            "        error = self._deserialize.failsafe_deserialize("
+                            f"{type_annotation},{pylint_disable}\n  "
                             "pipeline_response)"
                         )
                     condition = "elif"

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

@@ -32,6 +32,9 @@ class ModelInitSerializer:
                         ", ".join(model_enum_name_intersection)
                     )
                 )
-
+        has_models = self.models
+        has_enums = self.enums
         template = self.env.get_template("model_init.py.jinja2")
-        return template.render(code_model=self.code_model, schemas=schemas, enums=enums)
+        return template.render(
+            code_model=self.code_model, schemas=schemas, enums=enums, has_models=has_models, has_enums=has_enums
+        )

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

@@ -11,6 +11,9 @@ from .{{ code_model.models_filename }} import (  # type: ignore
     {{ schema }},
     {% endfor %}
 )
+{% elif has_models %}
+
+from . import _models
 {% endif %}
 {% if enums %}
 
@@ -19,6 +22,9 @@ from .{{ code_model.enums_filename }} import (  # type: ignore
     {{ enum }},
 {% endfor %}
 )
+{% elif has_enums %}
+
+from . import _enums
 {% endif %}
 {{ keywords.patch_imports() }}
 __all__ = [

package/generator/pygen/codegen/templates/operation_tools.jinja2

@@ -19,7 +19,8 @@
     {% endfor %}
     {% for description in param_description_and_response_docstring %}
         {% if description %}
-{{ wrap_string(description, wrapstring='\n ') }}
+{% set description = wrap_string(description, wrapstring='\n ') %}
+{{ " " if description[0] != ":" and description[0] != " " else "" }}{{ description}}
         {% else %}
 
         {% endif %}

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

@@ -9,7 +9,7 @@ from specs.azure.clientgenerator.core.clientlocation.aio import ClientLocationCl
 
 @pytest.fixture
 async def client():
-    async with ClientLocationClient() as client:
+    async with ClientLocationClient(storage_account="testaccount") as client:
         yield client
 
 
@@ -46,3 +46,10 @@ async def test_move_to_new_sub_client_product_operations_list_products(client: C
 @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()
+
+
+@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"
+    )

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

@@ -24,6 +24,17 @@ async def test_group_parameters(client: OverrideClient):
     await client.group_parameters.group(param1="param1", param2="param2")
 
 
+@pytest.mark.asyncio
+async def test_require_optional_parameter(client: OverrideClient):
+    await client.require_optional_parameter.require_optional("param1", "param2")
+
+
+@pytest.mark.asyncio
+async def test_remove_optional_parameter(client: OverrideClient):
+    # Test with optional param2 provided
+    await client.remove_optional_parameter.remove_optional("param1", param2="param2")
+
+
 def test_reorder_parameters_unit_async(client: OverrideClient):
     # make sure signature name of `reorder_parameters` are ["param1", "param2"]
     # Get the reorder method from the reorder_parameters operation
@@ -41,3 +52,55 @@ def test_reorder_parameters_unit_async(client: OverrideClient):
 
     # Assert that the parameter names are exactly ["param1", "param2"]
     assert param_names == ["param1", "param2"], f"Expected parameter names ['param1', 'param2'], but got {param_names}"
+
+
+def test_require_optional_parameter_signature(client: OverrideClient):
+    # Get the require_optional method
+    require_optional_method = client.require_optional_parameter.require_optional
+
+    # Inspect the method signature
+    sig = inspect.signature(require_optional_method)
+
+    # Get parameter details
+    params = sig.parameters
+
+    # Check that both param1 and param2 are required (no default values)
+    assert "param1" in params, "param1 should be present in signature"
+    assert "param2" in params, "param2 should be present in signature"
+    assert params["param1"].default == params["param1"].empty, "param1 should have no default value"
+    assert params["param2"].default == params["param2"].empty, "param2 should have no default value"
+
+
+def test_remove_optional_parameter_signature(client: OverrideClient):
+    """Test that remove_optional_parameter.remove_optional method signature has correct parameters.
+
+    The @override decorator should remove some optional parameters from the method signature.
+    Only param1 (required) and param2 (optional) should remain.
+    """
+    # Get the remove_optional method
+    remove_optional_method = client.remove_optional_parameter.remove_optional
+
+    # Inspect the method signature
+    sig = inspect.signature(remove_optional_method)
+
+    # Get parameter names excluding 'self' and '**kwargs'
+    param_names = [
+        param_name
+        for param_name, param in sig.parameters.items()
+        if param_name not in ("self", "kwargs") and param.kind != param.VAR_KEYWORD
+    ]
+
+    # Should have param1 (required) and param2 (keyword-only optional)
+    assert "param1" in param_names, "param1 should be present in signature"
+    assert "param2" in sig.parameters, "param2 should be present in signature"
+
+    # param1 should be required (positional)
+    assert sig.parameters["param1"].default == sig.parameters["param1"].empty, "param1 should have no default value"
+
+    # param2 should be optional keyword-only with None default
+    assert sig.parameters["param2"].kind == sig.parameters["param2"].KEYWORD_ONLY, "param2 should be keyword-only"
+    assert sig.parameters["param2"].default is None, "param2 should have None as default value"
+
+    # param3 and param4 should be removed
+    assert "param3" not in param_names, "param3 should not be present in signature"
+    assert "param4" not in param_names, "param4 should not be present in signature"

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

@@ -0,0 +1,29 @@
+# -------------------------------------------------------------------------
+# 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 client.structure.clientoperationgroup.models import ClientType
+from client.structure.clientoperationgroup.aio import FirstClient, SecondClient
+
+
+@pytest.mark.asyncio
+async def test_first_client_operations():
+    client = FirstClient(endpoint="http://localhost:3000", client=ClientType.CLIENT_OPERATION_GROUP)
+
+    await client.one()
+
+    await client.group3.two()
+    await client.group3.three()
+
+    await client.group4.four()
+
+
+@pytest.mark.asyncio
+async def test_second_client_operations():
+    client = SecondClient(endpoint="http://localhost:3000", client=ClientType.CLIENT_OPERATION_GROUP)
+
+    await client.five()
+
+    await client.group5.six()

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

@@ -18,7 +18,7 @@ def start_server_process():
     azure_http_path = Path(os.path.dirname(__file__)) / Path("../../../../node_modules/@azure-tools/azure-http-specs")
     http_path = Path(os.path.dirname(__file__)) / Path("../../../../node_modules/@typespec/http-specs")
     os.chdir(azure_http_path.resolve())
-    cmd = f"tsp-spector serve ./specs  {(http_path / 'specs').resolve()}"
+    cmd = f"npx tsp-spector serve ./specs  {(http_path / 'specs').resolve()}"
     if os.name == "nt":
         return subprocess.Popen(cmd, shell=True)
     return subprocess.Popen(cmd, shell=True, preexec_fn=os.setsid)

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

@@ -9,7 +9,7 @@ from specs.azure.clientgenerator.core.clientlocation import ClientLocationClient
 
 @pytest.fixture
 def client():
-    with ClientLocationClient() as client:
+    with ClientLocationClient(storage_account="testaccount") as client:
         yield client
 
 
@@ -39,3 +39,7 @@ def test_move_to_new_sub_client_product_operations_list_products(client: ClientL
 
 def test_move_to_root_client_resource_operations_get_resource(client: ClientLocationClient):
     client.move_to_root_client.resource_operations.get_resource()
+
+
+def test_move_method_parameter_to_client_blob_operations_get_blob(client: ClientLocationClient):
+    client.move_method_parameter_to_client.blob_operations.get_blob(container="testcontainer", blob="testblob.txt")

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

@@ -22,6 +22,15 @@ def test_group_parameters(client: OverrideClient):
     client.group_parameters.group(param1="param1", param2="param2")
 
 
+def test_require_optional_parameter(client: OverrideClient):
+    client.require_optional_parameter.require_optional("param1", "param2")
+
+
+def test_remove_optional_parameter(client: OverrideClient):
+    # Test with optional param2 provided
+    client.remove_optional_parameter.remove_optional("param1", param2="param2")
+
+
 # make sure signature name of `reorder_parameters` are ["param1", "param2"]
 def test_reorder_parameters_unit(client: OverrideClient):
     # Get the reorder method from the reorder_parameters operation
@@ -39,3 +48,55 @@ def test_reorder_parameters_unit(client: OverrideClient):
 
     # Assert that the parameter names are exactly ["param1", "param2"]
     assert param_names == ["param1", "param2"], f"Expected parameter names ['param1', 'param2'], but got {param_names}"
+
+
+def test_require_optional_parameter_signature(client: OverrideClient):
+    # Get the require_optional method
+    require_optional_method = client.require_optional_parameter.require_optional
+
+    # Inspect the method signature
+    sig = inspect.signature(require_optional_method)
+
+    # Get parameter details
+    params = sig.parameters
+
+    # Check that both param1 and param2 are required (no default values)
+    assert "param1" in params, "param1 should be present in signature"
+    assert "param2" in params, "param2 should be present in signature"
+    assert params["param1"].default == params["param1"].empty, "param1 should have no default value"
+    assert params["param2"].default == params["param2"].empty, "param2 should have no default value"
+
+
+def test_remove_optional_parameter_signature(client: OverrideClient):
+    """Test that remove_optional_parameter.remove_optional method signature has correct parameters.
+
+    The @override decorator should remove some optional parameters from the method signature.
+    Only param1 (required) and param2 (optional) should remain.
+    """
+    # Get the remove_optional method
+    remove_optional_method = client.remove_optional_parameter.remove_optional
+
+    # Inspect the method signature
+    sig = inspect.signature(remove_optional_method)
+
+    # Get parameter names excluding 'self' and '**kwargs'
+    param_names = [
+        param_name
+        for param_name, param in sig.parameters.items()
+        if param_name not in ("self", "kwargs") and param.kind != param.VAR_KEYWORD
+    ]
+
+    # Should have param1 (required) and param2 (keyword-only optional)
+    assert "param1" in param_names, "param1 should be present in signature"
+    assert "param2" in sig.parameters, "param2 should be present in signature"
+
+    # param1 should be required (positional)
+    assert sig.parameters["param1"].default == sig.parameters["param1"].empty, "param1 should have no default value"
+
+    # param2 should be optional keyword-only with None default
+    assert sig.parameters["param2"].kind == sig.parameters["param2"].KEYWORD_ONLY, "param2 should be keyword-only"
+    assert sig.parameters["param2"].default is None, "param2 should have None as default value"
+
+    # param3 and param4 should be removed
+    assert "param3" not in param_names, "param3 should not be present in signature"
+    assert "param4" not in param_names, "param4 should not be present in signature"

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

@@ -0,0 +1,26 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from client.structure.clientoperationgroup.models import ClientType
+from client.structure.clientoperationgroup import FirstClient, SecondClient
+
+
+def test_first_client_operations():
+    client = FirstClient(endpoint="http://localhost:3000", client=ClientType.CLIENT_OPERATION_GROUP)
+
+    client.one()
+
+    client.group3.two()
+    client.group3.three()
+
+    client.group4.four()
+
+
+def test_second_client_operations():
+    client = SecondClient(endpoint="http://localhost:3000", client=ClientType.CLIENT_OPERATION_GROUP)
+
+    client.five()
+
+    client.group5.six()

package/generator/test/azure/requirements.txt

@@ -36,6 +36,7 @@ azure-mgmt-core==1.6.0
 -e ./generated/client-naming-enum-conflict
 -e ./generated/client-overload
 -e ./generated/client-structure-default
+-e ./generated/client-structure-clientoperationgroup
 -e ./generated/client-structure-multiclient
 -e ./generated/client-structure-renamedoperation
 -e ./generated/client-structure-twooperationgroup

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",
@@ -82,7 +82,7 @@
     "@azure-tools/typespec-azure-resource-manager": "~0.60.0",
     "@azure-tools/typespec-azure-rulesets": "~0.60.0",
     "@azure-tools/typespec-client-generator-core": "~0.60.2",
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.28",
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.30-dev.6",
     "@typespec/compiler": "^1.4.0",
     "@typespec/http": "^1.4.0",
     "@typespec/openapi": "^1.4.0",