Skip to main content

AppGroup

This works similar to a regular click :class:~click.Group but it changes the behavior of the :meth:command decorator so that it automatically wraps the functions in :func:with_appcontext.

Methods


command()

@classmethod
def command(
args: t.Any,
kwargs: t.Any
) - > t.Callable[[t.Callable[..., t.Any]], click.Command]

This works exactly like the method of the same name on a regular :class:click.Group but it wraps callbacks in :func:with_appcontext unless it's disabled by passing ``with_appcontext=False`.

Parameters

NameTypeDescription
argst.AnyPositional arguments passed to the underlying click.Group.command method.
kwargst.AnyKeyword arguments passed to the underlying click.Group.command method. The 'with_appcontext' keyword argument can be used to disable automatic app context wrapping.

Returns

TypeDescription
t.Callable[[t.Callable[..., t.Any]], click.Command]A decorator that registers a command with the group.

group()

@classmethod
def group(
args: t.Any,
kwargs: t.Any
) - > t.Callable[[t.Callable[..., t.Any]], click.Group]

This works exactly like the method of the same name on a regular :class:click.Group but it defaults the group class to :class:AppGroup.

Parameters

NameTypeDescription
argst.AnyPositional arguments passed to the underlying click.Group.group method.
kwargst.AnyKeyword arguments passed to the underlying click.Group.group method. The 'cls' keyword argument is defaulted to AppGroup.

Returns

TypeDescription
t.Callable[[t.Callable[..., t.Any]], click.Group]A decorator that registers a nested group with the current group.