Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

DSL does not provide expected argument validation

Ouverte
  • Quelque chose ne va pas ?
#355 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
42/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
graphql, python
Domaine
api, backend

Piste de recherche

Commencez par dsl.dsl_gql et comparez son comportement à celui de gql.gql en utilisant la reproduction de l’API countries dans cet Issue. Suivez la manière dont les arguments de la requête DSL sont traités et vérifiez que le filtre malformé de l’étape 5 lève un GraphQLError équivalent au lieu de renvoyer des résultats non filtrés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

type: feature

Describe the bug

  • When creating a query with gql.gql(), the query string is checked for invalid arguments, and raises an exception if any are found. (expected behavior)
  • When creating a query with gql.dsl.dsl_gql(), the arguments are not checked, causing unexpected return values. (unexpected behavior)

I've been able to recreate this using the countries api used in the docs.

To Reproduce

Jump to step 5 to see the actual improper behavior.

  1. Set up the transport/client.

    import json

import gql
from gql.transport.requests import RequestsHTTPTransport as Transport
from gql import dsl

url = "https://countries.trevorblades.com/"

transport = Transport(url=url)
client = gql.Client(transport=transport, fetch_schema_from_transport=True)

# Fetch the schema (lemme know if there's a recommended approach for this).
client.connect_sync()
client.close_sync()
ds = dsl.DSLSchema(client.schema)

  2. Run a good query using strings.

    good_query_str = gql.gql(
    """
    query {
        continents (filter:{code:{eq:"AN"}}) {
            code
            name
        }
    }
    """
)
result = client.execute(good_query_str)
print(json.dumps(result, indent=2))

    Result:

     {
 "continents": [
     {
     "code": "AN",
     "name": "Antarctica"
     }
 ]
 }

  3. Run a bad query using strings. The only change here is using 'AN' directly as an argument to code, instead of providing the eq directive.

    bad_query_str = gql.gql(
    """
    query {
        continents (filter:{code:"AN"}) {
            code
            name
        }
    }
    """
)
result = client.execute(bad_query_str)
print(json.dumps(result, indent=2))

    Result:

    GraphQLError: Expected value of type 'StringQueryOperatorInput', found "AN".

 GraphQL request:3:34
 2 |     query {
 3 |         continents (filter:{code:"AN"}) {
 |                                  ^
 4 |             code

  4. Run a good query using DSL.

    good_query_dsl = dsl.dsl_gql(
    dsl.DSLQuery(
        ds.Query.continents(
            filter={
                'code': {'eq': 'AN'}
            }
        ).select(
            ds.Continent.code,
            ds.Continent.name,
        )
    )
)
result = client.execute(good_query_dsl)
print(json.dumps(result, indent=2))

    Result:

     {
 "continents": [
     {
     "code": "AN",
     "name": "Antarctica"
     }
 ]
 }

  5. Run a bad query using DSL. Same deal, just remove the 'eq' level of filter specification. Note that the result is an unfiltered response.

    bad_query_dsl = dsl.dsl_gql(
    dsl.DSLQuery(
        ds.Query.continents(
            filter={
                'code': 'AN'
            }
        ).select(
            ds.Continent.code,
            ds.Continent.name,
        )
    )
)
result = client.execute(bad_query_dsl)
print(json.dumps(result, indent=2))

    Result:

     {
 "continents": [
     {
     "code": "AF",
     "name": "Africa"
     },
     {
     "code": "AN",
     "name": "Antarctica"
     },
     {
     "code": "AS",
     "name": "Asia"
     },
     {
     "code": "EU",
     "name": "Europe"
     },
     {
     "code": "NA",
     "name": "North America"
     },
     {
     "code": "OC",
     "name": "Oceania"
     },
     {
     "code": "SA",
     "name": "South America"
     }
 ]
 }

Expected behavior

Step 5 should raise an equivalent exception to step 3.

System info (please complete the following information):

  • OS: Wins 10
  • Python version: 3.9.12
  • gql version: 3.4.0
  • graphql-core version: 3.2.1
Langage dominant
Python
Étoiles
1.7k
Forks
197
Merge moyen
12 min
PR mergées (30 j)
2

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de graphql-python/gql

Toutes les issues de graphql-python/gql

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.