[python] add support for parameterized next link (#7152)

fixes #6681

---------

Co-authored-by: iscai-msft <[email protected]>
Co-authored-by: tadelesh <[email protected]>

Author: 3 people

.chronus/changes/python-parameterizedNextLink-2025-3-28-12-34-24.md

@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@typespec/http-client-python"
+---
+
+Add support for legacy parameterized next links

cspell.yaml

@@ -203,6 +203,7 @@ words:
   - recorda
   - regen
   - rehype
+  - reinjected
   - repr
   - respecify
   - rjust

packages/http-client-python/.vscode/launch.json

@@ -10,7 +10,7 @@
       "cwd": "${workspaceFolder}",
       "args": [
         "compile",
-        "${workspaceFolder}/DocumentIntelligence",
+        "${workspaceFolder}/node_modules/@azure-tools/azure-http-specs/specs/azure/core/page",
         "--emit=${workspaceFolder}",
         "--option=@typespec/http-client-python.debug=true"
       ],

packages/http-client-python/emitter/src/http.ts

@@ -208,13 +208,26 @@ function addPagingInformation(
   base.responses.forEach((resp: Record<string, any>) => {
     resp.type = itemType;
   });
+  const nextLinkReInjectedParameters: Record<string, any>[] = [];
+  for (const segList of method.pagingMetadata.nextLinkReInjectedParametersSegments ?? []) {
+    for (const param of segList) {
+      if (param.kind === "method") {
+        for (const parameter of method.operation.parameters) {
+          if (parameter.kind === "query" && parameter.correspondingMethodParams.includes(param)) {
+            nextLinkReInjectedParameters.push(emitHttpQueryParameter(context, parameter, method));
+          }
+        }
+      }
+    }
+  }
   return {
     ...base,
     name: camelToSnakeCase(method.name),
     discriminator: "paging",
     exposeStreamKeyword: false,
     itemName,
     nextLinkName,
+    nextLinkReInjectedParameters,
     itemType,
     description: method.doc ?? "",
     summary: method.summary,

packages/http-client-python/eng/scripts/ci/mypy.ini

@@ -2,7 +2,7 @@
 [mypy]
 python_version = 3.9
 # Exclude mypy check for sub client tests
-exclude = (azure/clientgenerator/core/clientinitialization/operations/_operations\.py|azure/clientgenerator/core/clientinitialization/aio/operations/_operations\.py)
+exclude = (.*azure/clientgenerator/core/clientinitialization/operations/_operations\.py|.*azure/clientgenerator/core/clientinitialization/aio/operations/_operations\.py)
 
 # module level configurations
 [mypy-jsonrpc.*]

packages/http-client-python/eng/scripts/ci/regenerate.ts

@@ -263,6 +263,7 @@ async function executeCommand(tspCommand: TspCommand): Promise<void> {
   }
   const execFileAsync = promisify(execFile);
   try {
+    console.log(chalk.green(`start tsp ${tspCommand.command.join(" ")}`));
     await execFileAsync("tsp", tspCommand.command, { shell: true });
     console.log(chalk.green(`tsp ${tspCommand.command.join(" ")} succeeded`));
   } catch (err) {
@@ -404,16 +405,20 @@ function _getCmdList(spec: string, flags: RegenerateFlags): TspCommand[] {
 }
 
 async function runTaskPool(tasks: Array<() => Promise<void>>, poolLimit: number): Promise<void> {
-  let currentIndex = 0;
-
-  async function worker() {
-    while (currentIndex < tasks.length) {
-      const index = currentIndex++;
-      await tasks[index]();
+  async function worker(start: number, end: number) {
+    while (start < end) {
+      await tasks[start]();
+      start++;
     }
   }
 
-  const workers = new Array(Math.min(poolLimit, tasks.length)).fill(null).map(() => worker());
+  const workers = [];
+  let start = 0;
+  while (start < tasks.length) {
+    const end = Math.min(start + poolLimit, tasks.length);
+    workers.push((async () => await worker(start, end))());
+    start = end;
+  }
   await Promise.all(workers);
 }
 

packages/http-client-python/generator/pygen/codegen/models/paging_operation.py

@@ -16,6 +16,7 @@
 from .parameter_list import ParameterList
 from .model_type import ModelType
 from .list_type import ListType
+from .parameter import Parameter
 
 if TYPE_CHECKING:
     from .code_model import CodeModel
@@ -59,6 +60,9 @@ def __init__(
         self.pager_sync: str = yaml_data.get("pagerSync") or f"{self.code_model.core_library}.paging.ItemPaged"
         self.pager_async: str = yaml_data.get("pagerAsync") or f"{self.code_model.core_library}.paging.AsyncItemPaged"
         self.continuation_token: Dict[str, Any] = yaml_data.get("continuationToken", {})
+        self.next_link_reinjected_parameters: List[Parameter] = [
+            Parameter.from_yaml(p, code_model) for p in yaml_data.get("nextLinkReInjectedParameters", [])
+        ]
 
     @property
     def has_continuation_token(self) -> bool:

packages/http-client-python/generator/pygen/codegen/serializers/builder_serializer.py

@@ -1276,6 +1276,17 @@ def call_next_link_request_builder(self, builder: PagingOperationType) -> List[s
                 else api_version_param.full_client_name
             )
             retval.append(f'_next_request_params["api-version"] = {api_version}')
+            if builder.next_link_reinjected_parameters:
+                for param in builder.next_link_reinjected_parameters:
+                    if param.location == ParameterLocation.QUERY:
+                        retval.extend(
+                            self.parameter_serializer.serialize_query_header(
+                                param,
+                                "next_request_params",
+                                self.serializer_name,
+                                self.code_model.is_legacy,
+                            )
+                        )
             query_str = ", params=_next_request_params"
             next_link_str = "urllib.parse.urljoin(next_link, _parsed_next_link.path)"
         except StopIteration:

packages/http-client-python/generator/test/azure/mock_api_tests/asynctests/test_azure_core_page_async.py

@@ -56,3 +56,13 @@ async def test_two_models_as_page_item(client: aio.PageClient):
     result = [item async for item in client.two_models_as_page_item.list_second_item()]
     assert len(result) == 1
     assert result[0].name == "Madge"
+
+
+@pytest.mark.asyncio
+async def test_list_with_parameterized_next_link(client: aio.PageClient):
+    result = [item async for item in client.with_parameterized_next_link(select="name", include_pending=True)]
+    assert len(result) == 2
+    assert result[0].id == 1
+    assert result[0].name == "User1"
+    assert result[1].id == 2
+    assert result[1].name == "User2"

packages/http-client-python/generator/test/azure/mock_api_tests/test_azure_core_page.py

@@ -49,3 +49,12 @@ def test_two_models_as_page_item(client: PageClient):
     result = list(client.two_models_as_page_item.list_second_item())
     assert len(result) == 1
     assert result[0].name == "Madge"
+
+
+def test_list_with_parameterized_next_link(client: PageClient):
+    result = list(client.with_parameterized_next_link(select="name", include_pending=True))
+    assert len(result) == 2
+    assert result[0].id == 1
+    assert result[0].name == "User1"
+    assert result[1].id == 2
+    assert result[1].name == "User2"