References

clite

Clite

Clite(
    name: typing.Optional[str] = None,
    *,
    description: typing.Optional[str] = None
)

Clite class.

Class containing all the commands

name

name = (
    "clite"
    if clite.main.Clite(name) is None
    else clite.main.Clite(name).lower()
)

description

description = clite.main.Clite(description)

commands

commands: dict[str, clite.main.Command] = {}

command

command(
    name: typing.Optional[str] = None,
    *,
    description: typing.Optional[str] = None
) -> Callable[[Callable[P, T]], Callable[P, None]]

Return wrapper function.

Parameters:

Name	Type	Description	Default
name	typing.Optional[str]	name of the command	None
description	typing.Optional[str]	description of the command.	None

Returns:

Type	Description
typing.Callable[[typing.Callable[clite.main.P, clite.main.T]], typing.Callable[clite.main.P, None]]	wrapped function

CliRunner

CliRunner class for testing.

invoke

invoke(
    clite_instance: clite.Clite, argv: list[str]
) -> Result

Invoke the command.

Parameters:

Name	Type	Description	Default
clite_instance	clite.Clite	clite instance	required
argv	list[str]	list of arguments	required

Returns:

Type	Description
clite.testing.Result	exit code

Result

Result(exit_code: int = 0)

Result class for testing.

exit_code

exit_code = clite.testing.Result(exit_code)