Can we have support for typing_extensions.Doc (PEP 727)?

[jeroendecroos]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the Typer documentation, with the integrated search.
• I already searched in Google "How to X in Typer" and didn't find any information.
• I already read and followed all the tutorials in the docs and didn't find an answer.
• I already checked if it is not related to Typer but to Click.

Commit to Help

• I commit to help with one of those options 👆

Example Code

# call with --help
from typing import Annotated
from typing_extensions import Doc
import typer

app = typer.Typer()

@app.command()
def doc_ext(
    arg_help: Annotated[
        int,
        Doc("doc help should not appear if arg help is set"),
        typer.Argument(help="arg help should appear")
        ],
    arg_doc_help: Annotated[
        int,
        Doc("doc help should appear if no typer arg is set")
        ],
    arg_help_doc_help: Annotated[
        int,
        Doc("doc help should appear if typer arg does not contain help"),
        typer.Argument(),
        ],
    opt_help: Annotated[
        int,
        Doc("doc help should not appear if opt help is set"),
        typer.Option(help="opt help should appear")
        ] = None,
    opt_doc_help: Annotated[
        int,
        Doc("doc help should appear if no typer opt is set")
        ] = None,
    opt_help_doc_help: Annotated[
        int,
        Doc("doc help should appear if typer opt does not contain help"),
        typer.Option(),
        ] = None,
    ):
    """ Something something
    """
    pass

app()

Description

You might be familiar with https://peps.python.org/pep-0727/ ;-)

I like the general idea and although it seems the pep won't be accepted in it's current form, the support is there in typing_extension.

Adding it in typer will allow users to integrate nicely with other tools that provide support for typing_extensions.doc (e.g. https://mkdocstrings.github.io/griffe-typingdoc/)

I've done a tentative implementation and will open a PR. I've added tests but not yet documentation. I can add that if this feature has a chance of acceptance.

Operating System

Linux, Windows

Operating System Details

No response

Typer Version

0.15.1 (clone from main)

Python Version

3.12.8

Additional Context

No response

[jeroendecroos]

PR: #1111