Source code for robot.libdocpkg.model

#  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.

import json
import re
from itertools import chain

from robot.model import Tags
from robot.utils import (IRONPYTHON, getshortdoc, get_timestamp,
                         Sortable, setter, unicode)

from .datatypes import DataTypeCatalog
from .htmlutils import HtmlToText, DocFormatter
from .writer import LibdocWriter
from .output import LibdocOutput

[docs]class LibraryDoc(object): def __init__(self, name='', doc='', version='', type='LIBRARY', scope='TEST', doc_format='ROBOT', source=None, lineno=-1): = name self._doc = doc self.version = version self.type = type self.scope = scope self.doc_format = doc_format self.source = source self.lineno = lineno self.data_types = DataTypeCatalog() self.inits = [] self.keywords = [] @property def doc(self): if self.doc_format == 'ROBOT' and '%TOC%' in self._doc: return self._add_toc(self._doc) return self._doc def _add_toc(self, doc): toc = self._create_toc(doc) return '\n'.join(line if line.strip() != '%TOC%' else toc for line in doc.splitlines()) def _create_toc(self, doc): entries = re.findall(r'^\s*=\s+(.+?)\s+=\s*$', doc, flags=re.MULTILINE) if self.inits: entries.append('Importing') if self.keywords: entries.append('Keywords') if self.data_types: entries.append('Data types') return '\n'.join('- `%s`' % entry for entry in entries) @setter def doc_format(self, format): return format or 'ROBOT' @setter def inits(self, inits): return self._process_keywords(inits) @setter def keywords(self, kws): return self._process_keywords(kws) def _process_keywords(self, kws): for keyword in kws: self._add_types_from_keyword(keyword) keyword.parent = self keyword.generate_shortdoc() return sorted(kws) def _add_types_from_keyword(self, keyword): for arg in keyword.args: self.data_types.update(arg.types) @property def all_tags(self): return Tags(chain.from_iterable(kw.tags for kw in self.keywords))
[docs] def save(self, output=None, format='HTML'): with LibdocOutput(output, format) as outfile: LibdocWriter(format).write(self, outfile)
[docs] def convert_docs_to_html(self): formatter = DocFormatter(self.keywords, self.data_types, self.doc, self.doc_format) self._doc = formatter.html(self.doc, intro=True) self.doc_format = 'HTML' for init in self.inits: init.doc = formatter.html(init.doc) for keyword in self.keywords: keyword.doc = formatter.html(keyword.doc) for type_doc in self.data_types: type_doc.doc = formatter.html(type_doc.doc)
[docs] def to_dictionary(self): return { 'name':, 'doc': self.doc, 'version': self.version, 'generated': get_timestamp(daysep='-', millissep=None), 'type': self.type, 'scope': self.scope, 'docFormat': self.doc_format, 'source': self.source, 'lineno': self.lineno, 'tags': list(self.all_tags), 'inits': [init.to_dictionary() for init in self.inits], 'keywords': [kw.to_dictionary() for kw in self.keywords], 'dataTypes': self.data_types.to_dictionary() }
[docs] def to_json(self, indent=None): data = self.to_dictionary() if IRONPYTHON: # Workaround for data = self._unicode_to_utf8(data) return json.dumps(data, indent=indent)
def _unicode_to_utf8(self, data): if isinstance(data, dict): return {self._unicode_to_utf8(key): self._unicode_to_utf8(value) for key, value in data.items()} if isinstance(data, (list, tuple)): return [self._unicode_to_utf8(item) for item in data] if isinstance(data, unicode): return data.encode('UTF-8') return data
[docs]class KeywordDoc(Sortable): def __init__(self, name='', args=(), doc='', shortdoc='', tags=(), source=None, lineno=-1, parent=None): = name self.args = args self.doc = doc self._shortdoc = shortdoc self.tags = Tags(tags) self.source = source self.lineno = lineno self.parent = parent @property def shortdoc(self): if self._shortdoc: return self._shortdoc return self._get_shortdoc() def _get_shortdoc(self): doc = self.doc if self.parent and self.parent.doc_format == 'HTML': doc = HtmlToText().get_shortdoc_from_html(doc) return ' '.join(getshortdoc(doc).splitlines()) @shortdoc.setter def shortdoc(self, shortdoc): self._shortdoc = shortdoc @property def deprecated(self): return self.doc.startswith('*DEPRECATED') and '*' in self.doc[1:] @property def _sort_key(self): return
[docs] def generate_shortdoc(self): if not self._shortdoc: self.shortdoc = self._get_shortdoc()
[docs] def to_dictionary(self): return { 'name':, 'args': [self._arg_to_dict(arg) for arg in self.args], 'doc': self.doc, 'shortdoc': self.shortdoc, 'tags': list(self.tags), 'source': self.source, 'lineno': self.lineno }
def _arg_to_dict(self, arg): return { 'name':, 'types': arg.types_reprs, 'defaultValue': arg.default_repr, 'kind': arg.kind, 'required': arg.required, 'repr': unicode(arg) }