Optional type args are mistyped in help

オープン

#508 2024年4月19日に作成コメント 5 件リアクション 0 件担当者 0 名 GitHub で見る

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

評価

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

issue の種類: バグ
明瞭さ: おおむね明確
活発さ: 停滞
技術スタック: python
領域: cli

調査の方向性

まず、fire.Fire(main) を通して2つの例を再現し、生成された --help の出力を確認します。Optional アノテーションが表示される型にどのように変換されるかを追跡し、その後、どちらのデフォルト値でも期待される Optional[str] という文言になることを検証します。

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

説明

bug

Type annotations that use typing.Optional are incorrectly documented when showing help.

Example 1

from typing import Optional

import fire

def main(arg: Optional[str] = 'something'):
    """Do something with arg."""


if __name__ == '__main__':
    fire.Fire(main)

The corresponding help output is:

INFO: Showing help with the command 'firetest.py -- --help'.

NAME
    firetest.py - Do something with arg.

SYNOPSIS
    firetest.py <flags>

DESCRIPTION
    Do something with arg.

FLAGS
    -a, --arg=ARG
        Type: Optional
        Default: 'something'

Here, Type: Optional is totally incorrect. It should be Optional[str]. My use of str is just an example and it can be anything.

Example 2

from typing import Optional

import fire


def main(arg: Optional[str] = None):
    """Do something with arg."""


if __name__ == '__main__':
    fire.Fire(main)

The corresponding help output is:

INFO: Showing help with the command 'firetest.py -- --help'.

NAME
    firetest.py - Do something with arg.

SYNOPSIS
    firetest.py <flags>

DESCRIPTION
    Do something with arg.

FLAGS
    -a, --arg=ARG
        Type: Optional[Optional]
        Default: None

Here, Type: Optional[Optional] is even more incorrect. It should be Optional[str]. My use of str is just an example and it can be anything.

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

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

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

はじめの一歩

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

google/python-fire のほかの issue

Test suite fails on Windows: unescaped path regex in testArgPassing, NamedTemporaryFile reopen in testFileNameFire オープン

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

google/python-fire#693 · 2026年8月16日に作成
Release 0.7.2? オープン

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

google/python-fire#698 · 2026年8月30日に作成
Uncaught exception when a component has a property whose getter raises (intended?) オープン

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

google/python-fire#672 · コメント 5 件 · 2026年6月6日に作成
python-fire: (1) PAGER+shell=True RCE in console_io.More (2) bash $(...) runs when sourcing --completion from maliciously named .py file. PoC verified. オープン

難易度 4/5 3〜5日初心者へのやさしさ 45/100

google/python-fire#665 · コメント 2 件 · 2026年5月5日に作成
**kwargs unexpectedly parses flags for later chained method オープン

難易度 4/5 3〜5日初心者へのやさしさ 55/100

google/python-fire#659 · コメント 1 件 · 2026年4月3日に作成

google/python-fire の issue をすべて見る

似ている issue

Use `charmlibs.interfaces.oauth` instead of deprecated `hydra.oauth` オープン

enhancement

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

canonical/paas-charm#368 · コメント 1 件 · 2026年9月23日に作成
Model API: distributable field returns false even when "Allow Distributed Inference Across Workers" is checked オープン

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

gpustack/gpustack#6275 · 2026年9月23日に作成
attachment_urls parameter descriptions do not state that the value must be a reference オープン

tech debt

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

epam/ai-dial-quickapps-backend#579 · 2026年9月23日に作成
addition to tracking list オープン

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

StevenBlack/hosts#3256 · 2026年9月23日に作成
Fix-WebUI-README-screenshot-links オープン

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

qualcomm/qai-appbuilder#275 · 2026年9月23日に作成

Python の issue をもっと見る