Source code for robot.libdocpkg.xmlwriter

#  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 datetime import datetime
import os.path

from robot.utils import WINDOWS, XmlWriter

from .htmlwriter import DocToHtml

[docs]class LibdocXmlWriter(object): def __init__(self, force_html_doc=False): self._force_html_doc = force_html_doc
[docs] def write(self, libdoc, outfile): formatter = DocFormatter(libdoc.doc_format, self._force_html_doc) writer = XmlWriter(outfile, usage='Libdoc spec') self._write_start(libdoc, writer, formatter) self._write_keywords('init', libdoc.inits, libdoc.source, writer, formatter) self._write_keywords('kw', libdoc.keywords, libdoc.source, writer, formatter) self._write_end(writer)
def _write_start(self, libdoc, writer, formatter): generated = datetime.utcnow().replace(microsecond=0).isoformat() + 'Z' attrs = {'name':, 'type': libdoc.type, 'format': formatter.format, 'scope': libdoc.scope, 'namedargs': 'true' if libdoc.named_args else 'false', 'generated': generated, 'specversion': '2'} self._add_source_info(attrs, libdoc, writer.output) writer.start('keywordspec', attrs) writer.element('version', libdoc.version) # TODO: Remove 'scope' and 'namedargs' elements in RF 4.0. # writer.element('scope', self._get_old_style_scope(libdoc)) writer.element('namedargs', 'yes' if libdoc.named_args else 'no') writer.element('doc', formatter(libdoc.doc)) def _add_source_info(self, attrs, item, outfile, lib_source=None): if item.source and item.source != lib_source: attrs['source'] = self._format_source(item.source, outfile) if item.lineno > 0: attrs['lineno'] = str(item.lineno) def _format_source(self, source, outfile): if not os.path.exists(source): return source source = os.path.normpath(source) if not (hasattr(outfile, 'name') and os.path.isfile( and self._on_same_drive(source, return source return os.path.relpath(source, os.path.dirname( def _on_same_drive(self, path1, path2): if not WINDOWS: return True return os.path.splitdrive(path1)[0] == os.path.splitdrive(path2)[0] def _get_old_style_scope(self, libdoc): if libdoc.type == 'RESOURCE': return '' return {'GLOBAL': 'global', 'SUITE': 'test suite', 'TEST': 'test case'}[libdoc.scope] def _write_keywords(self, kw_type, keywords, lib_source, writer, formatter): for kw in keywords: attrs = self._get_start_attrs(kw_type, kw, lib_source, writer) writer.start(kw_type, attrs) writer.start('arguments') for arg in kw.args: writer.element('arg', arg) writer.end('arguments') writer.element('doc', formatter(kw.doc)) if kw_type == 'kw' and kw.tags: writer.start('tags') for tag in kw.tags: writer.element('tag', tag) writer.end('tags') writer.end(kw_type) def _get_start_attrs(self, kw_type, kw, lib_source, writer): if kw_type == 'init': attrs = {} else: attrs = {'name':} if kw.deprecated: attrs['deprecated'] = 'true' self._add_source_info(attrs, kw, writer.output, lib_source) return attrs def _write_end(self, writer): writer.end('keywordspec') writer.close()
[docs]class DocFormatter(object): def __init__(self, doc_format, force_html=False): if force_html: self._formatter = DocToHtml(doc_format) self.format = 'HTML' else: self._formatter = lambda doc: doc self.format = doc_format def __call__(self, doc): return self._formatter(doc)