fix ci, set up tox, set up pre-commit, various cleanups

Author: Julien Nakache

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+default_language_version:
+    python: python3.7
+repos:
+-   repo: git://github.com/pre-commit/pre-commit-hooks
+    rev: c8bad492e1b1d65d9126dba3fe3bd49a5a52b9d6  # v2.1.0
+    hooks:
+    -   id: check-merge-conflict
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: end-of-file-fixer
+        exclude: ^docs/.*$
+    # TODO Enable in its own PR
+    # -   id: trailing-whitespace
+    #     exclude: README.md
+-   repo: git://github.com/PyCQA/flake8
+    rev: 88caf5ac484f5c09aedc02167c59c66ff0af0068  # 3.7.7
+    hooks:
+    -   id: flake8

.travis.yml

@@ -1,42 +1,47 @@
 language: python
-sudo: false
-python:
-- 2.7
-- 3.4
-- 3.5
-- 3.6
-before_install:
-install:
-- |
-  if [ "$TEST_TYPE" = build ]; then
-    pip install pytest==3.0.2 pytest-cov pytest-benchmark coveralls six mock sqlalchemy_utils
-    pip install -e .
-    python setup.py develop
-  elif [ "$TEST_TYPE" = lint ]; then
-    pip install flake8
-  fi
-script:
-- |
-  if [ "$TEST_TYPE" = lint ]; then
-    echo "Checking Python code lint."
-    flake8 graphene_sqlalchemy
-    exit
-  elif [ "$TEST_TYPE" = build ]; then
-    py.test --cov=graphene_sqlalchemy graphene_sqlalchemy examples
-  fi
-after_success:
-- |
-  if [ "$TEST_TYPE" = build ]; then
-      coveralls
-  fi
-env:
-  matrix:
-  - TEST_TYPE=build
 matrix:
-  fast_finish: true
   include:
-  - python: '2.7'
-    env: TEST_TYPE=lint
+    # Python 2.7
+    # TODO Fix enum and add back tests for py27
+    # See https://github.com/graphql-python/graphene-sqlalchemy/pull/177
+    # - env: TOXENV=py27
+    #   python: 2.7
+    # Python 3.5
+    - env: TOXENV=py34
+      python: 3.4
+    # Python 3.5
+    - env: TOXENV=py35
+      python: 3.5
+    # Python 3.6
+    - env: TOXENV=py36
+      python: 3.6
+    # Python 3.7
+    - env: TOXENV=py37
+      python: 3.7
+      dist: xenial
+    # SQLAlchemy 1.1
+    - env: TOXENV=py37-sql11
+      python: 3.7
+      dist: xenial
+    # SQLAlchemy 1.2
+    - env: TOXENV=py37-sql12
+      python: 3.7
+      dist: xenial
+    # SQLAlchemy 1.3
+    - env: TOXENV=py37-sql13
+      python: 3.7
+      dist: xenial
+    # Pre-commit
+    - env: TOXENV=pre-commit
+      python: 3.7
+      dist: xenial
+install: pip install .[dev]
+script: tox
+after_success: coveralls
+cache:
+  directories:
+    - $HOME/.cache/pip
+    - $HOME/.cache/pre-commit
 deploy:
   provider: pypi
   user: syrusakbary

README.md

@@ -112,14 +112,24 @@ To learn more check out the following [examples](examples/):
 
 ## Contributing
 
-After cloning this repo, ensure dependencies are installed by running:
+Set up our development dependencies:
 
 ```sh
-python setup.py install
+pip install -e ".[dev]"
+pre-commit install  
 ```
 
-After developing, the full test suite can be evaluated by running:
+We use `tox` to test this library against different versions of `python` and `SQLAlchemy`.
+While developping locally, it is usually fine to run the tests against the most recent versions:
 
 ```sh
-python setup.py test # Use --pytest-args="-v -s" for verbose mode
+tox -e py37  # Python 3.7, SQLAlchemy < 2.0
+tox -e py37 -- -v -s  # Verbose output
+tox -e py37 -- -k test_query  # Only test_query.py 
+```
+
+Our linters will run automatically when committing via git hooks but you can also run them manually:
+
+```sh
+tox -e pre-commit
 ```

examples/nameko_sqlalchemy/README.md

@@ -51,4 +51,4 @@ Now the following command will setup the database, and start the server:
 
 Now head on over to postman and send POST request to:
 [http://127.0.0.1:5000/graphql](http://127.0.0.1:5000/graphql)
-and run some queries!
+and run some queries!

examples/nameko_sqlalchemy/app.py

@@ -33,4 +33,4 @@ def parse_body(self,request):
       elif content_type in ('application/x-www-form-urlencoded', 'multipart/form-data'):
           return request.form
 
-      return {}
+      return {}

examples/nameko_sqlalchemy/config.yml

@@ -1 +1 @@
-WEB_SERVER_ADDRESS: '0.0.0.0:5000'
+WEB_SERVER_ADDRESS: '0.0.0.0:5000'

examples/nameko_sqlalchemy/requirements.txt

@@ -1,4 +1,4 @@
 graphene[sqlalchemy]
 SQLAlchemy==1.0.11
 nameko
-graphql-server-core
+graphql-server-core

examples/nameko_sqlalchemy/run.sh

@@ -1,4 +1,4 @@
 #!/bin/sh
 echo "Starting application service server"
 # Run Service
-nameko run --config config.yml service
+nameko run --config config.yml service

examples/nameko_sqlalchemy/service.py

@@ -8,4 +8,4 @@ class DepartmentService:
 
     @http('POST', '/graphql')
     def query(self, request):
-        return App().query(request)
+        return App().query(request)

graphene_sqlalchemy/tests/test_converter.py

@@ -168,7 +168,7 @@ class Test(Base):
         )
 
     graphene_type = convert_sqlalchemy_column(Test.column)
-    assert graphene_type.kwargs["required"] == False
+    assert not graphene_type.kwargs["required"]
 
 
 def test_should_scalar_list_convert_list():
@@ -343,4 +343,3 @@ def __init__(self, col1, col2):
         )
 
     assert "Don't know how to convert the composite field" in str(excinfo.value)
-

graphene_sqlalchemy/tests/test_query.py

@@ -555,4 +555,3 @@ def makeNodes(nodeList):
         assert set(node["node"]["name"] for node in value["edges"]) == set(
             node["node"]["name"] for node in expectedNoSort[key]["edges"]
         )
-

graphene_sqlalchemy/tests/test_reflected.py

@@ -18,4 +18,3 @@ def test_objecttype_registered():
     assert issubclass(Reflected, ObjectType)
     assert Reflected._meta.model == ReflectedEditor
     assert list(Reflected._meta.fields.keys()) == ["editor_id", "name"]
-

graphene_sqlalchemy/tests/test_schema.py

@@ -47,4 +47,3 @@ class Meta:
             model = Reporter
             only_fields = ("id", "email")
     assert list(Reporter2._meta.fields.keys()) == ["id", "email"]
-

graphene_sqlalchemy/tests/test_types.py

@@ -1,7 +1,7 @@
 from collections import OrderedDict
 from graphene import Field, Int, Interface, ObjectType
 from graphene.relay import Node, is_node, Connection
-import six
+import six  # noqa: F401
 from promise import Promise
 
 from ..registry import Registry
@@ -176,7 +176,9 @@ class TestConnection(Connection):
         class Meta:
             node = ReporterWithCustomOptions
 
-    resolver = lambda *args, **kwargs: Promise.resolve([])
+    def resolver(*args, **kwargs):
+        return Promise.resolve([])
+
     result = SQLAlchemyConnectionField.connection_resolver(
         resolver, TestConnection, ReporterWithCustomOptions, None, None
     )

graphene_sqlalchemy/types.py

@@ -1,9 +1,11 @@
 from collections import OrderedDict
 
+import sqlalchemy
 from sqlalchemy.inspection import inspect as sqlalchemyinspect
 from sqlalchemy.ext.hybrid import hybrid_property
 from sqlalchemy.orm.exc import NoResultFound
 
+import graphene
 from graphene import Field  # , annotate, ResolveInfo
 from graphene.relay import Connection, Node
 from graphene.types.objecttype import ObjectType, ObjectTypeOptions
@@ -80,9 +82,9 @@ def construct_fields(model, registry, only_fields, exclude_fields):
 
 
 class SQLAlchemyObjectTypeOptions(ObjectTypeOptions):
-    model = None  # type: Model
-    registry = None  # type: Registry
-    connection = None  # type: Type[Connection]
+    model = None  # type: sqlalchemy.Model
+    registry = None  # type: sqlalchemy.Registry
+    connection = None  # type: graphene.Type[Connection]
     id = None  # type: str
 
 

setup.cfg

@@ -2,28 +2,9 @@
 exclude = setup.py,docs/*,examples/*,tests
 max-line-length = 120
 
-[coverage:run]
-omit = */tests/*
-
+# TODO Add isort as a pre-commit hook
 [isort]
 known_first_party=graphene,graphene_sqlalchemy
 
-[tool:pytest]
-testpaths = graphene_sqlalchemy/
-addopts =
-    -s
-    ; --cov graphene-sqlalchemy
-norecursedirs =
-    __pycache__
-    *.egg-info
-    .cache
-    .git
-    .tox
-    appdir
-    docs
-filterwarnings =
-    error
-    ignore::DeprecationWarning
-
 [bdist_wheel]
 universal=1

setup.py

@@ -10,6 +10,12 @@
         ast.literal_eval(_version_re.search(f.read().decode("utf-8")).group(1))
     )
 
+tests_require = [
+    "pytest==4.3.1",
+    "mock==2.0.0",
+    "pytest-cov==2.6.1",
+    "sqlalchemy_utils==0.33.9",
+]
 
 setup(
     name="graphene-sqlalchemy",
@@ -37,10 +43,20 @@
     keywords="api graphql protocol rest relay graphene",
     packages=find_packages(exclude=["tests"]),
     install_requires=[
-        "six>=1.10.0",
-        "graphene>=2.1.3",
-        "SQLAlchemy",
-        "singledispatch>=3.4.0.3",
+        # To keep things simple, we only support newer versions of Graphene
+        "graphene>=2.1.3,<3",
+        # Tests fail with 1.0.19
+        "SQLAlchemy>=1.1,<2",
+        "six>=1.10.0,<2",
+        "singledispatch>=3.4.0.3,<4",
     ],
-    tests_require=["pytest>=2.7.2", "mock", "sqlalchemy_utils"],
+    extras_require={
+        "dev": [
+            "tox==3.7.0",  # Should be kept in sync with tox.ini
+            "coveralls==1.7.0",
+            "pre-commit==1.14.4",
+        ],
+        "test": tests_require,
+    },
+    tests_require=tests_require,
 )

tox.ini

@@ -0,0 +1,20 @@
+[tox]
+envlist = pre-commit,py{34,35,36,37}-sql{11,12,13}
+skipsdist = true
+minversion = 3.7.0
+
+[testenv]
+deps =
+    .[test]
+    sql11: sqlalchemy>=1.1,<1.2
+    sql12: sqlalchemy>=1.2,<1.3
+    sql13: sqlalchemy>=1.3,<1.4
+commands =
+    pytest graphene_sqlalchemy --cov=graphene_sqlalchemy {posargs}
+
+[testenv:pre-commit]
+basepython=python3.7
+deps =
+    .[dev]
+commands =
+    pre-commit {posargs:run --all-files}