@typespec/http-client-python 0.7.1 → 0.8.0

package/emitter/src/http.ts

@@ -1,6 +1,7 @@
+import { NoTarget } from "@typespec/compiler";
+
 import {
   SdkBasicServiceMethod,
-  SdkBodyModelPropertyType,
   SdkBodyParameter,
   SdkClientType,
   SdkHeaderParameter,
@@ -10,16 +11,16 @@ import {
   SdkHttpResponse,
   SdkLroPagingServiceMethod,
   SdkLroServiceMethod,
+  SdkModelPropertyType,
   SdkPagingServiceMethod,
   SdkPathParameter,
   SdkQueryParameter,
   SdkServiceMethod,
   SdkServiceResponseHeader,
-  SdkType,
   UsageFlags,
 } from "@azure-tools/typespec-client-generator-core";
 import { HttpStatusCodeRange } from "@typespec/http";
-import { PythonSdkContext } from "./lib.js";
+import { PythonSdkContext, reportDiagnostic } from "./lib.js";
 import { KnownTypes, getType } from "./types.js";
 import {
   camelToSnakeCase,
@@ -29,6 +30,7 @@ import {
   getImplementation,
   isAbstract,
   isAzureCoreErrorResponse,
+  isContinuationToken,
 } from "./utils.js";
 
 function isContentTypeParameter(parameter: SdkHeaderParameter) {
@@ -96,6 +98,88 @@ function addLroInformation(
   };
 }
 
+function getWireNameFromPropertySegments(segments: SdkModelPropertyType[]): string | undefined {
+  if (segments[0].kind === "property") {
+    return segments
+      .filter((s) => s.kind === "property")
+      .map((s) => s.serializationOptions.json?.name ?? "")
+      .join(".");
+  }
+
+  return undefined;
+}
+
+function getWireNameWithDiagnostics(
+  context: PythonSdkContext<SdkHttpOperation>,
+  segments: SdkModelPropertyType[] | undefined,
+  code: "invalid-paging-items" | "invalid-next-link" | "invalid-lro-result",
+  method?: SdkServiceMethod<SdkHttpOperation>,
+): string | undefined {
+  if (segments && segments.length > 0) {
+    const result = getWireNameFromPropertySegments(segments);
+    if (result) {
+      return result;
+    }
+    const operationId = method ? method.name : "";
+    reportDiagnostic(context.program, {
+      code: code,
+      target: NoTarget,
+      format: { operationId: operationId },
+    });
+  }
+
+  return undefined;
+}
+
+function buildContinuationToken(
+  context: PythonSdkContext<SdkHttpOperation>,
+  method: SdkPagingServiceMethod<SdkHttpOperation> | SdkLroPagingServiceMethod<SdkHttpOperation>,
+  segments: SdkModelPropertyType[],
+  input: boolean = true,
+): Record<string, any> {
+  if (segments[0].kind === "property") {
+    const wireName = getWireNameFromPropertySegments(segments);
+    if (wireName) {
+      return { wireName, location: "body" };
+    }
+  } else if (input) {
+    for (const parameter of method.operation.parameters) {
+      if (isContinuationToken(parameter, method)) {
+        return { wireName: parameter.serializedName, location: parameter.kind };
+      }
+    }
+  } else {
+    for (const response of method.operation.responses) {
+      for (const header of response.headers) {
+        if (isContinuationToken(header, method, false)) {
+          return { wireName: header.serializedName, location: "header" };
+        }
+      }
+    }
+  }
+  reportDiagnostic(context.program, {
+    code: "invalid-continuation-token",
+    target: NoTarget,
+    format: { operationId: method.name, direction: input ? "request" : "response" },
+  });
+  return {};
+}
+
+function buildAllContinuationToken(
+  context: PythonSdkContext<SdkHttpOperation>,
+  method: SdkPagingServiceMethod<SdkHttpOperation> | SdkLroPagingServiceMethod<SdkHttpOperation>,
+): Record<string, any> {
+  const parameterSegments = method.pagingMetadata.continuationTokenParameterSegments ?? [];
+  const responseSegments = method.pagingMetadata.continuationTokenResponseSegments ?? [];
+  if (parameterSegments.length > 0 && responseSegments.length > 0) {
+    return {
+      input: buildContinuationToken(context, method, parameterSegments),
+      output: buildContinuationToken(context, method, responseSegments, false),
+    };
+  }
+  return {};
+}
+
 function addPagingInformation(
   context: PythonSdkContext<SdkHttpOperation>,
   rootClient: SdkClientType<SdkHttpOperation>,
@@ -109,13 +193,17 @@ function addPagingInformation(
   }
   const itemType = getType(context, method.response.type!);
   const base = emitHttpOperation(context, rootClient, operationGroupName, method.operation, method);
-  const itemName = getPropertyWireName(
-    method.operation.responses[0].type,
-    method.response.resultPath,
+  const itemName = getWireNameWithDiagnostics(
+    context,
+    method.response.resultSegments,
+    "invalid-paging-items",
+    method,
   );
-  const continuationTokenName = getPropertyWireName(
-    method.operation.responses[0].type,
-    method.nextLinkPath,
+  const nextLinkName = getWireNameWithDiagnostics(
+    context,
+    method.pagingMetadata.nextLinkSegments,
+    "invalid-next-link",
+    method,
   );
   base.responses.forEach((resp: Record<string, any>) => {
     resp.type = itemType;
@@ -126,23 +214,14 @@ function addPagingInformation(
     discriminator: "paging",
     exposeStreamKeyword: false,
     itemName,
-    continuationTokenName,
+    nextLinkName,
     itemType,
     description: method.doc ?? "",
     summary: method.summary,
+    continuationToken: buildAllContinuationToken(context, method),
   };
 }
 
-function getPropertyWireName(type: SdkType | undefined, path?: string) {
-  if (!path || !type || type.kind !== "model") return path;
-  for (const property of type.properties) {
-    if (property.name === path) {
-      return (property as SdkBodyModelPropertyType).serializedName;
-    }
-  }
-  return path;
-}
-
 export function emitLroHttpMethod(
   context: PythonSdkContext<SdkHttpOperation>,
   rootClient: SdkClientType<SdkHttpOperation>,
@@ -192,7 +271,7 @@ function emitHttpOperation(
   const result = {
     url: operation.path,
     method: operation.verb.toUpperCase(),
-    parameters: emitHttpParameters(context, rootClient, operation),
+    parameters: emitHttpParameters(context, rootClient, operation, method),
     bodyParameter: emitHttpBodyParameter(context, operation.bodyParam),
     responses,
     exceptions,
@@ -277,8 +356,9 @@ function emitHttpPathParameter(
 function emitHttpHeaderParameter(
   context: PythonSdkContext<SdkHttpOperation>,
   parameter: SdkHeaderParameter,
+  method: SdkServiceMethod<SdkHttpOperation>,
 ): Record<string, any> {
-  const base = emitParamBase(context, parameter);
+  const base = emitParamBase(context, parameter, method);
   const [delimiter, explode] = getDelimiterAndExplode(parameter);
   let clientDefaultValue = parameter.clientDefaultValue;
   if (isContentTypeParameter(parameter)) {
@@ -302,8 +382,9 @@ function emitHttpHeaderParameter(
 function emitHttpQueryParameter(
   context: PythonSdkContext<SdkHttpOperation>,
   parameter: SdkQueryParameter,
+  method: SdkServiceMethod<SdkHttpOperation>,
 ): Record<string, any> {
-  const base = emitParamBase(context, parameter);
+  const base = emitParamBase(context, parameter, method);
   const [delimiter, explode] = getDelimiterAndExplode(parameter);
   return {
     ...base,
@@ -320,15 +401,16 @@ function emitHttpParameters(
   context: PythonSdkContext<SdkHttpOperation>,
   rootClient: SdkClientType<SdkHttpOperation>,
   operation: SdkHttpOperation,
+  method: SdkServiceMethod<SdkHttpOperation>,
 ): Record<string, any>[] {
   const parameters: Record<string, any>[] = [...context.__endpointPathParameters];
   for (const parameter of operation.parameters) {
     switch (parameter.kind) {
       case "header":
-        parameters.push(emitHttpHeaderParameter(context, parameter));
+        parameters.push(emitHttpHeaderParameter(context, parameter, method));
         break;
       case "query":
-        parameters.push(emitHttpQueryParameter(context, parameter));
+        parameters.push(emitHttpQueryParameter(context, parameter, method));
         break;
       case "path":
         parameters.push(emitHttpPathParameter(context, parameter));
@@ -387,7 +469,12 @@ function emitHttpResponse(
     type,
     contentTypes: response.contentTypes,
     defaultContentType: response.defaultContentType ?? "application/json",
-    resultProperty: method?.response.resultPath,
+    resultProperty: getWireNameWithDiagnostics(
+      context,
+      method?.response.resultSegments,
+      "invalid-lro-result",
+      method,
+    ),
   };
 }
 

package/emitter/src/lib.ts

@@ -83,6 +83,30 @@ const libDef = {
         default: "Can't generate Python SDK since no client defined in typespec file.",
       },
     },
+    "invalid-paging-items": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`No valid paging items for operation '${"operationId"}'.`,
+      },
+    },
+    "invalid-next-link": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`No valid next link for operation '${"operationId"}'.`,
+      },
+    },
+    "invalid-lro-result": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`No valid LRO result for operation '${"operationId"}'.`,
+      },
+    },
+    "invalid-continuation-token": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`No valid continuation token in '${"direction"}' for operation '${"operationId"}'.`,
+      },
+    },
   },
   emitter: {
     options: EmitterOptionsSchema as JSONSchemaType<PythonEmitterOptions>,

package/emitter/src/types.ts

@@ -294,7 +294,7 @@ function emitModel<TServiceOperation extends SdkServiceOperation>(
     usage: type.usage,
     isXml: type.usage & UsageFlags.Xml ? true : false,
     xmlMetadata: getXmlMetadata(type),
-    clientNamespace: getClientNamespace(context, type.clientNamespace),
+    clientNamespace: getClientNamespace(context, type.namespace),
   };
 
   typesMap.set(type, newValue);
@@ -364,7 +364,7 @@ function emitEnum<TServiceOperation extends SdkServiceOperation>(
     values,
     xmlMetadata: {},
     crossLanguageDefinitionId: type.crossLanguageDefinitionId,
-    clientNamespace: getClientNamespace(context, type.clientNamespace),
+    clientNamespace: getClientNamespace(context, type.namespace),
   };
   for (const value of type.values) {
     newValue.values.push(emitEnumMember(value, newValue));
@@ -482,7 +482,7 @@ function emitUnion<TServiceOperation extends SdkServiceOperation>(
     type: "combined",
     types: type.variantTypes.map((x) => getType(context, x)),
     xmlMetadata: {},
-    clientNamespace: getClientNamespace(context, type.clientNamespace),
+    clientNamespace: getClientNamespace(context, type.namespace),
   });
 }
 

package/emitter/src/utils.ts

@@ -1,4 +1,5 @@
 import {
+  InitializedByFlags,
   SdkHeaderParameter,
   SdkHttpParameter,
   SdkMethod,
@@ -7,6 +8,7 @@ import {
   SdkQueryParameter,
   SdkServiceMethod,
   SdkServiceOperation,
+  SdkServiceResponseHeader,
   SdkType,
 } from "@azure-tools/typespec-client-generator-core";
 import { getNamespaceFullName } from "@typespec/compiler";
@@ -150,6 +152,7 @@ type ParamBase = {
   inOverload: boolean;
   isApiVersion: boolean;
   type: Record<string, any>;
+  isContinuationToken: boolean;
 };
 
 export function getAddedOn<TServiceOperation extends SdkServiceOperation>(
@@ -160,15 +163,46 @@ export function getAddedOn<TServiceOperation extends SdkServiceOperation>(
   // if type is added in the first version of the client, we do not need to add the versioning info
   if (
     type.apiVersions[0] ===
-    context.sdkPackage.clients.find((c) => c.initialization.access === "public")?.apiVersions[0]
+    context.sdkPackage.clients.find(
+      (c) => c.clientInitialization.initializedBy | InitializedByFlags.Individually,
+    )?.apiVersions[0]
   )
     return undefined;
   return type.apiVersions[0];
 }
 
+export function isContinuationToken<TServiceOperation extends SdkServiceOperation>(
+  parameter: SdkParameter | SdkHttpParameter | SdkServiceResponseHeader,
+  method?: SdkServiceMethod<TServiceOperation>,
+  input: boolean = true,
+): boolean {
+  const parameterSegments =
+    method && method.kind === "paging"
+      ? method.pagingMetadata.continuationTokenParameterSegments
+      : undefined;
+  const responseSegments =
+    method && method.kind === "paging"
+      ? method.pagingMetadata.continuationTokenResponseSegments
+      : undefined;
+  if (!parameterSegments || !responseSegments) return false;
+  if (input) {
+    return Boolean(
+      parameterSegments &&
+        parameterSegments.length > 0 &&
+        (parameter.kind === "header" || parameter.kind === "query" || parameter.kind === "body") &&
+        parameterSegments.at(-1) === parameter.correspondingMethodParams.at(-1),
+    );
+  }
+
+  return Boolean(
+    responseSegments && responseSegments.length > 0 && responseSegments.at(-1) === parameter,
+  );
+}
+
 export function emitParamBase<TServiceOperation extends SdkServiceOperation>(
   context: PythonSdkContext<TServiceOperation>,
   parameter: SdkParameter | SdkHttpParameter,
+  method?: SdkServiceMethod<TServiceOperation>,
 ): ParamBase {
   let type = getType(context, parameter.type);
   if (parameter.isApiVersionParam) {
@@ -187,6 +221,7 @@ export function emitParamBase<TServiceOperation extends SdkServiceOperation>(
     clientName: camelToSnakeCase(parameter.name),
     inOverload: false,
     isApiVersion: parameter.isApiVersionParam,
+    isContinuationToken: isContinuationToken(parameter, method),
     type,
   };
 }