How to skip callback for specific functions using a decorator

[SamEdwardes]

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 tutorial 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

import typer


app = typer.Typer()


@app.callback()
def callback(ctx: typer.Context):
    commands_to_skip = ["hello"]
    if ctx.invoked_subcommand in commands_to_skip:
        return None
    print("Running the callback function")


@app.command()
def create():
    print("Creating user...")


@app.command()
def hello():
    print("I don't want the callback to run on this command.")


if __name__ == "__main__":
    app()

Description

I am looking for an approach to run the callback only on certain functions. The provided code example is the most graceful way I have found to do this so far. But I am looking for something a bit easier to maintain.

I think the ideal solution would use a decorator that I can put on a function that will tell it to skip the callback. For example.

@app.command()
@skip_callback
def hello():
    print("I don't want the callback to run on this command.")

I have been trying to come up with a way to do this, but so far nothing has worked. Does anyone have suggestions for this pattern? Or another pattern they use to skip the callback?

Operating System

macOS

Operating System Details

No response

Typer Version

0.7.0

Python Version

3.11.3

Additional Context

No response

[SamEdwardes]

For example, here is my best current effort. But it does not work because the callback gets executed before the code in the decorator does.

import functools
import typer


app = typer.Typer()
STATE = {"skip_callback": False}


def skip_callback(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        print("Skipping the callback")
        STATE["skip_callback"] = True
        return func(*args, **kwargs)
    return wrapper


@app.callback()
def callback(ctx: typer.Context):
    if STATE["skip_callback"]:
        return None
    print("Running the callback function")


@skip_callback
@app.command()
def hello():
    print("I don't want the callback to run on this command.")


if __name__ == "__main__":
    app()