Release 0.1.3 (#4)

Author: avanov

CHANGES.rst

@@ -0,0 +1,4 @@
+0.1.3
+=====
+
+* Initial functional release

docs/conf.py

@@ -22,7 +22,7 @@
 author = 'Maxim Avanov'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.2'
+release = '0.1.3'
 
 
 # -- General configuration ---------------------------------------------------

docs/index.rst

@@ -7,8 +7,11 @@
 graphql-dsl
 ===========
 
-Compose GraphQL queries by defining Python types
-------------------------------------------------
+.. contents::
+   :local:
+
+Quick intro
+===========
 
 Let's take a manually written `GraphQL query <https://graphql.org/learn/schema/#the-query-and-mutation-types>`_:
 
@@ -85,9 +88,66 @@ field reference syntax (because dataclasses don't define class-level field gette
            | PASS  | (Input, 'droid_id') * TO * (HeroAndDroid, 'droid') * AS * 'id'
            )
 
-Indices and tables
-==================
+Simple queries
+--------------
+
+Let's use `Countries API <https://countries.trevorblades.com/>`_ and prepare the simplest query for it.
+
+We want to fetch a list of all country codes
+
+.. code-block:: python
+
+    from typing import Sequence, NamedTuple
+
+    class Country(NamedTuple):
+        code: str
+
+    class Query(NamedTuple):
+        countries: Sequence[Country]
+
+We can start composing our query with:
+
+.. code-block:: python
+
+    from graphql_dsl import QUERY
+
+    countries_query = QUERY | Query
+
+
+If we don't need to provide input parameters to the query, we can immediately compile it:
+
+.. code-block:: python
+
+    from graphql_dsl import GQL
+
+    compiled_query = GQL(countries_query)
+
+
+Now we are able to call the service and receive the typed result from it:
+
+.. code-block:: python
+
+    import requests
+
+    response = requests.post(
+        url="https://countries.trevorblades.com/",
+        json={
+            "operationName": compiled_query.name,
+            "query": compiled_query.query,
+        }
+    )
+
+    data = compiled_query.get_result(response)
+    assert isinstance(data, Query)
+
+    # will print AD, AE, AF, AG, AI, AL, AM, AO, ...
+    print(', '.join(country.code for country in data.countries))
+
+
+
+Documentation Indices and tables
+================================
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`

graphql_dsl/__init__.py

@@ -6,7 +6,7 @@
     'QUERY',
     'WITH',
     'PASS',
-    'MUTATION',
+    'MUTATE',
     'TO',
     'AS',
     'GQL',

graphql_dsl/dsl.py

@@ -22,7 +22,7 @@
     'PASS',
     'TO',
     'AS',
-    'MUTATION',
+    'MUTATE',
     'GQL',
 )
 
@@ -95,7 +95,9 @@ class ResolvedBinding(NamedTuple):
 
 class GraphQLQuery(NamedTuple):
     query: str
+    name: str
     get_input_vars: Callable[..., Mapping[str, Any]]
+    get_result: Callable[[Mapping[str, Any]], Any]
 
 
 class GraphQLQueryConstructor(NamedTuple):
@@ -104,12 +106,15 @@ class GraphQLQueryConstructor(NamedTuple):
 
     def __call__(self, expr: 'Expr') -> GraphQLQuery:
         mk_input_vars, dict_input_vars = self.typer ^ expr.input
+        mk_result, dict_result = self.typer ^ expr.query
         bindings = self.prepare_bindings(expr)
         query_decl = expr.type.value
         query_body = translate(expr.query, bindings, self.typer)
         return GraphQLQuery(
+            name=expr.query.__name__,
             query=f'{query_decl} {query_body}',
             get_input_vars=dict_input_vars,
+            get_result=lambda x: mk_result(x['data']),
         )
 
     def prepare_bindings(self, expr: Expr) -> Mapping[str, Iterable[ResolvedBinding]]:
@@ -162,8 +167,8 @@ def __or__(self, other: Union[Type[Any], Expr]) -> Expr:
         return Expr(type=self.type, query=other)
 
 
-QUERY = Query(QueryType.QUERY)
-MUTATION = Query(QueryType.MUTATION)
+QUERY  = Query(QueryType.QUERY)
+MUTATE = Query(QueryType.MUTATION)
 
 
 @infix

setup.py

@@ -21,7 +21,7 @@
 # ----------------------------
 
 setup(name='graphql-dsl',
-      version='0.1.2',
+      version='0.1.3',
       description='GraphQL DSL',
       long_description=README,
       classifiers=[
@@ -33,10 +33,17 @@
           'Programming Language :: Python :: 3',
           'Operating System :: POSIX',
           'Topic :: Internet :: WWW/HTTP',
+          'Topic :: Software Development :: Libraries',
+          'Topic :: Software Development :: Code Generators',
+          'Typing :: Typed',
       ],
       author='Maxim Avanov',
       author_email='[email protected]',
       url='https://maximavanov.com/',
+      project_urls={
+          'Documentation': 'https://graphql-dsl.rtfd.io/',
+          'Source': 'https://github.com/avanov/graphql-dsl',
+      },
       keywords='web',
       packages=find_packages(exclude=['tests', 'tests.*']),
       include_package_data=True,

tests/test_tokenizer.py

@@ -23,9 +23,6 @@ class Country(NamedTuple):
     class CountriesQuery(NamedTuple):
         countries: Sequence[Country]
 
-
-    mk_countries_query, dict_countries_query = GQL.typer ^ CountriesQuery
-
     q = QUERY | CountriesQuery
 
     graphql_query = GQL(q)
@@ -36,20 +33,19 @@ class CountriesQuery(NamedTuple):
         response = requests.post(
             url='https://countries.trevorblades.com/',
             json={
-                "operationName": f"{CountriesQuery.__name__}",
+                "operationName": graphql_query.name,
                 "variables": {},
                 "query": graphql_query.query,
             },
             headers={
                 'Content-Type': 'application/json',
                 'Accept': 'application/json',
-                'Origin': 'https://countries.trevorblades.com',
             }
         )
     response.raise_for_status()
-    data = response.json()['data']
+    data = response.json()
     assert data
-    typed_data = mk_countries_query(data)
+    typed_data = graphql_query.get_result(data)
     assert isinstance(typed_data, CountriesQuery)
 
 
@@ -161,10 +157,10 @@ class Input3(NamedTuple):
     class CreateReviewForEpisode(NamedTuple):
         create_review: Review
 
-    q = GQL(MUTATION | CreateReviewForEpisode
-           |    WITH | Input3
-           |    PASS | Input3.episode * TO * CreateReviewForEpisode.create_review
-                     & Input3.review  * TO * CreateReviewForEpisode.create_review
-           )
+    q = GQL( MUTATE | CreateReviewForEpisode
+           |   WITH | Input3
+           |   PASS | Input3.episode * TO * CreateReviewForEpisode.create_review
+                    & Input3.review  * TO * CreateReviewForEpisode.create_review )
+
     expected = 'mutation CreateReviewForEpisode($episode:Episode!,$review:Review!){createReview(episode:$episode,review:$review){stars commentary}}'
     assert q.query == expected

tests/vcr/countries.yaml

@@ -1,7 +1,7 @@
 interactions:
 - request:
-    body: '{"operationName": "CountriesQuery", "variables": {}, "query": "query CountriesQuery
-      {countries{code name languages{code name } } }"}'
+    body: '{"operationName": "CountriesQuery", "variables": {}, "query": "query CountriesQuery{countries{code
+      name languages{code name}}}"}'
     headers:
       Accept:
       - application/json
@@ -10,11 +10,9 @@ interactions:
       Connection:
       - keep-alive
       Content-Length:
-      - '132'
+      - '128'
       Content-Type:
       - application/json
-      Origin:
-      - https://countries.trevorblades.com
       User-Agent:
       - python-requests/2.23.0
     method: POST
@@ -412,7 +410,7 @@ interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Sat, 23 May 2020 22:42:28 GMT
+      - Mon, 25 May 2020 21:15:56 GMT
       Etag:
       - W/"5b6b-d1+62eE1I7PMiWAV7I5FC0xGL7c"
       Server: