model.py

Go to the documentation of this file.

#  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
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  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.running import ArgumentSpec
from robot.utils import getshortdoc, Sortable, setter
 
from .htmlutils import DocFormatter, DocToHtml, HtmlToText
from .writer import LibdocWriter
from .output import LibdocOutput, get_generation_time
 
 
 
class LibraryDoc:
 
    def __init__(self, name='', doc='', version='', type='LIBRARY', scope='TEST',
                 doc_format='ROBOT', source=None, lineno=-1):
        self.namename = name
        self._doc_doc = doc
        self.versionversion = version
        self.typetype = type
        self.scopescope = scope
        self.doc_formatdoc_formatdoc_format = doc_format
        self.sourcesource = source
        self.linenolineno = lineno
        self.initsinitsinits = ()
        self.keywordskeywordskeywords = ()
        self.type_docstype_docstype_docs = ()
 
    @property
    doc = property
    
    def doc(self):
        if self.doc_formatdoc_formatdoc_format == 'ROBOT' and '%TOC%' in self._doc_doc:
            return self._add_toc_add_toc(self._doc_doc)
        return self._doc_doc
 
    def _add_toc(self, doc):
        toc = self._create_toc_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.initsinitsinits:
            entries.append('Importing')
        if self.keywordskeywordskeywords:
            entries.append('Keywords')
        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_process_keywords(inits)
 
    @setter
    
    def keywords(self, kws):
        return self._process_keywords_process_keywords(kws)
 
    @setter
    def type_docs(self, type_docs):
        return set(type_docs)
 
    def _process_keywords(self, kws):
        for keyword in kws:
            keyword.parent = self
        return sorted(kws)
 
    @property
    all_tags = property
    
    def all_tags(self):
        return Tags(chain.from_iterable(kw.tags for kw in self.keywordskeywordskeywords))
 
    def save(self, output=None, format='HTML', theme=None):
        with LibdocOutput(output, format) as outfile:
            LibdocWriter(format, theme).write(self, outfile)
 
    def convert_docs_to_html(self):
        formatter = DocFormatter(self.keywordskeywordskeywords, self.type_docstype_docstype_docs, self.docdocdoc, self.doc_formatdoc_formatdoc_format)
        self._doc_doc = formatter.html(self.docdocdoc, intro=True)
        for item in self.initsinitsinits + self.keywordskeywordskeywords:
            # If 'shortdoc' is not set, it is generated automatically based on 'doc'
            # when accessed. Generate and set it to avoid HTML format affecting it.
            item.shortdoc = item.shortdoc
            item.doc = formatter.html(item.doc)
        for type_doc in self.type_docstype_docstype_docs:
            # Standard docs are always in ROBOT format ...
            if type_doc.type == type_doc.STANDARD:
                # ... unless they have been converted to HTML already.
                if not type_doc.doc.startswith('<p>'):
                    type_doc.doc = DocToHtml('ROBOT')(type_doc.doc)
            else:
                type_doc.doc = formatter.html(type_doc.doc)
        self.doc_formatdoc_formatdoc_format = 'HTML'
 
    def to_dictionary(self, include_private=False, theme=None):
        data = {
            'specversion': 1,
            'name': self.namename,
            'doc': self.docdocdoc,
            'version': self.versionversion,
            'generated': get_generation_time(),
            'type': self.typetype,
            'scope': self.scopescope,
            'docFormat': self.doc_formatdoc_formatdoc_format,
            'source': self.sourcesource,
            'lineno': self.linenolineno,
            'tags': list(self.all_tagsall_tagsall_tags),
            'inits': [init.to_dictionary() for init in self.initsinitsinits],
            'keywords': [kw.to_dictionary() for kw in self.keywordskeywordskeywords
                         if include_private or not kw.private],
            # 'dataTypes' was deprecated in RF 5, 'typedoc' should be used instead.
            'dataTypes': self._get_data_types_get_data_types(self.type_docstype_docstype_docs),
            'typedocs': [t.to_dictionary() for t in sorted(self.type_docstype_docstype_docs)]
        }
        if theme:
            data['theme'] = theme.lower()
        return data
 
    def _get_data_types(self, types):
        enums = sorted(t for t in types if t.type == 'Enum')
        typed_dicts = sorted(t for t in types if t.type == 'TypedDict')
        return {
            'enums': [t.to_dictionary(legacy=True) for t in enums],
            'typedDicts': [t.to_dictionary(legacy=True) for t in typed_dicts]
        }
 
    def to_json(self, indent=None, include_private=True, theme=None):
        data = self.to_dictionaryto_dictionary(include_private, theme)
        return json.dumps(data, indent=indent)
 
 
 
class KeywordDoc(Sortable):
 
    def __init__(self, name='', args=None, doc='', shortdoc='', tags=(), private=False,
                 deprecated=False, source=None, lineno=-1, parent=None):
        self.namename = name
        self.argsargs = args or ArgumentSpec()
        self.docdoc = doc
        self._shortdoc_shortdoc = shortdoc
        self.tagstags = Tags(tags)
        self.privateprivate = private
        self.deprecateddeprecated = deprecated
        self.sourcesource = source
        self.linenolineno = lineno
        self.parentparent = parent
        # Map argument types to type documentations.
        self.type_docstype_docs = {arg.name: {} for arg in self.argsargs}
 
    @property
    shortdoc = property
    
    def shortdoc(self):
        return self._shortdoc_shortdoc or self._doc_to_shortdoc_doc_to_shortdoc()
 
    def _doc_to_shortdoc(self):
        if self.parentparent and self.parentparent.doc_format == 'HTML':
            doc = HtmlToText().get_shortdoc_from_html(self.docdoc)
        else:
            doc = self.docdoc
        return ' '.join(getshortdoc(doc).splitlines())
 
    @shortdoc.setter
    
    def shortdoc(self, shortdoc):
        self._shortdoc_shortdoc = shortdoc
 
    @property
    _sort_key = property
    
    def _sort_key(self):
        return self.namename.lower()
 
    def to_dictionary(self):
        data = {
            'name': self.namename,
            'args': [self._arg_to_dict_arg_to_dict(arg) for arg in self.argsargs],
            'doc': self.docdoc,
            'shortdoc': self.shortdocshortdocshortdocshortdoc,
            'tags': list(self.tagstags),
            'source': self.sourcesource,
            'lineno': self.linenolineno
        }
        if self.privateprivate:
            data['private'] = True
        if self.deprecateddeprecated:
            data['deprecated'] = True
        return data
 
    def _arg_to_dict(self, arg):
        return {
            'name': arg.name,
            'types': arg.types_reprs,
            'typedocs': self.type_docstype_docs.get(arg.name, {}),
            'defaultValue': arg.default_repr,
            'kind': arg.kind,
            'required': arg.required,
            'repr': str(arg)
        }