ENH: accept autoclass member options (#205)

* ENH: accept autoclass member options

* BUG: options can be None (from review)

* MAINT: fixes from review

Co-Authored-By: mattip <[email protected]>

Author: mattip

numpydoc/docscrape.py

@@ -16,6 +16,7 @@
 import copy
 import sys
 
+from sphinx.ext.autodoc import ALL
 
 def strip_blank_lines(l):
     "Remove leading and trailing blank lines from a list of lines"
@@ -597,18 +598,25 @@ def __init__(self, cls, doc=None, modulename='', func_doc=FunctionDoc,
 
         NumpyDocString.__init__(self, doc)
 
-        if config.get('show_class_members', True):
+        _members = config.get('members', [])
+        if _members is ALL:
+            _members = None
+        _exclude = config.get('exclude-members', [])
+        
+        if config.get('show_class_members', True) and _exclude is not ALL:
             def splitlines_x(s):
                 if not s:
                     return []
                 else:
                     return s.splitlines()
-
             for field, items in [('Methods', self.methods),
                                  ('Attributes', self.properties)]:
                 if not self[field]:
                     doc_list = []
                     for name in sorted(items):
+                        if (name in _exclude or 
+                                (_members and name not in _members)):
+                            continue
                         try:
                             doc_item = pydoc.getdoc(getattr(self._cls, name))
                             doc_list.append(

numpydoc/numpydoc.py

@@ -154,6 +154,7 @@ def mangle_docstrings(app, what, name, obj, options, lines):
            app.config.numpydoc_show_inherited_class_members,
            'class_members_toctree': app.config.numpydoc_class_members_toctree}
 
+    cfg.update(options or {})
     u_NL = sixu('\n')
     if what == 'module':
         # Strip top title
@@ -199,7 +200,7 @@ def mangle_signature(app, what, name, obj, options, sig, retann):
 
     if not hasattr(obj, '__doc__'):
         return
-    doc = get_doc_object(obj)
+    doc = get_doc_object(obj, config={'show_class_members': False})
     sig = doc['Signature'] or getattr(obj, '__text_signature__', None)
     if sig:
         sig = re.sub(sixu("^[^(]*"), sixu(""), sig)

numpydoc/tests/test_docscrape.py

@@ -866,11 +866,13 @@ class BadSection(object):
         pass
 
     with warnings.catch_warnings(record=True) as w:
+        warnings.filterwarnings('always', '', UserWarning)
         NumpyDocString(doc_text)
         assert len(w) == 1
         assert "Unknown section Mope" == str(w[0].message)
 
     with warnings.catch_warnings(record=True) as w:
+        warnings.filterwarnings('always', '', UserWarning)
         SphinxClassDoc(BadSection)
         assert len(w) == 1
         assert('test_docscrape.test_unknown_section.<locals>.BadSection'
@@ -1337,6 +1339,24 @@ def test_args_and_kwargs():
         Keyword arguments
     """)
 
+def test_autoclass():
+    cfg=dict(show_class_members=True,
+             show_inherited_class_members=True)
+    doc = SphinxClassDoc(str, '''
+A top section before
+
+.. autoclass:: str
+    ''', config=cfg)
+    line_by_line_compare(str(doc), r'''
+A top section before
+
+.. autoclass:: str
+
+.. rubric:: Methods
+
+
+    ''')
+
 
 if __name__ == "__main__":
     import pytest

numpydoc/tests/test_numpydoc.py

@@ -0,0 +1,56 @@
+# -*- encoding:utf-8 -*-
+from __future__ import division, absolute_import, print_function
+
+from numpydoc.numpydoc import mangle_docstrings
+from sphinx.ext.autodoc import ALL
+
+class MockConfig():
+    numpydoc_use_plots = False
+    numpydoc_use_blockquotes = True
+    numpydoc_show_class_members = True
+    numpydoc_show_inherited_class_members = True
+    numpydoc_class_members_toctree = True
+    templates_path = []
+    numpydoc_edit_link = False
+    numpydoc_citation_re = '[a-z0-9_.-]+'
+
+class MockBuilder():
+    config = MockConfig()
+
+class MockApp():
+    config = MockConfig()
+    builder = MockBuilder()
+    translator = None
+
+
+app = MockApp()
+app.builder.app = app
+
+def test_mangle_docstrings():
+    s ='''
+A top section before
+
+.. autoclass:: str
+    '''
+    lines = s.split('\n')
+    doc = mangle_docstrings(MockApp(), 'class', 'str', str, {}, lines)
+    assert 'rpartition' in [x.strip() for x in lines]
+
+    lines = s.split('\n')
+    doc = mangle_docstrings(MockApp(), 'class', 'str', str, {'members': ['upper']}, lines)
+    assert 'rpartition' not in [x.strip() for x in lines]
+    assert 'upper' in [x.strip() for x in lines]
+    
+    lines = s.split('\n')
+    doc = mangle_docstrings(MockApp(), 'class', 'str', str, {'exclude-members': ALL}, lines)
+    assert 'rpartition' not in [x.strip() for x in lines]
+    assert 'upper' not in [x.strip() for x in lines]
+
+    lines = s.split('\n')
+    doc = mangle_docstrings(MockApp(), 'class', 'str', str,
+                            {'exclude-members': ['upper']}, lines)
+    assert 'rpartition' in [x.strip() for x in lines]
+    assert 'upper' not in [x.strip() for x in lines]
+
+if __name__ == "__main__":
+    import pytest