graphene

Grafeno

Únete a la comunidad en Discord

¡Estamos buscando colaboradores ! Consulte los problemas actuales para ver cómo puede ayudar ❤️

Introducción

Graphene es una biblioteca de Python obstinada para crear esquemas/tipos GraphQL de forma rápida y sencilla.

• Fácil de usar: Graphene te ayuda a usar GraphQL en Python sin esfuerzo.
• Relay: Graphene tiene soporte integrado para Relay.
• Agnóstico de datos: Graphene admite cualquier tipo de fuente de datos: SQL (Django, SQLAlchemy), Mongo, objetos Python personalizados, etc. Creemos que al proporcionar una API completa, puede conectar Graphene en cualquier lugar donde se encuentren sus datos y hacer que estén disponibles a través de GraphQL.

Integraciones

Graphene tiene múltiples integraciones con diferentes marcos:

integración	Paquete
SQLAlquimia	grafeno-sqlalquimia
mongo	grafeno-mongo
Federación Apolo	federación-de-grafeno
Django	grafeno-django

Además, Graphene es totalmente compatible con la especificación GraphQL y funciona perfectamente con todos los clientes GraphQL, como Relay, Apollo y gql.

Instalación

Para instalar graphene , simplemente ejecute este comando en su shell

=3.1"">

pip install " graphene>=3.1 " 

Ejemplos

A continuación se muestra un ejemplo para que pueda comenzar:

 import graphene

class Query ( graphene . ObjectType ):
    hello = graphene . String ( description = 'A typical hello world' )

    def resolve_hello ( self , info ):
        return 'World'

schema = graphene . Schema ( query = Query )

Entonces consultar graphene.Schema es tan simple como:

 query = '''
    query SayHello {
      hello
    }
'''
result = schema . execute ( query )

Si quieres aprender aún más, también puedes consultar los siguientes ejemplos:

• Esquema básico : ejemplo de Starwars
• Esquema de retransmisión : ejemplo de retransmisión de Starwars

Documentación

La documentación y los enlaces a recursos adicionales están disponibles en https://docs.graphene-python.org/en/latest/

Contribuyendo

Después de clonar este repositorio, cree un entorno virtual y asegúrese de que las dependencias estén instaladas ejecutando:

virtualenv venv
source venv/bin/activate
pip install -e " .[test] "

Para este proyecto es importante realizar pruebas bien redactadas y mantener una buena cobertura de las mismas. Mientras desarrolla, ejecute pruebas nuevas y existentes con:

pytest graphene/relay/tests/test_node.py # Single file
pytest graphene/relay # All tests in directory

Agregue el indicador -s si ha introducido puntos de interrupción en el código para la depuración. Agregue el indicador -v ("detallado") para obtener resultados de prueba más detallados. Para obtener resultados aún más detallados, utilice -vv . Consulte la documentación de pytest para obtener más opciones y probar los controles de ejecución.

Asegúrese periódicamente de que sus enlaces pre-commit estén actualizados y habilitados:

pre-commit install

También puede ejecutar los puntos de referencia con:

pytest graphene --benchmark-only

Graphene admite varias versiones de Python. Para asegurarnos de que los cambios no rompan la compatibilidad con ninguna de esas versiones, usamos tox para crear entornos virtuales para cada versión de Python y ejecutar pruebas con esa versión. Para ejecutar todas las versiones de Python definidas en el archivo de configuración tox.ini , simplemente ejecute:

tox

Si desea ejecutar con una versión específica definida en el archivo tox.ini :

tox -e py39

Tox solo puede usar cualquier versión de Python que esté instalada en su sistema. Cuando crea una solicitud de extracción, los canales de GitHub Actions también ejecutarán las mismas pruebas e informarán los resultados, por lo que no es necesario que los contribuyentes potenciales intenten instalar cada versión de Python en su propio sistema con anticipación. ¡Apreciamos la apertura de problemas y solicitudes de extracción para hacer que el grafeno sea aún más estable y útil!

Documentación de construcción

La documentación se genera utilizando el excelente Sphinx y un tema personalizado.

Se produce una versión HTML de la documentación ejecutando:

make docs