fix docstrings validation

Author: penguinolog

advanced_descriptors/separate_class_method.py

@@ -152,7 +152,8 @@ def __objclass__(self) -> typing.Optional[type]:  # pragma: no cover
         """Read-only owner.
 
         :return: property owner class
-        :rtype: typing.Optional[type]"""
+        :rtype: typing.Optional[type]
+        """
         return self.__owner
 
     @property

setup.cfg

@@ -34,6 +34,7 @@ exclude =
   *egg,
   build,
   __init__.py,
+  _version.py,
   docs
 ignore =
   E203,

setup.py

@@ -149,7 +149,6 @@ def get_simple_vars_from_src(
         * Executable code, including string formatting and comprehensions.
 
     Examples:
-
     >>> string_sample = "a = '1'"
     >>> get_simple_vars_from_src(string_sample)
     {'a': '1'}

test/test_advanced_property.py

@@ -1,12 +1,18 @@
 # pylint: skip-file
 
+"""Tests for AdvancedProperty."""
+
 import unittest
 
 import advanced_descriptors
 
 
 class TestAdvancedProperty(unittest.TestCase):
+    """Main tests for AdvancedProperty."""
+
     def test_01_normal_property(self):
+        """Test work like normal property."""
+
         class Target:
             def __init__(tself):
                 tself._value = 42
@@ -33,6 +39,8 @@ def val(tself):
             getattr(Target, "val")  # noqa: B009
 
     def test_02_full(self):
+        """Test all getters + setter + deleter implemented."""
+
         class Target:
             _value = 777
 
@@ -67,6 +75,8 @@ def val(cls):
         self.assertEqual(Target.val, 777)
 
     def test_03_class_wide_only(self):
+        """Test class wide getter is implemented, while instance not."""
+
         class Target:
             getcls = advanced_descriptors.AdvancedProperty()
 
@@ -78,6 +88,8 @@ def getcls(cls):
         self.assertIs(Target, Target().getcls)
 
     def test_04_no_methods(self):
+        """Test no any methods implemented."""
+
         class Target:
             prop = advanced_descriptors.AdvancedProperty()
 
@@ -94,6 +106,8 @@ class Target:
             del Target().prop
 
     def test_05_methods_access(self):
+        """Test access to original methods."""
+
         def getter(inst):
             return inst._value
 

test/test_log_on_access.py

@@ -1,5 +1,7 @@
 # pylint: skip-file
 
+"""Tests for LogOnAccess descriptor."""
+
 import io
 import logging
 import unittest
@@ -8,22 +10,28 @@
 
 
 class TestLogOnAccess(unittest.TestCase):
+    """Main tests for LogOnAccess descriptor."""
+
     def setUp(self):
+        """Initialize specific logger for tests."""
         self.stream = io.StringIO()
         logging.getLogger().handlers.clear()
         logging.basicConfig(level=logging.DEBUG, stream=self.stream)
 
     def tearDown(self):
+        """Close test logger."""
         logging.getLogger().handlers.clear()
         self.stream.close()
 
     def test_01_positive(self):
+        """Test positive scenario."""
+
         class Target:
             def __init__(self, val="ok"):
                 self.val = val
 
             def __repr__(self):
-                return "{cls}(val={self.val})".format(cls=self.__class__.__name__, self=self)
+                return f"{self.__class__.__name__}(val={self.val})"
 
             @advanced_descriptors.LogOnAccess
             def ok(self):
@@ -56,6 +64,8 @@ def ok(self):
         self.assertEqual(self.stream.getvalue(), "DEBUG:advanced_descriptors.log_on_access:del Target(val=OK).ok\n")
 
     def test_02_positive_properties(self):
+        """Test positive scenario with non standard settings."""
+
         class Target:
             def __init__(self, val="ok"):
                 self.val = val
@@ -76,10 +86,12 @@ def ok(self):
         self.assertEqual(target.ok, "ok")
         self.assertEqual(
             self.stream.getvalue(),
-            "INFO:advanced_descriptors.log_on_access:<Target() at 0x{id:X}>.override -> 'ok'\n".format(id=id(target)),
+            f"INFO:advanced_descriptors.log_on_access:<Target() at 0x{id(target):X}>.override -> 'ok'\n",
         )
 
     def test_03_positive_no_log(self):
+        """Test log_success flag."""
+
         class Target:
             def __init__(self, val="ok"):
                 self.val = val
@@ -99,9 +111,11 @@ def ok(self):
         self.assertEqual(self.stream.getvalue(), "")
 
     def test_04_negative(self):
+        """Test basic negative scenario."""
+
         class Target:
             def __repr__(self):
-                return "{cls}()".format(cls=self.__class__.__name__)
+                return f"{self.__class__.__name__}()"
 
             @advanced_descriptors.LogOnAccess
             def ok(self):
@@ -147,6 +161,8 @@ def ok(self):
         )
 
     def test_05_negative_properties(self):
+        """Test negative scenario with non standard settings."""
+
         class Target:
             def __init__(self, val="ok"):
                 self.val = val
@@ -170,11 +186,13 @@ def ok(self):
 
         self.assertEqual(
             self.stream.getvalue().splitlines()[0],
-            "ERROR:advanced_descriptors.log_on_access:Failed: <Target() at 0x{id:X}>.override".format(id=id(target)),
+            f"ERROR:advanced_descriptors.log_on_access:Failed: <Target() at 0x{id(target):X}>.override",
         )
         self.assertEqual(len(self.stream.getvalue().splitlines()), 1)
 
     def test_06_negative_no_log(self):
+        """Test log_failure flag."""
+
         class Target:
             def __init__(self, val="ok"):
                 self.val = val
@@ -196,9 +214,11 @@ def ok(self):
         self.assertEqual(self.stream.getvalue(), "")
 
     def test_07_property_mimic(self):
+        """Test property API not broken."""
+
         class Target:
             def __repr__(self):
-                return "{}()".format(self.__class__.__name__)
+                return f"{self.__class__.__name__}()"
 
             empty = advanced_descriptors.LogOnAccess(doc="empty_property")
 
@@ -216,6 +236,8 @@ def __repr__(self):
         self.assertEqual(self.stream.getvalue(), "")
 
     def test_08_logger(self):
+        """Test with logger enforced."""
+
         class Target:
             on_init_set = advanced_descriptors.LogOnAccess(
                 logger=logging.getLogger("on_init_set"), fget=lambda self: "on_init_set"
@@ -235,7 +257,7 @@ def prop_name(self):
             prop_name.logger = "prop_name"
 
             def __repr__(self):
-                return "{}()".format(self.__class__.__name__)
+                return f"{self.__class__.__name__}()"
 
         target = Target()
 
@@ -261,6 +283,8 @@ def __repr__(self):
         self.assertEqual(self.stream.getvalue(), "DEBUG:prop_name:Target().prop_name -> 'prop_name'\n")
 
     def test_09_logger_implemented(self):
+        """Test with logger attribute available in target instance."""
+
         class Target:
             def __init__(self, val="ok"):
                 self.val = val
@@ -300,13 +324,15 @@ def ok(self):
         self.assertEqual(self.stream.getvalue(), "DEBUG:Target:del Target(val=OK).ok\n")
 
     def test_10_log_implemented(self):
+        """Test with log attribute available in target instance."""
+
         class Target:
             def __init__(self, val="ok"):
                 self.val = val
                 self.log = logging.getLogger(self.__class__.__name__)
 
             def __repr__(self):
-                return "{cls}(val={self.val})".format(cls=self.__class__.__name__, self=self)
+                return f"{self.__class__.__name__}(val={self.val})"
 
             @advanced_descriptors.LogOnAccess
             def ok(self):

test/test_separate_class_method.py

@@ -1,12 +1,18 @@
 # pylint: skip-file
 
+"""Tests for SeparateClassMethod."""
+
 import unittest
 
 import advanced_descriptors
 
 
 class TestSeparateClassMethod(unittest.TestCase):
+    """Main tests for SeparateClassMethod."""
+
     def test_01_instance_method(self):
+        """Test instance method support with decorating in-place."""
+
         class Target(object):
             def __init__(tself):
                 tself.value = 42
@@ -21,6 +27,8 @@ def getval(tself):
             Target.getval()
 
     def test_02_alt_instance_method(self):
+        """Test instance method support with late bind."""
+
         class Target(object):
             def __init__(tself):
                 tself.value = 42
@@ -37,6 +45,8 @@ def getval(tself):
             Target.getval()
 
     def test_03_class_method(self):
+        """Test class method support."""
+
         class Target(object):
             getcls = advanced_descriptors.SeparateClassMethod()
 
@@ -48,6 +58,8 @@ def getcls(cls):
         self.assertIs(Target, Target().getcls())
 
     def test_04_both(self):
+        """Test coexistency of class method and instance method."""
+
         class Target(object):
             value = 1
 
@@ -67,6 +79,7 @@ def getval(cls):
         self.assertEqual(Target.getval(), 1)
 
     def test_05_functions_access(self):
+        """Test possibility to get original functions from decorator object."""
         def imeth(instance):
             return instance.value