python / python/cpython

Better/complete documentation of sys.stdin/stdout/stderr default behavior

オープン
#92,298 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

docs
主要言語
Python
スター
77.2k
フォーク
36k
PR マージ指標
PR 指標を取得中

説明

See https://docs.python.org/3/library/sys.html?highlight=stdin#sys.stdin
The default behavior of sys.stdin/stdout/stderr is not fully documented (e.g. the default newline mode, depending on OS), and the current existing documentation is a lot more difficult to understand than it would need to be, referring to internal c-api settings instead of explaining in clear language what is going.

Given how important this information is and given that the behavior of sys.stdin/out/err is surprisingly DIFFERENT from what the default would be if open with default settings would be used, making the documentation more complete and easier to understand would be rather important. The number of questions on stackoverlow (partly with incorrect or hard to verify answers) about this is a good indicator of how confusing and important this matter is.

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

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

はじめの一歩

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

調査の方向性

リンク先の Python ドキュメントページにある sys.stdin、sys.stdout、sys.stderr のセクションから始め、その説明を、各オペレーティングシステムでデフォルト設定を使って open を実行した場合の動作と比較します。デフォルトの改行動作とその他の関連する違いが、内部 C API の用語に頼らず、明確かつ正確に説明されていれば作業は完了です。

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

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。