Use black code style (#21)

* Use black code style

* Unify code style around projects

Author: penguinolog

README.rst

@@ -16,6 +16,8 @@ Advanced descriptors
     :target: https://pypi.python.org/pypi/advanced-descriptors
 .. image:: https://img.shields.io/github/license/python-useful-helpers/advanced-descriptors.svg
     :target: https://raw.githubusercontent.com/python-useful-helpers/advanced-descriptors/master/LICENSE
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/ambv/black
 
 This package includes helpers for special cases:
 

advanced_descriptors/__init__.py

@@ -16,19 +16,16 @@
 from .separate_class_method import SeparateClassMethod
 from .advanced_property import AdvancedProperty
 
-__all__ = (
-    'SeparateClassMethod',
-    'AdvancedProperty',
-)
+__all__ = ("SeparateClassMethod", "AdvancedProperty")
 
-__version__ = '1.0.5'
+__version__ = "1.0.5"
 __author__ = "Alexey Stepanov"
-__author_email__ = 'penguinolog@gmail.com'
+__author_email__ = "penguinolog@gmail.com"
 __maintainers__ = {
-    'Alexey Stepanov': 'penguinolog@gmail.com',
-    'Antonio Esposito': 'esposito.cloud@gmail.com',
-    'Dennis Dmitriev': 'dis-xcom@gmail.com',
+    "Alexey Stepanov": "penguinolog@gmail.com",
+    "Antonio Esposito": "esposito.cloud@gmail.com",
+    "Dennis Dmitriev": "dis-xcom@gmail.com",
 }
-__url__ = 'https://github.com/python-useful-helpers/advanced-descriptors'
+__url__ = "https://github.com/python-useful-helpers/advanced-descriptors"
 __description__ = "Advanced descriptors for special cases."
 __license__ = "Apache License, Version 2.0"

advanced_descriptors/advanced_property.py

@@ -17,9 +17,7 @@
 
 import typing  # noqa: F401  # pylint: disable=unused-import
 
-__all__ = (
-    'AdvancedProperty',
-)
+__all__ = ("AdvancedProperty",)
 
 
 class AdvancedProperty(object):
@@ -115,19 +113,14 @@ class AdvancedProperty(object):
     True
     """
 
-    __slots__ = (
-        '__fget',
-        '__fset',
-        '__fdel',
-        '__fcget',
-    )
+    __slots__ = ("__fget", "__fset", "__fdel", "__fcget")
 
     def __init__(
-            self,
-            fget=None,  # type: typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]
-            fset=None,  # type: typing.Optional[typing.Callable[[typing.Any, typing.Any], None]]
-            fdel=None,  # type: typing.Optional[typing.Callable[[typing.Any, ], None]]
-            fcget=None,  # type: typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]
+        self,
+        fget=None,  # type: typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]
+        fset=None,  # type: typing.Optional[typing.Callable[[typing.Any, typing.Any], None]]
+        fdel=None,  # type: typing.Optional[typing.Callable[[typing.Any, ], None]]
+        fcget=None,  # type: typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]
     ):  # type: (...) -> None
         """Advanced property main entry point.
 
@@ -148,11 +141,7 @@ def __init__(
 
         self.__fcget = fcget
 
-    def __get__(
-        self,
-        instance,  # type: typing.Optional[typing.Any]
-        owner  # type: typing.Any
-    ):  # type: (...) -> typing.Any
+    def __get__(self, instance, owner):  # type: (typing.Optional[typing.Any], typing.Any) -> typing.Any
         """Get descriptor.
 
         :param instance: Owner class instance. Filled only if instance created, else None.
@@ -168,11 +157,7 @@ def __get__(
             return self.__fcget(owner)
         return self.__fget(instance)
 
-    def __set__(
-        self,
-        instance,  # type: typing.Any
-        value  # type: typing.Any
-    ):  # type: (...) -> None
+    def __set__(self, instance, value):  # type: (typing.Any, typing.Any) -> None
         """Set descriptor.
 
         :param instance: Owner class instance. Filled only if instance created, else None.
@@ -184,10 +169,7 @@ def __set__(
             raise AttributeError()
         return self.__fset(instance, value)
 
-    def __delete__(
-        self,
-        instance  # type: typing.Any
-    ):  # type: (...) -> None
+    def __delete__(self, instance):  # type: (typing.Any) -> None
         """Delete descriptor.
 
         :param instance: Owner class instance. Filled only if instance created, else None.
@@ -231,8 +213,7 @@ def fcget(self):  # type: () -> typing.Optional[typing.Callable[[typing.Any, ],
         return self.__fcget
 
     def getter(
-            self,
-            fget  # type: typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]
+        self, fget  # type: typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]
     ):  # type: (...) -> AdvancedProperty
         """Descriptor to change the getter on a property.
 
@@ -244,8 +225,7 @@ def getter(
         return self
 
     def setter(
-            self,
-            fset  # type: typing.Optional[typing.Callable[[typing.Any, typing.Any], None]]
+        self, fset  # type: typing.Optional[typing.Callable[[typing.Any, typing.Any], None]]
     ):  # type: (...) -> AdvancedProperty
         """Descriptor to change the setter on a property.
 
@@ -257,8 +237,7 @@ def setter(
         return self
 
     def deleter(
-            self,
-            fdel  # type: typing.Optional[typing.Callable[[typing.Any, ], None]]
+        self, fdel  # type: typing.Optional[typing.Callable[[typing.Any, ], None]]
     ):  # type: (...) -> AdvancedProperty
         """Descriptor to change the deleter on a property.
 
@@ -270,8 +249,7 @@ def deleter(
         return self
 
     def cgetter(
-            self,
-            fcget  # type: typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]
+        self, fcget  # type: typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]
     ):  # type: (...) -> AdvancedProperty
         """Descriptor to change the class wide getter on a property.
 
@@ -283,6 +261,7 @@ def cgetter(
         return self
 
 
-if __name__ == '__main__':  # pragma: no cover
+if __name__ == "__main__":  # pragma: no cover
     import doctest
+
     doctest.testmod(verbose=True)

advanced_descriptors/separate_class_method.py

@@ -19,9 +19,7 @@
 
 import six
 
-__all__ = (
-    'SeparateClassMethod',
-)
+__all__ = ("SeparateClassMethod",)
 
 
 class SeparateClassMethod(object):
@@ -92,16 +90,11 @@ class SeparateClassMethod(object):
     True
     """
 
-    __slots__ = (
-        '__instance_method',
-        '__class_method',
-    )
+    __slots__ = ("__instance_method", "__class_method")
 
     def __init__(
-            self,
-            imeth=None,  # type: typing.Optional[typing.Callable]
-            cmeth=None,  # type: typing.Optional[typing.Callable]
-    ):  # type: (...) -> None
+        self, imeth=None, cmeth=None
+    ):  # type: (typing.Optional[typing.Callable], typing.Optional[typing.Callable]) -> None
         """Separate class method and instance methods.
 
         :param imeth: Instance method
@@ -112,11 +105,7 @@ def __init__(
         self.__instance_method = imeth
         self.__class_method = cmeth
 
-    def __get__(
-        self,
-        instance,  # type: typing.Optional[typing.Any]
-        owner  # type: typing.Any
-    ):  # type: (...) -> typing.Callable
+    def __get__(self, instance, owner):  # type: (typing.Optional[typing.Any], typing.Any) -> typing.Callable
         """Get descriptor.
 
         :rtype: typing.Callable
@@ -140,10 +129,7 @@ def instance_method(*args, **kwargs):  # type: (typing.Any, typing.Any) -> typin
 
         return instance_method
 
-    def instance_method(
-            self,
-            imeth  # type: typing.Optional[typing.Callable]
-    ):  # type: (...) -> SeparateClassMethod
+    def instance_method(self, imeth):  # type: (typing.Optional[typing.Callable]) -> SeparateClassMethod
         """Descriptor to change instance method.
 
         :param imeth: New instance method.
@@ -153,10 +139,7 @@ def instance_method(
         self.__instance_method = imeth
         return self
 
-    def class_method(
-            self,
-            cmeth  # type: typing.Optional[typing.Callable]
-    ):  # type: (...) -> SeparateClassMethod
+    def class_method(self, cmeth):  # type: (typing.Optional[typing.Callable]) -> SeparateClassMethod
         """Descriptor to change class method.
 
         :type cmeth: New class method.
@@ -183,6 +166,7 @@ def cmeth(self):  # type: () -> typing.Optional[typing.Callable]
         return self.__class_method
 
 
-if __name__ == '__main__':  # pragma: no cover
+if __name__ == "__main__":  # pragma: no cover
     import doctest
+
     doctest.testmod(verbose=True)

pyproject.toml

@@ -5,3 +5,7 @@ requires = [
     "setuptools >= 21.0.0,!=24.0.0,!=34.0.0,!=34.0.1,!=34.0.2,!=34.0.3,!=34.1.0,!=34.1.1,!=34.2.0,!=34.3.0,!=34.3.1,!=34.3.2,!=36.2.0",  # PSF/ZPL
     "wheel",
 ]
+
+[tool.black]
+line-length = 120
+safe = true

setup.cfg

@@ -38,13 +38,23 @@ exclude =
     __init__.py,
     docs
 ignore =
+    E203
+# whitespace before ':'
 show-pep8 = True
 show-source = True
 count = True
 max-line-length = 120
 
 [pydocstyle]
-ignore = D401, D203, D213
+ignore =
+    D401,
+    D202,
+    D203,
+    D213
+# First line should be in imperative mood; try rephrasing
+# No blank lines allowed after function docstring
+# 1 blank line required before class docstring
+# Multi-line docstring summary should start at the second line
 
 [aliases]
 test=pytest

test/test_advanced_property.py

@@ -28,7 +28,7 @@ def val(tself):
         del instance.val
         self.assertEqual(instance.val, 0)
         with self.assertRaises(AttributeError):
-            getattr(Target, 'val')
+            getattr(Target, "val")
 
     def test_02_full(self):
         class Target(object):
@@ -80,10 +80,10 @@ class Target(object):
             prop = advanced_descriptors.AdvancedProperty()
 
         with self.assertRaises(AttributeError):
-            getattr(Target, 'prop')
+            getattr(Target, "prop")
 
         with self.assertRaises(AttributeError):
-            getattr(Target(), 'prop')
+            getattr(Target(), "prop")
 
         with self.assertRaises(AttributeError):
             Target().prop = 1
@@ -110,12 +110,7 @@ class Target(object):
             def __init__(self):
                 self._value = 42
 
-            val = advanced_descriptors.AdvancedProperty(
-                fget=getter,
-                fset=setter,
-                fdel=deleter,
-                fcget=cgetter
-            )
+            val = advanced_descriptors.AdvancedProperty(fget=getter, fset=setter, fdel=deleter, fcget=cgetter)
 
         instance = Target()
         self.assertEqual(instance.val, 42)
@@ -126,7 +121,7 @@ def __init__(self):
         self.assertEqual(instance.val, 0)
         self.assertEqual(Target.val, 777)
 
-        prop = Target.__dict__['val']
+        prop = Target.__dict__["val"]
         self.assertIs(prop.fget, getter)
         self.assertIs(prop.fset, setter)
         self.assertIs(prop.fdel, deleter)

test/test_separate_class_method.py

@@ -76,13 +76,12 @@ class Target(object):
 
             def __init__(tself):
                 tself.value = 2
-            getval = advanced_descriptors.SeparateClassMethod(
-                imeth, cmeth
-            )
+
+            getval = advanced_descriptors.SeparateClassMethod(imeth, cmeth)
 
         instance = Target()
         self.assertEqual(instance.getval(), 2)
         self.assertEqual(Target.getval(), 1)
-        descr = Target.__dict__['getval']
+        descr = Target.__dict__["getval"]
         self.assertIs(descr.imeth, imeth)
         self.assertIs(descr.cmeth, cmeth)

tox.ini

@@ -5,7 +5,7 @@
 
 [tox]
 minversion = 2.0
-envlist = pep8, pylint, mypy, bandit, pep257, py{27,34,35,36,37,py,py3}, py{34,35,36,37}-nocov, docs,
+envlist = black, pep8, pylint, mypy, bandit, pep257, py{27,34,35,36,37,py,py3}, py{34,35,36,37}-nocov, docs,
 skipsdist = True
 skip_missing_interpreters = True
 
@@ -104,13 +104,23 @@ exclude =
     __init__.py,
     docs
 ignore =
+    E203
+# whitespace before ':'
 show-pep8 = True
 show-source = True
 count = True
 max-line-length = 120
 
 [pydocstyle]
-ignore = D401, D203, D213
+ignore =
+    D401,
+    D202,
+    D203,
+    D213
+# First line should be in imperative mood; try rephrasing
+# No blank lines allowed after function docstring
+# 1 blank line required before class docstring
+# Multi-line docstring summary should start at the second line
 
 [testenv:docs]
 deps =
@@ -127,8 +137,15 @@ deps =
     pipdeptree
 commands = pipdeptree
 
+[testenv:black]
+deps =
+    black
+usedevelop = False
+commands =
+    black advanced_descriptors
+
 [testenv:mypy]
 deps =
-    mypy>=0.620
+    mypy>=0.630
     -r{toxinidir}/CI_REQUIREMENTS.txt
 commands = mypy --strict advanced_descriptors