Black codebase

Author: craigds

fieldsignals/signals.py

@@ -7,12 +7,10 @@
 from django.dispatch import Signal
 
 
-__all__ = ('pre_save_changed', 'post_save_changed')
+__all__ = ("pre_save_changed", "post_save_changed")
 
 
-IMMUTABLE_TYPES_WHITELIST = tuple(
-    [tuple, frozenset, float, str, int]
-)
+IMMUTABLE_TYPES_WHITELIST = tuple([tuple, frozenset, float, str, int])
 
 
 class ChangedSignal(Signal):
@@ -38,7 +36,7 @@ def connect(self, receiver, sender=None, fields=None, dispatch_uid=None, **kwarg
 
         # Validate arguments
 
-        if kwargs.get('weak', False):
+        if kwargs.get("weak", False):
             # TODO: weak refs? I'm hella confused.
             # We can't go passing our proxy receivers around as weak refs, since they're
             # defined as closures and hence don't exist by the time they're called.
@@ -62,21 +60,25 @@ def is_reverse_rel(f):
                 if is_reverse_rel(f):
                     raise ValueError(
                         "django-fieldsignals doesn't handle reverse related fields "
-                        "({f.name} is a {f.__class__.__name__})"
-                        .format(f=f)
+                        "({f.name} is a {f.__class__.__name__})".format(f=f)
                     )
 
         if not fields:
             raise ValueError("fields must be non-empty")
 
         proxy_receiver = self._make_proxy_receiver(receiver, sender, fields)
 
-        super(ChangedSignal, self).connect(proxy_receiver, sender=sender, weak=False, dispatch_uid=dispatch_uid)
+        super(ChangedSignal, self).connect(
+            proxy_receiver, sender=sender, weak=False, dispatch_uid=dispatch_uid
+        )
 
         ### post_init : initialize the list of fields for each instance
         def post_init_closure(sender, instance, **kwargs):
             self.get_and_update_changed_fields(receiver, instance, fields)
-        _signals.post_init.connect(post_init_closure, sender=sender, weak=False, dispatch_uid=(self, receiver))
+
+        _signals.post_init.connect(
+            post_init_closure, sender=sender, weak=False, dispatch_uid=(self, receiver)
+        )
         self.connect_source_signals(sender)
 
     def connect_source_signals(self, sender):
@@ -95,10 +97,15 @@ def _make_proxy_receiver(self, receiver, sender, fields):
         to watch. The original receiver is called for an instance iff the value of
         at least one of the fields has changed since the last time it was called.
         """
+
         def pr(instance, *args, **kwargs):
-            changed_fields = self.get_and_update_changed_fields(receiver, instance, fields)
+            changed_fields = self.get_and_update_changed_fields(
+                receiver, instance, fields
+            )
             if changed_fields:
-                receiver(instance=instance, changed_fields=changed_fields, *args, **kwargs)
+                receiver(
+                    instance=instance, changed_fields=changed_fields, *args, **kwargs
+                )
 
         pr._original_receiver = receiver
         pr._fields = fields
@@ -123,7 +130,7 @@ def get_and_update_changed_fields(self, receiver, instance, fields):
         #       (id(<signal instance>), id(<receiver>)) : {"field_name": "old value",},
         #   }
         key = (id(self), id(receiver))
-        if not hasattr(instance, '_fieldsignals_originals'):
+        if not hasattr(instance, "_fieldsignals_originals"):
             instance._fieldsignals_originals = {}
         if key not in instance._fieldsignals_originals:
             instance._fieldsignals_originals[key] = {}
@@ -156,20 +163,28 @@ def _on_model_pre_save(self, sender, instance=None, **kwargs):
         return self.send(sender, instance=instance)
 
     def connect_source_signals(self, sender):
-        _signals.pre_save.connect(self._on_model_pre_save, sender=sender, dispatch_uid=id(self))
+        _signals.pre_save.connect(
+            self._on_model_pre_save, sender=sender, dispatch_uid=id(self)
+        )
 
 
 class PostSaveChangedSignal(ChangedSignal):
-    def _on_model_post_save(self, sender, instance=None, created=None, using=None, **kwargs):
+    def _on_model_post_save(
+        self, sender, instance=None, created=None, using=None, **kwargs
+    ):
         return self.send(sender, instance=instance, created=created, using=using)
 
     def connect_source_signals(self, sender):
-        _signals.post_save.connect(self._on_model_post_save, sender=sender, dispatch_uid=id(self))
+        _signals.post_save.connect(
+            self._on_model_post_save, sender=sender, dispatch_uid=id(self)
+        )
 
 
 ### API:
 
 pre_save_changed = PreSaveChangedSignal(providing_args=["instance", "changed_fields"])
-post_save_changed = PostSaveChangedSignal(providing_args=["instance", "changed_fields", "created", "using"])
+post_save_changed = PostSaveChangedSignal(
+    providing_args=["instance", "changed_fields", "created", "using"]
+)
 
-#TODO other signals?
+# TODO other signals?

fieldsignals/tests/__init__.py

@@ -1,3 +1,2 @@
 import os
 from .test_signals import *
-

fieldsignals/tests/test_signals.py

@@ -13,15 +13,15 @@
 
 from fieldsignals.signals import post_save_changed, pre_save_changed
 
-_field = namedtuple('field', ['name'])
+_field = namedtuple("field", ["name"])
 
 
 @contextmanager
 def must_be_called(must=True):
-    x = {'called': False}
+    x = {"called": False}
 
     def func(*args, **kwargs):
-        x['called'] = True
+        x["called"] = True
         func.args = args
         func.kwargs = kwargs
 
@@ -30,9 +30,9 @@ def func(*args, **kwargs):
 
     yield func
 
-    if x['called'] and not must:
+    if x["called"] and not must:
         raise AssertionError("Function was called, shouldn't have been")
-    elif must and not x['called']:
+    elif must and not x["called"]:
         raise AssertionError("Function wasn't called, should have been")
 
 
@@ -70,19 +70,19 @@ def to_python(self, value):
 
 
 class FakeModel(object):
-    a_key = 'a value'
-    another = 'something else'
+    a_key = "a value"
+    another = "something else"
     m2m = []
     a_datetime = None
 
     class _meta(object):
         @staticmethod
         def get_fields():
             return [
-                Field('a_key'),
-                Field('another'),
-                Field('m2m', m2m=True),
-                DateTimeField('a_datetime'),
+                Field("a_key"),
+                Field("another"),
+                Field("m2m", m2m=True),
+                DateTimeField("a_datetime"),
             ]
 
     def get_deferred_fields(self):
@@ -96,12 +96,12 @@ class _meta(object):
         @staticmethod
         def get_fields():
             return [
-                Field('a'),
-                Field('b'),
+                Field("a"),
+                Field("b"),
             ]
 
     def get_deferred_fields(self):
-        return {'b'}
+        return {"b"}
 
 
 class MockOneToOneRel(OneToOneRel):
@@ -112,13 +112,13 @@ def __init__(self, name):
 
 
 class FakeModelWithOneToOne(object):
-    f = 'a value'
+    f = "a value"
     o2o = 1
 
     class _meta(object):
         @staticmethod
         def get_fields():
-            return [Field('f'), MockOneToOneRel('o2o')]
+            return [Field("f"), MockOneToOneRel("o2o")]
 
 
 class TestGeneral(object):
@@ -129,13 +129,13 @@ def ready(self):
     def test_m2m_fields_error(self):
         with must_be_called(False) as func:
             with pytest.raises(ValueError):
-                post_save_changed.connect(func, sender=FakeModel, fields=('m2m',))
+                post_save_changed.connect(func, sender=FakeModel, fields=("m2m",))
 
     def test_one_to_one_rel_field_error(self):
         with must_be_called(False) as func:
             with pytest.raises(ValueError):
                 post_save_changed.connect(
-                    func, sender=FakeModelWithOneToOne, fields=('o2o', 'f')
+                    func, sender=FakeModelWithOneToOne, fields=("o2o", "f")
                 )
 
     def test_one_to_one_rel_excluded(self):
@@ -153,10 +153,10 @@ def test_compare_after_to_python(self):
         Ensures that to_python() is called prior to comparison between old & new values.
         """
         with must_be_called(False) as func:
-            pre_save_changed.connect(func, sender=FakeModel, fields=('a_datetime',))
+            pre_save_changed.connect(func, sender=FakeModel, fields=("a_datetime",))
 
             obj = FakeModel()
-            obj.a_datetime = '2017-01-01T00:00:00.000000Z'
+            obj.a_datetime = "2017-01-01T00:00:00.000000Z"
             post_init.send(instance=obj, sender=FakeModel)
 
             # This is identical to the above, even though the type is different,
@@ -170,7 +170,7 @@ def test_deferred_fields(self):
         obj = DeferredModel()
         post_init.send(instance=obj, sender=DeferredModel)
 
-        assert list(obj._fieldsignals_originals.values()) == [{'a': 1}]
+        assert list(obj._fieldsignals_originals.values()) == [{"a": 1}]
 
 
 class TestPostSave(object):
@@ -194,31 +194,31 @@ def test_post_save_changed(self):
             obj = FakeModel()
             post_init.send(instance=obj, sender=FakeModel)
 
-            obj.a_key = 'another value'
+            obj.a_key = "another value"
             post_save.send(instance=obj, sender=FakeModel)
-        assert func.kwargs['changed_fields'] == {'a_key': ('a value', 'another value')}
+        assert func.kwargs["changed_fields"] == {"a_key": ("a value", "another value")}
 
     def test_post_save_with_fields_changed(self):
         with must_be_called(True) as func:
-            post_save_changed.connect(func, sender=FakeModel, fields=('a_key',))
+            post_save_changed.connect(func, sender=FakeModel, fields=("a_key",))
 
             obj = FakeModel()
             post_init.send(instance=obj, sender=FakeModel)
 
-            obj.a_key = 'change a field that we care about'
+            obj.a_key = "change a field that we care about"
             post_save.send(instance=obj, sender=FakeModel)
-        assert func.kwargs['changed_fields'] == {
-            'a_key': ('a value', 'change a field that we care about')
+        assert func.kwargs["changed_fields"] == {
+            "a_key": ("a value", "change a field that we care about")
         }
 
     def test_post_save_with_fields_unchanged(self):
         with must_be_called(False) as func:
-            post_save_changed.connect(func, sender=FakeModel, fields=('a_key',))
+            post_save_changed.connect(func, sender=FakeModel, fields=("a_key",))
 
             obj = FakeModel()
             post_init.send(instance=obj, sender=FakeModel)
 
-            obj.another = 'dont care about this field'
+            obj.another = "dont care about this field"
             post_save.send(instance=obj, sender=FakeModel)
 
 
@@ -247,30 +247,30 @@ def test_pre_save_changed(self):
             # post_init sets list of initial values
             post_init.send(instance=obj, sender=FakeModel)
 
-            obj.a_key = 'another value'
+            obj.a_key = "another value"
             pre_save.send(instance=obj, sender=FakeModel)
 
-        assert func.kwargs['changed_fields'] == {'a_key': ('a value', 'another value')}
+        assert func.kwargs["changed_fields"] == {"a_key": ("a value", "another value")}
 
     def test_pre_save_with_fields_changed(self):
         with must_be_called(True) as func:
-            pre_save_changed.connect(func, sender=FakeModel, fields=('a_key',))
+            pre_save_changed.connect(func, sender=FakeModel, fields=("a_key",))
 
             obj = FakeModel()
             post_init.send(instance=obj, sender=FakeModel)
 
-            obj.a_key = 'change a field that we care about'
+            obj.a_key = "change a field that we care about"
             pre_save.send(instance=obj, sender=FakeModel)
-        assert func.kwargs['changed_fields'] == {
-            'a_key': ('a value', 'change a field that we care about')
+        assert func.kwargs["changed_fields"] == {
+            "a_key": ("a value", "change a field that we care about")
         }
 
     def test_pre_save_with_fields_unchanged(self):
         with must_be_called(False) as func:
-            pre_save_changed.connect(func, sender=FakeModel, fields=('a_key',))
+            pre_save_changed.connect(func, sender=FakeModel, fields=("a_key",))
 
             obj = FakeModel()
             post_init.send(instance=obj, sender=FakeModel)
 
-            obj.another = 'dont care about this field'
+            obj.another = "dont care about this field"
             pre_save.send(instance=obj, sender=FakeModel)

setup.py

@@ -2,36 +2,36 @@
 from setuptools import setup
 
 try:
-    README = open(os.path.join(os.path.dirname(__file__), 'README.md')).read()
+    README = open(os.path.join(os.path.dirname(__file__), "README.md")).read()
 except:
-    README = ''
+    README = ""
 
 # allow setup.py to be run from any path
 os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
 
 setup(
-    name='django-fieldsignals',
-    version='0.5.0',
-    packages=['fieldsignals', 'fieldsignals.tests'],
+    name="django-fieldsignals",
+    version="0.5.0",
+    packages=["fieldsignals", "fieldsignals.tests"],
     include_package_data=True,
-    test_suite='fieldsignals.tests.test_signals',
-    description='Django fieldsignals simply makes it easy to tell when the fields on your model have changed.',
+    test_suite="fieldsignals.tests.test_signals",
+    description="Django fieldsignals simply makes it easy to tell when the fields on your model have changed.",
     long_description=README,
-    long_description_content_type='text/markdown',
-    url='https://github.com/craigds/django-fieldsignals',
-    author='Craig de Stigter',
-    author_email='[email protected]',
+    long_description_content_type="text/markdown",
+    url="https://github.com/craigds/django-fieldsignals",
+    author="Craig de Stigter",
+    author_email="[email protected]",
     classifiers=[
-        'Environment :: Web Environment',
-        'Framework :: Django',
-        'Intended Audience :: Developers',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Topic :: Internet :: WWW/HTTP',
-        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+        "Environment :: Web Environment",
+        "Framework :: Django",
+        "Intended Audience :: Developers",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Topic :: Internet :: WWW/HTTP",
+        "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
     ],
 )