chore: use pre-commit with ruff

Author: kiendang

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+default_language_version:
+    python: python3.10
+exclude: LICENSE
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: check-merge-conflict
+    -   id: check-json
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: end-of-file-fixer
+        exclude: ^docs/.*$
+    -   id: pretty-format-json
+        args:
+        - --autofix
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.282
+    hooks:
+    -   id: ruff
+        args: [--fix, --exit-non-zero-on-fix, --show-fixes]

.ruff.toml

@@ -0,0 +1,28 @@
+select = [
+    "E",    # pycodestyle
+    "W",    # pycodestyle
+    "F",    # pyflake
+    "I",    # isort
+    "B",    # flake8-bugbear
+    "UP",   # pyupgrade
+]
+
+ignore = [
+    "E501",  # line-too-long
+    "B904",  # check for raise statements in exception handlers that lack a from clause
+]
+
+exclude = [
+    "**/docs",
+]
+
+target-version = "py38"
+
+[per-file-ignores]
+# Ignore unused imports (F401) in these files
+"__init__.py" = ["F401"]
+
+[isort]
+known-first-party = ["graphql_server"]
+force-wrap-aliases = true
+combine-as-imports = true

CONTRIBUTING.md

@@ -31,8 +31,7 @@ Activate the virtualenv and install dependencies by running:
 python pip install -e ".[test]"
 ```
 
-If you are using Linux or MacOS, you can make use of Makefile command 
-`make dev-setup`, which is a shortcut for the above python command.
+If you are using Linux or MacOS, you can make use of Makefile command `make dev-setup`, which is a shortcut for the above python command.
 
 ### Development on Conda
 
@@ -60,8 +59,7 @@ After developing, the full test suite can be evaluated by running:
 pytest tests --cov=graphql-server -vv
 ```
 
-If you are using Linux or MacOS, you can make use of Makefile command 
-`make tests`, which is a shortcut for the above python command.
+If you are using Linux or MacOS, you can make use of Makefile command `make tests`, which is a shortcut for the above python command.
 
 You can also test on several python environments by using tox.
 
@@ -73,8 +71,7 @@ Install tox:
 pip install tox
 ```
 
-Run `tox` on your virtualenv (do not forget to activate it!) 
-and that's it! 
+Run `tox` on your virtualenv (do not forget to activate it!) and that's it!
 
 ### Running tox on Conda
 
@@ -89,5 +86,4 @@ This install tox underneath so no need to install it before.
 
 Then uncomment the `requires = tox-conda` line on `tox.ini` file.
 
-Run `tox` and you will see all the environments being created 
-and all passing tests. :rocket:
+Run `tox` and you will see all the environments being created and all passing tests. :rocket:

codecov.yml

@@ -7,4 +7,4 @@ coverage:
   status:
     project:
       default:
-        target: auto
+        target: auto

graphql_server/aiohttp/graphqlview.py

@@ -56,7 +56,7 @@ class GraphQLView:
     encode = staticmethod(json_encode)
 
     def __init__(self, **kwargs):
-        super(GraphQLView, self).__init__()
+        super().__init__()
         for key, value in kwargs.items():
             if hasattr(self, key):
                 setattr(self, key, value)
@@ -194,9 +194,9 @@ async def __call__(self, request):
             if is_graphiql:
                 graphiql_data = GraphiQLData(
                     result=result,
-                    query=getattr(all_params[0], "query"),
-                    variables=getattr(all_params[0], "variables"),
-                    operation_name=getattr(all_params[0], "operation_name"),
+                    query=all_params[0].query,
+                    variables=all_params[0].variables,
+                    operation_name=all_params[0].operation_name,
                     subscription_url=self.subscriptions,
                     headers=self.headers,
                 )

graphql_server/error.py

@@ -16,7 +16,7 @@ def __init__(self, status_code, message=None, is_graphql_error=False, headers=No
         self.message = message
         self.is_graphql_error = is_graphql_error
         self.headers = headers
-        super(HttpQueryError, self).__init__(message)
+        super().__init__(message)
 
     def __eq__(self, other):
         """Check whether this HTTP query error is equal to another one."""

graphql_server/flask/graphqlview.py

@@ -53,7 +53,7 @@ class GraphQLView(View):
     encode = staticmethod(json_encode)
 
     def __init__(self, **kwargs):
-        super(GraphQLView, self).__init__()
+        super().__init__()
         for key, value in kwargs.items():
             if hasattr(self, key):
                 setattr(self, key, value)
@@ -126,9 +126,9 @@ def dispatch_request(self):
             if show_graphiql:
                 graphiql_data = GraphiQLData(
                     result=result,
-                    query=getattr(all_params[0], "query"),
-                    variables=getattr(all_params[0], "variables"),
-                    operation_name=getattr(all_params[0], "operation_name"),
+                    query=all_params[0].query,
+                    variables=all_params[0].variables,
+                    operation_name=all_params[0].operation_name,
                     subscription_url=self.subscriptions,
                     headers=self.headers,
                 )

graphql_server/quart/graphqlview.py

@@ -57,7 +57,7 @@ class GraphQLView(View):
     encode = staticmethod(json_encode)
 
     def __init__(self, **kwargs):
-        super(GraphQLView, self).__init__()
+        super().__init__()
         for key, value in kwargs.items():
             if hasattr(self, key):
                 setattr(self, key, value)
@@ -142,9 +142,9 @@ async def dispatch_request(self):
             if show_graphiql:
                 graphiql_data = GraphiQLData(
                     result=result,
-                    query=getattr(all_params[0], "query"),
-                    variables=getattr(all_params[0], "variables"),
-                    operation_name=getattr(all_params[0], "operation_name"),
+                    query=all_params[0].query,
+                    variables=all_params[0].variables,
+                    operation_name=all_params[0].operation_name,
                     subscription_url=self.subscriptions,
                     headers=self.headers,
                 )

graphql_server/sanic/graphqlview.py

@@ -58,7 +58,7 @@ class GraphQLView(HTTPMethodView):
     encode = staticmethod(json_encode)
 
     def __init__(self, **kwargs):
-        super(GraphQLView, self).__init__()
+        super().__init__()
         for key, value in kwargs.items():
             if hasattr(self, key):
                 setattr(self, key, value)
@@ -147,9 +147,9 @@ async def __handle_request(self, request, *args, **kwargs):
                 if show_graphiql:
                     graphiql_data = GraphiQLData(
                         result=result,
-                        query=getattr(all_params[0], "query"),
-                        variables=getattr(all_params[0], "variables"),
-                        operation_name=getattr(all_params[0], "operation_name"),
+                        query=all_params[0].query,
+                        variables=all_params[0].variables,
+                        operation_name=all_params[0].operation_name,
                         subscription_url=self.subscriptions,
                         headers=self.headers,
                     )

graphql_server/webob/graphqlview.py

@@ -52,7 +52,7 @@ class GraphQLView:
     encode = staticmethod(json_encode)
 
     def __init__(self, **kwargs):
-        super(GraphQLView, self).__init__()
+        super().__init__()
         for key, value in kwargs.items():
             if hasattr(self, key):
                 setattr(self, key, value)
@@ -128,9 +128,9 @@ def dispatch_request(self, request):
             if show_graphiql:
                 graphiql_data = GraphiQLData(
                     result=result,
-                    query=getattr(all_params[0], "query"),
-                    variables=getattr(all_params[0], "variables"),
-                    operation_name=getattr(all_params[0], "operation_name"),
+                    query=all_params[0].query,
+                    variables=all_params[0].variables,
+                    operation_name=all_params[0].operation_name,
                     subscription_url=self.subscriptions,
                     headers=self.headers,
                 )

tests/test_helpers.py

@@ -139,7 +139,7 @@ def test_encode_execution_results_with_format_error():
     def format_error(error):
         return {
             "msg": error.message,
-            "loc": "{}:{}".format(error.locations[0].line, error.locations[0].column),
+            "loc": f"{error.locations[0].line}:{error.locations[0].column}",
             "pth": "/".join(error.path),
         }
 

tests/webob/app.py

@@ -11,7 +11,7 @@ def url_string(url="/graphql", **url_params):
     return f"{url}?{urlencode(url_params)}" if url_params else url
 
 
-class Client(object):
+class Client:
     def __init__(self, **kwargs):
         self.schema = kwargs.pop("schema", None) or Schema
         self.settings = kwargs.pop("settings", None) or {}