Use dotted.module.path:func syntax instead of typer --func=func dotted.module.path run

[lmmx]

Click to show checkboxes

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

I want to run a function step_1 in a module one in package autocli like this:

$ typer 'autocli.one:step_1' run 123
Not a valid file or Python module: autocli.one:step_1

but I can only run it with the explicit --func flag:

$ typer --func=step_1 'autocli.one' run 123
Step 1: Processing with a=123, result=processed_123.txt

For reference the demo module is:

# src/autocli/one.py
from pathlib import Path

def step_1(a: int) -> Path:
    """First step of the process."""
    result_path = Path(f"processed_{a}.txt")
    print(f"Step 1: Processing with a={a}, result={result_path}")
    return result_path

Description

The maybe_update_state function treats the input string to typer run as a "path or module", but does not support : to also append a specific function:

typer/typer/cli.py

Lines 43 to 61 in 3b17788

	def maybe_update_state(ctx: click.Context) -> None:
	path_or_module = ctx.params.get("path_or_module")
	if path_or_module:
	file_path = Path(path_or_module)
	if file_path.exists() and file_path.is_file():
	state.file = file_path
	else:
	if not re.fullmatch(r"[a-zA-Z_]\w*(\.[a-zA-Z_]\w*)*", path_or_module):
	typer.echo(
	f"Not a valid file or Python module: {path_or_module}", err=True
	)
	sys.exit(1)
	state.module = path_or_module
	app_name = ctx.params.get("app")
	if app_name:
	state.app = app_name
	func_name = ctx.params.get("func")
	if func_name:
	state.func = func_name

It could instead parse the path_or_module:function_name syntax by adding this

    if path_or_module:
+        if ":" in path_or_module:
+            module_part, func_part = path_or_module.rsplit(":", 1)
+            path_or_module = module_part
+            ctx.params.update({"func": func_part})

making it

def maybe_update_state(ctx: click.Context) -> None:
    path_or_module = ctx.params.get("path_or_module")
    if path_or_module:
        if ":" in path_or_module:
            module_part, func_part = path_or_module.rsplit(":", 1)
            path_or_module = module_part
            ctx.params.update({"func": func_part})
        file_path = Path(path_or_module)
        if file_path.exists() and file_path.is_file():
            state.file = file_path
        else:
            if not re.fullmatch(r"[a-zA-Z_]\w*(\.[a-zA-Z_]\w*)*", path_or_module):
                typer.echo(
                    f"Not a valid file or Python module: {path_or_module}", err=True
                )
                sys.exit(1)
            state.module = path_or_module
    app_name = ctx.params.get("app")
    if app_name:
        state.app = app_name
    func_name = ctx.params.get("func")
    if func_name:
        state.func = func_name

With this small change the above example would work 🎉

$ typer 'autocli.one:step_1' run 123
Step 1: Processing with a=123, result=processed_123.txt
$ typer src/autocli/one.py:step_1 run 123
Step 1: Processing with a=123, result=processed_123.txt

Operating System

Linux

Operating System Details

No response

Typer Version

0.16.0

Python Version

Python 3.13.3

Additional Context

No response

[lmmx]

Small PR submitted! 🙂

• ✨ Add module:function syntax support for typer CLI #1275