Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

hybrid_property annotations with built-in types defaulting to `ForwardRef` and failing schema compilation

Offen
  • Stimmt etwas nicht?
#396 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
python, sqlalchemy
Bereich
api, database

Rechercherichtung

Untersuche graphene_sqlalchemy/converter.py, insbesondere convert_hybrid_property_return_type und convert_sqlalchemy_hybrid_property_bare_str, und verwende die gemeldeten MyModel-hybrid_property-Beispiele als Reproduktion. Überprüfe, wie annotierte Rückgabetypen str und bool während der Schemaerstellung konvertiert werden. Die Aufgabe ist abgeschlossen, wenn integrierte Annotationen bei der Schemakompilierung nicht mehr als ForwardRef-Werte fehlschlagen oder der resultierende Fehler das unterstützte Verhalten klar erklärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

dependencies:

python 3.10.7

sqlalchemy==1.4.48
graphene==3.2.2
graphene-sqlalchemy==v3.0.0b4
graphql-server[flask]==v3.0.0b6

I am upgrading from graphene==2.1.9 and graphene-sqlalchemy==2.3.0 where these hybrid properties worked.

simplified example:


# myproject/routes/graphql_view.py

from myproject.schema import schema

GraphQLView.as_view('graphql', schema=schema, graphiql=False) # simplified, used in flask create_app in __init__.py

# myproject/models/core.py

class MyModel(db.Model, DictMixin, Timestamp):
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    ...

    @hybrid_property
    def prop_string -> str:
       # logic based on model's other fields
       result: str = ...
       return result

    @hybrid_property
    def prop_boolean -> bool:
       # logic based on model's other fields
       result: bool = ...
       return result

# myproject/schema.py

from myproject.models.core import MyModel

class MyModelQuery(SQLAlchemyObjectType):
    class Meta:
        model = MyModel
        interfaces = (relay.Node,)

class Query(graphene.ObjectType):
    node = relay.Node.Field()
    ... # other query fields
    model = graphene.Field(MyModelQuery, model_id=graphene.Int())

    def resolve_model(self, info, model_id):
        query = MyModelQuery.get_query(info)
        return query.get(model_id)

schema = graphene.Schema(query=Query, mutation=Mutation)

It seems like support was added for these annotations in https://github.com/graphql-python/graphene-sqlalchemy/pull/340 in v3.0.0b2, but then is no longer working as expected since several refactors.

I get this error for the string return type hybrid

../../../myproject/schema.py:581: in <module>
    schema = graphene.Schema(query=Query, mutation=Mutation)
../../../venv/lib/python3.10/site-packages/graphene/types/schema.py:440: in __init__
    self.graphql_schema = GraphQLSchema(
../../../venv/lib/python3.10/site-packages/graphql/type/schema.py:224: in __init__
    collect_referenced_types(query)
../../../venv/lib/python3.10/site-packages/graphql/type/schema.py:433: in collect_referenced_types
    collect_referenced_types(field.type)
../../../venv/lib/python3.10/site-packages/graphql/type/schema.py:433: in collect_referenced_types
    collect_referenced_types(field.type)
../../../venv/lib/python3.10/site-packages/graphql/type/schema.py:433: in collect_referenced_types
    collect_referenced_types(field.type)
../../../venv/lib/python3.10/site-packages/graphql/type/schema.py:432: in collect_referenced_types
    for field in named_type.fields.values():
/[...]/.pyenv/versions/3.10.7/lib/python3.10/functools.py:981: in __get__
    val = self.func(instance)
../../../venv/lib/python3.10/site-packages/graphql/type/definition.py:811: in fields
    raise cls(f"{self.name} fields cannot be resolved. {error}") from error
E   TypeError: MyModelQuery fields cannot be resolved. No model found in Registry for forward reference for type ForwardRef('str'). Only forward references to other SQLAlchemy Models mapped to SQLAlchemyObjectTypes are allowed.

and this for the Boolean.

TypeError: MyModelQuery fields cannot be resolved. No model found in Registry for forward reference for type ForwardRef('bool'). Only forward references to other SQLAlchemy Models mapped to SQLAlchemyObjectTypes are allowed.

MyModel in reality has many many fields so it was also hard to figure out it was the hybrid_property fields that were causing problems, vs. the actual relationship fields etc

Which seems to be because the function convert_hybrid_property_return_type
https://github.com/graphql-python/graphene-sqlalchemy/blob/v3.0.0b4/graphene_sqlalchemy/converter.py#L640

returns a string version of the type, and string defaults to being processed by convert_sqlalchemy_hybrid_property_bare_str even though those strings are valid types, not ForwardRefs.
https://github.com/graphql-python/graphene-sqlalchemy/blob/v3.0.0b4/graphene_sqlalchemy/converter.py#L632

I am getting around this by explicitly declaring the graphene types but my understanding was that graphene-sqlalchemy should be able to pick them up automatically due to the recent support that was integrated, as referenced above.

workaround:

class MyModelQuery(SQLAlchemyObjectType):
    class Meta:
        model = MyModel
        interfaces = (relay.Node,)

    prop_string = graphene.String()
    prop_boolean = graphene.Boolean()

If this is intended behaviour, could the error be more helpful? Spent several hours digging as I was not attempting anything with a ForwardRef type.

Vorherrschende Sprache
Python
Sterne
984
Forks
224
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus graphql-python/graphene-sqlalchemy

Alle Issues in graphql-python/graphene-sqlalchemy

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.