pytest-threadpool 0.3.5__tar.gz → 0.4.0__tar.gz

{pytest_threadpool-0.3.5 → pytest_threadpool-0.4.0}/.gitignore

@@ -163,6 +163,9 @@ cython_debug/
 .idea/
 uv.lock
 
+# Live-view saved logs
+logs/
+
 # hatch-vcs generated version file
 src/pytest_threadpool/_version.py
 

pytest_threadpool-0.4.0/CHANGELOG.md

@@ -0,0 +1,161 @@
+# Changelog
+
+## 0.4.0
+
+### Highlights
+
+- **Interactive live-view terminal UI** (`--threadpool-output live`) with
+  split-pane layout, test tree navigation, and real-time output inspection.
+
+### Live-view features
+
+- **Split-pane layout**: `Tab` opens a tree panel on the left with the main
+  content on the right, both independently scrollable.
+- **Test tree**: Full session hierarchy (packages > modules > classes > tests)
+  with live outcome markers (`✓` passed, `✗` failed, `E` error, `s` skipped,
+  `x` xfail, `X` xpass). Groups show aggregated status.
+- **Fuzzy search**: Type in the tree panel to fuzzy-filter tests (fzf-style
+  subsequence matching). `Escape` clears the query.
+- **Context switching**: `Enter` on a test shows its captured output (stdout,
+  stderr, logs, colored tracebacks) in the content pane. `Enter` on a group
+  shows combined output for all descendants. `Summary` node returns to the
+  main progress view.
+- **Outcome filters**: `Ctrl+P` toggles passed test visibility, `Ctrl+X`
+  toggles failed test visibility. Empty groups are automatically hidden.
+- **Content search**: `/` activates vim-style search within the content pane.
+  `n`/`N` navigate matches. Current match highlighted in orange, other matches
+  in grey. `Escape` clears search.
+- **Save to file**: `Ctrl+W` saves the full active buffer (ANSI-stripped) to
+  `logs/{name}_{timestamp}.log`.
+- **Focus switching**: `Ctrl+←`/`Ctrl+→` switches keyboard focus between panes.
+  Mouse scroll targets whichever pane the cursor is over.
+- **Keybinds hint line**: Bottom bar shows available keyboard shortcuts.
+- **Configurable tree width**: `threadpool_tree_width` ini setting (supports
+  `pyproject.toml`, `pytest.ini`).
+
+### Test outcome markers
+
+- Added `x` (xfail), `X` (xpass), and `E` (setup/teardown error) markers
+  to the live reporter alongside existing `.` (pass), `F` (fail), `s` (skip).
+- Sequential nodeid-style output now shows `XFAIL`, `XPASS`, and `ERROR` words.
+
+### Scroll responsiveness
+
+- Fixed scroll input being unresponsive after tests finish — root cause was
+  multiple competing `InputReader` threads stealing from the shared terminal
+  input buffer on free-threaded Python.
+- `InputReader` now uses `os.dup()` to create a private fd immune to pytest
+  capture redirections.
+- Device-level singleton ensures only one active reader per terminal device.
+- `ensure_entered()` uses `threading.Event` + lock for thread-safe
+  initialization on free-threaded Python.
+- `ensure_cbreak()` uses `TCSANOW` to avoid flushing pending input.
+
+### Architecture
+
+- Region-based dirty tracking (`Region` enum) for independent pane rendering
+  without cross-pane flicker.
+- `Display.redraw_buffer()` supports `left_offset` for split-pane rendering,
+  `highlight`/`highlight_line` for search result visualization.
+- `Display.redraw_pane()` and `redraw_separator()` for side panel rendering.
+
+### Tests
+
+- Integration tests for all test outcome markers (pass, fail, skip, xfail,
+  xpass, error) in both classic and live modes.
+- Integration test for tree panel rendering.
+- Unit tests for tree overlay (navigation, fuzzy search, outcome filters,
+  group markers, expand/collapse).
+- Unit tests for content search highlighting.
+- Unit tests for scroll latency.
+
+## 0.3.6
+
+### Fixes
+
+- Fixed session, module, and class-scoped fixtures being torn down and
+  re-created between parallel groups instead of being resolved once and
+  shared for their entire scope. The same fix applies to xunit-style
+  `setup_module`/`setup_class` hooks.
+
+## 0.3.5
+
+### Fixes
+
+- Fixed crash (KeyError) when a worker thread throws an unexpected exception
+  outside the normal test lifecycle — failures are now reported gracefully
+  instead of taking down the entire test run.
+- `--threadpool` with a non-numeric value (e.g. `--threadpool foo`) now raises
+  a clean `pytest.UsageError` instead of an unhandled `ValueError` traceback.
+- `@parallelizable("children")` applied directly to a test function now emits
+  a warning explaining that functions have no children, instead of being
+  silently ignored.
+
+### Cleanup
+
+- Moved `ParallelScope` import to module top in `_markers.py`, removed
+  misleading circular-import comment.
+
+## 0.3.4
+
+### Highlights
+
+- GIL-enabled builds now supported — `--threadpool` no longer raises
+  `UsageError` on non-free-threaded Python; it issues a warning instead
+  and runs with GIL-limited parallelism.
+- Thread-safe stdout/stderr capture via `_ThreadLocalStream` proxy,
+  preventing worker `print()` output from corrupting test result lines.
+- Package-group merging — split package-level parallel groups (interrupted
+  by sequential `@not_parallelizable` items) are merged back together.
+
+### New examples
+
+- DI container, parallel logging, user pool with LIFO queue, shared state
+  patterns (barrier, atomic counter, async counter).
+
+### Improvements
+
+- Cross-module package groups correctly initialize per-module shared fixtures.
+- Mixed parallel/sequential reporting with `nodeid PASSED` format.
+- Live reporter line separation fixes between groups and transitions.
+
+### Build & CI
+
+- Python version matrix expanded to 3.13, 3.13t, 3.14, 3.14t, 3.15, 3.15t.
+- Codecov integration, CI ignores tag pushes.
+
+## 0.3.3
+
+### Build & CI
+
+- Added GitHub Actions workflows for CI and PyPI publishing.
+- Integrated `hatch-vcs` for automatic version management.
+
+## 0.3.2
+
+### Features
+
+- Parallelized function-scoped fixture teardowns — `yield` cleanup,
+  `addfinalizer` callbacks, and xunit `teardown_method` now run in
+  worker threads alongside test calls.
+
+## 0.3.1
+
+### Cleanup
+
+- Removed unused `selenium` dependency.
+
+## 0.3.0
+
+### Features
+
+- Parallelized function-scoped fixture setups — each worker creates
+  independent fixture instances from cloned `FixtureDef` objects.
+- Shared fixtures (module/class/session) resolved once sequentially
+  before workers launch.
+
+## 0.2.0
+
+- Initial beta release with core parallel execution engine.
+- Marker-based parallelism (`children`, `parameters`, `all`).
+- Priority chain: `not_parallelizable` > own > class > module > package.

{pytest_threadpool-0.3.5 → pytest_threadpool-0.4.0}/PKG-INFO

@@ -1,16 +1,17 @@
 Metadata-Version: 2.4
 Name: pytest-threadpool
-Version: 0.3.5
-Summary: Parallel test execution for free-threaded Python builds
+Version: 0.4.0
+Summary: Parallel test execution using threads — true parallelism on free-threaded Python, concurrent I/O on standard builds
 Project-URL: Homepage, https://github.com/pytest-threadpool/pytest-threadpool
 Project-URL: Source, https://github.com/pytest-threadpool/pytest-threadpool
 Project-URL: Issues, https://github.com/pytest-threadpool/pytest-threadpool/issues
 License-Expression: Apache-2.0
 License-File: LICENSE
-Keywords: free-threaded,nogil,parallel,pytest,pytest parallel,testing,threadpool
+Keywords: concurrent testing,free-threaded,nogil,parallel,pytest,pytest parallel,sdet,test automation,testing,threadpool
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
@@ -128,7 +129,8 @@ objects — both within a parallel group and across sequential groups:
 
 ```python
 import threading
-import pytest
+
+from pytest_threadpool import parallelizable
 
 
 class SharedState:
@@ -137,7 +139,7 @@ class SharedState:
   results = {}
 
 
-@pytest.mark.parallelizable("children")
+@parallelizable("children")
 class TestGroupA:
   def test_a1(self):
     with SharedState.lock:
@@ -148,7 +150,7 @@ class TestGroupA:
       SharedState.results["a2"] = True
 
 
-@pytest.mark.parallelizable("children")
+@parallelizable("children")
 class TestGroupB:
   def test_b1(self):
     SharedState.event.set()
@@ -179,6 +181,83 @@ pytest --threadpool 8
 pytest
 ```
 
+To enable `--threadpool` by default, add it to your config:
+
+**pyproject.toml** (pytest 9.0+):
+
+```toml
+[tool.pytest]
+addopts = ["--threadpool", "auto"]
+```
+
+**pytest.ini**:
+
+```ini
+[pytest]
+addopts = --threadpool auto
+```
+
+## Configuration
+
+### Command-line options
+
+| Option                | Values            | Default   | Description                                                                                                   |
+|-----------------------|-------------------|-----------|---------------------------------------------------------------------------------------------------------------|
+| `--threadpool`        | `N` or `auto`     | *(off)*   | Enable parallel execution with N threads. `auto` uses `os.cpu_count()`.                                       |
+| `--threadpool-output` | `classic`, `live` | `classic` | Output mode. `live` opens an interactive terminal viewer with scroll, tree navigation, and real-time updates. |
+
+### INI settings
+
+Set in `pyproject.toml`, `pytest.ini`, or `setup.cfg`:
+
+| Setting                 | Type | Default | Description                                                                     |
+|-------------------------|------|---------|---------------------------------------------------------------------------------|
+| `threadpool_tree_width` | int  | `0`     | Width (columns) of the live-view tree pane. `0` = auto (1/4 of terminal width). |
+
+**pyproject.toml:**
+
+```toml
+[tool.pytest]
+threadpool_tree_width = "35"
+
+# or under ini_options
+[tool.pytest.ini_options]
+threadpool_tree_width = "35"
+```
+
+**pytest.ini:**
+
+```ini
+[pytest]
+threadpool_tree_width = "35"
+```
+
+### Live-view keybindings
+
+Available when `--threadpool-output live` is active:
+
+| Key               | Action                                               |
+|-------------------|------------------------------------------------------|
+| `↑` `↓`           | Scroll content / move tree cursor                    |
+| `PgUp` `PgDn`     | Page scroll                                          |
+| `Home` `End`      | Jump to top / bottom                                 |
+| `Tab`             | Toggle tree panel (split-pane)                       |
+| `Enter`           | Show test/group output in content pane               |
+| `←` `→`           | Collapse/expand tree node                            |
+| `Ctrl+←` `Ctrl+→` | Switch keyboard focus between tree and content panes |
+| `Ctrl+P`          | Toggle show/hide passed tests in tree                |
+| `Ctrl+X`          | Toggle show/hide failed tests in tree                |
+| `/`               | Search within content pane (when focused)            |
+| `n` / `N`         | Jump to next / previous search match                 |
+| `Ctrl+W`          | Save current pane content to `.log` file             |
+| Mouse scroll      | Scrolls whichever pane the cursor is over            |
+| `Escape`          | Clear search / close tree                            |
+| `Ctrl+C`          | Exit                                                 |
+
+The tree panel shows the full test hierarchy (session > packages > modules > classes > tests)
+with live outcome markers (`✓` passed, `✗` failed, `E` error, `s` skipped, `x` xfail, `X` xpass).
+Groups show aggregated status. Type in the tree panel to fuzzy-filter tests (fzf-style).
+
 ## Tested versions
 
 | Component | Versions                              |
@@ -211,17 +290,46 @@ worth browsing for real-world grouping, fixture, and reporting scenarios.
 - **No plugin compatibility guarantees** — Interactions with other pytest
   plugins (e.g. `pytest-xdist`, `pytest-timeout`, `pytest-randomly`) are
   untested and may conflict.
-- **No `capsys`/`capfd`/`caplog` in parallel** — These fixtures are not
-  thread-safe. `capsys`/`capfd` fail with "cannot use capsys and capsys at
-  the same time" when requested by parallel tests. `caplog` leaks records
-  across fixtures and its `at_level()` context managers race on the shared
-  root logger. Alternatives:
-  - **`print()`** — Worker output is suppressed by default (buffered by
-    thread-local stream proxies). Pass `-s` (`--capture=no`) to disable
-    suppression and see interleaved output.
-  - **Logging** — Use a per-test `FileHandler` writing to `tmp_path`, or
-    collect structured records in a shared thread-safe list (see
-    [`examples/test_logging/`](examples/test_logging/)).
+- **No `capsys`/`capfd` in parallel** — These fixtures are not thread-safe.
+  `capsys`/`capfd` fail with "cannot use capsys and capsys at the same time"
+  when requested by parallel tests. Alternatives:
+  - **`print()`** — Worker output is buffered by thread-local stream
+    proxies and reported alongside each test's result. In default capture
+    mode, output appears in "Captured stdout call" sections on failure.
+    With `-vs` (`--capture=no -v`), captured output is emitted after the
+    PASSED/FAILED line for each test. TTY mode (default without `-s`)
+    suppresses print output; use `-vs` to see it. A TTY-friendly output
+    viewer with switchable per-thread/per-test frames is planned (see
+    [ROADMAP](ROADMAP.md)).
+  - **`caplog`** — The `caplog` fixture works natively in parallel tests.
+    `caplog.records`, `caplog.text`, `caplog.record_tuples`,
+    `caplog.messages`, `caplog.clear()`, `caplog.at_level()`, and
+    `caplog.set_level()` all behave the same as in sequential pytest.
+    Each worker gets its own `LogCaptureHandler` with per-thread record
+    isolation — parallel tests don't leak records into each other's
+    caplog. Failed tests show "Captured log call" sections as expected.
+  - **`logging.Logger`** — Standard `logging` calls (`logger.info()`,
+    `logger.warning()`, etc.) work natively in parallel tests. A
+    thread-local log handler captures records per-worker and attaches
+    them to "Captured log call" report sections on failure, matching
+    sequential pytest behavior. Log output does not appear in stdout
+    for passing tests unless `--log-cli-level` is set or a
+    `StreamHandler` explicitly targets `sys.stdout` or `sys.stderr`.
+    `--log-level` controls which records are captured. Existing
+    `StreamHandler` instances are automatically redirected through
+    the per-thread proxy so their output is grouped per-test instead
+    of interleaving globally.
+  - **IDE and CI runners (PyCharm, TeamCity, VS Code)** — Each test's
+    function-scoped setup, call, and teardown output appears in its own
+    report. Shared fixture output (session/package/module/class setup
+    and teardown) is emitted at the suite level, not inside individual
+    tests. Parametrized tests are reported in collection order so
+    runners group them correctly. Works via the `teamcity-messages`
+    plugin (`--teamcity` flag); PyCharm and TeamCity CI use the same
+    protocol.
+  - **Custom output hook** — Implement `pytest_threadpool_report` in a
+    conftest or plugin to customize how captured worker output is handled.
+    Return `True` to suppress the default output handling.
 
 ## License
 

{pytest_threadpool-0.3.5 → pytest_threadpool-0.4.0}/README.md

@@ -105,7 +105,8 @@ objects — both within a parallel group and across sequential groups:
 
 ```python
 import threading
-import pytest
+
+from pytest_threadpool import parallelizable
 
 
 class SharedState:
@@ -114,7 +115,7 @@ class SharedState:
   results = {}
 
 
-@pytest.mark.parallelizable("children")
+@parallelizable("children")
 class TestGroupA:
   def test_a1(self):
     with SharedState.lock:
@@ -125,7 +126,7 @@ class TestGroupA:
       SharedState.results["a2"] = True
 
 
-@pytest.mark.parallelizable("children")
+@parallelizable("children")
 class TestGroupB:
   def test_b1(self):
     SharedState.event.set()
@@ -156,6 +157,83 @@ pytest --threadpool 8
 pytest
 ```
 
+To enable `--threadpool` by default, add it to your config:
+
+**pyproject.toml** (pytest 9.0+):
+
+```toml
+[tool.pytest]
+addopts = ["--threadpool", "auto"]
+```
+
+**pytest.ini**:
+
+```ini
+[pytest]
+addopts = --threadpool auto
+```
+
+## Configuration
+
+### Command-line options
+
+| Option                | Values            | Default   | Description                                                                                                   |
+|-----------------------|-------------------|-----------|---------------------------------------------------------------------------------------------------------------|
+| `--threadpool`        | `N` or `auto`     | *(off)*   | Enable parallel execution with N threads. `auto` uses `os.cpu_count()`.                                       |
+| `--threadpool-output` | `classic`, `live` | `classic` | Output mode. `live` opens an interactive terminal viewer with scroll, tree navigation, and real-time updates. |
+
+### INI settings
+
+Set in `pyproject.toml`, `pytest.ini`, or `setup.cfg`:
+
+| Setting                 | Type | Default | Description                                                                     |
+|-------------------------|------|---------|---------------------------------------------------------------------------------|
+| `threadpool_tree_width` | int  | `0`     | Width (columns) of the live-view tree pane. `0` = auto (1/4 of terminal width). |
+
+**pyproject.toml:**
+
+```toml
+[tool.pytest]
+threadpool_tree_width = "35"
+
+# or under ini_options
+[tool.pytest.ini_options]
+threadpool_tree_width = "35"
+```
+
+**pytest.ini:**
+
+```ini
+[pytest]
+threadpool_tree_width = "35"
+```
+
+### Live-view keybindings
+
+Available when `--threadpool-output live` is active:
+
+| Key               | Action                                               |
+|-------------------|------------------------------------------------------|
+| `↑` `↓`           | Scroll content / move tree cursor                    |
+| `PgUp` `PgDn`     | Page scroll                                          |
+| `Home` `End`      | Jump to top / bottom                                 |
+| `Tab`             | Toggle tree panel (split-pane)                       |
+| `Enter`           | Show test/group output in content pane               |
+| `←` `→`           | Collapse/expand tree node                            |
+| `Ctrl+←` `Ctrl+→` | Switch keyboard focus between tree and content panes |
+| `Ctrl+P`          | Toggle show/hide passed tests in tree                |
+| `Ctrl+X`          | Toggle show/hide failed tests in tree                |
+| `/`               | Search within content pane (when focused)            |
+| `n` / `N`         | Jump to next / previous search match                 |
+| `Ctrl+W`          | Save current pane content to `.log` file             |
+| Mouse scroll      | Scrolls whichever pane the cursor is over            |
+| `Escape`          | Clear search / close tree                            |
+| `Ctrl+C`          | Exit                                                 |
+
+The tree panel shows the full test hierarchy (session > packages > modules > classes > tests)
+with live outcome markers (`✓` passed, `✗` failed, `E` error, `s` skipped, `x` xfail, `X` xpass).
+Groups show aggregated status. Type in the tree panel to fuzzy-filter tests (fzf-style).
+
 ## Tested versions
 
 | Component | Versions                              |
@@ -188,17 +266,46 @@ worth browsing for real-world grouping, fixture, and reporting scenarios.
 - **No plugin compatibility guarantees** — Interactions with other pytest
   plugins (e.g. `pytest-xdist`, `pytest-timeout`, `pytest-randomly`) are
   untested and may conflict.
-- **No `capsys`/`capfd`/`caplog` in parallel** — These fixtures are not
-  thread-safe. `capsys`/`capfd` fail with "cannot use capsys and capsys at
-  the same time" when requested by parallel tests. `caplog` leaks records
-  across fixtures and its `at_level()` context managers race on the shared
-  root logger. Alternatives:
-  - **`print()`** — Worker output is suppressed by default (buffered by
-    thread-local stream proxies). Pass `-s` (`--capture=no`) to disable
-    suppression and see interleaved output.
-  - **Logging** — Use a per-test `FileHandler` writing to `tmp_path`, or
-    collect structured records in a shared thread-safe list (see
-    [`examples/test_logging/`](examples/test_logging/)).
+- **No `capsys`/`capfd` in parallel** — These fixtures are not thread-safe.
+  `capsys`/`capfd` fail with "cannot use capsys and capsys at the same time"
+  when requested by parallel tests. Alternatives:
+  - **`print()`** — Worker output is buffered by thread-local stream
+    proxies and reported alongside each test's result. In default capture
+    mode, output appears in "Captured stdout call" sections on failure.
+    With `-vs` (`--capture=no -v`), captured output is emitted after the
+    PASSED/FAILED line for each test. TTY mode (default without `-s`)
+    suppresses print output; use `-vs` to see it. A TTY-friendly output
+    viewer with switchable per-thread/per-test frames is planned (see
+    [ROADMAP](ROADMAP.md)).
+  - **`caplog`** — The `caplog` fixture works natively in parallel tests.
+    `caplog.records`, `caplog.text`, `caplog.record_tuples`,
+    `caplog.messages`, `caplog.clear()`, `caplog.at_level()`, and
+    `caplog.set_level()` all behave the same as in sequential pytest.
+    Each worker gets its own `LogCaptureHandler` with per-thread record
+    isolation — parallel tests don't leak records into each other's
+    caplog. Failed tests show "Captured log call" sections as expected.
+  - **`logging.Logger`** — Standard `logging` calls (`logger.info()`,
+    `logger.warning()`, etc.) work natively in parallel tests. A
+    thread-local log handler captures records per-worker and attaches
+    them to "Captured log call" report sections on failure, matching
+    sequential pytest behavior. Log output does not appear in stdout
+    for passing tests unless `--log-cli-level` is set or a
+    `StreamHandler` explicitly targets `sys.stdout` or `sys.stderr`.
+    `--log-level` controls which records are captured. Existing
+    `StreamHandler` instances are automatically redirected through
+    the per-thread proxy so their output is grouped per-test instead
+    of interleaving globally.
+  - **IDE and CI runners (PyCharm, TeamCity, VS Code)** — Each test's
+    function-scoped setup, call, and teardown output appears in its own
+    report. Shared fixture output (session/package/module/class setup
+    and teardown) is emitted at the suite level, not inside individual
+    tests. Parametrized tests are reported in collection order so
+    runners group them correctly. Works via the `teamcity-messages`
+    plugin (`--teamcity` flag); PyCharm and TeamCity CI use the same
+    protocol.
+  - **Custom output hook** — Implement `pytest_threadpool_report` in a
+    conftest or plugin to customize how captured worker output is handled.
+    Return `True` to suppress the default output handling.
 
 ## License