@typespec/http-client-python 0.7.1 → 0.8.1

package/generator/pygen/preprocess/__init__.py

@@ -14,7 +14,7 @@ from .helpers import (
     pad_builtin_namespaces,
     pad_special_chars,
 )
-from .python_mappings import CADL_RESERVED_WORDS, RESERVED_WORDS, PadType
+from .python_mappings import TSP_RESERVED_WORDS, RESERVED_WORDS, PadType
 
 from .. import YamlUpdatePlugin
 from ..utils import (
@@ -182,11 +182,11 @@ class PreProcessPlugin(YamlUpdatePlugin):
 
     @property
     def models_mode(self) -> Optional[str]:
-        return self.options.get("models-mode", "dpg" if self.is_cadl else None)
+        return self.options.get("models-mode", "dpg" if self.is_tsp else None)
 
     @property
-    def is_cadl(self) -> bool:
-        return self.options.get("cadl_file", False)
+    def is_tsp(self) -> bool:
+        return self.options.get("tsp_file", False)
 
     def add_body_param_type(
         self,
@@ -197,9 +197,7 @@ class PreProcessPlugin(YamlUpdatePlugin):
         if (  # pylint: disable=too-many-boolean-expressions
             body_parameter
             and body_parameter["type"]["type"] in ("model", "dict", "list")
-            and (
-                has_json_content_type(body_parameter) or (self.is_cadl and has_multi_part_content_type(body_parameter))
-            )
+            and (has_json_content_type(body_parameter) or (self.is_tsp and has_multi_part_content_type(body_parameter)))
             and not body_parameter["type"].get("xmlMetadata")
             and not any(t for t in ["flattened", "groupedBy"] if body_parameter.get(t))
         ):
@@ -210,7 +208,7 @@ class PreProcessPlugin(YamlUpdatePlugin):
                 "types": [body_parameter["type"]],
             }
             # don't add binary overload for multipart content type
-            if not (self.is_cadl and has_multi_part_content_type(body_parameter)):
+            if not (self.is_tsp and has_multi_part_content_type(body_parameter)):
                 body_parameter["type"]["types"].append(KNOWN_TYPES["binary"])
 
             if origin_type == "model" and is_dpg_model and self.models_mode == "dpg":
@@ -223,8 +221,8 @@ class PreProcessPlugin(YamlUpdatePlugin):
             # we'll pass in empty operation groups sometime etc.
             return name
 
-        if self.is_cadl:
-            reserved_words = {k: (v + CADL_RESERVED_WORDS.get(k, [])) for k, v in RESERVED_WORDS.items()}
+        if self.is_tsp:
+            reserved_words = {k: (v + TSP_RESERVED_WORDS.get(k, [])) for k, v in RESERVED_WORDS.items()}
         else:
             reserved_words = RESERVED_WORDS
         name = pad_special_chars(name)
@@ -506,6 +504,6 @@ class PreProcessPlugin(YamlUpdatePlugin):
 
 
 if __name__ == "__main__":
-    # CADL pipeline will call this
+    # TSP pipeline will call this
     args, unknown_args = parse_args()
-    PreProcessPlugin(output_folder=args.output_folder, cadl_file=args.cadl_file, **unknown_args).process()
+    PreProcessPlugin(output_folder=args.output_folder, tsp_file=args.tsp_file, **unknown_args).process()

package/generator/pygen/preprocess/python_mappings.py

@@ -185,7 +185,7 @@ RESERVED_WORDS = {
     PadType.OPERATION_GROUP: [*_always_reserved],
 }
 
-CADL_RESERVED_WORDS = {
+TSP_RESERVED_WORDS = {
     PadType.PARAMETER: ["stream"],
     PadType.PROPERTY: RESERVED_MODEL_PROPERTIES,
 }

package/generator/pygen/utils.py

@@ -44,7 +44,7 @@ def to_snake_case(name: str) -> str:
 
 
 def parse_args(
-    need_cadl_file: bool = True,
+    need_tsp_file: bool = True,
 ) -> Tuple[argparse.Namespace, Dict[str, Any]]:
     parser = argparse.ArgumentParser(
         description="Run mypy against target folder. Add a local custom plugin to the path prior to execution. "
@@ -56,10 +56,10 @@ def parse_args(
         required=True,
     )
     parser.add_argument(
-        "--cadl-file",
-        dest="cadl_file",
-        help="Serialized cadl file",
-        required=need_cadl_file,
+        "--tsp-file",
+        dest="tsp_file",
+        help="Serialized tsp file",
+        required=need_tsp_file,
     )
     parser.add_argument(
         "--debug",

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

@@ -18,6 +18,7 @@ async def client(credential, authentication_policy):
         SUBSCRIPTION_ID,
         "http://localhost:3000",
         authentication_policy=authentication_policy,
+        polling_interval=0,
     ) as client:
         yield client
 

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

@@ -18,6 +18,7 @@ def client(credential, authentication_policy):
         SUBSCRIPTION_ID,
         "http://localhost:3000",
         authentication_policy=authentication_policy,
+        polling_interval=0,
     ) as client:
         yield client
 

package/generator/test/azure/tox.ini

@@ -10,7 +10,7 @@ commands =
     pytest mock_api_tests ../generic_mock_api_tests
 
     # pylint
-    pip install azure-pylint-guidelines-checker==0.5.1 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    pip install azure-pylint-guidelines-checker==0.5.2 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
     python ../../../eng/scripts/ci/run_pylint.py -t azure -s "generated" {posargs}
 
     # mypy
@@ -33,7 +33,7 @@ commands =
 deps=
     -r requirements.txt
 commands =
-    pip install azure-pylint-guidelines-checker==0.5.1 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    pip install azure-pylint-guidelines-checker==0.5.2 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
     python ../../../eng/scripts/ci/run_pylint.py -t azure -s "generated" {posargs}
 
 [testenv:mypy]

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

@@ -107,7 +107,7 @@ def png_data() -> bytes:
 @pytest.mark.asyncio
 async def test_request_body(client: BytesClient, png_data: bytes):
     await client.request_body.default(
-        value=bytes("test", "utf-8"),
+        value=png_data,
     )
     await client.request_body.octet_stream(
         value=png_data,
@@ -126,8 +126,9 @@ async def test_request_body(client: BytesClient, png_data: bytes):
 @pytest.mark.asyncio
 async def test_response_body(client: BytesClient, png_data: bytes):
     expected = b"test"
-    assert expected == await client.response_body.default()
+    assert b"".join([d async for d in (await client.response_body.default())]) == png_data
     assert expected == await client.response_body.base64()
-    assert expected == await client.response_body.base64_url()
     assert b"".join([d async for d in (await client.response_body.octet_stream())]) == png_data
     assert b"".join([d async for d in (await client.response_body.custom_content_type())]) == png_data
+    # will reopen after TCGC release a fix version for https://github.com/Azure/typespec-azure/pull/2411
+    # assert expected == await client.response_body.base64_url()

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

@@ -33,12 +33,6 @@ async def test_query_ssv(client: CollectionFormatClient):
     await client.query.ssv(colors=["blue", "red", "green"])
 
 
-@pytest.mark.asyncio
-@pytest.mark.skip(reason="https://github.com/aio-libs/aiohttp/issues/5904")
-async def test_query_tsv(client: CollectionFormatClient):
-    await client.query.tsv(colors=["blue", "red", "green"])
-
-
 @pytest.mark.asyncio
 async def test_csv_header(client: CollectionFormatClient):
     await client.header.csv(colors=["blue", "red", "green"])

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

@@ -0,0 +1,75 @@
+# -------------------------------------------------------------------------
+# 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 payload.pageable.aio import PageableClient
+
+
+@pytest.fixture
+async def client():
+    async with PageableClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def assert_result(result):
+    assert len(result) == 4
+    assert result[0].id == "1"
+    assert result[1].id == "2"
+    assert result[2].id == "3"
+    assert result[3].id == "4"
+    assert result[0].name == "dog"
+    assert result[1].name == "cat"
+    assert result[2].name == "bird"
+    assert result[3].name == "fish"
+
+
+@pytest.mark.asyncio
+async def test_link(client: PageableClient):
+    result = [p async for p in client.server_driven_pagination.link()]
+    assert_result(result)
+
+
+@pytest.mark.asyncio
+async def test_request_query_response_body(client: PageableClient):
+    result = [
+        p
+        async for p in client.server_driven_pagination.continuation_token.request_query_response_body(
+            foo="foo", bar="bar"
+        )
+    ]
+    assert_result(result)
+
+
+@pytest.mark.asyncio
+async def test_request_header_response_body(client: PageableClient):
+    result = [
+        p
+        async for p in client.server_driven_pagination.continuation_token.request_header_response_body(
+            foo="foo", bar="bar"
+        )
+    ]
+    assert_result(result)
+
+
+@pytest.mark.asyncio
+async def test_request_query_response_header(client: PageableClient):
+    result = [
+        p
+        async for p in client.server_driven_pagination.continuation_token.request_query_response_header(
+            foo="foo", bar="bar"
+        )
+    ]
+    assert_result(result)
+
+
+@pytest.mark.asyncio
+async def test_request_header_response_header(client: PageableClient):
+    result = [
+        p
+        async for p in client.server_driven_pagination.continuation_token.request_query_response_header(
+            foo="foo", bar="bar"
+        )
+    ]
+    assert_result(result)

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

@@ -262,6 +262,7 @@ async def test_spread_model_array(client: AdditionalPropertiesClient):
     await client.spread_model_array.put(body)
 
 
+@pytest.mark.skip(reason="https://github.com/microsoft/typespec/pull/6425")
 @pytest.mark.asyncio
 async def test_spread_record_discriminated_union(client: AdditionalPropertiesClient):
     body = {

package/generator/test/generic_mock_api_tests/test_encode_bytes.py

@@ -103,7 +103,7 @@ def png_data() -> bytes:
 
 def test_request_body(client: BytesClient, png_data: bytes):
     client.request_body.default(
-        value=bytes("test", "utf-8"),
+        value=png_data,
     )
     client.request_body.octet_stream(
         value=png_data,
@@ -121,8 +121,9 @@ def test_request_body(client: BytesClient, png_data: bytes):
 
 def test_response_body(client: BytesClient, png_data: bytes):
     expected = b"test"
-    assert expected == client.response_body.default()
+    assert b"".join(client.response_body.default()) == png_data
     assert expected == client.response_body.base64()
-    assert expected == client.response_body.base64_url()
     assert b"".join(client.response_body.octet_stream()) == png_data
     assert b"".join(client.response_body.custom_content_type()) == png_data
+    # will reopen after TCGC release a fix version for https://github.com/Azure/typespec-azure/pull/2411
+    # assert expected == client.response_body.base64_url()

package/generator/test/generic_mock_api_tests/test_parameters_collection_format.py

@@ -29,9 +29,5 @@ def test_query_ssv(client: CollectionFormatClient):
     client.query.ssv(colors=["blue", "red", "green"])
 
 
-def test_query_tsv(client: CollectionFormatClient):
-    client.query.tsv(colors=["blue", "red", "green"])
-
-
 def test_csv_header(client: CollectionFormatClient):
     client.header.csv(colors=["blue", "red", "green"])

package/generator/test/generic_mock_api_tests/test_payload_pageable.py

@@ -0,0 +1,54 @@
+# -------------------------------------------------------------------------
+# 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 payload.pageable import PageableClient
+
+
+@pytest.fixture
+def client():
+    with PageableClient(endpoint="http://localhost:3000") as client:
+        yield client
+
+
+def assert_result(result):
+    assert len(result) == 4
+    assert result[0].id == "1"
+    assert result[1].id == "2"
+    assert result[2].id == "3"
+    assert result[3].id == "4"
+    assert result[0].name == "dog"
+    assert result[1].name == "cat"
+    assert result[2].name == "bird"
+    assert result[3].name == "fish"
+
+
+def test_link(client: PageableClient):
+    result = list(client.server_driven_pagination.link())
+    assert_result(result)
+
+
+def test_request_query_response_body(client: PageableClient):
+    result = list(client.server_driven_pagination.continuation_token.request_query_response_body(foo="foo", bar="bar"))
+    assert_result(result)
+
+
+def test_request_header_response_body(client: PageableClient):
+    result = list(client.server_driven_pagination.continuation_token.request_header_response_body(foo="foo", bar="bar"))
+    assert_result(result)
+
+
+def test_request_query_response_header(client: PageableClient):
+    result = list(
+        client.server_driven_pagination.continuation_token.request_query_response_header(foo="foo", bar="bar")
+    )
+    assert_result(result)
+
+
+def test_request_header_response_header(client: PageableClient):
+    result = list(
+        client.server_driven_pagination.continuation_token.request_header_response_header(foo="foo", bar="bar")
+    )
+    assert_result(result)

package/generator/test/generic_mock_api_tests/test_typetest_property_additionalproperties.py

@@ -236,6 +236,7 @@ def test_spread_model_array(client: AdditionalPropertiesClient):
     client.spread_model_array.put(body)
 
 
+@pytest.mark.skip(reason="https://github.com/microsoft/typespec/pull/6425")
 def test_spread_record_discriminated_union(client: AdditionalPropertiesClient):
     body = {
         "name": "abc",

package/generator/test/unbranded/tox.ini

@@ -10,7 +10,7 @@ commands =
     pytest mock_api_tests ../generic_mock_api_tests
 
     # pylint
-    pip install azure-pylint-guidelines-checker==0.5.1 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    pip install azure-pylint-guidelines-checker==0.5.2 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
     python ../../../eng/scripts/ci/run_pylint.py -t unbranded -s "generated" {posargs}
 
     # mypy
@@ -33,7 +33,7 @@ commands =
 deps=
     -r requirements.txt
 commands =
-    pip install azure-pylint-guidelines-checker==0.5.1 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
+    pip install azure-pylint-guidelines-checker==0.5.2 --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
     python ../../../eng/scripts/ci/run_pylint.py -t unbranded -s "generated" {posargs}
 
 [testenv:mypy]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.7.1",
+  "version": "0.8.1",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",
@@ -32,7 +32,7 @@
     "clean": "rimraf ./dist ./temp ./emitter/temp ./generator/test/azure/generated ./generator/test/unbranded/generated ./venv",
     "build": "tsc -p ./emitter/tsconfig.build.json && tsx ./eng/scripts/setup/build.ts",
     "watch": "tsc -p ./emitter/tsconfig.build.json --watch",
-    "lint": "eslint . --max-warnings=0",
+    "lint": "eslint emitter/ --max-warnings=0",
     "lint:py": "tsx ./eng/scripts/ci/lint.ts --folderName generator/pygen",
     "format": "pnpm -w format:dir packages/http-client-python && tsx ./eng/scripts/ci/format.ts",
     "install": "tsx ./eng/scripts/setup/install.ts",
@@ -53,16 +53,16 @@
     "emitter"
   ],
   "peerDependencies": {
-    "@azure-tools/typespec-autorest": ">=0.52.0 <1.0.0",
-    "@azure-tools/typespec-azure-core": ">=0.52.0 <1.0.0",
-    "@azure-tools/typespec-azure-resource-manager": ">=0.52.0 <1.0.0",
-    "@azure-tools/typespec-azure-rulesets": ">=0.52.0 <3.0.0",
-    "@azure-tools/typespec-client-generator-core": ">=0.52.0 <1.0.0",
-    "@typespec/compiler": ">=0.66.0 <1.0.0",
-    "@typespec/http": ">=0.66.0 <1.0.0",
-    "@typespec/openapi": ">=0.66.0 <1.0.0",
-    "@typespec/rest": ">=0.66.0 <1.0.0",
-    "@typespec/versioning": ">=0.66.0 <1.0.0"
+    "@azure-tools/typespec-autorest": ">=0.53.0 <1.0.0",
+    "@azure-tools/typespec-azure-core": ">=0.53.0 <1.0.0",
+    "@azure-tools/typespec-azure-resource-manager": ">=0.53.0 <1.0.0",
+    "@azure-tools/typespec-azure-rulesets": ">=0.53.0 <3.0.0",
+    "@azure-tools/typespec-client-generator-core": ">=0.53.0 <1.0.0",
+    "@typespec/compiler": ">=0.67.0 <1.0.0",
+    "@typespec/http": ">=0.67.0 <1.0.0",
+    "@typespec/openapi": ">=0.67.0 <1.0.0",
+    "@typespec/rest": ">=0.67.0 <1.0.0",
+    "@typespec/versioning": ">=0.67.0 <1.0.0"
   },
   "dependencies": {
     "js-yaml": "~4.1.0",
@@ -72,21 +72,21 @@
     "tsx": "~4.19.1"
   },
   "devDependencies": {
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.7",
-    "@azure-tools/typespec-autorest": "~0.52.0",
-    "@azure-tools/typespec-azure-core": "~0.52.0",
-    "@azure-tools/typespec-azure-resource-manager": "~0.52.0",
-    "@azure-tools/typespec-azure-rulesets": "~0.52.0",
-    "@azure-tools/typespec-client-generator-core": "~0.52.0",
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.10",
+    "@azure-tools/typespec-autorest": "~0.53.0",
+    "@azure-tools/typespec-azure-core": "~0.53.0",
+    "@azure-tools/typespec-azure-resource-manager": "~0.53.0",
+    "@azure-tools/typespec-azure-rulesets": "~0.53.0",
+    "@azure-tools/typespec-client-generator-core": "~0.53.0",
     "@types/js-yaml": "~4.0.5",
     "@types/node": "~22.5.4",
     "@types/semver": "7.5.8",
-    "@typespec/compiler": "~0.66.0",
-    "@typespec/http": "~0.66.0",
-    "@typespec/http-specs": "0.1.0-alpha.11",
-    "@typespec/openapi": "~0.66.0",
-    "@typespec/rest": "~0.66.0",
-    "@typespec/versioning": "~0.66.0",
+    "@typespec/compiler": "~0.67.0",
+    "@typespec/http": "~0.67.0",
+    "@typespec/http-specs": "0.1.0-alpha.15-dev.3",
+    "@typespec/openapi": "~0.67.0",
+    "@typespec/rest": "~0.67.0",
+    "@typespec/versioning": "~0.67.0",
     "c8": "^10.1.3",
     "chalk": "5.3.0",
     "rimraf": "~6.0.1",

package/generator/test/unbranded/mock_api_tests/cadl-ranch-config.yaml

@@ -1,27 +0,0 @@
-unsupportedScenarios: Azure_ClientGenerator_Core_Access_InternalOperation
-  Azure_ClientGenerator_Core_Access_PublicOperation
-  Azure_ClientGenerator_Core_Access_RelativeModelInOperation
-  Azure_ClientGenerator_Core_Access_SharedModelInOperation
-  Azure_ClientGenerator_Core_Usage_ModelInOperation
-  Azure_Core_Basic_createOrReplace
-  Azure_Core_Basic_createOrUpdate
-  Azure_Core_Basic_delete
-  Azure_Core_Basic_export
-  Azure_Core_Basic_get
-  Azure_Core_Basic_list
-  Azure_Core_Basic_listWithCustomPageModel
-  Azure_Core_Basic_listWithPage
-  Azure_Core_Basic_listWithParameters
-  Azure_Core_Basic_TwoModelsAsPageItem
-  Azure_Core_Lro_Rpc_longRunningRpc
-  Azure_Core_Lro_Standard_createOrReplace
-  Azure_Core_Lro_Standard_delete
-  Azure_Core_Lro_Standard_export
-  Azure_Core_Scalar_AzureLocationScalar_get
-  Azure_Core_Scalar_AzureLocationScalar_header
-  Azure_Core_Scalar_AzureLocationScalar_post
-  Azure_Core_Scalar_AzureLocationScalar_put
-  Azure_Core_Scalar_AzureLocationScalar_query
-  Azure_Core_Traits_repeatableAction
-  Azure_Core_Traits_smokeTest
-  Azure_SpecialHeaders_XmsClientRequestId