IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add test cases for #8180

Browse Source 
The test checks, if ":meta private:" and ":meta public:" have an effect
in attributes of a class. Currently the new test cases fail.
The fix is in the next commit.
This commit is contained in:
Anselm Kruis 2022-05-11 13:19:24 +02:00 committed by Takeshi KOMIYA
parent cab2d93076
commit 336885c4e2
2 changed files with 66 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
tests/roots/test-ext-autodoc/target/private.py
View File

@ -13,3 +13,15 @@ def _public_function(name):
PRIVATE_CONSTANT = None #: :meta private: PRIVATE_CONSTANT = None #: :meta private:
_PUBLIC_CONSTANT = None #: :meta public: _PUBLIC_CONSTANT = None #: :meta public:
class Foo:
#: A public class attribute whose name starts with an underscore.
#:
#: :meta public:
_public_attribute = 47
#: A private class attribute whose name does not start with an underscore.
#:
#: :meta private:
private_attribute = 11

54
tests/test_ext_autodoc_private_members.py
View File

@ -102,3 +102,57 @@ def test_private_members(app):
' :meta public:', ' :meta public:',
'', '',
] ]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_private_attributes(app):
app.config.autoclass_content = 'class'
options = {"members": None}
actual = do_autodoc(app, 'class', 'target.private.Foo', options)
assert list(actual) == [
'',
'.. py:class:: Foo()',
' :module: target.private',
'',
'',
' .. py:attribute:: Foo._public_attribute',
' :module: target.private',
' :value: 47',
'',
' A public class attribute whose name starts with an underscore.',
'',
' :meta public:',
'',
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_private_attributes_and_private_members(app):
app.config.autoclass_content = 'class'
options = {"members": None,
"private-members": None}
actual = do_autodoc(app, 'class', 'target.private.Foo', options)
assert list(actual) == [
'',
'.. py:class:: Foo()',
' :module: target.private',
'',
'',
' .. py:attribute:: Foo._public_attribute',
' :module: target.private',
' :value: 47',
'',
' A public class attribute whose name starts with an underscore.',
'',
' :meta public:',
'',
'',
' .. py:attribute:: Foo.private_attribute',
' :module: target.private',
' :value: 11',
'',
' A private class attribute whose name does not start with an underscore.',
'',
' :meta private:',
'',
]