Fix documentation CI dependencies and lint checks

Author: wolph

docs/examples/_registry.py

@@ -59,7 +59,11 @@ def svg_path(self) -> pathlib.Path:
 DEMOS: tuple[Demo, ...] = (
     Demo('howto/colors', 'Fixed and gradient bar colors'),
     Demo('howto/custom-widget', 'The current job phase', term_width=60),
-    Demo('howto/dynamic-messages', 'Errors found while scanning logs', term_width=60),
+    Demo(
+        'howto/dynamic-messages',
+        'Errors found while scanning logs',
+        term_width=60,
+    ),
     Demo(
         'howto/file-transfer',
         'DataSize, FileTransferSpeed, AdaptiveTransferSpeed',

docs/examples/howto/prefix_suffix.py

@@ -8,7 +8,13 @@
 
 import progressbar
 
-FILES: list[str] = ['users.csv', 'sales.csv', 'stock.csv', 'costs.csv', 'audit.csv']
+FILES: list[str] = [
+    'users.csv',
+    'sales.csv',
+    'stock.csv',
+    'costs.csv',
+    'audit.csv',
+]
 BLOCKS_PER_FILE: int = 20
 
 
@@ -17,7 +23,7 @@ def main() -> None:
     bar: progressbar.ProgressBar
     file_number: int
     filename: str
-    block: int
+    _block: int
     with progressbar.ProgressBar(
         max_value=len(FILES) * BLOCKS_PER_FILE,
         prefix='{variables.filename} {variables.file_number}/5 ',
@@ -26,7 +32,7 @@ def main() -> None:
         widgets=[progressbar.Percentage(), ' ', progressbar.Bar()],
     ) as bar:
         for file_number, filename in enumerate(FILES, start=1):
-            for block in range(BLOCKS_PER_FILE):
+            for _block in range(BLOCKS_PER_FILE):
                 time.sleep(0.02)
                 completed += 1
                 bar.update(

progressbar/utils.py

@@ -128,13 +128,13 @@ def deltas_to_seconds(
 
 
 def no_color(value: StringT) -> StringT:
-    """Return the `value` without ANSI escape codes.
+    r"""Return the `value` without ANSI escape codes.
 
-    >>> no_color(b'\\x1b[1234]abc')
+    >>> no_color(b'\x1b[1234]abc')
     b'abc'
-    >>> str(no_color('\\x1b[1234]abc'))
+    >>> str(no_color('\x1b[1234]abc'))
     'abc'
-    >>> str(no_color('\\x1b[1234]abc'))
+    >>> str(no_color('\x1b[1234]abc'))
     'abc'
     >>> no_color(123)
     Traceback (most recent call last):
@@ -158,13 +158,13 @@ def no_color(value: StringT) -> StringT:
 
 
 def len_color(value: types.StringTypes) -> int:
-    """Return the length of `value` without ANSI escape codes.
+    r"""Return the length of `value` without ANSI escape codes.
 
-    >>> len_color(b'\\x1b[1234]abc')
+    >>> len_color(b'\x1b[1234]abc')
     3
-    >>> len_color('\\x1b[1234]abc')
+    >>> len_color('\x1b[1234]abc')
     3
-    >>> len_color('\\x1b[1234]abc')
+    >>> len_color('\x1b[1234]abc')
     3
     """
     return len(no_color(value))

pyproject.toml

@@ -149,6 +149,7 @@ docs-tests = [
     'playwright>=1.48.0',
     'pytest-cov>=2.6.1',
     'pytest>=4.6.9',
+    'sphinx>=1.8.5',
 ]
 
 [dependency-groups]

scripts/render_demos.py

@@ -379,10 +379,10 @@ def _parse_history_frames(
         for part in raw_line.split('\r'):
             line: str = normalize_terminal_line(part.strip())
             if line:
-                frames.append((history + [line])[-history_lines:])
+                frames.append([*history, line][-history_lines:])
                 last_line = line
         if last_line:
-            history = (history + [last_line])[-history_lines:]
+            history = [*history, last_line][-history_lines:]
     return frames
 
 

tests/console/test_console.py

@@ -29,10 +29,10 @@
 * ``test_multibar_demos_have_no_run_button`` -- ``MultiBar``'s ``with``
   form starts a real OS thread, which Pyodide cannot provide
   (``Thread.start()`` raises there). Both ``howto/multibar`` and
-  ``howto/parallel-execution`` need threads (``readme/multibar`` is registered for
-  SVG rendering only -- ``README.md`` embeds it as a static image for
+  ``howto/parallel-execution`` need threads. ``readme/multibar`` is only
+  registered for SVG rendering -- ``README.md`` embeds a static image for
   PyPI/GitHub, never through the ``.. demo::`` directive, so it never
-  produces a ``.demo-run`` element to test). The Run button must never
+  produces a ``.demo-run`` element to test. The Run button must never
   be offered there, and the contrast case
   (``howto/multibar-line-offset``, which does not use the threaded
   form) must still get one -- otherwise this test would pass whether or
@@ -268,7 +268,9 @@ def test_run_button_streams_progress_to_completion(
     assert not errors, f'console errors during a normal run: {errors}'
 
 
-@pytest.mark.parametrize('demo_name', ['howto/multibar', 'howto/parallel-execution'])
+@pytest.mark.parametrize(
+    'demo_name', ['howto/multibar', 'howto/parallel-execution']
+)
 def test_multibar_demos_have_no_run_button(
     server: str,
     page: tuple[Page, list[str]],

tests/console/test_homepage.py

@@ -66,12 +66,16 @@ def test_showcase_keyboard_updates_recording_title_and_guide(
     tabs.first.focus()
     browser_page.keyboard.press('ArrowRight')
     playwright_api.expect(tabs.nth(1)).to_be_focused()
-    playwright_api.expect(tabs.nth(1)).to_have_attribute('aria-selected', 'true')
+    playwright_api.expect(tabs.nth(1)).to_have_attribute(
+        'aria-selected', 'true'
+    )
     playwright_api.expect(recording).to_have_attribute(
         'data', '_static/demos/readme-multibar.svg'
     )
     playwright_api.expect(title).to_have_text('Several jobs in one terminal')
-    playwright_api.expect(guide).to_have_attribute('href', 'howto/multibar.html')
+    playwright_api.expect(guide).to_have_attribute(
+        'href', 'howto/multibar.html'
+    )
     browser_page.keyboard.press('End')
     playwright_api.expect(tabs.last).to_be_focused()
     playwright_api.expect(guide).to_have_attribute(
@@ -186,7 +190,9 @@ def test_showcase_reduced_motion_and_failed_recording_keep_guides(
     browser_page.route('**/readme-multibar.svg', _missing)
     browser_page.get_by_role('tab', name='Multiple jobs').click()
     guide: Locator = browser_page.locator('#showcase-guide')
-    playwright_api.expect(guide).to_have_attribute('href', 'howto/multibar.html')
+    playwright_api.expect(guide).to_have_attribute(
+        'href', 'howto/multibar.html'
+    )
     playwright_api.expect(guide).to_be_visible()
     playwright_api.expect(
         browser_page.locator('#showcase-pause')

tests/console/test_showcase_assets.py

@@ -1,4 +1,4 @@
-"""The homepage's raw HTML recordings fail the build when an asset is absent."""
+"""Reject missing homepage recording assets during the build."""
 
 from __future__ import annotations
 
@@ -14,7 +14,9 @@
 ROOT: pathlib.Path = pathlib.Path(__file__).resolve().parents[2]
 
 
-@pytest.mark.parametrize('name', ['readme/colors', 'readme/multibar', 'readme/hero'])
+@pytest.mark.parametrize(
+    'name', ['readme/colors', 'readme/multibar', 'readme/hero']
+)
 def test_missing_showcase_recording_is_a_build_error(
     name: str,
     tmp_path: pathlib.Path,

tests/test_readme_demos.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import itertools
 import os
 import re
 import sys
@@ -414,9 +415,7 @@ def test_parse_frames_groups_repeated_manual_line_offsets() -> None:
 
 def test_multibar_clear_removes_only_the_retired_row() -> None:
     output: str = (
-        '\x1b[2Fbuild 100%\x1b[2E'
-        '\x1b[1Ftest 50%\x1b[1E'
-        '\x1b[2F\x1b[2K\x1b[2E'
+        '\x1b[2Fbuild 100%\x1b[2E\x1b[1Ftest 50%\x1b[1E\x1b[2F\x1b[2K\x1b[2E'
     )
     assert demos.parse_frames(output)[-1] == ['test 50%']
 
@@ -431,8 +430,7 @@ def test_manual_line_offset_capture_shows_four_actual_rows() -> None:
     )
     assert len(frames[-1]) == 4
     assert all(
-        '(20 of 20)' in demos.ANSI_SGR_RE.sub('', line)
-        for line in frames[-1]
+        '(20 of 20)' in demos.ANSI_SGR_RE.sub('', line) for line in frames[-1]
     )
     assert min(_bar_widths(frames)) >= 20
 
@@ -450,7 +448,7 @@ def test_parallel_execution_capture_shows_three_active_workers() -> None:
             plain_line: str = demos.ANSI_SGR_RE.sub('', line)
             match: re.Match[str] | None = demos.PERCENT_RE.search(plain_line)
             if match and 0 < int(match.group()[:-1]) < 100:
-                active_workers.add(plain_line[:match.start()].strip())
+                active_workers.add(plain_line[: match.start()].strip())
         if len(active_workers) >= 3:
             break
     else:
@@ -504,16 +502,17 @@ def test_non_tty_capture_keeps_increasing_updates_in_history() -> None:
         [
             int(match.group()[:-1])
             for line in frame
-            if (match := demos.PERCENT_RE.search(
-                demos.ANSI_SGR_RE.sub('', line)
-            ))
+            if (
+                match := demos.PERCENT_RE.search(
+                    demos.ANSI_SGR_RE.sub('', line)
+                )
+            )
         ]
         for frame in frames
     ]
     assert max(map(len, frames)) == 4
     assert any(
-        len(values) == 4
-        and all(a < b for a, b in zip(values, values[1:]))
+        len(values) == 4 and all(a < b for a, b in itertools.pairwise(values))
         for values in percentages
     )
     assert percentages[-1][-1] == 100
@@ -582,7 +581,7 @@ def test_tutorial_recording_preserves_intermediate_progress() -> None:
     assert percentages[0] == 0
     assert percentages[-1] == 100
     assert len(set(percentages)) >= 80
-    assert max(b - a for a, b in zip(percentages, percentages[1:])) <= 2
+    assert max(b - a for a, b in itertools.pairwise(percentages)) <= 2
 
 
 # Demos whose entire purpose is a time-derived reading (an elapsed duration,