Module rpa_logger.utils.args

Helpers for adding Logger parameters to ArgumentParser and parsing Logger parameters from parsed command line arguments.

'''Helpers for adding Logger parameters to `ArgumentParser` and parsing
`rpa_logger.logger.Logger` parameters from parsed command line arguments.
'''
from argparse import ArgumentParser, Namespace


def get_argparser(parser: ArgumentParser = None) -> ArgumentParser:
    '''Get `ArgumentParser` with `rpa_logger.logger.Logger` arguments

    Args:
        parser: `ArgumentParser` to add arguments to. If None, new
            `ArgumentParser` will be created.

    Returns:
        Created or modified `ArgumentParser`.
    '''
    if not parser:
        parser = ArgumentParser()

    parser.add_argument(
        '--ascii-only',
        action='store_true',
        help='Only use ascii characters in the indicators.')
    parser.add_argument(
        '--no-animation',
        dest='animation',
        action='store_false',
        help='Disable progress animations in console output.')
    parser.add_argument(
        '--no-colors',
        dest='colors',
        action='store_false',
        help='Disable colors in console output.')
    parser.add_argument(
        '--print-output-immediately',
        action='store_true',
        help=(
            'Print task output immediately as it is logged instead of '
            'printing it when the task is completed. If enabled, start of '
            'task is also printed.'))

    return parser


def get_rpa_logger_parameters(args: Namespace) -> dict:
    '''Parse `rpa_logger.logger.Logger` parameters from parsed command line
    arguments.

    Args:
        args: Parsed command line arguments.

    Returns:
        `dict` with `rpa_logger.logger.Logger` parameters.
    '''
    return dict(
        animations=args.animation,
        colors=args.colors,
        ascii_only=args.ascii_only,
        print_output_immediately=args.print_output_immediately,
    )

Functions

def get_argparser(parser: argparse.ArgumentParser = None) ‑> argparse.ArgumentParser

Get ArgumentParser with Logger arguments

Args

parser

ArgumentParser to add arguments to. If None, new ArgumentParser will be created.

Returns

Created or modified ArgumentParser.

Expand source code

def get_argparser(parser: ArgumentParser = None) -> ArgumentParser:
    '''Get `ArgumentParser` with `rpa_logger.logger.Logger` arguments

    Args:
        parser: `ArgumentParser` to add arguments to. If None, new
            `ArgumentParser` will be created.

    Returns:
        Created or modified `ArgumentParser`.
    '''
    if not parser:
        parser = ArgumentParser()

    parser.add_argument(
        '--ascii-only',
        action='store_true',
        help='Only use ascii characters in the indicators.')
    parser.add_argument(
        '--no-animation',
        dest='animation',
        action='store_false',
        help='Disable progress animations in console output.')
    parser.add_argument(
        '--no-colors',
        dest='colors',
        action='store_false',
        help='Disable colors in console output.')
    parser.add_argument(
        '--print-output-immediately',
        action='store_true',
        help=(
            'Print task output immediately as it is logged instead of '
            'printing it when the task is completed. If enabled, start of '
            'task is also printed.'))

    return parser

def get_rpa_logger_parameters(args: argparse.Namespace) ‑> dict

Parse Logger parameters from parsed command line arguments.

Args

args

Parsed command line arguments.

Returns

dict with Logger parameters.

Expand source code

def get_rpa_logger_parameters(args: Namespace) -> dict:
    '''Parse `rpa_logger.logger.Logger` parameters from parsed command line
    arguments.

    Args:
        args: Parsed command line arguments.

    Returns:
        `dict` with `rpa_logger.logger.Logger` parameters.
    '''
    return dict(
        animations=args.animation,
        colors=args.colors,
        ascii_only=args.ascii_only,
        print_output_immediately=args.print_output_immediately,
    )