Sphinx 8.1.2__tar.gz → 8.1.3__tar.gz

{sphinx-8.1.2 → sphinx-8.1.3}/CHANGES.rst

@@ -1,3 +1,12 @@
+Release 8.1.3 (released Oct 13, 2024)
+=====================================
+
+Bugs fixed
+----------
+
+* #13013: Restore support for :func:`!cut_lines` with no object type.
+  Patch by Adam Turner.
+
 Release 8.1.2 (released Oct 12, 2024)
 =====================================
 
@@ -24,7 +33,6 @@ Bugs fixed
   ``fontawesome`` or ``fontawesome5`` packages are not installed.
   Patch by Jean-François B.
 
-
 Release 8.1.0 (released Oct 10, 2024)
 =====================================
 

{sphinx-8.1.2 → sphinx-8.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Sphinx
-Version: 8.1.2
+Version: 8.1.3
 Summary: Python documentation generator
 Author-email: Georg Brandl <georg@python.org>
 Requires-Python: >=3.10

{sphinx-8.1.2 → sphinx-8.1.3}/sphinx/__init__.py

@@ -1,6 +1,6 @@
 """The Sphinx documentation toolchain."""
 
-__version__ = '8.1.2'
+__version__ = '8.1.3'
 __display_version__ = __version__  # used for command line version
 
 # Keep this file executable as-is in Python 3!
@@ -30,7 +30,7 @@ warnings.filterwarnings(
 #:
 #: .. versionadded:: 1.2
 #:    Before version 1.2, check the string ``sphinx.__version__``.
-version_info = (8, 1, 2, 'final', 0)
+version_info = (8, 1, 3, 'final', 0)
 
 package_dir = os.path.abspath(os.path.dirname(__file__))
 

{sphinx-8.1.2 → sphinx-8.1.3}/sphinx/ext/autodoc/__init__.py

@@ -186,7 +186,7 @@ def merge_members_option(options: dict) -> None:
 # Some useful event listener factories for autodoc-process-docstring.
 
 def cut_lines(
-    pre: int, post: int = 0, what: str | list[str] | None = None
+    pre: int, post: int = 0, what: Sequence[str] | None = None
 ) -> _AutodocProcessDocstringListener:
     """Return a listener that removes the first *pre* and last *post*
     lines of every docstring.  If *what* is a sequence of strings,
@@ -199,7 +199,12 @@ def cut_lines(
 
     This can (and should) be used in place of :confval:`automodule_skip_lines`.
     """
-    what_unique = frozenset(what or ())
+    if not what:
+        what_unique: frozenset[str] = frozenset()
+    elif isinstance(what, str):  # strongly discouraged
+        what_unique = frozenset({what})
+    else:
+        what_unique = frozenset(what)
 
     def process(
         app: Sphinx,
@@ -209,7 +214,7 @@ def cut_lines(
         options: dict[str, bool],
         lines: list[str],
     ) -> None:
-        if what_ not in what_unique:
+        if what_unique and what_ not in what_unique:
             return
         del lines[:pre]
         if post:

{sphinx-8.1.2 → sphinx-8.1.3}/tests/test_extensions/test_ext_autodoc_events.py

@@ -58,6 +58,26 @@ def test_cut_lines(app):
     ]
 
 
+def test_cut_lines_no_objtype():
+    docstring_lines = [
+        'first line',
+        '---',
+        'second line',
+        '---',
+        'third line ',
+        '',
+    ]
+    process = cut_lines(2)
+
+    process(None, 'function', 'func', None, {}, docstring_lines)  # type: ignore[arg-type]
+    assert docstring_lines == [
+        'second line',
+        '---',
+        'third line ',
+        '',
+    ]
+
+
 @pytest.mark.sphinx('html', testroot='ext-autodoc')
 def test_between(app):
     app.connect('autodoc-process-docstring', between('---', ['function']))