Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

`graphql_schema` introspection doesn't output docstrings descriptions

Aperta
#1,492 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
38/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
graphql, python
Ambito
api

Direzione di ricerca

Riproduci il problema definendo un tipo e un campo Graphene con descrizioni nella docstring, quindi esegui il comando manage graphql_schema per esportare schema.graphql. Confronta lo schema esportato con le descrizioni previste del tipo e del campo; il lavoro è completato quando entrambe le descrizioni sono incluse nell’output e il comportamento di description= e Meta è stato verificato, se applicabile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

🐛 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)

Lingua principale
Python
Stelle
8.2k
Fork
818
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di graphql-python/graphene

Tutte le issue di graphql-python/graphene

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.