Source code for robot.utils.application

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  See the License for the specific language governing permissions and
#  limitations under the License.

from __future__ import print_function

import sys

from robot.errors import (INFO_PRINTED, DATA_ERROR, STOPPED_BY_USER,
                          FRAMEWORK_ERROR, Information, DataError)

from .argumentparser import ArgumentParser
from .encoding import console_encode
from .error import get_error_details

[docs]class Application(object): def __init__(self, usage, name=None, version=None, arg_limits=None, env_options=None, logger=None, **auto_options): self._ap = ArgumentParser(usage, name, version, arg_limits, self.validate, env_options, **auto_options) self._logger = logger or DefaultLogger()
[docs] def main(self, arguments, **options): raise NotImplementedError
[docs] def validate(self, options, arguments): return options, arguments
[docs] def execute_cli(self, cli_arguments, exit=True): with self._logger:'%s %s' % (, self._ap.version)) options, arguments = self._parse_arguments(cli_arguments) rc = self._execute(arguments, options) if exit: self._exit(rc) return rc
[docs] def console(self, msg): if msg: print(console_encode(msg))
def _parse_arguments(self, cli_args): try: options, arguments = self.parse_arguments(cli_args) except Information as msg: self._report_info(msg.message) except DataError as err: self._report_error(err.message, help=True, exit=True) else:'Arguments: %s' % ','.join(arguments)) return options, arguments
[docs] def 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 """ return self._ap.parse_args(cli_args)
[docs] def execute(self, *arguments, **options): with self._logger:'%s %s' % (, self._ap.version)) return self._execute(list(arguments), options)
def _execute(self, arguments, options): try: rc = self.main(arguments, **options) except DataError as err: return self._report_error(err.message, help=True) except (KeyboardInterrupt, SystemExit): return self._report_error('Execution stopped by user.', rc=STOPPED_BY_USER) except: error, details = get_error_details(exclude_robot_traces=False) return self._report_error('Unexpected error: %s' % error, details, rc=FRAMEWORK_ERROR) else: return rc or 0 def _report_info(self, message): self.console(message) self._exit(INFO_PRINTED) def _report_error(self, message, details=None, help=False, rc=DATA_ERROR, exit=False): if help: message += '\n\nTry --help for usage information.' if details: message += '\n' + details self._logger.error(message) if exit: self._exit(rc) return rc def _exit(self, rc): sys.exit(rc)
[docs]class DefaultLogger(object):
[docs] def info(self, message): pass
[docs] def error(self, message): print(console_encode(message))
[docs] def close(self): pass
def __enter__(self): pass def __exit__(self, *exc_info): pass