# 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 os
import sys
import re
from robot.errors import DataError
from robot.running import (ArgumentSpec, ResourceFileBuilder, TestLibrary,
TestSuiteBuilder, TypeInfo)
from robot.utils import is_string, split_tags_from_doc, unescape
from robot.variables import search_variable
from .datatypes import TypeDoc
from .model import LibraryDoc, KeywordDoc
[docs]
class LibraryDocBuilder:
_argument_separator = '::'
[docs]
def build(self, library):
name, args = self._split_library_name_and_args(library)
lib = TestLibrary.from_name(name, args=args)
libdoc = LibraryDoc(name=lib.name,
doc=self._get_doc(lib),
version=lib.version,
scope=lib.scope.name,
doc_format=lib.doc_format,
source=lib.source,
lineno=lib.lineno)
libdoc.inits = self._get_initializers(lib)
libdoc.keywords = KeywordDocBuilder().build_keywords(lib)
libdoc.type_docs = self._get_type_docs(libdoc.inits + libdoc.keywords,
lib.converters)
return libdoc
def _split_library_name_and_args(self, library):
args = library.split(self._argument_separator)
name = args.pop(0)
return self._normalize_library_path(name), args
def _normalize_library_path(self, library):
path = library.replace('/', os.sep)
if os.path.exists(path):
return os.path.abspath(path)
return library
def _get_doc(self, lib):
return lib.doc or f"Documentation for library ``{lib.name}``."
def _get_initializers(self, lib):
if lib.init.args:
return [KeywordDocBuilder().build_keyword(lib.init)]
return []
def _get_type_docs(self, keywords, custom_converters):
all_type_docs = {}
for kw in keywords:
for name, type_info in self._yield_names_and_infos(kw.args):
type_docs = kw.type_docs.setdefault(name, {})
type_doc = TypeDoc.for_type(type_info, custom_converters)
if type_doc:
type_docs[type_info.name] = type_doc.name
all_type_docs.setdefault(type_doc, set()).add(kw.name)
for type_doc, usages in all_type_docs.items():
type_doc.usages = sorted(usages, key=str.lower)
return set(all_type_docs)
def _yield_names_and_infos(self, args: ArgumentSpec):
for arg in args:
for type_info in self._yield_infos(arg.type):
yield arg.name, type_info
if args.return_type:
for type_info in self._yield_infos(args.return_type):
yield 'return', type_info
def _yield_infos(self, info: TypeInfo):
if not info.is_union:
yield info
for nested in info.nested or ():
yield from self._yield_infos(nested)
[docs]
class ResourceDocBuilder:
type = 'RESOURCE'
[docs]
def build(self, path):
path = self._find_resource_file(path)
resource, name = self._import_resource(path)
libdoc = LibraryDoc(name=name,
doc=self._get_doc(resource, name),
type=self.type,
scope='GLOBAL',
source=resource.source,
lineno=1)
libdoc.keywords = KeywordDocBuilder(resource=True).build_keywords(resource)
return libdoc
def _import_resource(self, path):
resource = ResourceFileBuilder(process_curdir=False).build(path)
return resource, resource.name
def _find_resource_file(self, path):
if os.path.isfile(path):
return os.path.normpath(os.path.abspath(path))
for dire in [item for item in sys.path if os.path.isdir(item)]:
candidate = os.path.normpath(os.path.join(dire, path))
if os.path.isfile(candidate):
return os.path.abspath(candidate)
raise DataError(f"Resource file '{path}' does not exist.")
def _get_doc(self, resource, name):
if resource.doc:
return unescape(resource.doc)
return f"Documentation for resource file ``{name}``."
[docs]
class SuiteDocBuilder(ResourceDocBuilder):
type = 'SUITE'
def _import_resource(self, path):
builder = TestSuiteBuilder(process_curdir=False)
if os.path.basename(path).lower() == '__init__.robot':
path = os.path.dirname(path)
builder.allow_empty_suite = True
# Hack to disable parsing nested files.
builder.included_files = ('-no-files-included-',)
suite = builder.build(path)
return suite.resource, suite.name
def _get_doc(self, resource, name):
return f"Documentation for keywords in suite ``{name}``."
[docs]
class KeywordDocBuilder:
def __init__(self, resource=False):
self._resource = resource
[docs]
def build_keywords(self, owner):
return [self.build_keyword(kw) for kw in owner.keywords]
[docs]
def build_keyword(self, kw):
doc, tags = self._get_doc_and_tags(kw)
if kw.error:
doc = f'*Creating keyword failed:* {kw.error}'
if not self._resource:
self._escape_strings_in_defaults(kw.args.defaults)
if kw.args.embedded:
self._remove_embedded(kw.args)
return KeywordDoc(name=kw.name,
args=kw.args,
doc=doc,
tags=tags,
private=tags.robot('private'),
deprecated=doc.startswith('*DEPRECATED') and '*' in doc[1:],
source=kw.source,
lineno=kw.lineno)
def _escape_strings_in_defaults(self, defaults):
for name, value in defaults.items():
if is_string(value):
value = re.sub(r'[\\\r\n\t]', lambda x: repr(str(x.group()))[1:-1], value)
value = self._escape_variables(value)
defaults[name] = re.sub('^(?= )|(?<= )$|(?<= )(?= )', r'\\', value)
def _escape_variables(self, value):
result = ''
match = search_variable(value)
while match:
result += r'%s\%s{%s}' % (match.before, match.identifier,
self._escape_variables(match.base))
for item in match.items:
result += '[%s]' % self._escape_variables(item)
match = search_variable(match.after)
return result + match.string
def _get_doc_and_tags(self, kw):
doc = self._get_doc(kw)
doc, tags = split_tags_from_doc(doc)
return doc, kw.tags + tags
def _get_doc(self, kw):
if self._resource:
return unescape(kw.doc)
return kw.doc
def _remove_embedded(self, spec: ArgumentSpec):
embedded = len(spec.embedded)
pos_only = len(spec.positional_only)
spec.positional_only = spec.positional_only[embedded:]
if embedded > pos_only:
spec.positional_or_named = spec.positional_or_named[embedded-pos_only:]
spec.embedded = ()