Cached property (#12)

* add support for cached property

Author: jdkandersson

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+## [v1.2.0] - 2023-07-12
+
+### Added
+
+- Support for `functools.cached_property`.
+
 ## [v1.1.0] - 2023-01-26
 
 ### Added

README.md

@@ -1420,6 +1420,16 @@ class FooClass:
     def bar(self):
         return "bar"
 
+class FooClass:
+    """Perform foo action.
+
+    Attrs:
+    """
+
+    @functools.cached_property
+    def bar(self):
+        return "bar"
+
 class FooClass:
     """Perform foo action.
 
@@ -1461,6 +1471,17 @@ class FooClass:
     def bar(self):
         return "bar"
 
+class FooClass:
+    """Perform foo action.
+
+    Attrs:
+        bar: The value to perform the foo action on.
+    """
+
+    @functools.cached_property
+    def bar(self):
+        return "bar"
+
 class FooClass:
     """Perform foo action.
 

flake8_docstrings_complete/attrs.py

@@ -55,13 +55,23 @@ def is_property_decorator(node: ast.expr) -> bool:
         Whether the node is a property decorator.
     """
     if isinstance(node, ast.Name):
-        return node.id == "property"
+        return node.id in {"property", "cached_property"}
 
     # Handle call
     if isinstance(node, ast.Call):
         return is_property_decorator(node=node.func)
 
-    return False
+    # Handle attr
+    if isinstance(node, ast.Attribute):
+        value = node.value
+        return (
+            node.attr == "cached_property"
+            and isinstance(value, ast.Name)
+            and value.id == "functools"
+        )
+
+    # There is no valid syntax that gets to here
+    return False  # pragma: nocover
 
 
 def _get_class_target_name(target: ast.expr) -> ast.Name | None:

tests/unit/test___init__.py

@@ -569,6 +569,38 @@ def function_1(self):
 class Class1:
     """Docstring.
 
+    Attrs:
+        function_1:
+    """
+    @cached_property
+    def function_1(self):
+        """Docstring 1."""
+        return 1
+''',
+            (),
+            id="cached_property return value docstring no returns section",
+        ),
+        pytest.param(
+            '''
+class Class1:
+    """Docstring.
+
+    Attrs:
+        function_1:
+    """
+    @functools.cached_property
+    def function_1(self):
+        """Docstring 1."""
+        return 1
+''',
+            (),
+            id="functools.cached_property return value docstring no returns section",
+        ),
+        pytest.param(
+            '''
+class Class1:
+    """Docstring.
+
     Attrs:
         function_1:
     """

tests/unit/test___init__attrs.py

@@ -183,6 +183,36 @@ def attr_1():
 class Class1:
     """Docstring 1.
 
+    Attrs:
+    """
+    @cached_property
+    def attr_1():
+        """Docstring 2."""
+        return "value 1"
+''',
+            (f"8:4 {ATTR_NOT_IN_DOCSTR_MSG % 'attr_1'}",),
+            id="class has single cached_property docstring no attr",
+        ),
+        pytest.param(
+            '''
+class Class1:
+    """Docstring 1.
+
+    Attrs:
+    """
+    @functools.cached_property
+    def attr_1():
+        """Docstring 2."""
+        return "value 1"
+''',
+            (f"8:4 {ATTR_NOT_IN_DOCSTR_MSG % 'attr_1'}",),
+            id="class has single functools.cached_property docstring no attr",
+        ),
+        pytest.param(
+            '''
+class Class1:
+    """Docstring 1.
+
     Attrs:
     """
     @property
@@ -583,6 +613,38 @@ def attr_1():
 class Class1:
     """Docstring 1.
 
+    Attrs:
+        attr_1:
+    """
+    @cached_property
+    def attr_1():
+        """Docstring 2."""
+        return "value 1"
+''',
+            (),
+            id="class single cached_property docstring single attr",
+        ),
+        pytest.param(
+            '''
+class Class1:
+    """Docstring 1.
+
+    Attrs:
+        attr_1:
+    """
+    @functools.cached_property
+    def attr_1():
+        """Docstring 2."""
+        return "value 1"
+''',
+            (),
+            id="class single functools.cached_property docstring single attr",
+        ),
+        pytest.param(
+            '''
+class Class1:
+    """Docstring 1.
+
     Attrs:
         attr_1:
     """