graphene

Графен

Присоединяйтесь к сообществу в Discord

Мы ищем соавторов ! Пожалуйста, проверьте текущие проблемы, чтобы узнать, как вы можете помочь ❤️

Введение

Graphene — это авторитетная библиотека Python для быстрого и простого создания схем/типов GraphQL.

• Простота в использовании: Graphene помогает вам без труда использовать GraphQL в Python.
• Реле: Graphene имеет встроенную поддержку реле.
• Независимость от данных: Graphene поддерживает любые источники данных: SQL (Django, SQLAlchemy), Mongo, пользовательские объекты Python и т. д. Мы считаем, что, предоставляя полный API, вы можете подключить Graphene везде, где находятся ваши данные, и сделать их доступными через GraphQL.

Интеграции

Graphene имеет множество интеграций с различными фреймворками:

интеграция	Упаковка
SQLАлхимия	графен-sqlалхимия
Монго	графен-монго
Федерация Аполлона	графен-федерация
Джанго	графен-джанго

Кроме того, Graphene полностью совместим со спецификацией GraphQL и без проблем работает со всеми клиентами GraphQL, такими как Relay, Apollo и gql.

Установка

Чтобы установить graphene , просто запустите эту команду в своей оболочке

=3.1"">

pip install " graphene>=3.1 " 

Примеры

Вот один пример для начала:

 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 )

Тогда запрос graphene.Schema так же прост, как:

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

Если вы хотите узнать еще больше, вы также можете проверить следующие примеры:

• Базовая схема : пример «Звездных войн»
• Схема реле : пример реле из «Звездных войн»

Документация

Документация и ссылки на дополнительные ресурсы доступны по адресу https://docs.graphene-python.org/en/latest/.

Содействие

После клонирования этого репозитория создайте virtualenv и убедитесь, что зависимости установлены, запустив:

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

Для этого проекта важны хорошо написанные тесты и поддержание хорошего тестового покрытия. Во время разработки запускайте новые и существующие тесты с помощью:

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

Добавьте флаг -s , если вы ввели в код точки останова для отладки. Добавьте флаг -v («подробный»), чтобы получить более подробные выходные данные теста. Для еще более подробного вывода используйте -vv . Ознакомьтесь с документацией pytest, чтобы узнать больше о параметрах и протестировать элементы управления.

Регулярно проверяйте, чтобы ваши перехватчики pre-commit были обновлены и включены:

pre-commit install

Вы также можете запустить тесты с помощью:

pytest graphene --benchmark-only

Graphene поддерживает несколько версий Python. Чтобы убедиться, что изменения не нарушают совместимость ни с одной из этих версий, мы используем tox для создания виртуальных окружений для каждой версии Python и запускаем тесты с этой версией. Чтобы запустить все версии Python, определенные в файле конфигурации tox.ini , просто запустите:

tox

Если вы хотите запустить конкретную версию, определенную в файле tox.ini :

tox -e py39

Tox может использовать только те версии Python, которые установлены в вашей системе. Когда вы создаете запрос на включение, конвейеры GitHub Actions также будут выполнять те же тесты и сообщать о результатах, поэтому потенциальным участникам не нужно заранее пытаться установить каждую версию Python в своей системе. Мы ценим открытие проблем и запросы на включение, чтобы сделать графен еще более стабильным и полезным!

Строительная документация

Документация создается с использованием превосходного Sphinx и специальной темы.

HTML-версия документации создается путем запуска:

make docs