Doesn't report a cached_property

[oprypin]

foo.py

import functools

import cached_property


class C:
    @property
    def aaa(self):
        """aaa"""

    @functools.cached_property
    def bbb(self):
        """bbb"""

    @cached_property.cached_property
    def ccc(self):
        """ccc"""

Only aaa (the normal property) is reported. Both functools.cached_property and cached_property.cached_property are ignored.

python -m pytkdocs <<<'{"objects":[{"path": "foo.C"}]}' | jq      

{
  "loading_errors": [],
  "parsing_errors": {},
  "objects": [
    {
      "name": "C",
      "path": "foo.C",
      "category": "class",
      "file_path": "/tmp/foo.py",
      "relative_file_path": "tmp/foo.py",
      "properties": [],
      "parent_path": "foo",
      "has_contents": true,
      "docstring": "",
      "docstring_sections": [],
      "source": {},
      "children": {
        "foo.C.aaa": {
          "name": "aaa",
          "path": "foo.C.aaa",
          "category": "attribute",
          "file_path": "/tmp/foo.py",
          "relative_file_path": "tmp/foo.py",
          "properties": [
            "property",
            "readonly"
          ],
          "parent_path": "foo.C",
          "has_contents": true,
          "docstring": "aaa",
          "docstring_sections": [
            {
              "type": "markdown",
              "value": "aaa"
            }
          ],
          "source": {
            "code": "    @property\n    def aaa(self):\n        \"\"\"aaa\"\"\"\n",
            "line_start": 7
          },
          "children": {},
          "attributes": [],
          "methods": [],
          "functions": [],
          "modules": [],
          "classes": [],
          "type": ""
        }
      },
      "attributes": [
        "foo.C.aaa"
      ],
      "methods": [],
      "functions": [],
      "modules": [],
      "classes": []
    }
  ]
}

[pawamoy]

Confirmed, thanks for the report @oprypin. I'll investigate 🙂

[yajo]

I just wanted to mention that this is affecting copier-org/copier#314 too.

[pawamoy]

And I just found why it happens 🙂

Reading https://docs.python.org/3/library/functools.html#functools.cached_property, we see that a cached property does not use the same mechanics of a classic property. Maybe not relevant. But then inspect.unwrap returns the same object (<functools.cached_property at 0x...>), and pytkdocs.loader.ObjectNode.is_property returns False.

I guess we can add a bit of code in that is_property method to support cached_property. Something like:

    def is_property(self) -> bool:
        return isinstance(self.obj, property) or isinstance(self.obj, cached_property)

Let see how the rest of the code behaves with this change. Continuing investigation 🙂

[pawamoy]

Just pushed a fix, closing! Please tell me if it works or not!

[yajo]

Yes, it works, thanks!