@typespec/http-client-python 0.7.0 → 0.8.0

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

@@ -630,7 +630,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
             operation_name=f"('{builder.name}')" if builder.group_name == "" else "",
         )
         for p in builder.parameters.parameters:
-            if p.hide_in_operation_signature:
+            if p.hide_in_operation_signature and not p.is_continuation_token:
                 kwargs.append(f'{p.client_name} = kwargs.pop("{p.client_name}", None)')
         cls_annotation = builder.cls_type_annotation(
             async_mode=self.async_mode, serialize_namespace=self.serialize_namespace
@@ -1001,9 +1001,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                 retval.extend(deserialize_code)
         return retval
 
-    def handle_error_response(  # pylint: disable=too-many-statements, too-many-branches
-        self, builder: OperationType
-    ) -> List[str]:
+    def handle_error_response(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 = [
@@ -1290,16 +1288,20 @@ class _PagingOperationSerializer(_OperationSerializer[PagingOperationType]):
 
     def _prepare_request_callback(self, builder: PagingOperationType) -> List[str]:
         retval = self._initialize_overloads(builder)
-        retval.append("def prepare_request(next_link=None):")
-        retval.append("    if not next_link:")
-        retval.extend([f"        {line}" for line in self.call_request_builder(builder, is_paging=True)])
-        retval.append("")
-        retval.append("    else:")
-        retval.extend([f"        {line}" for line in self.call_next_link_request_builder(builder)])
-        if not builder.next_request_builder and self.code_model.is_legacy:
-            retval.append('        _request.method = "GET"')
+        if builder.has_continuation_token:
+            retval.append(f"def prepare_request({builder.next_variable_name}=None):")
+            retval.extend([f"    {line}" for line in self.call_request_builder(builder, is_paging=True)])
         else:
+            retval.append("def prepare_request(next_link=None):")
+            retval.append("    if not next_link:")
+            retval.extend([f"        {line}" for line in self.call_request_builder(builder, is_paging=True)])
             retval.append("")
+            retval.append("    else:")
+            retval.extend([f"        {line}" for line in self.call_next_link_request_builder(builder)])
+            if not builder.next_request_builder and self.code_model.is_legacy:
+                retval.append('        _request.method = "GET"')
+            else:
+                retval.append("")
         retval.append("    return _request")
         return retval
 
@@ -1307,7 +1309,7 @@ class _PagingOperationSerializer(_OperationSerializer[PagingOperationType]):
     def _function_def(self) -> str:
         return "def"
 
-    def _extract_data_callback(self, builder: PagingOperationType) -> List[str]:
+    def _extract_data_callback(self, builder: PagingOperationType) -> List[str]:  # pylint: disable=too-many-statements
         retval = [f"{'async ' if self.async_mode else ''}def extract_data(pipeline_response):"]
         response = builder.responses[0]
         deserialized = "pipeline_response.http_response.json()"
@@ -1328,7 +1330,13 @@ class _PagingOperationSerializer(_OperationSerializer[PagingOperationType]):
         else:
             retval.append(f"    deserialized = {deserialized}")
         item_name = builder.item_name
-        access = f".{item_name}" if self.code_model.options["models_mode"] == "msrest" else f'["{item_name}"]'
+        if self.code_model.options["models_mode"] == "msrest":
+            access = f".{item_name}"
+        else:
+            item_name_array = item_name.split(".")
+            access = (
+                "".join([f'.get("{i}", {{}})' for i in item_name_array[:-1]]) + f'.get("{item_name_array[-1]}", [])'
+            )
         list_of_elem_deserialized = ""
         if self.code_model.options["models_mode"] == "dpg":
             item_type = builder.item_type.type_annotation(
@@ -1341,20 +1349,34 @@ class _PagingOperationSerializer(_OperationSerializer[PagingOperationType]):
         retval.append("    if cls:")
         retval.append("        list_of_elem = cls(list_of_elem) # type: ignore")
 
-        continuation_token_name = builder.continuation_token_name
-        if not continuation_token_name:
-            cont_token_property = "None"
-        elif self.code_model.options["models_mode"] == "msrest":
-            cont_token_property = f"deserialized.{continuation_token_name} or None"
+        if builder.has_continuation_token:
+            location = builder.continuation_token.get("output", {}).get("location")
+            wire_name = builder.continuation_token.get("output", {}).get("wireName") or ""
+            if location == "header":
+                cont_token_property = f'pipeline_response.http_response.headers.get("{wire_name}") or None'
+            else:
+                wire_name_array = wire_name.split(".")
+                wire_name_call = (
+                    "".join([f'.get("{i}", {{}})' for i in wire_name_array[:-1]]) + f'.get("{wire_name_array[-1]}")'
+                )
+                cont_token_property = f"deserialized{wire_name_call} or None"
         else:
-            cont_token_property = f'deserialized.get("{continuation_token_name}") or None'
+            next_link_name = builder.next_link_name
+            if not next_link_name:
+                cont_token_property = "None"
+            elif self.code_model.options["models_mode"] == "msrest":
+                cont_token_property = f"deserialized.{next_link_name} or None"
+            else:
+                cont_token_property = f'deserialized.get("{next_link_name}") or None'
         list_type = "AsyncList" if self.async_mode else "iter"
         retval.append(f"    return {cont_token_property}, {list_type}(list_of_elem)")
         return retval
 
     def _get_next_callback(self, builder: PagingOperationType) -> List[str]:
-        retval = [f"{'async ' if self.async_mode else ''}def get_next(next_link=None):"]
-        retval.append("    _request = prepare_request(next_link)")
+        retval = [
+            f"{'async ' if self.async_mode else ''}def get_next({builder.next_variable_name}=None):"  # pylint: disable=line-too-long
+        ]
+        retval.append(f"    _request = prepare_request({builder.next_variable_name})")
         retval.append("")
         retval.extend([f"    {l}" for l in self.make_pipeline_call(builder)])
         retval.append("    response = pipeline_response.http_response")
@@ -1506,10 +1528,10 @@ class LROPagingOperationSerializer(
 
     def get_long_running_output(self, builder: LROPagingOperation) -> List[str]:
         retval = ["def get_long_running_output(pipeline_response):"]
-        retval.append(f"    {self._function_def} internal_get_next(next_link=None):")
-        retval.append("        if next_link is None:")
+        retval.append(f"    {self._function_def} internal_get_next({builder.next_variable_name}=None):")
+        retval.append(f"        if {builder.next_variable_name} is None:")
         retval.append("            return pipeline_response")
-        retval.append(f"        return {self._call_method}get_next(next_link)")
+        retval.append(f"        return {self._call_method}get_next({builder.next_variable_name})")
         retval.append("")
         retval.append(f"    return {builder.get_pager(self.async_mode)}(")
         retval.append("        internal_get_next, extract_data")

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/pygen.egg-info/PKG-INFO

@@ -20,7 +20,6 @@ License-File: LICENSE
 Requires-Dist: black==24.8.0
 Requires-Dist: docutils>=0.20.1
 Requires-Dist: Jinja2==3.1.3
-Requires-Dist: m2r2==0.3.3.post2
 Requires-Dist: PyYAML==6.0.1
 Requires-Dist: tomli==2.0.1
 Requires-Dist: setuptools==69.5.1

package/generator/pygen.egg-info/SOURCES.txt

@@ -5,7 +5,6 @@ setup.py
 pygen/__init__.py
 pygen/_version.py
 pygen/black.py
-pygen/m2r.py
 pygen/utils.py
 pygen.egg-info/PKG-INFO
 pygen.egg-info/SOURCES.txt

package/generator/pygen.egg-info/requires.txt

@@ -1,7 +1,6 @@
 black==24.8.0
 docutils>=0.20.1
 Jinja2==3.1.3
-m2r2==0.3.3.post2
 PyYAML==6.0.1
 tomli==2.0.1
 setuptools==69.5.1

package/generator/setup.py

@@ -51,7 +51,6 @@ setup(
         "black==24.8.0",
         "docutils>=0.20.1",
         "Jinja2==3.1.3",
-        "m2r2==0.3.3.post2",
         "PyYAML==6.0.1",
         "tomli==2.0.1",
         "setuptools==69.5.1",

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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-python",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec emitter for Python SDKs",
   "homepage": "https://typespec.io",
@@ -66,6 +66,7 @@
   },
   "dependencies": {
     "js-yaml": "~4.1.0",
+    "marked": "^15.0.6",
     "pyodide": "0.26.2",
     "semver": "~7.6.2",
     "tsx": "~4.19.1"

package/generator/build/lib/pygen/m2r.py

@@ -1,65 +0,0 @@
-# -------------------------------------------------------------------------
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for
-# license information.
-# --------------------------------------------------------------------------
-"""An MD to RST plugin.
-"""
-import logging
-from typing import Any, Dict, Set, Union
-
-import m2r2
-
-from . import YamlUpdatePlugin
-from .utils import parse_args
-
-
-_LOGGER = logging.getLogger(__name__)
-
-
-class GeneratorRenderer(m2r2.RestRenderer):
-    """Redefine the concept of inline HTML in the renderer, we don't want to define a new format
-    in the description/summary.
-    """
-
-    def inline_html(self, html: str) -> str:
-        """Do not render inline HTML with a role definition."""
-        return r"\ :code:`{}`".format(html)
-
-
-class M2R(YamlUpdatePlugin):
-    """A plugin to convert any description and summary from MD to RST."""
-
-    def update_yaml(self, yaml_data: Dict[str, Any]) -> None:
-        """Convert in place the YAML str."""
-        self._convert_docstring_no_cycles(yaml_data, set())
-
-    def _convert_docstring_no_cycles(self, yaml_data: Union[Dict[str, Any], str], node_list: Set[int]) -> None:
-        """Walk the YAML tree to convert MD to RST."""
-        if id(yaml_data) in node_list:
-            return
-        node_list.add(id(yaml_data))
-
-        if isinstance(yaml_data, list):
-            for elt in yaml_data:
-                self._convert_docstring_no_cycles(elt, node_list)
-        elif isinstance(yaml_data, dict):
-            for key, value in yaml_data.items():
-                if key in ["description", "summary"]:
-                    yaml_data[key] = self.convert_to_rst(value)
-                    continue
-                self._convert_docstring_no_cycles(value, node_list)
-
-    @staticmethod
-    def convert_to_rst(string_to_convert: str) -> str:
-        """Convert that string from MD to RST."""
-        try:
-            return m2r2.convert(string_to_convert, renderer=GeneratorRenderer()).strip()
-        except Exception:  # pylint: disable=broad-except
-            return string_to_convert
-
-
-if __name__ == "__main__":
-    # CADL pipeline will call this
-    args, unknown_args = parse_args()
-    M2R(output_folder=args.output_folder, cadl_file=args.cadl_file, **unknown_args).process()

package/generator/pygen/m2r.py

@@ -1,65 +0,0 @@
-# -------------------------------------------------------------------------
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for
-# license information.
-# --------------------------------------------------------------------------
-"""An MD to RST plugin.
-"""
-import logging
-from typing import Any, Dict, Set, Union
-
-import m2r2
-
-from . import YamlUpdatePlugin
-from .utils import parse_args
-
-
-_LOGGER = logging.getLogger(__name__)
-
-
-class GeneratorRenderer(m2r2.RestRenderer):
-    """Redefine the concept of inline HTML in the renderer, we don't want to define a new format
-    in the description/summary.
-    """
-
-    def inline_html(self, html: str) -> str:
-        """Do not render inline HTML with a role definition."""
-        return r"\ :code:`{}`".format(html)
-
-
-class M2R(YamlUpdatePlugin):
-    """A plugin to convert any description and summary from MD to RST."""
-
-    def update_yaml(self, yaml_data: Dict[str, Any]) -> None:
-        """Convert in place the YAML str."""
-        self._convert_docstring_no_cycles(yaml_data, set())
-
-    def _convert_docstring_no_cycles(self, yaml_data: Union[Dict[str, Any], str], node_list: Set[int]) -> None:
-        """Walk the YAML tree to convert MD to RST."""
-        if id(yaml_data) in node_list:
-            return
-        node_list.add(id(yaml_data))
-
-        if isinstance(yaml_data, list):
-            for elt in yaml_data:
-                self._convert_docstring_no_cycles(elt, node_list)
-        elif isinstance(yaml_data, dict):
-            for key, value in yaml_data.items():
-                if key in ["description", "summary"]:
-                    yaml_data[key] = self.convert_to_rst(value)
-                    continue
-                self._convert_docstring_no_cycles(value, node_list)
-
-    @staticmethod
-    def convert_to_rst(string_to_convert: str) -> str:
-        """Convert that string from MD to RST."""
-        try:
-            return m2r2.convert(string_to_convert, renderer=GeneratorRenderer()).strip()
-        except Exception:  # pylint: disable=broad-except
-            return string_to_convert
-
-
-if __name__ == "__main__":
-    # CADL pipeline will call this
-    args, unknown_args = parse_args()
-    M2R(output_folder=args.output_folder, cadl_file=args.cadl_file, **unknown_args).process()

package/generator/test/generic_mock_api_tests/unittests/test_m2r.py

@@ -1,10 +0,0 @@
-# ------------------------------------
-# Copyright (c) Microsoft Corporation.
-# Licensed under the MIT License.
-# ------------------------------------
-from pygen.m2r import M2R
-
-
-def test_inline_html():
-    des = "Format: <MajorVersion>.<MinorVersion>.<Patch>"
-    M2R.convert_to_rst(des) == r"Format: \ :code:`<MajorVersion>`.\ :code:`<MinorVersion>`.\ :code:`<Patch>`"

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