Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Is there a way to only show base "--help" for explicitly defined options?

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
cli

調査の方向性

traitlets.config.application.Application から始め、aliases と組み込みオプションから --help の出力がどのように組み立てられるかを追跡します。例を基に期待される動作を確認します。--help には --github-token のように明示的に定義されたオプションだけが表示され、完全なセットについては --help-all を引き続き利用できるようにします。

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

説明

When creating the aliases, flags, etc for the options, is there a way to only show those options that I've explicitly defined?

For example, consider this code:

from traitlets import Unicode
from traitlets.config import SingletonConfigurable
from traitlets.config.application import Application


class ConfigStore(SingletonConfigurable):
    github_token = Unicode("", help="Your Github access token").tag(config=True)


class AppController(Application):
    classes = [ConfigStore]
    aliases = {
        ("github-token"): (
            "ConfigStore.github_token",
            "your github access token, usually set via environment variable GITHUB_TOKEN",
        ),
    }

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)


if __name__ == "__main__":
    app = AppController()
    app.launch_instance()

When called with --help it outputs the following:

This is an application.

Options
=======
The options below are convenience aliases to configurable class-options,
as listed in the "Equivalent to" description-line of the aliases.
To see all configurable class-options for some <cmd>, use:
    <cmd> --help-all

--debug
    Set log-level to debug, for the most verbose logging.
    Equivalent to: [--Application.log_level=10]
--show-config
    Show the application's configuration (human-readable format)
    Equivalent to: [--Application.show_config=True]
--show-config-json
    Show the application's configuration (json format)
    Equivalent to: [--Application.show_config_json=True]
--github-token=<Unicode>
    your github access token, usually set via environment variable GITHUB_TOKEN
    Default: ''
    Equivalent to: [--ConfigStore.github_token]

To see all available configurables, use `--help-all`.

Is there a way to configure the Application such that it only displays this:

--github-token=<Unicode>
    your github access token, usually set via environment variable GITHUB_TOKEN
    Default: ''

Sorry to ask a question in a github issue. Is there a better forum to ask these sorts of questions? Thank you!!

主要言語
Python
スター
653
フォーク
217
平均マージ
2日 21時間
マージ済み PR(30日)
2

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

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

はじめの一歩

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

ipython/traitlets のほかの issue

ipython/traitlets の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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