Generic Console Handlers

Overview¶

Description¶

Generic console handlers for common tasks.

See PyPoE/LICENSE

class PyPoE.cli.handler.BaseHandler(sub_parser, *args, **kwargs)[source]¶

Other handlers should inherit this one.

class PyPoE.cli.handler.ConfigHandler(sub_parser, config)[source]¶

Handler for config related tasks.

Sets up some basic config commands under the config sub menu.

Warning

Should be included in any application that uses the cli config

__init__(sub_parser, config)[source]¶

Parameters:	sub_parser (`argparse.ArgumentParser.add_subparsers()`) – sub parsers object config (ConfigHelper) – config instance
Raises:	`PyPoE.cli.config.ConfigError` – if config validation failed

get(args)[source]¶

Prints the config setting for the specified var.

Parameters:	args (argparse.Namespace) – namespace object as passed from argument parser
Returns:	success code
Return type:	int

print_all(args)[source]¶

Prints all currently registered config variables.

Parameters:	args (argparse.Namespace) – namespace object as passed from argument parser
Returns:	success code
Return type:	int

print_debug(args)[source]¶

Prints out the entire config as string.

Parameters:	args (argparse.Namespace) – namespace object as passed from argument parser
Returns:	success code
Return type:	int

set(args)[source]¶

Sets the specified config setting to the specified value.

Parameters:	args (argparse.Namespace) – namespace object as passed from argument parser
Returns:	success code
Return type:	int

class PyPoE.cli.handler.SetupHandler(sub_parser, config)[source]¶

Handler for config setup related tasks.

Setups up the commands under the “setup” sub menu.

Warning

Should be included in any application that uses the cli config

__init__(sub_parser, config)[source]¶

Parameters:	sub_parser (`argparse.ArgumentParser.add_subparsers()`) – sub parsers object config (ConfigHelper) – config instance

setup(args)[source]¶

Performs the setup (if needed)

Parameters:	args (argparse.Namespace) – namespace object as passed from argument parser
Returns:	success code
Return type:	int