Merge pull request #53 from Chilipp/sphinx-4.0

compatibility fixes for sphinx 4.0

Author: Chilipp

.github/workflows/python-app.yml

@@ -14,8 +14,8 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.5, 3.6, 3.7, 3.8]
-        sphinx-version: ["", "3.5.*", "3.4.*", "3.2.*",  "3.1.*", "3.0.*", "2.4.*", "2.3.*", "2.2.*"]
+        python-version: [3.6, 3.7, 3.8]
+        sphinx-version: ["", "4.0.*", "3.5.*", "3.4.*", "3.2.*",  "3.1.*", "3.0.*", "2.4.*", "2.3.*", "2.2.*"]
 
     steps:
     - uses: actions/checkout@v2
@@ -30,7 +30,7 @@ jobs:
         SPHINX_VERSION: ${{ matrix.sphinx-version }}
       run: |
         python -m pip install --upgrade pip
-        SPHINX=sphinx
+        SPHINX=Sphinx
         if [[ $SPHINX_VERSION != "" ]]; then
           SPHINX="${SPHINX}==${SPHINX_VERSION}";
         fi

autodocsumm/__init__.py

@@ -40,7 +40,12 @@
 
 sphinx_version = list(map(float, re.findall(r'\d+', sphinx.__version__)[:3]))
 
-from sphinx.util import force_decode
+try:
+    from sphinx.util import force_decode
+except ImportError:
+    # force_decode has been removed with sphinx 4.0
+    def force_decode(string: str, encoding: str) -> str:
+        return string
 
 
 try:
@@ -89,6 +94,15 @@ def bool_option(*args):
     return "True"
 
 
+def _get_arg(param, pos, default, *args, **kwargs):
+    if param in kwargs:
+        return kwargs[param]
+    elif len(args) > pos:
+        return args[pos]
+    else:
+        return default
+
+
 class AutosummaryDocumenter(object):
     """Abstract class for for extending Documenter methods
 
@@ -369,13 +383,14 @@ def format_args(self):
             return None
         return process_signature(callmeth)
 
-    def get_doc(self, encoding=None, ignore=1):
+    def get_doc(self, *args, **kwargs):
         """Reimplemented  to include data from the call method"""
         content = self.env.config.autodata_content
         if content not in ('both', 'call') or not self.get_attr(
                 self.get_attr(self.object, '__call__', None), '__doc__'):
             return super(CallableDataDocumenter, self).get_doc(
-                encoding=encoding, ignore=ignore)
+                *args, **kwargs
+            )
 
         # for classes, what the "docstring" is can be controlled via a
         # config value; the default is both docstrings
@@ -413,13 +428,14 @@ def format_args(self):
             return None
         return process_signature(callmeth)
 
-    def get_doc(self, encoding=None, ignore=1):
+    def get_doc(self, *args, **kwargs):
         """Reimplemented  to include data from the call method"""
         content = self.env.config.autodata_content
         if content not in ('both', 'call') or not self.get_attr(
                 self.get_attr(self.object, '__call__', None), '__doc__'):
             return super(CallableAttributeDocumenter, self).get_doc(
-                encoding=encoding, ignore=ignore)
+                *args, **kwargs
+            )
 
         # for classes, what the "docstring" is can be controlled via a
         # config value; the default is both docstrings
@@ -435,10 +451,17 @@ def get_doc(self, encoding=None, ignore=1):
             docstrings.append(calldocstring + '\n')
 
         doc = []
-        for docstring in docstrings:
-            if not isinstance(docstring, str):
-                docstring = force_decode(docstring, encoding)
-            doc.append(prepare_docstring(docstring, ignore))
+        if sphinx_version < [4, 0]:
+            encoding = _get_arg("encoding", 0, None, *args, **kwargs)
+            ignore = _get_arg("ignore", 1, 1, *args, **kwargs)
+            for docstring in docstrings:
+                if not isinstance(docstring, str):
+                    docstring = force_decode(docstring, encoding)
+                doc.append(prepare_docstring(docstring, ignore))
+        else:
+            ignore = _get_arg("ignore", 0, 1, *args, **kwargs)
+            for docstring in docstrings:
+                doc.append(prepare_docstring(docstring, ignore))
 
         return doc
 

setup.py

@@ -29,14 +29,14 @@ def readme():
         'Operating System :: OS Independent',
       ],
       keywords='sphinx autodoc autosummary content table',
-      python_requires=">=3.5",
+      python_requires=">=3.6",
       url='https://github.com/Chilipp/autodocsumm',
       author='Philipp S. Sommer',
       author_email='[email protected]',
       license="GPLv2",
       packages=find_packages(exclude=['docs', 'tests*', 'examples']),
       install_requires=[
-          'Sphinx>=2.2.*,<4.0.*',
+          'Sphinx>=2.2.*',
       ],
       setup_requires=pytest_runner,
       tests_require=['pytest', 'sphinx-testing'],

tests/test_autodocsumm.py

@@ -115,7 +115,10 @@ def test_module_no_nesting(self, app, status, warning):
             )
 
         # test the members are still displayed
-        self.assertIn('<dt id="dummy.Class_CallTest">', html)
+        self.assertRegexpMatches(
+            html,
+            r'<dt( class=".*")? id="dummy.Class_CallTest"( class=".*")*>'
+        )
 
     @with_app(buildername='html', srcdir=sphinx_supp,
               copy_srcdir_to_tmpdir=True)
@@ -129,7 +132,10 @@ def test_module_summary_only(self, app, status, warning):
         self.assertIn('<span class="pre">large_data</span>', html)
         self.assertIn('<span class="pre">small_data</span>', html)
 
-        self.assertNotIn('<dt id="dummy.Class_CallTest">', html)
+        self.assertNotRegexpMatches(
+            html,
+            r'<dt( class=".*")? id="dummy.Class_CallTest"( class=".*")*>'
+        )
 
     @with_app(buildername='html', srcdir=sphinx_supp,
               copy_srcdir_to_tmpdir=True)
@@ -198,7 +204,10 @@ def test_module_nosignatures(self, app, status, warning):
         self.assertIn('<span class="pre">large_data</span>', html)
         self.assertIn('<span class="pre">small_data</span>', html)
 
-        self.assertNotIn('<dt id="dummy.Class_CallTest">', html)
+        self.assertNotRegexpMatches(
+            html,
+            r'<dt( class=".*")? id="dummy.Class_CallTest"( class=".*")*>'
+        )
         self.assertNotIn('()', html)
 
     @with_app(buildername='html', srcdir=sphinx_supp,
@@ -305,7 +314,10 @@ def test_class_summary_only(self, app, status, warning):
         self.assertIn('<span class="pre">large_data</span>', html)
         self.assertIn('<span class="pre">small_data</span>', html)
 
-        self.assertNotIn('<dt id="dummy.TestClass.small_data">', html)
+        self.assertNotRegexpMatches(
+            html,
+            r'<dt( class=".*")? id="dummy.TestClass.small_data"( class=".*")*>'
+        )
 
     @with_app(buildername='html', srcdir=sphinx_supp,
         copy_srcdir_to_tmpdir=True)
@@ -332,7 +344,11 @@ def test_class_nosignatures(self, app, status, warning):
         self.assertIn('<span class="pre">large_data</span>', html)
         self.assertIn('<span class="pre">small_data</span>', html)
 
-        self.assertNotIn('<dt id="dummy.TestClass.small_data">', html)
+        self.assertNotRegexpMatches(
+            html,
+            r'<dt( class=".*")? id="dummy.TestClass.small_data"( class=".*")*>'
+        )
+
         self.assertNotIn('()', html)
 
     @with_app(buildername='html', srcdir=sphinx_supp,