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.
 
from itertools import chain
 
from robotide.lib.robot.model import Tags
from robotide.lib.robot.utils import getshortdoc, Sortable, setter
 
from .writer import LibdocWriter
from .output import LibdocOutput
 
 
class LibraryDoc():
 
    def __init__(self, name='', doc='', version='', type='library',
                 scope='', named_args=True, doc_format=''):
        self.namename = name
        self.docdoc = doc
        self.versionversion = version
        self.typetype = type
        self.scopescope = scope
        self.named_argsnamed_args = named_args
        self.doc_formatdoc_formatdoc_format = doc_format
        self.initsinits = []
        self.keywordskeywordskeywords = []
 
    @setter
    def doc_format(self, format):
        return format or 'ROBOT'
 
    @setter
    def keywords(self, kws):
        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'):
        with LibdocOutput(output, format) as outfile:
            LibdocWriter(format).write(self, outfile)
 
 
class KeywordDoc(Sortable):
 
    def __init__(self, name='', args=(), doc='', tags=()):
        self.namename = name
        self.argsargs = args
        self.docdoc = doc
        self.tagstags = Tags(tags)
 
    @property
    shortdoc = property
    
    def shortdoc(self):
        return getshortdoc(self.docdoc)
 
    @property
    _sort_key = property
    
    def _sort_key(self):
        return self.namename.lower()