Source code for robot.output.debugfile

#  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 robot.errors import DataError
from robot.utils import get_timestamp, file_writer, seq2str2

from .logger import LOGGER
from .loggerhelper import IsLogged

[docs]def DebugFile(path): if not path:'No debug file') return None try: outfile = file_writer(path, usage='debug') except DataError as err: LOGGER.error(err.message) return None else:'Debug file: %s' % path) return _DebugFileWriter(outfile)
class _DebugFileWriter: _separators = {'SUITE': '=', 'TEST': '-', 'KEYWORD': '~'} def __init__(self, outfile): self._indent = 0 self._kw_level = 0 self._separator_written_last = False self._outfile = outfile self._is_logged = IsLogged('DEBUG') def start_suite(self, suite): self._separator('SUITE') self._start('SUITE', suite.longname) self._separator('SUITE') def end_suite(self, suite): self._separator('SUITE') self._end('SUITE', suite.longname, suite.elapsedtime) self._separator('SUITE') if self._indent == 0: LOGGER.output_file('Debug', self.close() def start_test(self, test): self._separator('TEST') self._start('TEST', self._separator('TEST') def end_test(self, test): self._separator('TEST') self._end('TEST',, test.elapsedtime) self._separator('TEST') def start_keyword(self, kw): if self._kw_level == 0: self._separator('KEYWORD') self._start(kw.type,, kw.args) self._kw_level += 1 def end_keyword(self, kw): self._end(kw.type,, kw.elapsedtime) self._kw_level -= 1 def log_message(self, msg): if self._is_logged(msg.level): self._write(msg.message, level=msg.level, timestamp=msg.timestamp) def close(self): if not self._outfile.closed: self._outfile.close() def _start(self, type_, name, args=''): args = ' ' + seq2str2(args) self._write('+%s START %s: %s%s' % ('-'*self._indent, type_, name, args)) self._indent += 1 def _end(self, type_, name, elapsed): self._indent -= 1 self._write('+%s END %s: %s (%s)' % ('-'*self._indent, type_, name, elapsed)) def _separator(self, type_): self._write(self._separators[type_] * 78, separator=True) def _write(self, text, separator=False, level='INFO', timestamp=None): if separator and self._separator_written_last: return if not separator: text = '%s - %s - %s' % (timestamp or get_timestamp(), level, text) self._outfile.write(text.rstrip() + '\n') self._outfile.flush() self._separator_written_last = separator