Skip to content

Document zero-timeout BufferedReader polling with tests - #2138

Open
Solarboaters wants to merge 1 commit into
hardbyte:mainfrom
Solarboaters:docs/buffered-reader-zero-timeout
Open

Solarboaters wants to merge 1 commit into
hardbyte:mainfrom
Solarboaters:docs/buffered-reader-zero-timeout

Conversation

@Solarboaters

Copy link
Copy Markdown

Summary of Changes

Document BufferedReader.get_message(timeout=0) as an immediate queue poll, including FIFO draining and stopped-reader behaviour. Correct the stale BufferError documentation to the actual RuntimeError. No runtime code changes or artificial minimum timeout.

Related Issues / Pull Requests

Closes #1919.

Type of Change

  • Documentation update

Checklist

  • I have followed the contribution guide.
  • I have added or updated tests as appropriate.
  • I have added or updated documentation as appropriate.
  • I have added a news fragment for towncrier.
  • All checks and tests pass (tox).

Additional Notes

Python 3.12/Linux: all 13 listener tests pass, including three new cases. The wider suite excluding UDP multicast passes (517 tests, 107 skips, 32 deselections, 36 subtests). The full run has 20 multicast receive failures; the same 20 also fail with the original listener.py. No physical CAN hardware was tested.

Sphinx HTML builds with warnings treated as errors; changed production-file Ruff and changed-file Black checks pass. Full multi-version tox was not run. AI-assisted documentation and tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Buffered reader documentation for timeout 0

1 participant