graphene

그래핀

Discord에서 커뮤니티에 가입하세요

우리는 기여자를 찾고 있습니다 ! 현재 문제를 확인하여 어떻게 도움을 드릴 수 있는지 알아보세요 ❤️

소개

Graphene은 GraphQL 스키마/유형을 빠르고 쉽게 구축하기 위한 독보적인 Python 라이브러리입니다.

• 사용 용이성: Graphene은 Python에서 손쉽게 GraphQL을 사용할 수 있도록 도와줍니다.
• 릴레이: 그래핀에는 릴레이 지원 기능이 내장되어 있습니다.
• 데이터 불가지론: Graphene은 SQL(Django, SQLAlchemy), Mongo, 사용자 정의 Python 개체 등 모든 종류의 데이터 소스를 지원합니다. 우리는 완전한 API를 제공함으로써 데이터가 있는 모든 곳에 Graphene을 연결하고 GraphQL을 통해 데이터를 사용할 수 있다고 믿습니다.

통합

그래핀에는 다양한 프레임워크와 여러 통합이 있습니다.

완성	패키지
SQLAlchemy	그래핀-sqlalchemy
몽고	그래핀몽고
아폴로연맹	그래핀연맹
장고	그래핀장고

또한 Graphene은 GraphQL 사양과 완벽하게 호환되어 Relay, Apollo 및 gql과 같은 모든 GraphQL 클라이언트와 원활하게 작동합니다.

설치

graphene 설치하려면 쉘에서 이 명령을 실행하세요.

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 )

더 자세히 알아보고 싶다면 다음 예를 확인해 보세요.

• 기본 스키마 : 스타워즈 예시
• 릴레이 스키마 : Starwars Relay 예

선적 서류 비치

추가 리소스에 대한 문서 및 링크는 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 ("verbose") 플래그를 추가하세요. 더 자세한 출력을 보려면 -vv 사용하세요. 더 많은 옵션과 테스트 실행 컨트롤에 대해서는 pytest 문서를 확인하세요.

pre-commit 후크가 최신 상태이고 활성화되어 있는지 정기적으로 확인하세요.

pre-commit install

다음을 사용하여 벤치마크를 실행할 수도 있습니다.

pytest graphene --benchmark-only

Graphene은 여러 버전의 Python을 지원합니다. 변경 사항으로 인해 해당 버전과의 호환성이 손상되지 않도록 하기 위해 tox 사용하여 각 Python 버전에 대한 virtualenv를 생성하고 해당 버전으로 테스트를 실행합니다. tox.ini 구성 파일에 정의된 모든 Python 버전에 대해 실행하려면 다음을 실행하세요.

tox

tox.ini 파일에 정의된 특정 버전에 대해 실행하려는 경우:

tox -e py39

Tox는 시스템에 설치된 Python 버전만 사용할 수 있습니다. 끌어오기 요청을 생성하면 GitHub Actions 파이프라인도 동일한 테스트를 실행하고 결과를 보고하므로 잠재적인 기여자가 자신의 시스템에 Python의 모든 단일 버전을 미리 설치하려고 할 필요가 없습니다. 그래핀을 더욱 안정적이고 유용하게 만들기 위한 이슈 공개와 풀 요청에 감사드립니다!

문서 작성

문서는 뛰어난 Sphinx와 사용자 정의 테마를 사용하여 생성됩니다.

문서의 HTML 버전은 다음을 실행하여 생성됩니다.

make docs