Merge pull request #7061 from tk0miya/6785_attr_can_refer_props

Fix #6785: py domain: :py:attr: is able to refer properties again

CHANGES

@@ -62,6 +62,7 @@ Features added
 * #6418: Add new event: :event:`object-description-transform`
 * py domain: :rst:dir:`py:data` and :rst:dir:`py:attribute` take new options
   named ``:type:`` and ``:value:`` to describe its type and initial value
+* #6785: py domain: ``:py:attr:`` is able to refer properties again
 * #6772: apidoc: Add ``-q`` option for quiet mode
 
 Bugs fixed

sphinx/domains/python.py

@@ -1049,6 +1049,11 @@ def resolve_xref(self, env: BuildEnvironment, fromdocname: str, builder: Builder
         searchmode = 1 if node.hasattr('refspecific') else 0
         matches = self.find_obj(env, modname, clsname, target,
                                 type, searchmode)
+
+        if not matches and type == 'attr':
+            # fallback to meth (for property)
+            matches = self.find_obj(env, modname, clsname, target, 'meth', searchmode)
+
         if not matches:
             return None
         elif len(matches) > 1:

tests/roots/test-domain-py/module.rst

@@ -18,6 +18,12 @@ module
 
     * Link to :py:meth:`module_a.submodule.ModTopLevel.mod_child_1`
 
+.. py:method:: ModTopLevel.prop
+   :property:
+
+   * Link to :py:attr:`prop attribute <.prop>`
+   * Link to :py:meth:`prop method <.prop>`
+
 .. py:currentmodule:: None
 
 .. py:class:: ModNoModule

tests/test_domain_py.py

@@ -105,19 +105,22 @@ def assert_refnode(node, module_name, class_name, target, reftype=None,
                    'mod_child_2', 'meth')
     assert_refnode(refnodes[4], 'module_a.submodule', 'ModTopLevel',
                    'module_a.submodule.ModTopLevel.mod_child_1', 'meth')
-    assert_refnode(refnodes[5], 'module_b.submodule', None,
+    assert_refnode(refnodes[5], 'module_a.submodule', 'ModTopLevel',
+                   'prop', 'attr')
+    assert_refnode(refnodes[6], 'module_a.submodule', 'ModTopLevel',
+                   'prop', 'meth')
+    assert_refnode(refnodes[7], 'module_b.submodule', None,
                    'ModTopLevel', 'class')
-    assert_refnode(refnodes[6], 'module_b.submodule', 'ModTopLevel',
+    assert_refnode(refnodes[8], 'module_b.submodule', 'ModTopLevel',
                    'ModNoModule', 'class')
-    assert_refnode(refnodes[7], False, False, 'int', 'class')
-    assert_refnode(refnodes[8], False, False, 'tuple', 'class')
-    assert_refnode(refnodes[9], False, False, 'str', 'class')
-    assert_refnode(refnodes[10], False, False, 'float', 'class')
-    assert_refnode(refnodes[11], False, False, 'list', 'class')
-    assert_refnode(refnodes[11], False, False, 'list', 'class')
-    assert_refnode(refnodes[12], False, False, 'ModTopLevel', 'class')
-    assert_refnode(refnodes[13], False, False, 'index', 'doc', domain='std')
-    assert len(refnodes) == 14
+    assert_refnode(refnodes[9], False, False, 'int', 'class')
+    assert_refnode(refnodes[10], False, False, 'tuple', 'class')
+    assert_refnode(refnodes[11], False, False, 'str', 'class')
+    assert_refnode(refnodes[12], False, False, 'float', 'class')
+    assert_refnode(refnodes[13], False, False, 'list', 'class')
+    assert_refnode(refnodes[14], False, False, 'ModTopLevel', 'class')
+    assert_refnode(refnodes[15], False, False, 'index', 'doc', domain='std')
+    assert len(refnodes) == 16
 
     doctree = app.env.get_doctree('module_option')
     refnodes = list(doctree.traverse(addnodes.pending_xref))
@@ -161,6 +164,21 @@ def test_domain_py_objects(app, status, warning):
     assert objects['NestedParentB.child_1'] == ('roles', 'method')
 
 
+@pytest.mark.sphinx('html', testroot='domain-py')
+def test_resolve_xref_for_properties(app, status, warning):
+    app.builder.build_all()
+
+    content = (app.outdir / 'module.html').text()
+    assert ('Link to <a class="reference internal" href="#module_a.submodule.ModTopLevel.prop"'
+            ' title="module_a.submodule.ModTopLevel.prop">'
+            '<code class="xref py py-attr docutils literal notranslate"><span class="pre">'
+            'prop</span> <span class="pre">attribute</span></code></a>' in content)
+    assert ('Link to <a class="reference internal" href="#module_a.submodule.ModTopLevel.prop"'
+            ' title="module_a.submodule.ModTopLevel.prop">'
+            '<code class="xref py py-meth docutils literal notranslate"><span class="pre">'
+            'prop</span> <span class="pre">method</span></code></a>' in content)
+
+
 @pytest.mark.sphinx('dummy', testroot='domain-py')
 def test_domain_py_find_obj(app, status, warning):