Merge pull request #28 from qlient-org/develop

Release 0.2.1-beta

Author: dfseifert

.deepsource.toml

@@ -0,0 +1,11 @@
+version = 1
+
+test_patterns = ["tests/**"]
+
+[[analyzers]]
+name = "python"
+enabled = true
+
+  [analyzers.meta]
+  max_line_length = 120
+  runtime_version = "3.x.x"

README.md

@@ -1,6 +1,7 @@
 # Qlient: Python GraphQL Client
 
 [![qlient-org](https://circleci.com/gh/qlient-org/python-qlient.svg?style=svg)](https://circleci.com/gh/qlient-org/python-qlient)
+[![DeepSource](https://deepsource.io/gh/qlient-org/python-qlient.svg/?label=resolved+issues&token=WQWScZui5Jy-cNg3fzvWxqhW)](https://deepsource.io/gh/qlient-org/python-qlient/?ref=repository-badge)
 [![pypi](https://img.shields.io/pypi/v/qlient.svg)](https://pypi.python.org/pypi/qlient)
 [![versions](https://img.shields.io/pypi/pyversions/qlient.svg)](https://github.com/qlient-org/python-qlient)
 [![license](https://img.shields.io/github/license/qlient-org/python-qlient.svg)](https://github.com/qlient-org/python-qlient/blob/master/LICENSE)

docs/examples/full_settings.py

@@ -1,9 +1,13 @@
+import json
+
 from qlient import Settings, Client
 
 my_settings = Settings(
     introspect=True,  # default, enable backend schema introspection
     validate_fields=True,  # default, enable query field selection validation
-    validate_variables=True  # default, enable query variable validation
+    validate_variables=True,  # default, enable query variable validation,
+    json_dumps=json.dumps,  # default, use python's builtin json.dumps for internal dumping
+    json_loads=json.loads,  # default, use python's builtin json.loads for internal loading
 )
 
 my_client = Client("https://...", settings=my_settings)

docs/examples/project_batches.md

@@ -1,4 +1,5 @@
 [![qlient-org](https://circleci.com/gh/qlient-org/python-qlient.svg?style=svg)](https://circleci.com/gh/qlient-org/python-qlient)
+[![DeepSource](https://deepsource.io/gh/qlient-org/python-qlient.svg/?label=resolved+issues&token=WQWScZui5Jy-cNg3fzvWxqhW)](https://deepsource.io/gh/qlient-org/python-qlient/?ref=repository-badge)
 [![pypi](https://img.shields.io/pypi/v/qlient.svg)](https://pypi.python.org/pypi/qlient)
 [![versions](https://img.shields.io/pypi/pyversions/qlient.svg)](https://github.com/qlient-org/python-qlient)
 [![license](https://img.shields.io/github/license/qlient-org/python-qlient.svg)](https://github.com/qlient-org/python-qlient/blob/master/LICENSE)

docs/examples/simple_client_instantiation.py

@@ -2,5 +2,5 @@
 
 client = Client("https://swapi-graphql.netlify.app/.netlify/functions/index")
 
-assert isinstance(client.schema, Schema)
-assert isinstance(client.backend, HTTPBackend)
+isinstance(client.schema, Schema)
+isinstance(client.backend, HTTPBackend)

docs/examples/using_sqlite_cache.py

@@ -1,14 +1,20 @@
-from qlient import Client
+from qlient import Client, Settings
 from qlient.cache import SqliteCache
 
 client = Client("https://...", cache=SqliteCache())
 
 # or with custom settings
 
+settings = Settings(
+    json_loads=...,  # uses json.loads by default, can be overwritten to ujson.loads
+    json_dumps=...,  # and ujson.dumps
+)
+
 client = Client(
     "https://...",
     cache=SqliteCache(
         path="/path/to/my/schema_cache.sqlite",
-        expires_in=86400  # seconds
+        expires_in=86400,  # seconds
+        settings=settings,
     )
 )

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qlient"
-version = "0.2.0-beta"
+version = "0.2.1-beta"
 description = "A fast and modern graphql client designed with simplicity in mind."
 authors = ["Daniel Seifert <[email protected]>"]
 maintainers = ["Daniel Seifert <[email protected]>"]

pyproject.toml

@@ -1,4 +1,4 @@
-""" This file contains the qlient exports
+"""This file contains the qlient exports
 
 :author: Daniel Seifert
 :created: 09.09.2021

src/qlient/__init__.py

@@ -1,4 +1,4 @@
-""" This file contains the different transports
+"""This file contains the different transports
 
 :author: Daniel Seifert
 :created: 09.09.2021
@@ -22,6 +22,13 @@
 
 
 class Backend(abc.ABC):
+    """Abstract base class for all graphql backend.
+
+    In order to create your own custom graphql backend you must overwrite the `execute_query`
+    method down below.
+
+    This is useful in cases where your backend is not typically reachable via http.
+    """
 
     @abc.abstractmethod
     def execute_query(
@@ -32,12 +39,25 @@ def execute_query(
             context: GraphQLContext = None,
             root: GraphQLRoot = None,
     ) -> GraphQLReturnType:
+        """Abstract method to execute a query on this backend.
+
+        Keep in mind that this method is synchronous.
+        If you want to create an async backend, make sure that the `execute_query` method
+        returns a result and not a Promise.
+
+        :param query: holds the graphql query
+        :param variables: optional, holds variables that are mentioned in the query
+        :param operation_name: optional, holds the name of this specific operation
+        :param context: optional, holds a graphql context
+        :param root: optional, holds a root value for this query
+        :return: the result of the graphql backend
+        """
         raise NotImplementedError
 
     @property
     @abc.abstractmethod
     def cache_key(self) -> str:
-        """ A key that uniquely identifies the schema for a specific backend
+        """A key that uniquely identifies the schema for a specific backend
 
         For example this can be a unique url or hostname.
         Or even a static key if the schema remains the same for the backend.
@@ -50,6 +70,10 @@ def cache_key(self) -> str:
 
 
 class HTTPBackend(Backend):
+    """A backend implementation that communicates with a http server.
+
+    The HTTPBackend uses pythons requests package under the hood for making requests.
+    """
 
     def __init__(
             self,
@@ -69,7 +93,7 @@ def execute_query(
             context: GraphQLContext = None,
             root: GraphQLRoot = None,
     ) -> GraphQLReturnType:
-        """ Send a query to the graphql endpoint
+        """Send a query to the http graphql backend
 
         :param query: holds the query
         :param variables: holds variables that should be sent with in the query
@@ -95,6 +119,10 @@ def execute_query(
 
     @property
     def cache_key(self) -> str:
+        """The http backend uses the http server uri as the unique cache key.
+
+        :return: the endpoint where the graphql server is running.
+        """
         return self.endpoint
 
     def __str__(self) -> str: