Update legacy tests for corrected double-finish semantics

The monitor_progress goldens and the colors test encoded the duplicate
final render caused by the double finish() from the iterator plus the
context manager; finish() is idempotent now so the bar renders its
final state once. The multibar example finishes its bars explicitly
since the context manager now genuinely waits for completion. The
transfer-speed golden for zero progress uses the regular format. Also:
FORCE_COLOR handling returns directly instead of break (avoids an
unrecordable coverage arc), SIGWINCH dispatch and reverse-order
unwrapping gained coverage, and the repro_bugs.py scratch battery is
replaced by the regression tests.

Author: wolph

examples.py

@@ -85,6 +85,11 @@ def do_something(bar):
             # Increment one of the progress bars at random
             multibar[bar_label].increment()
 
+        # The multibar context manager waits for all bars to finish on
+        # exit, so finish them explicitly
+        for bar_label in bar_labels:
+            multibar[bar_label].finish()
+
 
 @example
 def multiple_bars_line_offset_example() -> None:

progressbar/env.py

@@ -96,8 +96,7 @@ def from_env(cls) -> ColorSupport:
                 # Generic truthy flags such as `FORCE_COLOR=1` enable
                 # color support but don't specify the depth; assume full
                 # color support analogous to the Jupyter handling above.
-                support = cls.XTERM_TRUECOLOR
-                break
+                return cls.XTERM_TRUECOLOR
 
         return support
 

progressbar/multi.py

@@ -386,10 +386,10 @@ def stop(self, timeout: float | None = None):
         self.join(timeout=timeout)
 
     def get_sorted_bars(self):
-        # Snapshot the values so other threads can add or remove bars
-        # while we are sorting/rendering
+        # sorted() materializes the values in a single pass, so other
+        # threads can add or remove bars while we are rendering
         return sorted(
-            list(self.values()),
+            self.values(),
             key=self.sort_keyfunc,
             reverse=self.sort_reverse,
         )

tests/test_color.py

@@ -418,9 +418,7 @@ def test_hsl_interpolate_preserves_components() -> None:
     start_color = terminal.HSL(0, 100, 25)
     end_color = terminal.HSL(0, 100, 75)
 
-    assert start_color.interpolate(end_color, 0.5) == terminal.HSL(
-        0, 100, 50
-    )
+    assert start_color.interpolate(end_color, 0.5) == terminal.HSL(0, 100, 50)
 
 
 @pytest.mark.parametrize('value', ['1', 'true', 'on'])

tests/test_monitor_progress.py

@@ -200,7 +200,6 @@ def test_line_breaks(testdir) -> None:
             ' 60%|################################                      |',
             ' 80%|###########################################           |',
             '100%|######################################################|',
-            '100%|######################################################|',
         ),
     )
 
@@ -224,8 +223,6 @@ def test_no_line_breaks(testdir) -> None:
         ' 60%|################################                      |',
         ' 80%|###########################################           |',
         '100%|######################################################|',
-        '',
-        '100%|######################################################|',
     ]
 
 
@@ -248,8 +245,6 @@ def test_percentage_label_bar(testdir) -> None:
         '|###########################60%####                        |',
         '|###########################80%################            |',
         '|###########################100%###########################|',
-        '',
-        '|###########################100%###########################|',
     ]
 
 
@@ -272,8 +267,6 @@ def test_granular_bar(testdir) -> None:
         '|OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOo                       |',
         '|OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO.           |',
         '|OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO|',
-        '',
-        '|OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO|',
     ]
 
 
@@ -287,10 +280,10 @@ def test_colors(testdir) -> None:
         testdir.makepyfile(_create_script(enable_colors=True, **kwargs)),
     )
     pprint.pprint(result.stderr.lines, width=70)
-    assert result.stderr.lines == ['\x1b[92mgreen\x1b[0m'] * 3
+    assert result.stderr.lines == ['\x1b[92mgreen\x1b[0m'] * 2
 
     result = testdir.runpython(
         testdir.makepyfile(_create_script(enable_colors=False, **kwargs)),
     )
     pprint.pprint(result.stderr.lines, width=70)
-    assert result.stderr.lines == ['green'] * 3
+    assert result.stderr.lines == ['green'] * 2

tests/test_progressbar.py

@@ -160,6 +160,11 @@ def test_sigwinch_restored_with_overlapping_bars() -> None:
         bar2 = progressbar.ProgressBar(max_value=5, fd=io.StringIO())
         bar2.start()
 
+        # A resize signal is dispatched to all live bars
+        signal.raise_signal(signal.SIGWINCH)
+        assert isinstance(bar1.term_width, int)
+        assert isinstance(bar2.term_width, int)
+
         bar1.update(5)
         bar1.finish()
         bar2.update(5)

tests/test_speed.py

@@ -6,7 +6,9 @@
 @pytest.mark.parametrize(
     'total_seconds_elapsed,value,expected',
     [
-        (1, 0, '  0.0 s/B'),
+        # Zero progress means no data yet, so the regular format is used
+        # instead of the inverse (seconds per unit) format
+        (1, 0, '  0.0 B/s'),
         (1, 0.01, '100.0 s/B'),
         (1, 0.1, '  0.1 B/s'),
         (1, 1, '  1.0 B/s'),

tests/test_utils.py

@@ -137,6 +137,14 @@ def test_stream_wrapper_unwrap_restores_excepthook() -> None:
         assert sys.excepthook == wrapper.excepthook
         wrapper.unwrap_stderr()
         assert sys.excepthook is hook_before
+
+        # Same in reverse order: stderr first, then stdout
+        wrapper.wrap_stdout()
+        wrapper.wrap_stderr()
+        wrapper.unwrap_stderr()
+        assert sys.excepthook == wrapper.excepthook
+        wrapper.unwrap_stdout()
+        assert sys.excepthook is hook_before
     finally:
         sys.excepthook = wrapper.original_excepthook
         sys.stdout = wrapper.original_stdout

tests/test_windows.py

@@ -111,7 +111,5 @@ def fake_read_console_input(handle, buffer, length, events_read):
         events_read._obj.value = 1
         return 1
 
-    monkeypatch.setattr(
-        windows, '_ReadConsoleInput', fake_read_console_input
-    )
+    monkeypatch.setattr(windows, '_ReadConsoleInput', fake_read_console_input)
     assert windows.getch() == 'a'