Skip to content

[python] consider usage decorator for paging models #9001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[python] consider usage decorator for paging models #9001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a72e89b
consider usage override when dealing with paging models
Nov 13, 2025
37578fc
add changeset
Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .chronus/changes/python-pagingModelUsage-2025-10-13-15-25-59.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
changeKind: fix
packages:
- "@typespec/http-client-python"
---

Emit paging models marked with `@usage` overrides
5 changes: 4 additions & 1 deletion packages/http-client-python/emitter/src/code-model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,9 +335,12 @@ export function emitCodeModel(sdkContext: PythonSdkContext) {
}
getType(sdkContext, sdkEnum);
}

// clear usage when a model is only used by paging
for (const type of typesMap.values()) {
const usageOverride = (type["usageOverride"] as UsageFlags | undefined) || 0;
if ((usageOverride & UsageFlags.Input) > 0 || (usageOverride & UsageFlags.Output) > 0) {
continue; // Don't clear usage for types used as Input or Output
Copy link
Contributor

@msyyc msyyc Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any context or issue for this PR?

}
if (
type["type"] === "model" &&
type["referredByOperationType"] === ReferredByOperationTypes.PagingOnly
Expand Down
4 changes: 3 additions & 1 deletion packages/http-client-python/emitter/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import {
getUsageOverride,
isHttpMetadata,
SdkArrayType,
SdkBuiltInType,
Expand All @@ -16,7 +17,7 @@ import {
SdkUnionType,
UsageFlags,
} from "@azure-tools/typespec-client-generator-core";
import { Type } from "@typespec/compiler";
import { Model, Type } from "@typespec/compiler";
import { HttpAuth, Visibility } from "@typespec/http";
import { dump } from "js-yaml";
import { PythonSdkContext } from "./lib.js";
Expand Down Expand Up @@ -284,6 +285,7 @@ function emitModel(context: PythonSdkContext, type: SdkModelType): Record<string
internal: type.access === "internal",
crossLanguageDefinitionId: type.crossLanguageDefinitionId,
usage: type.usage,
usageOverride: type.__raw ? getUsageOverride(context, type.__raw as Model) : undefined,
isXml: type.usage & UsageFlags.Xml ? true : false,
xmlMetadata: getXmlMetadata(type),
clientNamespace: getClientNamespace(context, type.namespace),
Expand Down
Loading