👷 Add pre-commit (#1336)

* 🔧 Add pre-commit config

Similar to graphene and graphene-sqlalchemy

* ⬆ Bump black

* 👷 Lint on CI

* ⬆ Bump flake8-black

* 🔧 Keep excluding migrations

* ⬆ Bump flake8

* 🔧 Remove black and flake8 from tox config

* ⬆ Update pre-commit versions

* Upgrade syntax to python 3.7+

* Format with pre-commit

dedent docs/schema.py to allow formatting

* Fix tests on python 3.7

Author: nikolaik

.github/ISSUE_TEMPLATE/bug_report.md

@@ -27,8 +27,8 @@ a github repo, https://repl.it or similar (you can use this template as a starti
 
 
 * **Please tell us about your environment:**
-  
-  - Version: 
-  - Platform: 
+
+  - Version:
+  - Platform:
 
 * **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow)

.github/workflows/lint.yml

@@ -16,7 +16,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install tox
-    - name: Run lint 💅
+    - name: Run pre-commit 💅
       run: tox
       env:
-        TOXENV: flake8
+        TOXENV: pre-commit

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+default_language_version:
+  python: python3.9
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.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
+        exclude: README.md
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v2.37.3
+    hooks:
+    -   id: pyupgrade
+        args: [--py37-plus]
+-   repo: https://github.com/psf/black
+    rev: 22.6.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+    -   id: flake8

CONTRIBUTING.md

@@ -59,4 +59,4 @@ Then to produce a HTML version of the documentation:
 
 ```sh
 make html
-```
+```

MANIFEST.in

@@ -3,4 +3,4 @@ recursive-include graphene_django/templates *
 recursive-include graphene_django/static *
 
 include examples/cookbook/cookbook/ingredients/fixtures/ingredients.json
-include examples/cookbook-plain/cookbook/ingredients/fixtures/ingredients.json
+include examples/cookbook-plain/cookbook/ingredients/fixtures/ingredients.json

Makefile

@@ -13,7 +13,7 @@ tests:
 
 .PHONY: format ## Format code
 format:
-	black --exclude "/migrations/" graphene_django examples setup.py
+	black graphene_django examples setup.py
 
 .PHONY: lint ## Lint code
 lint:

docs/schema.py

@@ -1,60 +1,57 @@
-  import graphene
+import graphene
 
-  from graphene_django.types import DjangoObjectType
+from graphene_django.types import DjangoObjectType
 
-  from cookbook.ingredients.models import Category, Ingredient
+from cookbook.ingredients.models import Category, Ingredient
 
 
-  class CategoryType(DjangoObjectType):
-      class Meta:
-          model = Category
-          fields = '__all__'
+class CategoryType(DjangoObjectType):
+    class Meta:
+        model = Category
+        fields = "__all__"
 
 
-  class IngredientType(DjangoObjectType):
-      class Meta:
-          model = Ingredient
-          fields = '__all__'
+class IngredientType(DjangoObjectType):
+    class Meta:
+        model = Ingredient
+        fields = "__all__"
 
 
-  class Query(object):
-      category = graphene.Field(CategoryType,
-                                id=graphene.Int(),
-                                name=graphene.String())
-      all_categories = graphene.List(CategoryType)
+class Query:
+    category = graphene.Field(CategoryType, id=graphene.Int(), name=graphene.String())
+    all_categories = graphene.List(CategoryType)
 
+    ingredient = graphene.Field(
+        IngredientType, id=graphene.Int(), name=graphene.String()
+    )
+    all_ingredients = graphene.List(IngredientType)
 
-      ingredient = graphene.Field(IngredientType,
-                                  id=graphene.Int(),
-                                  name=graphene.String())
-      all_ingredients = graphene.List(IngredientType)
+    def resolve_all_categories(self, info, **kwargs):
+        return Category.objects.all()
 
-      def resolve_all_categories(self, info, **kwargs):
-          return Category.objects.all()
+    def resolve_all_ingredients(self, info, **kwargs):
+        return Ingredient.objects.all()
 
-      def resolve_all_ingredients(self, info, **kwargs):
-          return Ingredient.objects.all()
+    def resolve_category(self, info, **kwargs):
+        id = kwargs.get("id")
+        name = kwargs.get("name")
 
-      def resolve_category(self, info, **kwargs):
-          id = kwargs.get('id')
-          name = kwargs.get('name')
+        if id is not None:
+            return Category.objects.get(pk=id)
 
-          if id is not None:
-              return Category.objects.get(pk=id)
+        if name is not None:
+            return Category.objects.get(name=name)
 
-          if name is not None:
-              return Category.objects.get(name=name)
+        return None
 
-          return None
+    def resolve_ingredient(self, info, **kwargs):
+        id = kwargs.get("id")
+        name = kwargs.get("name")
 
-      def resolve_ingredient(self, info, **kwargs):
-          id = kwargs.get('id')
-          name = kwargs.get('name')
+        if id is not None:
+            return Ingredient.objects.get(pk=id)
 
-          if id is not None:
-              return Ingredient.objects.get(pk=id)
+        if name is not None:
+            return Ingredient.objects.get(name=name)
 
-          if name is not None:
-              return Ingredient.objects.get(name=name)
-
-          return None
+        return None

docs/tutorial-plain.rst

@@ -85,8 +85,8 @@ Make sure the app name in ``cookbook.ingredients.apps.IngredientsConfig`` is set
     # cookbook/ingredients/apps.py
 
     from django.apps import AppConfig
-    
-    
+
+
     class IngredientsConfig(AppConfig):
         default_auto_field = 'django.db.models.BigAutoField'
         name = 'cookbook.ingredients'

examples/cookbook-plain/cookbook/ingredients/fixtures/ingredients.json

@@ -1 +1,52 @@
-[{"model": "ingredients.category", "pk": 1, "fields": {"name": "Dairy"}}, {"model": "ingredients.category", "pk": 2, "fields": {"name": "Meat"}}, {"model": "ingredients.ingredient", "pk": 1, "fields": {"name": "Eggs", "notes": "Good old eggs", "category": 1}}, {"model": "ingredients.ingredient", "pk": 2, "fields": {"name": "Milk", "notes": "Comes from a cow", "category": 1}}, {"model": "ingredients.ingredient", "pk": 3, "fields": {"name": "Beef", "notes": "Much like milk, this comes from a cow", "category": 2}}, {"model": "ingredients.ingredient", "pk": 4, "fields": {"name": "Chicken", "notes": "Definitely doesn't come from a cow", "category": 2}}]
+[
+  {
+    "fields": {
+      "name": "Dairy"
+    },
+    "model": "ingredients.category",
+    "pk": 1
+  },
+  {
+    "fields": {
+      "name": "Meat"
+    },
+    "model": "ingredients.category",
+    "pk": 2
+  },
+  {
+    "fields": {
+      "category": 1,
+      "name": "Eggs",
+      "notes": "Good old eggs"
+    },
+    "model": "ingredients.ingredient",
+    "pk": 1
+  },
+  {
+    "fields": {
+      "category": 1,
+      "name": "Milk",
+      "notes": "Comes from a cow"
+    },
+    "model": "ingredients.ingredient",
+    "pk": 2
+  },
+  {
+    "fields": {
+      "category": 2,
+      "name": "Beef",
+      "notes": "Much like milk, this comes from a cow"
+    },
+    "model": "ingredients.ingredient",
+    "pk": 3
+  },
+  {
+    "fields": {
+      "category": 2,
+      "name": "Chicken",
+      "notes": "Definitely doesn't come from a cow"
+    },
+    "model": "ingredients.ingredient",
+    "pk": 4
+  }
+]

examples/cookbook-plain/cookbook/ingredients/migrations/0001_initial.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
 # Generated by Django 1.9 on 2015-12-04 18:15
-from __future__ import unicode_literals
 
 import django.db.models.deletion
 from django.db import migrations, models
@@ -10,24 +8,46 @@ class Migration(migrations.Migration):
 
     initial = True
 
-    dependencies = [
-    ]
+    dependencies = []
 
     operations = [
         migrations.CreateModel(
-            name='Category',
+            name="Category",
             fields=[
-                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('name', models.CharField(max_length=100)),
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
             ],
         ),
         migrations.CreateModel(
-            name='Ingredient',
+            name="Ingredient",
             fields=[
-                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('name', models.CharField(max_length=100)),
-                ('notes', models.TextField()),
-                ('category', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='ingredients', to='ingredients.Category')),
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
+                ("notes", models.TextField()),
+                (
+                    "category",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="ingredients",
+                        to="ingredients.Category",
+                    ),
+                ),
             ],
         ),
     ]

examples/cookbook-plain/cookbook/ingredients/migrations/0002_auto_20161104_0050.py

@@ -1,20 +1,18 @@
-# -*- coding: utf-8 -*-
 # Generated by Django 1.9 on 2016-11-04 00:50
-from __future__ import unicode_literals
 
 from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('ingredients', '0001_initial'),
+        ("ingredients", "0001_initial"),
     ]
 
     operations = [
         migrations.AlterField(
-            model_name='ingredient',
-            name='notes',
+            model_name="ingredient",
+            name="notes",
             field=models.TextField(blank=True, null=True),
         ),
     ]

examples/cookbook-plain/cookbook/ingredients/migrations/0003_auto_20181018_1746.py

@@ -6,12 +6,12 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('ingredients', '0002_auto_20161104_0050'),
+        ("ingredients", "0002_auto_20161104_0050"),
     ]
 
     operations = [
         migrations.AlterModelOptions(
-            name='category',
-            options={'verbose_name_plural': 'Categories'},
+            name="category",
+            options={"verbose_name_plural": "Categories"},
         ),
     ]

examples/cookbook-plain/cookbook/ingredients/schema.py

@@ -16,7 +16,7 @@ class Meta:
         fields = "__all__"
 
 
-class Query(object):
+class Query:
     category = graphene.Field(CategoryType, id=graphene.Int(), name=graphene.String())
     all_categories = graphene.List(CategoryType)