Buffered reader documentation for timeout 0

オープン

#1,919 2025年2月18日に作成コメント 1 件リアクション 0 件担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度: 2/5
見積もり時間: 1〜3時間
初心者へのやさしさ: 35/100

issue の種類: ドキュメント
明瞭さ: おおむね明確
活発さ: 停滞
技術スタック: python
領域: documentation

調査の方向性

まず BufferedReader.get_message の実装と既存の docstring を読み、次に SimpleQueue が 0 の timeout をどのように処理するかを確認します。正の timeout に関する指針、最小 timeout、または 0 の timeout の動作を未規定とすることのうち、どのドキュメント変更が意図されているのかを判断し、それに応じてドキュメントを更新します。

索引モデルが issue の本文から書いたものです。

説明

Some guys asked me what would happen if one is using the BufferedReader.get_message function with a timeout of 0. I checked the implementation and it looks like as this library relys on the Python SimpleQueue this is depending on the specific system. See here:
https://bugs.python.org/issue28982

I would like to suggest some changes at least to the documentation. I have the following proposals while not all of them might be done:

Add information to the docstring that the timeout should always be a positive number (and maybe at least 10ms)
Add a check for the timeout to be at least 10ms (or even 1ms)
Add some information to the docstring that this relys on SimpleQueue and handling of a timeout of 0 or less is not specified

Please tell me your thoughts

主要言語: Python
スター: 1.6k
フォーク: 697
PR マージ指標: 30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
リポジトリをフォークし、ブランチを切って変更します。
issue 番号を参照したプルリクエストを送ります。

hardbyte/python-can のほかの issue

IXXAT: timestamps read 1.5 x wall time plus adapter uptime (misplaced parenthesis in _timeoffset; start tick never captured in vcinpl2) オープン

難易度 2/5 1〜3時間初心者へのやさしさ 88/100

hardbyte/python-can#2103 · 2026年9月18日に作成
Unhashable type for Systec interface errors オープン

bug

難易度 1/5 1時間未満初心者へのやさしさ 78/100

hardbyte/python-can#2077 · コメント 1 件 · リアクション 1 件 · 2026年7月13日に作成
New error behaviour when calling `flush_tx_buffer` for several interface types オープン

bug

難易度 1/5 1時間未満初心者へのやさしさ 68/100

hardbyte/python-can#1922 · リアクション 1 件 · 2025年2月22日に作成
Add support for the more efficient ElmüSoft Candlelight Protocol オープン

enhancement

難易度 5/5 1週間以上初心者へのやさしさ 30/100

hardbyte/python-can#2102 · 2026年9月15日に作成
PCAN message timestamps drift after macOS system sleep オープン

bug

難易度 3/5 1〜2日初心者へのやさしさ 68/100

hardbyte/python-can#2092 · 2026年8月21日に作成

hardbyte/python-can の issue をすべて見る

似ている issue

validate-structure inspecte challenge/work/.terraform et rend faux les labs qui ont un provider en cache オープン

bug

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

stephrobert/dsoxlab#238 · 2026年9月24日に作成
Uniform probability densities use the upper bound as an interval width オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

nasa/fmdtools#40 · 2026年9月24日に作成
_common_folder() treats a single file as the common folder; single-file archives can't be installed (4.2.8) / crash (master) オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

sublimehq/package_control#1780 · 2026年9月24日に作成
Set 'Sample' input in 'autorun.py' to utilize 'Sample' Tab in eLog オープン

難易度 2/5 1〜3時間初心者へのやさしさ 65/100

pcdshub/mfx#309 · コメント 2 件 · 2026年9月24日に作成
niri config file addition does not respect existing optional include オープン

難易度 2/5 1〜3時間初心者へのやさしさ 70/100

nwg-piotr/nwg-displays#145 · 2026年9月24日に作成

Python の issue をもっと見る