@graphql-codegen/python-operations

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

由文档驱动的 GraphQL 代码生成器插件,该插件释放出 Python 操作类型(操作结果+变量).

中文使用文档
文档目录4 节
  1. 示例
  2. 配置
  3. 行为/ 命名
  4. 不支持( 尚未支持)

@graphql-codegen/python-操作

A 类 文档驱动 GraphQL 代码生成器 插件那个 发射 Python 操作类型: 对于文档中的每个操作,它生成每次操作 结果 烟花 BaseModel 类别(每类命名、巢类) 对象选择)加a <Operation>Variables TypedDict 由线( GraphQL) 变量键入 名称。 重命名的响应密钥被固定 Field(alias=...) (单位:千美元) model_config = ConfigDict(populate_by_name=True)。 。 。 .

是业务对应方 @graphql-codegen/python (释放出基础计划类型), 类似如何 typescript-operations 补充 typescript。 。 。 .

示例

司马:

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

操作 :

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

输出 :

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]'

结果类型为 pydantic BaseModel 子类 <Operation>Variables 类型保持a TypedDict当一个响应键被重新命名(snake case或保留关键字)时,该属性是 被钉住 Field(alias='<wireName>') 和班级得到 model_config = ConfigDict(populate_by_name=True)。 。 。 .

配置

选项类型默认说明
namingConvention'keep' | 'snakeCase''snakeCase'反应键如何成为结果类属性. snakeCase 转换 Case snake* case, 后缀保留关键字 *,并重新命名为密钥 Field(alias=...)。 。 。 . keep 使用按键逐字记录。 变量总是保留线名.
baseModelstring'BaseModel'生成结果类型的基类扩展 .
runtimeImportstring'pydantic'模块基模从( )from {runtimeImport} import {baseModel},与 ConfigDict编号 :Field 在使用别名时附加).
typesImportstring– 说吧 –如果设定, 预留 from {typesImport} import * 因此在运行时间解析了基准类型名称(enum, 输入).

行为/ 命名

  • 结果根类型 : <OperationName><OperationType> (例如:. GetUsersQuery) (中文(简体) ).
  • 嵌入对象选择 : <ParentTypeName><PascalCase(responseFieldName)>。 。 。 .
  • 变量类型 : <OperationName><OperationType>Variables。 。 。 .
  • 字段名称是 snake_case; Python 保留的关键字获得后缀 _。 。 。 .
  • 异名使用别名作为响应键; __typename 变成 __typename__。 。 。 .
  • 每引注(前出引出),故出出令也.

不支持( 尚未支持)

碎片扩散、内含碎片和工会成员(... on Type) 尚未选定 已执行。 而不是默默地省略他们的字段(这会产生一种结果类型,即: 外观合法但数据缺失,插件 丢出一个明显的错误 生成时间,如果 行动包含一个——将实地直接纳入行动。 见 src/python-helpers.ts 用于重复的命名助手( TODO: 提取到共享) @graphql-codegen/python-common 软件包).

版本与发布记录

@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 是什么?

由文档驱动的 GraphQL 代码生成器插件,该插件释放出 Python 操作类型(操作结果+变量).

如何安装 @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 和提交记录判断。