fix docs example (#5)

Author: avanov

README.rst

@@ -24,8 +24,8 @@
     :target: https://pypi.python.org/pypi/graphql-dsl
     :alt: Latest PyPI Release
 
-Compose GraphQL queries by defining Python types
-================================================
+Compose GraphQL queries by composing Python types
+=================================================
 
 .. code-block:: bash
 

docs/index.rst

@@ -137,7 +137,7 @@ Now we are able to call the service and receive the typed result from it:
         }
     )
 
-    data = compiled_query.get_result(response)
+    data = compiled_query.get_result(response.json())
     assert isinstance(data, Query)
 
     # will print AD, AE, AF, AG, AI, AL, AM, AO, ...

graphql_dsl/cli/__init__.py

@@ -0,0 +1,33 @@
+import argparse
+import sys
+
+from pkg_resources import get_distribution
+
+from . import gen
+from ..info import DISTRIBUTION_NAME
+
+
+def main(args=None, in_channel=sys.stdin, out_channel=sys.stdout):
+    parser = argparse.ArgumentParser(description='GraphQL DSL')
+    parser.add_argument('-V', '--version', action='version',
+                        version=f'{DISTRIBUTION_NAME} {get_distribution(DISTRIBUTION_NAME).version}')
+    subparsers = parser.add_subparsers(title='sub-commands',
+                                       description='valid sub-commands',
+                                       help='additional help',
+                                       dest='sub-command')
+    # make subparsers required (see http://stackoverflow.com/a/23354355/458106)
+    subparsers.required = True
+
+    # $ <cmd> gen
+    # ---------------------------
+    gen.setup(subparsers)
+
+    # Parse arguments and config
+    # --------------------------
+    if args is None:
+        args = sys.argv[1:]
+    args = parser.parse_args(args)
+
+    # Set up and run
+    # --------------
+    args.run_cmd(args, in_channel=in_channel, out_channel=out_channel)

graphql_dsl/cli/gen.py

@@ -0,0 +1,43 @@
+import argparse
+import json
+import sys
+from pathlib import Path
+from typing import Mapping
+from itertools import islice
+
+from .. import parser
+
+
+def is_empty_dir(p: Path) -> bool:
+    return p.is_dir() and not bool(list(islice(p.iterdir(), 1)))
+
+
+def setup(subparsers: argparse._SubParsersAction) -> argparse.ArgumentParser:
+    sub = subparsers.add_parser('gen', help='Generate Python definitions from GraphQL schema source.')
+    sub.add_argument('-s', '--source', help="Path to a GraphQL schema file. "
+                                            "If not specified, then the data will be read from stdin.")
+    sub.add_argument('-o', '--out-dir', required=True,
+                     help="Output directory that will contain a newly generated Python client.")
+    sub.add_argument('-n', '--name', required=True,
+                     help="Name of a newly generated Python client (package name).")
+    sub.add_argument('-f', '--force-overwrite', required=False, action='store_true',
+                     help="Overwrite existing files and directories if they already exist"
+                     )
+    sub.set_defaults(run_cmd=main)
+    return sub
+
+
+def main(args: argparse.Namespace, in_channel=sys.stdin, out_channel=sys.stdout) -> None:
+    """ $ <cmd-prefix> gen <source> <target>
+    """
+    try:
+        src = Path(args.source).read_text()
+    except TypeError:
+        # source is None, read from stdin
+        src = in_channel.read()
+
+    spec = parser.parse(src)
+
+
+    out_channel.write('Successfully parsed.\n')
+

graphql_dsl/dsl.py

@@ -58,15 +58,26 @@ class Binding(NamedTuple):
     expr_field: FieldReference
     variable_alias: Optional[str] = None
 
-    def __and__(self, other: 'Binding') -> 'BindComb':
-        return BindComb(pvector([self, other]))
+    def __and__(self, other: Union['Binding', 'BindComb']) -> 'BindComb':
+        if isinstance(other, BindComb):
+            return BindComb(pvector([self]).extend(other.bindings))
+        elif isinstance(other, Binding):
+            return BindComb(pvector([self, other]))
+        raise NotImplementedError('Binding???')
 
 
 class BindComb(NamedTuple):
     """ Binding combinator
     """
     bindings: PVector[Binding] = pvector()
 
+    def __and__(self, other: Union['Binding', 'BindComb']) -> 'BindComb':
+        if isinstance(other, BindComb):
+            return self._replace(bindings=self.bindings.extend(other.bindings))
+        elif isinstance(other, Binding):
+            return self._replace(bindings=self.bindings.append(other))
+        raise NotImplementedError('BindComb???')
+
 
 class Unit(NamedTuple):
     pass
@@ -121,7 +132,16 @@ def prepare_bindings(self, expr: Expr) -> Mapping[str, Iterable[ResolvedBinding]
         rv = defaultdict(list)
         for binding in expr.bindings:
             resolved_input = self.resolve_binding(expr.input, binding.input_field, binding.variable_alias)
-            resolved_expr  = self.resolve_binding(expr.query, binding.expr_field, binding.variable_alias)
+            try:
+                resolved_expr  = self.resolve_binding(expr.query, binding.expr_field, binding.variable_alias)
+            except AttrNotFound:
+                for typ in self.typer.memo.keys():
+                    try:
+                        resolved_expr  = self.resolve_binding(typ, binding.expr_field, binding.variable_alias)
+                    except (AttributeError, TypeError, AttrNotFound):
+                        continue
+                    else:
+                        break
             rv[resolved_expr.attr_name].append(resolved_input)
         return rv
 
@@ -134,7 +154,7 @@ def resolve_binding(self, typ: Type[Any], field: FieldReference, alias: Optional
                     variable_python_type = field_type
                     break
             else:
-                raise TypeError(f"Couldn't find a field of alias \"{alias}\" in {typ}")
+                raise AttrNotFound(f"Couldn't find a field of alias \"{alias}\" in {typ}")
 
         elif isinstance(field, tuple):
             # dataclass
@@ -147,7 +167,10 @@ def resolve_binding(self, typ: Type[Any], field: FieldReference, alias: Optional
         overrider = get_global_name_overrider(self.typer.overrides)
         attr_name = overrider(name)
         is_optional = type(None) in inner_type_boundaries(variable_python_type)
-        type_name = GQL_SCALARS.get(variable_python_type, variable_python_type.__name__)
+        try:
+            type_name = GQL_SCALARS.get(variable_python_type, variable_python_type.__name__)
+        except AttributeError:
+            type_name = ''
         return ResolvedBinding(attr_name=overrider(name),
                                input_attr_name=alias if alias else attr_name,
                                type_name=type_name,
@@ -200,3 +223,7 @@ def AS(a: Binding, b: str) -> Binding:
 
 
 GQL = GraphQLQueryConstructor()
+
+
+class AttrNotFound(TypeError):
+    pass

graphql_dsl/info.py

@@ -0,0 +1,2 @@
+DISTRIBUTION_NAME = 'graphql-dsl'
+PACKAGE_NAME = 'graphql_dsl'

graphql_dsl/parser/__init__.py

@@ -0,0 +1,7 @@
+import graphql
+
+
+def parse(src: str) -> graphql.DocumentNode:
+    schema = graphql.parse(src)
+    schema.definitions[0].operation_types[0].type.name.value
+    return schema

requirements/minimal.txt

@@ -1,2 +1,3 @@
-typeit>=0.27.1
+typeit>=3.9.1.8
+graphql-core>=3
 infix==1.2

setup.py

@@ -21,8 +21,8 @@
 # ----------------------------
 
 setup(name='graphql-dsl',
-      version='0.1.3',
-      description='GraphQL DSL',
+      version='0.2.0',
+      description='Compose GraphQL queries by composing Python types!',
       long_description=README,
       classifiers=[
           'Development Status :: 1 - Planning',
@@ -51,5 +51,9 @@
       test_suite='tests',
       tests_require=['pytest', 'coverage'],
       install_requires=requires,
-      entry_points={}
+      entry_points={
+          'console_scripts': [
+              'graphql-dsl = graphql_dsl.cli:main'
+          ],
+      }
     )

shell.nix

@@ -1,44 +1,49 @@
-with (import (builtins.fetchTarball {
-  # Descriptive name to make the store path easier to identify
-  name = "graphql-dsl-python38";
-  # Commit hash for nixos-unstable as of 2019-10-27
-  url = https://github.com/NixOS/nixpkgs-channels/archive/f601ab37c2fb7e5f65989a92df383bcd6942567a.tar.gz;
-  # Hash obtained using `nix-prefetch-url --unpack <url>`
-  sha256 = "0ikhcmcc29iiaqjv5r91ncgxny2z67bjzkppd3wr1yx44sv7v69s";
-}) {});
+{
+    pkgs ? import (builtins.fetchTarball {
+               # https://nixos.wiki/wiki/FAQ/Pinning_Nixpkgs
+               # Descriptive name to make the store path easier to identify
+               name   = "nixpkgs-unstable-2021-01-20";
+               url    = https://github.com/NixOS/nixpkgs/archive/92c884dfd7140a6c3e6c717cf8990f7a78524331.tar.gz;
+               # hash obtained with `nix-prefetch-url --unpack <archive>`
+               sha256 = "0wk2jg2q5q31wcynknrp9v4wc4pj3iz3k7qlxvfh7gkpd8vq33aa";
+           }) {}
+,   pyVersion ? "39"
+,   isDevEnv  ? true
+}:
 
-let macOsDeps = with pkgs; stdenv.lib.optionals stdenv.isDarwin [
-    darwin.apple_sdk.frameworks.CoreServices
-    darwin.apple_sdk.frameworks.ApplicationServices
-];
+let
+    macOsDeps = with pkgs; stdenv.lib.optionals stdenv.isDarwin [
+        darwin.apple_sdk.frameworks.CoreServices
+        darwin.apple_sdk.frameworks.ApplicationServices
+    ];
+    python = pkgs."python${pyVersion}Full";
+    pythonPkgs = pkgs."python${pyVersion}Packages";
+    devLibs = if isDevEnv then [ pythonPkgs.twine pythonPkgs.wheel ] else [ pythonPkgs.coveralls ];
 
 in
 
 # Make a new "derivation" that represents our shell
-stdenv.mkDerivation {
-    name = "graphql-dsl38";
+pkgs.stdenv.mkDerivation {
+    name = "graphql-dsl39";
 
     # The packages in the `buildInputs` list will be added to the PATH in our shell
     # Python-specific guide:
     # https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/python.section.md
-    buildInputs = [
+    buildInputs = with pkgs; [
         # see https://nixos.org/nixos/packages.html
         # Python distribution
-        cookiecutter
-        python38Full
-        python38Packages.virtualenv
-        python38Packages.wheel
-        python38Packages.twine
+        python
+        pythonPkgs.virtualenv
+        pythonPkgs.wheel
+        pythonPkgs.twine
         taglib
         ncurses
         libxml2
         libxslt
         libzip
         zlib
-        libressl
+        openssl
 
-        libuv
-        postgresql
         # root CA certificates
         cacert
         which
@@ -49,13 +54,13 @@ stdenv.mkDerivation {
         # to allow package installs from PyPI
         export SOURCE_DATE_EPOCH=$(date +%s)
 
-        VENV_DIR=$PWD/.venv
+        export VENV_DIR="$PWD/.venv${pyVersion}"
 
         export PATH=$VENV_DIR/bin:$PATH
         export PYTHONPATH=""
         export LANG=en_US.UTF-8
 
-        export PIP_CACHE_DIR=$PWD/.local/pip-cache
+        export PIP_CACHE_DIR="$PWD/.local/pip-cache${pyVersion}"
 
         # Setup virtualenv
         if [ ! -d $VENV_DIR ]; then
@@ -67,6 +72,6 @@ stdenv.mkDerivation {
 
         # Dirty fix for Linux systems
         # https://nixos.wiki/wiki/Packaging/Quirks_and_Caveats
-        export LD_LIBRARY_PATH=${stdenv.cc.cc.lib}/lib/:$LD_LIBRARY_PATH
+        export LD_LIBRARY_PATH=${pkgs.stdenv.cc.cc.lib}/lib/:$LD_LIBRARY_PATH
     '';
 }

tests/examples/__init__.py

@@ -0,0 +1,56 @@
+from typing import NamedTuple, Sequence
+from graphql_dsl import *
+
+
+def test_github_query_example():
+    """ Composes the following example from
+    query ListIssues($owner: String!, $name: String!) {
+        repository(owner: $owner, name: $name) {
+            issues(first: 100) {
+                nodes {
+                    number
+                    title
+                }
+                pageInfo {
+                    hasNextPage
+                    endCursor
+                }
+            }
+        }
+    }
+    """
+    result = """
+    query ListIssues($owner:String!,$name:String!,$numFirstIssues:Int!){repository(owner:$owner,name:$name){issues(first:$numFirstIssues){nodes{number title}pageInfo{hasNextPage endCursor}}}}\
+    """
+
+    class Node(NamedTuple):
+        number: int
+        title: str
+
+    class PageInfo(NamedTuple):
+        hasNextPage: bool
+        endCursor: str
+
+    class Issue(NamedTuple):
+        nodes: Sequence[Node]
+        pageInfo: PageInfo
+
+    class Repository(NamedTuple):
+        issues: Sequence[Issue]
+
+    class ListIssues(NamedTuple):
+        repository: Repository
+
+    class Input(NamedTuple):
+        owner: str
+        name: str
+        numFirstIssues: int
+
+    q = GQL( QUERY | ListIssues
+             | WITH  | Input
+             | PASS  | Input.owner          * TO * ListIssues.repository
+             & Input.name           * TO * ListIssues.repository
+             & Input.numFirstIssues * TO * Repository.issues * AS * 'first'
+             )
+
+    assert q.query == result.strip()