robot.utils.application.Application Class Reference

Public Member Functions
def	__init__ (self, usage, name=None, version=None, arg_limits=None, env_options=None, logger=None, **auto_options)
def	console (self, msg)
def	execute (self, *arguments, **options)
def	execute_cli (self, cli_arguments, exit=True)
def	main (self, arguments, **options)
def	parse_arguments (self, cli_args)
	Public interface for parsing command line arguments. More...
def	validate (self, options, arguments)

Private Member Functions
def	_execute (self, arguments, options)
def	_exit (self, rc)
def	_parse_arguments (self, cli_args)
def	_report_error (self, message, details=None, help=False, rc=DATA_ERROR, exit=False)
def	_report_info (self, message)

Private Attributes
	_ap
	_logger

Detailed Description

Definition at line 26 of file application.py.

Constructor & Destructor Documentation

__init__()

def robot.utils.application.Application.__init__	(		self,
			usage,
			name = None,
			version = None,
			arg_limits = None,
			env_options = None,
			logger = None,
		**	auto_options
	)

Definition at line 28 of file application.py.

Member Function Documentation

_execute()

def robot.utils.application.Application._execute (   self,   arguments,   options  )

private

Definition at line 79 of file application.py.

_exit()

def robot.utils.application.Application._exit (   self,   rc  )

private

Definition at line 109 of file application.py.

_parse_arguments()

def robot.utils.application.Application._parse_arguments (   self,   cli_args  )

private

Definition at line 53 of file application.py.

_report_error()

def robot.utils.application.Application._report_error (   self,   message,   details = None,   help = False,   rc = DATA_ERROR,   exit = False  )

private

Definition at line 98 of file application.py.

_report_info()

def robot.utils.application.Application._report_info (   self,   message  )

private

Definition at line 94 of file application.py.

console()

def robot.utils.application.Application.console	(		self,
			msg
	)

Definition at line 49 of file application.py.

execute()

def robot.utils.application.Application.execute	(		self,
		*	arguments,
		**	options
	)

Definition at line 74 of file application.py.

execute_cli()

def robot.utils.application.Application.execute_cli	(		self,
			cli_arguments,
			exit = True
	)

Definition at line 40 of file application.py.

main()

def robot.utils.application.Application.main	(		self,
			arguments,
		**	options
	)

Definition at line 34 of file application.py.

parse_arguments()

def robot.utils.application.Application.parse_arguments	(		self,
			cli_args
	)

Public interface for parsing command line arguments.

    :param    cli_args: Command line arguments as a list
    :returns: options (dict), arguments (list)
    :raises:  :class:`~robot.errors.Information` when --help or --version used
    :raises:  :class:`~robot.errors.DataError` when parsing fails

Definition at line 71 of file application.py.

validate()

def robot.utils.application.Application.validate	(		self,
			options,
			arguments
	)

Definition at line 37 of file application.py.

Member Data Documentation

_ap

robot.utils.application.Application._ap

private

Definition at line 30 of file application.py.

_logger

robot.utils.application.Application._logger

private

Definition at line 32 of file application.py.

---

The documentation for this class was generated from the following file:

• src/robot/utils/application.py