python / python/cpython

Defaults conditionally omitted from help message when using ArgumentDefaultsHelpFormatter

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

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

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

説明

Bug report

Using ArgumentDefaultsHelpFormatter as formatter_class of ArgumentParser doesn't always shows default even if the default for argument is set. It's expected to show default if provided.

Example:

    parser = ArgumentParser(formatter_class=ArgumentDefaultsHelpFormatter)
    parser.add_argument('foo', default=1)
    parser.add_argument('bar', nargs='*', default=1)
    parser.add_argument('baz', nargs='*', default=1, help='baz help')
    parser.add_argument('-a', default=1)
    parser.add_argument('-b', default=1, help='b_help')
    parser.print_help()

provides

positional arguments:
  foo
  bar
  baz         baz help (default: 1)

options:
  -h, --help  show this help message and exit
  -a A
  -b B        b_help (default: 1)

Though I see no reason to not show default for -a, foo and bar.
Making help argument mandatory to show default is necessary imho, but what is really strange is that it's enough for an option, but requires nargs for a positional argument.

Your environment

  • CPython versions tested on: 3.10.5
  • Operating system and architecture: Arch Linux x86_64 5.15.55-1-lts
Linked PRs
  • gh-112682

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

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

はじめの一歩

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

調査の方向性

まず、提供されたArgumentParserの例をArgumentDefaultsHelpFormatterとともに再現し、位置引数とオプション引数に対するformatterの動作を確認します。既存の作業について、リンクされているPR gh-112682を確認してください。完了とは、報告されているケースでhelp出力に指定されたデフォルト値が一貫して表示されることを意味します。

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

評価

技術スタック
python
領域
cli
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
35/100

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

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