Merge pull request #83 from python-effect/black

use black to format python code, and update travis to run black --check

Author: radix

.travis.yml

@@ -10,9 +10,12 @@ install:
     - pip install .
     - pip install -r dev-requirements.txt
     - pip install sphinx sphinx_rtd_theme
+    # black isn't installing on pypy3, so just skip it
+    - 'if [ "$TRAVIS_PYTHON_VERSION" != "pypy3" ]; then pip install black; fi'
 script:
     - flake8
-    - py.test
+    - 'if [ "$TRAVIS_PYTHON_VERSION" != "pypy3" ]; then black --check .; fi'
+    - pytest
     - make doc
 
 notifications:

docs/source/conf.py

@@ -1,17 +1,17 @@
 # -*- coding: utf-8 -*-
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
 ]
 
 # include __init__ docstrings in class docstrings
-autoclass_content = 'both'
+autoclass_content = "both"
 
-source_suffix = '.rst'
-master_doc = 'index'
-project = u'Effect'
-copyright = u'2015, Christopher Armstrong'
-version = release = '0.12.0+'
+source_suffix = ".rst"
+master_doc = "index"
+project = u"Effect"
+copyright = u"2015, Christopher Armstrong"
+version = release = "0.12.0+"
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"

effect/__init__.py

@@ -8,27 +8,42 @@
 """
 
 from ._base import Effect, perform, NoPerformerFoundError, catch, raise_
-from ._sync import (
-    NotSynchronousError,
-    sync_perform,
-    sync_performer)
+from ._sync import NotSynchronousError, sync_perform, sync_performer
 from ._intents import (
-    Delay, perform_delay_with_sleep,
-    ParallelEffects, parallel, parallel_all_errors, FirstError,
-    Constant, Error, Func,
-    base_dispatcher)
+    Delay,
+    perform_delay_with_sleep,
+    ParallelEffects,
+    parallel,
+    parallel_all_errors,
+    FirstError,
+    Constant,
+    Error,
+    Func,
+    base_dispatcher,
+)
 from ._dispatcher import ComposedDispatcher, TypeDispatcher
 
 
 __all__ = [
     # Order here affects the order that these things show up in the API docs.
-    "Effect", "sync_perform", "sync_performer",
+    "Effect",
+    "sync_perform",
+    "sync_performer",
     "base_dispatcher",
-    "TypeDispatcher", "ComposedDispatcher",
-    "Delay", "perform_delay_with_sleep",
-    "ParallelEffects", "parallel", "parallel_all_errors",
-    "Constant", "Error", "Func",
-    "catch", "raise_",
-    "NoPerformerFoundError", "NotSynchronousError", "perform",
+    "TypeDispatcher",
+    "ComposedDispatcher",
+    "Delay",
+    "perform_delay_with_sleep",
+    "ParallelEffects",
+    "parallel",
+    "parallel_all_errors",
+    "Constant",
+    "Error",
+    "Func",
+    "catch",
+    "raise_",
+    "NoPerformerFoundError",
+    "NotSynchronousError",
+    "perform",
     "FirstError",
 ]

effect/_base.py

@@ -33,14 +33,14 @@ def on(self, success=None, error=None):
         If a callback returns an :obj:`Effect`, the result of that
         :obj:`Effect` will be passed to the next callback.
         """
-        return Effect(self.intent,
-                      callbacks=self.callbacks + [(success, error)])
+        return Effect(self.intent, callbacks=self.callbacks + [(success, error)])
 
 
 class _Box(object):
     """
     An object into which an effect dispatcher can place a result.
     """
+
     def __init__(self, cont):
         """
         :param callable cont: Called with (bool is_error, result)
@@ -119,13 +119,14 @@ def perform(dispatcher, effect):
        ``box.succeed(result)`` or ``box.fail(exc)``, where ``exc`` is
        an exception. Decorators like :func:`sync_performer` simply abstract this away.
     """
+
     def _run_callbacks(bouncer, chain, result):
         is_error, value = result
 
         if type(value) is Effect:
             bouncer.bounce(
-                _perform,
-                Effect(value.intent, callbacks=value.callbacks + chain))
+                _perform, Effect(value.intent, callbacks=value.callbacks + chain)
+            )
             return
 
         if not chain:
@@ -146,8 +147,8 @@ def _perform(bouncer, effect):
                 performer(
                     dispatcher,
                     effect.intent,
-                    _Box(partial(bouncer.bounce,
-                                 _run_callbacks, effect.callbacks)))
+                    _Box(partial(bouncer.bounce, _run_callbacks, effect.callbacks)),
+                )
         except Exception as e:
             _run_callbacks(bouncer, effect.callbacks, (True, e))
 
@@ -164,10 +165,12 @@ def catch(exc_type, callable):
     If any exception other than a ``SpecificException`` is thrown, it will be
     ignored by this handler and propogate further down the chain of callbacks.
     """
+
     def catcher(error):
         if isinstance(error, exc_type):
             return callable(error)
         raise error
+
     return catcher
 
 

effect/_continuation.py

@@ -19,7 +19,8 @@ def bounce(self, func, *args, **kwargs):
         if self.work is not None:
             raise RuntimeError(
                 "Already specified work %r, refusing to set to (%r %r %r)"
-                % (self.work, func, args, kwargs))
+                % (self.work, func, args, kwargs)
+            )
         self.work = (func, args, kwargs)
         if self._asynchronous:
             trampoline(func, *args, **kwargs)

effect/_dispatcher.py

@@ -12,6 +12,7 @@ class TypeDispatcher(object):
 
     :param mapping: mapping of intent type to performer
     """
+
     mapping = attr.ib()
 
     def __call__(self, intent):

effect/_intents.py

@@ -78,9 +78,10 @@ def parallel_all_errors(effects):
         False, then ``result`` will just be the result as provided by the child
         effect.
     """
-    effects = [effect.on(success=lambda r: (False, r),
-                         error=lambda e: (True, e))
-               for effect in effects]
+    effects = [
+        effect.on(success=lambda r: (False, r), error=lambda e: (True, e))
+        for effect in effects
+    ]
     return Effect(ParallelEffects(list(effects)))
 
 
@@ -90,12 +91,16 @@ class FirstError(Exception):
     One of the effects in a :obj:`ParallelEffects` resulted in an error. This
     represents the first such error that occurred.
     """
+
     exception = attr.ib()
     index = attr.ib()
 
     def __str__(self):
-        return '(index=%s) %s: %s' % (
-            self.index, type(self.exception).__name__, self.exception)
+        return "(index=%s) %s: %s" % (
+            self.index,
+            type(self.exception).__name__,
+            self.exception,
+        )
 
 
 @attr.s
@@ -108,6 +113,7 @@ class Delay(object):
 
     :param float delay: The number of seconds to delay.
     """
+
     delay = attr.ib()
 
 
@@ -124,6 +130,7 @@ class Constant(object):
 
     :param result: The object which the Effect will result in.
     """
+
     result = attr.ib()
 
 
@@ -140,6 +147,7 @@ class Error(object):
 
     :param BaseException exception: Exception instance to raise.
     """
+
     exception = attr.ib()
 
 
@@ -173,6 +181,7 @@ class Func(object):
     :param args: Positional arguments to pass to the function.
     :param kwargs: Keyword arguments to pass to the function.
     """
+
     func = attr.ib()
     args = attr.ib()
     kwargs = attr.ib()
@@ -189,8 +198,6 @@ def perform_func(dispatcher, intent):
     return intent.func(*intent.args, **intent.kwargs)
 
 
-base_dispatcher = TypeDispatcher({
-    Constant: perform_constant,
-    Error: perform_error,
-    Func: perform_func,
-})
+base_dispatcher = TypeDispatcher(
+    {Constant: perform_constant, Error: perform_error, Func: perform_func}
+)

effect/_sync.py

@@ -30,8 +30,7 @@ def sync_perform(dispatcher, effect):
     elif errors:
         raise errors[0]
     else:
-        raise NotSynchronousError("Performing %r was not synchronous!"
-                                  % (effect,))
+        raise NotSynchronousError("Performing %r was not synchronous!" % (effect,))
 
 
 def sync_performer(f):
@@ -61,6 +60,7 @@ def sync_performer(f):
         def perform_foo(dispatcher, foo):
             return do_side_effect(foo)
     """
+
     @wraps(f)
     def sync_wrapper(*args, **kwargs):
         box = args[-1]
@@ -69,4 +69,5 @@ def sync_wrapper(*args, **kwargs):
             box.succeed(f(*pass_args, **kwargs))
         except Exception as e:
             box.fail(e)
+
     return sync_wrapper

effect/_test_utils.py

@@ -13,11 +13,14 @@ class ReraisedTracebackMismatch(object):
     got_tb = attr.ib()
 
     def describe(self):
-        return ("The reference traceback:\n"
-                + ''.join(self.expected_tb)
-                + "\nshould match the tail end of the received traceback:\n"
-                + ''.join(self.got_tb)
-                + "\nbut it doesn't.")
+        return (
+            "The reference traceback:\n"
+            + "".join(self.expected_tb)
+            + "\nshould match the tail end of the received traceback:\n"
+            + "".join(self.got_tb)
+            + "\nbut it doesn't."
+        )
+
 
 @attr.s
 class MatchesException(object):
@@ -26,10 +29,11 @@ class MatchesException(object):
     def match(self, other):
         expected_type = type(self.expected)
         if type(other) is not expected_type:
-            return Mismatch('{} is not a {}'.format(other, expected_type))
+            return Mismatch("{} is not a {}".format(other, expected_type))
         if other.args != self.expected.args:
-            return Mismatch('{} has different arguments: {}.'.format(
-                other.args, self.expected.args))
+            return Mismatch(
+                "{} has different arguments: {}.".format(other.args, self.expected.args)
+            )
 
 
 @attr.s
@@ -44,12 +48,13 @@ def match(self, actual):
         typecheck = Equals(type(self.expected)).match(type(actual))
         if typecheck is not None:
             return typecheck
-        expected = list(traceback.TracebackException.from_exception(self.expected).format())
+        expected = list(
+            traceback.TracebackException.from_exception(self.expected).format()
+        )
         new = list(traceback.TracebackException.from_exception(actual).format())
-        tail_equals = lambda a, b: a == b[-len(a):]
+        tail_equals = lambda a, b: a == b[-len(a) :]
         if not tail_equals(expected[1:], new[1:]):
-            return ReraisedTracebackMismatch(expected_tb=expected,
-                                             got_tb=new)
+            return ReraisedTracebackMismatch(expected_tb=expected, got_tb=new)
 
 
 def raise_(e):

effect/_utils.py

@@ -10,6 +10,7 @@ def wraps(original):
     This is like :func:`functools.wraps`, except you can wrap non-functions
     without blowing up.
     """
+
     def wraps_decorator(wrapper):
         try:
             wrapper.__name__ = original.__name__
@@ -19,4 +20,5 @@ def wraps_decorator(wrapper):
         except:
             pass
         return wrapper
+
     return wraps_decorator