Replace Typer app with click cli #47

evenharder · 2025-08-17T13:32:43Z

Replace main typer app of pyodide-cli with click group.

As pytest depends on Typer's rich help integration which yields the origin of the subcommand,
it was implemented by subclassing click.Group. The following is an excerpt from pytest.

pyodide_cli/tests/test_cli.py::test_plugin_origin Usage: pyodide [OPTIONS] COMMAND [ARGS]...

  A command line interface for Pyodide.

  Other CLI subcommands are registered via the plugin system by installing
  Pyodide ecosystem packages (e.g. pyodide-build, pyodide-pack, auditwheel-
  emscripten, etc.)

Options:
  --version  Show the version of the Pyodide CLI
  --help     Show this message and exit.

Commands Registered by plugin-test:
  plugin_test_app   Test help message short desc
  plugin_test_cli   Test help message short desc
  plugin_test_func  Test help message short desc

Technically typer_kwargs is still supported. Perhaps we may need to introduce click_kwargs later on as a substitute.

I expect the overall behavior to be compatible, barring subtle difference due to different default behavior of click and typer.

Related: pyodide/pyodide-build#204

Typer app is now a click cli as Typer rich panel is not supported in click, pytest fails as package source is not printed

as click does not support `rich_help_panel` by default, grouping by origin was reimplemented by overriding some of the functions of click.Group

even though our mission is to drop Typer, we need to defer breaking changes

we need to update help message anyway, whether the module is either click command, typer app, or any other format

introduce click cli object with custom commands in pytest note that `test_plugin_origin` checks OriginGroup help while `test_plugin_origin_subcommand` checks imported module's help

let click checks if name is None and raise

for more information, see https://pre-commit.ci

ryanking13

Thanks for working on this @evenharder!

Overall the change looks good. But I found that I am getting an error when I call any subcommands on my local machine. Could you please take a look on that?

Interestingly, --help works fine.

ryanking13 · 2025-08-18T09:37:11Z

pyodide_cli/tests/test_cli.py


 def test_plugin_origin(plugins):
    output = check_output(["pyodide", "--help"]).decode("utf-8")
-    msg = "Registered by: plugin-test"


Why is this message changed?

The command section message is currently displayed as Commands Registered by <source>:, instead of Commands Registered by: <source> If the original message suits better, I will revert the change.

I see. I think this one is better. Thanks. Could you also update here too for consistency?

The referenced message is appended to the long help message of each subcommands, which is slightly different from what test_plugin_origin is checking (it is checked in test_plugin_origin_subcommand instead). Would you like to update it as well?

Yes, I think it is good to be consistent.

pyodide_cli/app.py

ryanking13 · 2025-08-18T09:54:29Z

pyodide_cli/app.py

+                    # NOTE: gettext is used in click! Any i18n support?
+                    with formatter.section(f"{gettext('Commands')}{source_desc}"):
+                        formatter.write_dl(rows)


Let's remove this prefix. I don't think we need to care about i18n, and it looks a bit verbose to me.

Do you prefer removing Commands in this case? If that's the case, I would like to preserve it only when the subcommand was added without origin.

when the subcommand was added without origin

When can this happen?

I thought the commands provided by pyodide-cli would be, please correct me if I am wrong or it is an unintended scenario.

pyodide-cli is a meta package and will not provide any subcommands.

ryanking13 · 2025-08-18T09:56:59Z

pyodide_cli/app.py

+                cmd = click.Command(
+                    plugin_name,
+                    callback=module,
+                    help=help_with_origin,
+                )


evenharder · 2025-08-20T10:45:47Z

Overall the change looks good. But I found that I am getting an error when I call any subcommands on my local machine. Could you please take a look on that?

I am also testing on my local and it does yield some unexpected behaviors. I will investigate it a bit more.

evenharder · 2025-09-02T11:18:09Z

Overall the change looks good. But I found that I am getting an error when I call any subcommands on my local machine. Could you please take a look on that?

I am also testing on my local and it does yield some unexpected behaviors. I will investigate it a bit more.

After some thorough investigation, non-typer functions should not be directly passed as a callback. One example is pyodide venv, which behaves like typer app, accepts typer arguments but is not a typer object. This means we have to stick to the original implementation as of now (wrap the callable in the typer object, then acquire as a click command).

ryanking13 · 2025-09-03T11:24:30Z

After some thorough investigation, non-typer functions should not be directly passed as a callback. One example is pyodide venv, which behaves like typer app, accepts typer arguments but is not a typer object. This means we have to stick to the original implementation as of now (wrap the callable in the typer object, then acquire as a click command).

Huh, I see. Thanks for the explanation. This kind of refactoring is always tricky and have many edge cases.

ryanking13

Thanks! I left some minor comments, otherwise looks good to me.

I think we can start refactoring other downstream packages after merging this. Could you please update CHANGELOG? I think we can release this with a version 0.4.0

Directly passing module as a click callback yields a weird behavior when the module is a function which accepts yper arguments and options In this case, their default values are neither checked nor assigned. To properly handle, construct typer app and append as a command. Actually this is identical to the original implementation except registering origins! Additionally, we have to reassign the help message of the original command. I am not sure if direct manipulation of attribute of click is a good idea...

Print 'Commands' section only once (if command exists) with removal of i18n support of 'Commands'.

now 'Registered by {pkgname}:' is used instead.

evenharder · 2025-09-09T12:36:37Z

I have updated the changelog as well, please review!

ryanking13 · 2025-09-12T09:36:58Z

@evenharder I just released 0.4.0. Thanks!

evenharder and others added 7 commits August 10, 2025 21:31

Replace Typer with click

78d00c8

Typer app is now a click cli as Typer rich panel is not supported in click, pytest fails as package source is not printed

Show origin of subcommands in click

fa21139

as click does not support `rich_help_panel` by default, grouping by origin was reimplemented by overriding some of the functions of click.Group

Support typer_kwargs compatibility

374a4aa

even though our mission is to drop Typer, we need to defer breaking changes

Construct a new click command regardless of module

1299c92

we need to update help message anyway, whether the module is either click command, typer app, or any other format

Add click cli test with clarification

1a5a0eb

introduce click cli object with custom commands in pytest note that `test_plugin_origin` checks OriginGroup help while `test_plugin_origin_subcommand` checks imported module's help

Refine name handling in OriginGroup

5a4ec40

let click checks if name is None and raise

[pre-commit.ci] auto fixes from pre-commit.com hooks

cff02d3

for more information, see https://pre-commit.ci

ryanking13 reviewed Aug 18, 2025

View reviewed changes

evenharder added 2 commits August 20, 2025 19:27

Update mypy depedency of click and typer

ffbd85e

Fix typer import

2190053

ryanking13 approved these changes Sep 3, 2025

View reviewed changes

evenharder added 2 commits September 7, 2025 23:09

Remove 'Command' prefix for every origin

9f76ca0

Print 'Commands' section only once (if command exists) with removal of i18n support of 'Commands'.

evenharder force-pushed the replace-with-click branch from 78b2e9d to 9f76ca0 Compare September 7, 2025 14:09

evenharder added 2 commits September 7, 2025 23:23

Fix consistency of register message

7ed7be9

now 'Registered by {pkgname}:' is used instead.

Update CHANGELOG for 0.4.0

fad12a7

ryanking13 merged commit e81bb02 into pyodide:main Sep 12, 2025
3 checks passed

Replace Typer app with click cli #47

Replace Typer app with click cli #47

Uh oh!

Conversation

evenharder commented Aug 17, 2025

Uh oh!

ryanking13 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

evenharder commented Aug 20, 2025

Uh oh!

evenharder commented Sep 2, 2025

Uh oh!

ryanking13 commented Sep 3, 2025

Uh oh!

ryanking13 left a comment

Choose a reason for hiding this comment

Uh oh!

evenharder commented Sep 9, 2025

Uh oh!

Uh oh!

ryanking13 commented Sep 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants