Merge pull request #557 from jazzband/add-pre-commit

Add pre commit

Author: j-antunes

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.11.0
+    hooks:
+    -   id: black
+        exclude: '.*migrations.*'

docs/advanced.rst

@@ -136,7 +136,7 @@ If you insert ``.non_polymorphic()`` anywhere into the query chain, then
 django_polymorphic will simply leave out the final step of retrieving the
 real objects, and the manager/queryset will return objects of the type of
 the base class you used for the query, like vanilla Django would
-(``ModelA`` in this example). 
+(``ModelA`` in this example).
 
 >>> qs=ModelA.objects.non_polymorphic().all()
 >>> qs
@@ -188,7 +188,7 @@ About Queryset Methods
 *   ``values()`` & ``values_list()`` currently do not return polymorphic
     results. This may change in the future however. If you want to use these
     methods now, it's best if you use ``Model.base_objects.values...`` as
-    this is guaranteed to not change. 
+    this is guaranteed to not change.
 
 *   ``defer()`` and ``only()`` work as expected. On Django 1.5+ they support
     the ``ModelX___field`` syntax, but on Django 1.4 it is only possible to
@@ -252,7 +252,7 @@ Restrictions & Caveats
     the resulting objects are required to have a unique primary key within
     the result set.
 
-*   Diamond shaped inheritance: There seems to be a general problem 
+*   Diamond shaped inheritance: There seems to be a general problem
     with diamond shaped multiple model inheritance with Django models
     (tested with V1.1 - V1.3).
     An example is here: http://code.djangoproject.com/ticket/10808.
@@ -288,4 +288,3 @@ Restrictions & Caveats
     - http://groups.google.com/group/django-users/browse_thread/thread/52f72cffebb705e/bc18c18b2e83881e?lnk=gst&q=model+inheritance#bc18c18b2e83881e
     - http://code.djangoproject.com/ticket/10808
     - http://code.djangoproject.com/ticket/7270
-

docs/api/polymorphic.admin.rst

@@ -90,4 +90,3 @@ These classes are useful when existing parts of the admin classes.
 
 .. autoclass:: polymorphic.admin.PolymorphicInlineAdminFormSet
     :show-inheritance:
-

docs/index.rst

@@ -81,4 +81,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

example/pexp/dumpdata_test_correct_output.txt

@@ -1,38 +1,38 @@
 [
     {
-        "pk": 1, 
-        "model": "pexp.project", 
+        "pk": 1,
+        "model": "pexp.project",
         "fields": {
-            "topic": "John's gathering", 
+            "topic": "John's gathering",
             "polymorphic_ctype": 2
         }
-    }, 
+    },
     {
-        "pk": 2, 
-        "model": "pexp.project", 
+        "pk": 2,
+        "model": "pexp.project",
         "fields": {
-            "topic": "Sculpting with Tim", 
+            "topic": "Sculpting with Tim",
             "polymorphic_ctype": 3
         }
-    }, 
+    },
     {
-        "pk": 3, 
-        "model": "pexp.project", 
+        "pk": 3,
+        "model": "pexp.project",
         "fields": {
-            "topic": "Swallow Aerodynamics", 
+            "topic": "Swallow Aerodynamics",
             "polymorphic_ctype": 4
         }
-    }, 
+    },
     {
-        "pk": 2, 
-        "model": "pexp.artproject", 
+        "pk": 2,
+        "model": "pexp.artproject",
         "fields": {
             "artist": "T. Turner"
         }
-    }, 
+    },
     {
-        "pk": 3, 
-        "model": "pexp.researchproject", 
+        "pk": 3,
+        "model": "pexp.researchproject",
         "fields": {
             "supervisor": "Dr. Winter"
         }

polymorphic/formsets/models.py

@@ -41,7 +41,6 @@ def __init__(
         help_texts=None,
         error_messages=None,
     ):
-
         self.model = model
 
         # Instead of initializing the form here right away,

polymorphic/query.py

@@ -53,7 +53,6 @@ def _polymorphic_iterator(self, base_iter):
             # Make sure the base iterator is read in chunks instead of
             # reading it completely, in case our caller read only a few objects.
             for i in range(Polymorphic_QuerySet_objects_per_request):
-
                 try:
                     o = next(base_iter)
                     base_result_objects.append(o)
@@ -258,7 +257,8 @@ def _polymorphic_add_immediate_loading(self, field_names):
 
     def _process_aggregate_args(self, args, kwargs):
         """for aggregate and annotate kwargs: allow ModelX___field syntax for kwargs, forbid it for args.
-        Modifies kwargs if needed (these are Aggregate objects, we translate the lookup member variable)"""
+        Modifies kwargs if needed (these are Aggregate objects, we translate the lookup member variable)
+        """
         ___lookup_assert_msg = "PolymorphicModel: annotate()/aggregate(): ___ model lookup supported for keyword arguments only"
 
         def patch_lookup(a):
@@ -386,7 +386,6 @@ class self.model, but as a class derived from self.model. We want to re-fetch
         ).pk
 
         for i, base_object in enumerate(base_result_objects):
-
             if base_object.polymorphic_ctype_id == self_model_class_id:
                 # Real class is exactly the same as base class, go straight to results
                 resultlist.append(base_object)

polymorphic/query_translate.py

@@ -40,7 +40,6 @@ def translate_polymorphic_filter_definitions_in_kwargs(
     """
     additional_args = []
     for field_path, val in kwargs.copy().items():  # Python 3 needs copy
-
         new_expr = _translate_polymorphic_filter_definition(
             queryset_model, field_path, val, using=using
         )

polymorphic/tests/models.py

@@ -372,6 +372,7 @@ class ProxyModelB(ProxyModelBase):
 # class TestBadFieldModel(ShowFieldType, PolymorphicModel):
 #    instance_of = models.CharField(max_length=10)
 
+
 # validation error: "polymorphic.relatednameclash: Accessor for field 'polymorphic_ctype' clashes
 # with related field 'ContentType.relatednameclash_set'." (reported by Andrew Ingram)
 # fixed with related_name
@@ -401,7 +402,6 @@ class CustomPkInherit(CustomPkBase):
 
 
 class DateModel(PolymorphicModel):
-
     date = models.DateTimeField()
 
 

polymorphic/tests/test_orm.py

@@ -1077,7 +1077,6 @@ def test_polymorphic__filtered_relation(self):
         self.assertIsInstance(result.last(), BlogB)
 
     def test_polymorphic__expressions(self):
-
         from django.db.models.functions import Concat
 
         # no exception raised
@@ -1240,6 +1239,5 @@ def test_refresh_from_db_fields(self):
         assert obj.field1 == "aa1"
 
     def test_non_polymorphic_parent(self):
-
         obj = NonPolymorphicParent.objects.create()
         assert obj.delete()