🔥 Remove auto naming of groups added via `add_typer` based on the group's callback function name #1052

patrick91 · 2024-11-18T13:30:38Z

While working on #1037 (allowing add_typer to extend an app), we found that callbacks are sometimes used to implicitly get a group's name.

This would happen in cases like this:

import typer

app = typer.Typer()
users_app = typer.Typer()

app.add_typer(users_app)


@users_app.callback()
def callback():
    ...

@users_app.command()
def create(name: str):
    print(f"Creating user: {name}")

Output for the above

[14:47:30] ➜ python example.py --help

 Usage: example.py [OPTIONS] COMMAND [ARGS]...

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.                                                                                    │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.                                             │
│ --help                        Show this message and exit.                                                                                                  │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ callback                                                                                                                                               │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

This is documented here: https://typer.tiangolo.com/tutorial/subcommands/name-and-help/#inferring-name-and-help-from-appcallback

With this PR, I'm proposing to remove this implicit behavior, this would make #1037 possible and without issue when using callbacks[1]

I did a quick code search and, while unfortunately GitHub only returns 5 pages of searches, it seems that almost no one is using this behaviour.

There's one interesting case, where they are pretty much using callbacks to do what #1037 should make it easier to implement:

https://github.com/pbdtools/xfds/blob/cf6f2a618ca8137a96eeb55eecadf6a61779d38c/src/xfds/_reset.py#L18-L19

And in cases where name isn't passed to add_typer, the Typer instance has a name, like here:

https://github.com/emergentmethods/flowdapt/blob/0be625437041b3b9c919f751d18969d7ce08c6b7/flowdapt/cli/db.py#L13-L18

[1] though they won't be supported in the first implementation

github-actions · 2024-11-18T13:43:37Z

📝 Docs preview for commit 3e91df4 at: https://3eeb7be0.typertiangolo.pages.dev

typer/main.py

patrick91 · 2024-11-18T14:55:08Z

@svlandeg do you have any opinion on this? 😊

tiangolo · 2024-11-18T22:31:47Z

Great write-up and investigation, thank you @patrick91! 🙇

I think this would be fine, we would release it in a new 0.x version. And it would allow new features that are worth it. I'll still wait for @svlandeg's opinion in case she sees something obvious we aren't seeing yet. 😅

github-actions · 2024-11-19T09:40:14Z

📝 Docs preview for commit f09b3c2 at: https://78985a46.typertiangolo.pages.dev

github-actions · 2024-11-19T09:45:35Z

📝 Docs preview for commit 6167f1d at: https://cb75dab2.typertiangolo.pages.dev

github-actions · 2024-11-19T10:56:12Z

📝 Docs preview for commit d55f9e9 at: https://afc212e1.typertiangolo.pages.dev

Modified Pages

https://afc212e1.typertiangolo.pages.dev/tutorial/subcommands/name-and-help/

github-actions · 2024-11-19T15:46:58Z

📝 Docs preview for commit 08552ee at: https://89a0ff7f.typertiangolo.pages.dev

Modified Pages

https://89a0ff7f.typertiangolo.pages.dev/tutorial/subcommands/name-and-help/

patrick91 · 2024-11-19T15:48:49Z

docs_src/subcommands/name_help/tutorial007.py

@@ -21,6 +21,7 @@ def new_users():
 app.add_typer(users_app, callback=new_users)


+# TODO: do we want this to work?
 @users_app.callback("call-users", help="Help from callback for users.")


@tiangolo I think we might want to remove support for this too 😊

Yep, I think so.

github-actions · 2024-11-20T11:47:00Z

📝 Docs preview for commit 3313794 at: https://8c9e9936.typertiangolo.pages.dev

Modified Pages

https://8c9e9936.typertiangolo.pages.dev/tutorial/subcommands/name-and-help/

github-actions · 2024-11-25T12:51:22Z

📝 Docs preview for commit d1a59ee at: https://8c484d8f.typertiangolo.pages.dev

Modified Pages

https://8c484d8f.typertiangolo.pages.dev/tutorial/subcommands/name-and-help/

github-actions · 2024-11-25T13:20:33Z

📝 Docs preview for commit 2584f5e at: https://9042d7ba.typertiangolo.pages.dev

Modified Pages

https://9042d7ba.typertiangolo.pages.dev/tutorial/subcommands/name-and-help/

github-actions · 2024-11-25T14:44:55Z

📝 Docs preview for commit 8dcef2b at: https://dba42811.typertiangolo.pages.dev

Modified Pages

https://dba42811.typertiangolo.pages.dev/tutorial/subcommands/name-and-help/

svlandeg

I had a detailed look into this and it does feel sensible to remove this behaviour. Great digging by Patrick to check the current usage of this in downstream applications, which appears to be pretty limited. We'd definitely have to warn users for the breaking change though.

It feels like it would make sense to also remove the help text taken from the callback, just for consistency.

I guess one final question I have is whether there's no other way to enable #1037, so we wouldn't have to touch existing behaviour.

svlandeg · 2024-11-25T13:43:01Z

docs/tutorial/subcommands/name-and-help.md

-### Name and help from callback parameter in `typer.Typer()`
+/// note
+
+In previous versions of Typer, in addition to the help text, the command name was also inferred from the callback function name, this is no longer the case.


I would specify the exact version of Typer in which this behaviour changed.

tiangolo · 2024-11-27T12:13:19Z

Thanks for the thorough review @svlandeg!

It feels like it would make sense to also remove the help text taken from the callback, just for consistency.

I think it's fine to keep support for the help from the callback, as it would only apply when there's an actual Click Group added instead of just the commands. And it would only be supported in the cases where the callback is also supported.

I guess one final question I have is whether there's no other way to enable #1037, so we wouldn't have to touch existing behaviour.

I was also thinking a bunch about this, but I think there wouldn't be a way, it was a design error from my side at the beginning, too few constraints on what is supported. 😅

Fortunately, it also didn't make much sense to many people as it's not too used. 😂

I think it's fine to remove it. We'll release a minor version with this (as Typer is pre-1.x that's equivalent to a major version) and add this in the breaking changes, with an example of how to upgrade. I think we are close to good to go.

@patrick91 let me know when you're ready for me to give it a final review and merge. 🤓

github-actions · 2024-11-27T14:45:08Z

📝 Docs preview for commit d45602e at: https://c9cd61b7.typertiangolo.pages.dev

Modified Pages

https://c9cd61b7.typertiangolo.pages.dev/tutorial/subcommands/name-and-help/

github-actions · 2024-11-27T15:23:11Z

📝 Docs preview for commit 53f65ba at: https://565ad54a.typertiangolo.pages.dev

Modified Pages

https://565ad54a.typertiangolo.pages.dev/tutorial/subcommands/name-and-help/

github-actions · 2024-11-27T15:37:06Z

📝 Docs preview for commit ff6a3ef at: https://e811c478.typertiangolo.pages.dev

Modified Pages

https://e811c478.typertiangolo.pages.dev/tutorial/subcommands/name-and-help/

github-actions · 2024-11-28T21:45:15Z

📝 Docs preview for commit 28f7d36 at: https://686d5e35.typertiangolo.pages.dev

Modified Pages

https://686d5e35.typertiangolo.pages.dev/tutorial/subcommands/name-and-help/

tiangolo

Awesome! I tweaked a tiny bit the docs to remove places that mentioned the old name, and this is now ready. 🚀

patrick91 added breaking refactor labels Nov 18, 2024

patrick91 removed the refactor label Nov 18, 2024

patrick91 commented Nov 18, 2024

View reviewed changes

typer/main.py Show resolved Hide resolved

svlandeg self-assigned this Nov 18, 2024

patrick91 commented Nov 19, 2024

View reviewed changes

svlandeg reviewed Nov 25, 2024

View reviewed changes

svlandeg assigned patrick91 and unassigned svlandeg Nov 25, 2024

patrick91 marked this pull request as ready for review November 27, 2024 15:20

patrick91 and others added 7 commits November 27, 2024 15:21

TMP: alwasy return none when getting group name

30fcad5

Update tutorials to always have a name

31160fb

Remove code and update docs

95d2208

Update docs

34e1bf7

Remove name parameter from callback

31e23ec

fix tutorial007 unit test

600ec87

Add warning

38f064f

Add warning when callback is passed but name is None

53f65ba

patrick91 force-pushed the remove-group-name-from-callback branch from d45602e to 53f65ba Compare November 27, 2024 15:21

Update docs

ff6a3ef

patrick91 requested a review from tiangolo November 28, 2024 10:24

📝 Tweak docs and example for setting help and name

28f7d36

tiangolo changed the title ~~🔥 Remove auto naming of groups added via add_typer~~ 🔥 Remove auto naming of groups added via add_typer based on the group's callback function name Nov 28, 2024

tiangolo approved these changes Nov 28, 2024

View reviewed changes

tiangolo merged commit 2d1a598 into master Nov 28, 2024
23 checks passed

tiangolo deleted the remove-group-name-from-callback branch November 28, 2024 22:06

Rugz007 mentioned this pull request Dec 4, 2024

Default Installation not working due to typer mismatch lmstudio-ai/venvstacks#96

Closed

flying-sheep mentioned this pull request Dec 10, 2024

Broken with Typer 0.14+ WaylonWalker/coverage-rich#4

Open

johnthagen mentioned this pull request Dec 11, 2024

chore(deps): update dependency typer to >0.6,<0.16 openapi-generators/openapi-python-client#1173

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🔥 Remove auto naming of groups added via `add_typer` based on the group's callback function name #1052

🔥 Remove auto naming of groups added via `add_typer` based on the group's callback function name #1052

patrick91 commented Nov 18, 2024 •

edited by tiangolo

Loading

github-actions bot commented Nov 18, 2024

patrick91 commented Nov 18, 2024

tiangolo commented Nov 18, 2024

github-actions bot commented Nov 19, 2024

github-actions bot commented Nov 19, 2024

github-actions bot commented Nov 19, 2024

github-actions bot commented Nov 19, 2024

patrick91 Nov 19, 2024

tiangolo Nov 27, 2024

github-actions bot commented Nov 20, 2024

github-actions bot commented Nov 25, 2024

github-actions bot commented Nov 25, 2024

github-actions bot commented Nov 25, 2024

svlandeg left a comment

svlandeg Nov 25, 2024

tiangolo commented Nov 27, 2024

github-actions bot commented Nov 27, 2024

github-actions bot commented Nov 27, 2024

github-actions bot commented Nov 27, 2024

github-actions bot commented Nov 28, 2024

tiangolo left a comment

🔥 Remove auto naming of groups added via add_typer based on the group's callback function name #1052

🔥 Remove auto naming of groups added via add_typer based on the group's callback function name #1052

Conversation

patrick91 commented Nov 18, 2024 • edited by tiangolo Loading

github-actions bot commented Nov 18, 2024

patrick91 commented Nov 18, 2024

tiangolo commented Nov 18, 2024

github-actions bot commented Nov 19, 2024

github-actions bot commented Nov 19, 2024

github-actions bot commented Nov 19, 2024

Modified Pages

github-actions bot commented Nov 19, 2024

Modified Pages

patrick91 Nov 19, 2024

Choose a reason for hiding this comment

tiangolo Nov 27, 2024

Choose a reason for hiding this comment

github-actions bot commented Nov 20, 2024

Modified Pages

github-actions bot commented Nov 25, 2024

Modified Pages

github-actions bot commented Nov 25, 2024

Modified Pages

github-actions bot commented Nov 25, 2024

Modified Pages

svlandeg left a comment

Choose a reason for hiding this comment

svlandeg Nov 25, 2024

Choose a reason for hiding this comment

tiangolo commented Nov 27, 2024

github-actions bot commented Nov 27, 2024

Modified Pages

github-actions bot commented Nov 27, 2024

Modified Pages

github-actions bot commented Nov 27, 2024

Modified Pages

github-actions bot commented Nov 28, 2024

Modified Pages

tiangolo left a comment

Choose a reason for hiding this comment

🔥 Remove auto naming of groups added via `add_typer` based on the group's callback function name #1052

🔥 Remove auto naming of groups added via `add_typer` based on the group's callback function name #1052

patrick91 commented Nov 18, 2024 •

edited by tiangolo

Loading