Optional type args are mistyped in help

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.

Thanks for reporting this. Looks like a bug to me. Next steps are to add a test case and identify and resolve the issue.

@dbieber

Hi @dbieber,

I submitted pr #513 to solve this bug and added tests, please let me know your opinion.

@dbieber

Hi @dbieber,

Updated pr #513 to work with the typing package, waiting for your review on the last commit.

Given that fire is seemingly dead and this bug really harms the displayed help, I figure it's wise to move away from fire. Any decent LLM, e.g. gpt-4o, can replace the use of fire in a module with a different package, e.g. click.

Unfortunately I have to agree, fire is dead. So many bugs since many years and nobody cares.

fix: show full Optional[T] type in help instead of just Optional

fix: show full type for Optional and generic type annotations in help

Navigation Menu

Repository navigation

Optional type args are mistyped in help #508

Example 1

Example 2

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Optional type args are mistyped in help #508

Description

Example 1

Example 2

Activity

dbieber commented on Apr 30, 2024

Jemeljanov commented on May 22, 2024

Jemeljanov commented on May 28, 2024

impredicative commented on Jul 24, 2024

ronny-rentner commented on Dec 22, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions