@graphql-codegen/python-operations

中文文档
0.1.0发布于 2026/11/11MITTypeScriptESM + CJS构建来源已验证近 30 天下载 4989

Document-driven GraphQL Code Generator plugin that emits Python operation types (per-operation result + variables).

原始使用文档
文档目录4 节
  1. Example
  2. Config
  3. Behaviour / naming
  4. Not (yet) supported

@graphql-codegen/python-operations

A document-driven GraphQL Code Generator plugin that emits Python operation types: for each operation in your documents it generates per-operation result pydantic BaseModel classes (named, nested classes for every object selection) plus a <Operation>Variables TypedDict keyed by the wire (GraphQL) variable names. Renamed response keys are pinned with Field(alias=...) and a model_config = ConfigDict(populate_by_name=True).

It is the operations counterpart to @graphql-codegen/python (which emits base schema types), analogous to how typescript-operations complements typescript.

Example

Schema:

enum Role {
  ADMIN
  USER
}
type User {
  id: ID!
  name: String!
  role: Role!
  friends: [User!]!
}
type Query {
  users(role: Role): [User!]!
}

Operation:

query GetUsers($role: Role) {
  users(role: $role) {
    id
    name
    role
    friends {
      id
      name
    }
  }
}

Output:

from typing import Optional, TypedDict
from pydantic import BaseModel


class GetUsersQueryUsersFriends(BaseModel):
    id: 'str'
    name: 'str'


class GetUsersQueryUsers(BaseModel):
    id: 'str'
    name: 'str'
    role: 'Role'
    friends: 'list[GetUsersQueryUsersFriends]'


class GetUsersQuery(BaseModel):
    users: 'list[GetUsersQueryUsers]'


class GetUsersQueryVariables(TypedDict):
    role: 'Optional[Role]'

Result types are pydantic BaseModel subclasses; the <Operation>Variables type stays a TypedDict. When a response key is renamed (snake_case or a reserved keyword), that attribute is pinned with Field(alias='<wireName>') and the class gets model_config = ConfigDict(populate_by_name=True).

Config

OptionTypeDefaultDescription
namingConvention'keep' | 'snakeCase''snakeCase'How response keys become result-class attributes. snakeCase converts camelCase→snake*case, suffixes reserved keywords with *, and pins renamed keys via Field(alias=...). keep uses keys verbatim. Variables always keep the wire name.
baseModelstring'BaseModel'Base class the generated result types extend.
runtimeImportstring'pydantic'Module the base model is imported from (from {runtimeImport} import {baseModel}, with ConfigDict/Field appended when aliases are used).
typesImportstring–If set, prepend from {typesImport} import * so base type names (enums, inputs) resolve at runtime.

Behaviour / naming

  • Result root type: <OperationName><OperationType> (e.g. GetUsersQuery).
  • Nested object selections: <ParentTypeName><PascalCase(responseFieldName)>.
  • Variables type: <OperationName><OperationType>Variables.
  • Field names are snake_case; Python reserved keywords get a trailing _.
  • Aliases use the alias as the response key; __typename becomes __typename__.
  • Every annotation is quoted (forward reference), so emit order does not matter.

Not (yet) supported

Fragment spreads, inline fragments and union member (... on Type) selections are not yet implemented. Rather than silently omitting their fields (which would produce a result type that looks valid but is missing data), the plugin throws a clear error at generate time if an operation contains one — inline the fields directly into the operation for now. See src/python-helpers.ts for the duplicated naming helpers (TODO: extract to a shared @graphql-codegen/python-common package).

版本与发布记录

@graphql-codegen/python-operations 共发布 29 个版本,首次发布于 2026/10/28;过去 12 个月发布了 29 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.0latest2026/11/115 天前
0.1.0-alpha-20261111095912-96ab889adc0f15f8a38d9950fef222ef73c46126alpha2026/11/115 天前
0.1.0-alpha-20261111092512-1367cf9075eac4fe42ec8e1d72610d15f541aa1d2026/11/115 天前
0.1.0-alpha-20261111092317-6bc0e0e15089cd3f43bfeb2b653a5086f48d05452026/11/115 天前
0.1.0-alpha-20261110215755-5ad8c7676642f8eaeee75d66042c7e8be214da642026/11/116 天前
0.1.0-alpha-20261110130114-66e7e67a38e78ab7516629f6d800b650e2fba9422026/11/106 天前

关于 @graphql-codegen/python-operations 的常见问题

@graphql-codegen/python-operations 是什么?

Document-driven GraphQL Code Generator plugin that emits Python operation types (per-operation result + variables).

如何安装 @graphql-codegen/python-operations?

在项目目录运行 npm install @graphql-codegen/python-operations,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:graphql(^16.0.0 || ^17.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@graphql-codegen/python-operations 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@graphql-codegen/python-operations 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@graphql-codegen/python-operations 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.18.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@graphql-codegen/python-operations 可以商用吗?

@graphql-codegen/python-operations 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@graphql-codegen/python-operations 的下载量有多少?

根据 npm 官方下载统计,@graphql-codegen/python-operations 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,989 次,日均约 166 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@graphql-codegen/python-operations 还在维护吗?

最新版本 0.1.0 发布于 2026/11/11(5 天前);至今共发布 29 个版本,其中过去 12 个月发布了 29 个;首次发布于 2026/10/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。