Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

`graphql_schema` introspection doesn't output docstrings descriptions

未关闭
#1,492 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
38/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
graphql, python
领域
api

调研方向

通过定义带有 docstring 描述的 Graphene 类型和字段来复现该问题，然后运行 manage graphql_schema 命令导出 schema.graphql。将导出的 schema 与预期的类型和字段描述进行比较；当输出中包含这两项描述，并且在适用的情况下也检查了 description= 和 Meta 的行为时，即表示完成。

由索引模型根据 Issue 内容生成。

描述

🐛 bug

Note: for support questions, please use stackoverflow. This repository's issues are reserved for feature requests and bug reports.

  • What is the current behavior?

Running manage graphql_schema to export the schema.graphql doesn't output the description for types and fields. I've only tested it when the description is described via docstrings, e.g.:

class SomeType(graphene.ObjectType):
    """
    Some description
    """

    field = graphene.String()

but I suspect it also doesn't work when using description= or the Meta class as described here:

Screenshot 2023-01-12 at 11 37 23
  • If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via
    a github repo, https://repl.it or similar.
  • Create a schema with at least one type with a description (and/or a field description)
  • Run the graphql_schema introspection command to export a schema.graphql file
  • What is the expected behavior?

The schema is outputted including field and type descriptions.

  • What is the motivation / use case for changing the behavior?

No type or field descriptions are exported.

  • Please tell us about your environment:

    • Version: ^2.13.0
    • Platform:

  • Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow)

主要语言
Python
星标
8.2k
派生
818
30 天内没有已合并 PR

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

graphql-python/graphene 的其他 Issue

查看 graphql-python/graphene 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。