Merge remote-tracking branch 'origin/use-entry-points' into publish-wheel

Author: bollwyvl

.github/workflows/lint.yml

@@ -14,7 +14,7 @@ jobs:
         python-version: 3.8
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
+        python -m pip install --upgrade pip wheel
         pip install tox
     - name: Run lint and static type checks
       run: tox

.github/workflows/tests.yml

@@ -30,7 +30,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
+          python -m pip install --upgrade pip wheel
           pip install tox tox-gh-actions
       - name: Test with tox
         run: tox
@@ -52,7 +52,7 @@ jobs:
           python-version: 3.8
       - name: Install dependencies with only ${{ matrix.dependency }} extra dependency
         run: |
-          python -m pip install --upgrade pip
+          python -m pip install --upgrade pip wheel
           pip install .[${{ matrix.dependency }},test_no_transport]
       - name: Test with --${{ matrix.dependency }}-only
         run: pytest tests --${{ matrix.dependency }}-only
@@ -68,9 +68,9 @@ jobs:
           python-version: 3.8
       - name: Install test dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install .[test]
+          python -m pip install --upgrade pip wheel
+          pip install -e.[test]
       - name: Test with coverage
-        run: pytest --cov=gql --cov-report=xml tests
+        run: pytest --cov=gql --cov-report=xml --cov-report=term-missing tests
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v1

MANIFEST.in

@@ -11,8 +11,6 @@ include Makefile
 
 include tox.ini
 
-include scripts/gql-cli
-
 include gql/py.typed
 
 recursive-include tests *.py *.graphql *.cnf *.yaml *.pem

Makefile

@@ -1,6 +1,6 @@
 .PHONY: clean tests docs
 
-SRC_PYTHON := gql tests scripts/gql-cli docs/code_examples
+SRC_PYTHON := gql tests docs/code_examples
 
 dev-setup:
 	python pip install -e ".[test]"

docs/code_examples/aiohttp_async.py

@@ -11,7 +11,8 @@ async def main():
     # Using `async with` on the client will start a connection on the transport
     # and provide a `session` variable to execute queries on this connection
     async with Client(
-        transport=transport, fetch_schema_from_transport=True,
+        transport=transport,
+        fetch_schema_from_transport=True,
     ) as session:
 
         # Execute single query

docs/code_examples/appsync/mutation_api_key.py

@@ -31,7 +31,8 @@ async def main():
     transport = AIOHTTPTransport(url=url, auth=auth)
 
     async with Client(
-        transport=transport, fetch_schema_from_transport=False,
+        transport=transport,
+        fetch_schema_from_transport=False,
     ) as session:
 
         query = gql(

docs/code_examples/appsync/mutation_iam.py

@@ -30,7 +30,8 @@ async def main():
     transport = AIOHTTPTransport(url=url, auth=auth)
 
     async with Client(
-        transport=transport, fetch_schema_from_transport=False,
+        transport=transport,
+        fetch_schema_from_transport=False,
     ) as session:
 
         query = gql(

docs/code_examples/requests_sync.py

@@ -2,7 +2,9 @@
 from gql.transport.requests import RequestsHTTPTransport
 
 transport = RequestsHTTPTransport(
-    url="https://countries.trevorblades.com/", verify=True, retries=3,
+    url="https://countries.trevorblades.com/",
+    verify=True,
+    retries=3,
 )
 
 client = Client(transport=transport, fetch_schema_from_transport=True)

docs/code_examples/requests_sync_dsl.py

@@ -3,7 +3,9 @@
 from gql.transport.requests import RequestsHTTPTransport
 
 transport = RequestsHTTPTransport(
-    url="https://countries.trevorblades.com/", verify=True, retries=3,
+    url="https://countries.trevorblades.com/",
+    verify=True,
+    retries=3,
 )
 
 client = Client(transport=transport, fetch_schema_from_transport=True)

docs/code_examples/websockets_async.py

@@ -14,7 +14,8 @@ async def main():
     # Using `async with` on the client will start a connection on the transport
     # and provide a `session` variable to execute queries on this connection
     async with Client(
-        transport=transport, fetch_schema_from_transport=True,
+        transport=transport,
+        fetch_schema_from_transport=True,
     ) as session:
 
         # Execute single query

gql/cli.py

@@ -1,5 +1,7 @@
+import asyncio
 import json
 import logging
+import signal as signal_module
 import sys
 from argparse import ArgumentParser, Namespace, RawDescriptionHelpFormatter
 from typing import Any, Dict, Optional
@@ -132,11 +134,15 @@ def get_parser(with_examples: bool = False) -> ArgumentParser:
     appsync_auth_group = appsync_group.add_mutually_exclusive_group()
 
     appsync_auth_group.add_argument(
-        "--api-key", help="Provide an API key for authentication", dest="api_key",
+        "--api-key",
+        help="Provide an API key for authentication",
+        dest="api_key",
     )
 
     appsync_auth_group.add_argument(
-        "--jwt", help="Provide an JSON Web token for authentication", dest="jwt",
+        "--jwt",
+        help="Provide an JSON Web token for authentication",
+        dest="jwt",
     )
 
     return parser
@@ -403,3 +409,46 @@ async def main(args: Namespace) -> int:
                 exit_code = 1
 
     return exit_code
+
+
+def gql_cli() -> None:
+    """Synchronously invoke ``main`` with the parsed command line arguments.
+
+    Formerly ``scripts/gql-cli``, now registered as an ``entry_point``
+    """
+    # Get arguments from command line
+    parser = get_parser(with_examples=True)
+    args = parser.parse_args()
+
+    try:
+        # Create a new asyncio event loop
+        loop = asyncio.new_event_loop()
+        asyncio.set_event_loop(loop)
+
+        # Create a gql-cli task with the supplied arguments
+        main_task = asyncio.ensure_future(main(args), loop=loop)
+
+        # Add signal handlers to close gql-cli cleanly on Control-C
+        for signal_name in ["SIGINT", "SIGTERM", "CTRL_C_EVENT", "CTRL_BREAK_EVENT"]:
+            signal = getattr(signal_module, signal_name, None)
+
+            if signal is None:
+                continue
+
+            try:
+                loop.add_signal_handler(signal, main_task.cancel)
+            except NotImplementedError:  # pragma: no cover
+                # not all signals supported on all platforms
+                pass
+
+        # Run the asyncio loop to execute the task
+        exit_code = 0
+        try:
+            exit_code = loop.run_until_complete(main_task)
+        finally:
+            loop.close()
+
+        # Return with the correct exit code
+        sys.exit(exit_code)
+    except KeyboardInterrupt:  # pragma: no cover
+        pass

gql/dsl.py

@@ -311,7 +311,9 @@ class DSLSelector(ABC):
     selection_set: SelectionSetNode
 
     def __init__(
-        self, *fields: "DSLSelectable", **fields_with_alias: "DSLSelectableWithAlias",
+        self,
+        *fields: "DSLSelectable",
+        **fields_with_alias: "DSLSelectableWithAlias",
     ):
         """:meta private:"""
         self.selection_set = SelectionSetNode(selections=())
@@ -326,7 +328,9 @@ def is_valid_field(self, field: "DSLSelectable") -> bool:
         )  # pragma: no cover
 
     def select(
-        self, *fields: "DSLSelectable", **fields_with_alias: "DSLSelectableWithAlias",
+        self,
+        *fields: "DSLSelectable",
+        **fields_with_alias: "DSLSelectableWithAlias",
     ):
         r"""Select the fields which should be added.
 
@@ -387,7 +391,9 @@ def executable_ast(self):
         )  # pragma: no cover
 
     def __init__(
-        self, *fields: "DSLSelectable", **fields_with_alias: "DSLSelectableWithAlias",
+        self,
+        *fields: "DSLSelectable",
+        **fields_with_alias: "DSLSelectableWithAlias",
     ):
         r"""Given arguments of type :class:`DSLSelectable` containing GraphQL requests,
         generate an operation which can be converted to a Document
@@ -552,7 +558,9 @@ def get_ast_definitions(self) -> Tuple[VariableDefinitionNode, ...]:
         """
         return tuple(
             VariableDefinitionNode(
-                type=var.type, variable=var.ast_variable, default_value=None,
+                type=var.type,
+                variable=var.ast_variable,
+                default_value=None,
             )
             for var in self.variables.values()
             if var.type is not None  # only variables used
@@ -889,7 +897,9 @@ class DSLInlineFragment(DSLSelectable, DSLFragmentSelector):
     ast_field: InlineFragmentNode
 
     def __init__(
-        self, *fields: "DSLSelectable", **fields_with_alias: "DSLSelectableWithAlias",
+        self,
+        *fields: "DSLSelectable",
+        **fields_with_alias: "DSLSelectableWithAlias",
     ):
         r"""Initialize the DSLInlineFragment.
 
@@ -944,7 +954,8 @@ class DSLFragment(DSLSelectable, DSLFragmentSelector, DSLExecutable):
     name: str
 
     def __init__(
-        self, name: str,
+        self,
+        name: str,
     ):
         r"""Initialize the DSLFragment.
 

gql/transport/aiohttp.py

@@ -222,7 +222,8 @@ async def execute(
             # If we upload files, we will extract the files present in the
             # variable_values dict and replace them by null values
             nulled_variable_values, files = extract_files(
-                variables=variable_values, file_classes=self.file_classes,
+                variables=variable_values,
+                file_classes=self.file_classes,
             )
 
             # Save the nulled variable values in the payload
@@ -275,7 +276,8 @@ async def execute(
         # Add headers for AppSync if requested
         if isinstance(self.auth, AppSyncAuthentication):
             post_args["headers"] = self.auth.get_headers(
-                json.dumps(payload), {"content-type": "application/json"},
+                json.dumps(payload),
+                {"content-type": "application/json"},
             )
 
         if self.session is None:

gql/transport/appsync_websockets.py

@@ -172,7 +172,12 @@ async def _send_query(
             "authorization": self.auth.get_headers(serialized_data)
         }
 
-        await self._send(json.dumps(message, separators=(",", ":"),))
+        await self._send(
+            json.dumps(
+                message,
+                separators=(",", ":"),
+            )
+        )
 
         return query_id
 

gql/transport/async_transport.py

@@ -7,16 +7,14 @@
 class AsyncTransport:
     @abc.abstractmethod
     async def connect(self):
-        """Coroutine used to create a connection to the specified address
-        """
+        """Coroutine used to create a connection to the specified address"""
         raise NotImplementedError(
             "Any AsyncTransport subclass must implement connect method"
         )  # pragma: no cover
 
     @abc.abstractmethod
     async def close(self):
-        """Coroutine used to Close an established connection
-        """
+        """Coroutine used to Close an established connection"""
         raise NotImplementedError(
             "Any AsyncTransport subclass must implement close method"
         )  # pragma: no cover
@@ -28,8 +26,8 @@ async def execute(
         variable_values: Optional[Dict[str, Any]] = None,
         operation_name: Optional[str] = None,
     ) -> ExecutionResult:
-        """Execute the provided document AST for either a remote or local GraphQL Schema.
-        """
+        """Execute the provided document AST for either a remote or local GraphQL
+        Schema."""
         raise NotImplementedError(
             "Any AsyncTransport subclass must implement execute method"
         )  # pragma: no cover

gql/transport/local_schema.py

@@ -10,7 +10,8 @@ class LocalSchemaTransport(AsyncTransport):
     """A transport for executing GraphQL queries against a local schema."""
 
     def __init__(
-        self, schema: GraphQLSchema,
+        self,
+        schema: GraphQLSchema,
     ):
         """Initialize the transport with the given local schema.
 
@@ -19,20 +20,20 @@ def __init__(
         self.schema = schema
 
     async def connect(self):
-        """No connection needed on local transport
-        """
+        """No connection needed on local transport"""
         pass
 
     async def close(self):
-        """No close needed on local transport
-        """
+        """No close needed on local transport"""
         pass
 
     async def execute(
-        self, document: DocumentNode, *args, **kwargs,
+        self,
+        document: DocumentNode,
+        *args,
+        **kwargs,
     ) -> ExecutionResult:
-        """Execute the provided document AST for on a local GraphQL Schema.
-        """
+        """Execute the provided document AST for on a local GraphQL Schema."""
 
         result_or_awaitable = execute(self.schema, document, *args, **kwargs)
 
@@ -48,7 +49,10 @@ async def execute(
         return execution_result
 
     async def subscribe(
-        self, document: DocumentNode, *args, **kwargs,
+        self,
+        document: DocumentNode,
+        *args,
+        **kwargs,
     ) -> AsyncGenerator[ExecutionResult, None]:
         """Send a subscription and receive the results using an async generator
 

gql/transport/requests.py

@@ -155,7 +155,8 @@ def execute(  # type: ignore
             # If we upload files, we will extract the files present in the
             # variable_values dict and replace them by null values
             nulled_variable_values, files = extract_files(
-                variables=variable_values, file_classes=self.file_classes,
+                variables=variable_values,
+                file_classes=self.file_classes,
             )
 
             # Save the nulled variable values in the payload

gql/transport/transport.py

@@ -18,8 +18,7 @@ def execute(self, document: DocumentNode, *args, **kwargs) -> ExecutionResult:
         )  # pragma: no cover
 
     def connect(self):
-        """Establish a session with the transport.
-        """
+        """Establish a session with the transport."""
         pass  # pragma: no cover
 
     def close(self):