@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 使用按键逐字记录。 变量总是保留线名. |
baseModel | string | 'BaseModel' | 生成结果类型的基类扩展 . |
runtimeImport | string | 'pydantic' | 模块基模从( )from {runtimeImport} import {baseModel},与 ConfigDict编号 :Field 在使用别名时附加). |
typesImport | string | – 说吧 – | 如果设定, 预留 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 软件包).