Lib.robot.libdocpkg.robotbuilder.py Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sikulixapi Show documentation
Show all versions of sikulixapi Show documentation
... for visual testing and automation
# Copyright 2008-2015 Nokia Solutions and Networks
#
# 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
from robot.errors import DataError
from robot.parsing import disable_curdir_processing
from robot.running import TestLibrary, UserLibrary, UserErrorHandler
from robot.utils import split_tags_from_doc, unescape
from .model import LibraryDoc, KeywordDoc
class LibraryDocBuilder(object):
_argument_separator = '::'
def build(self, library):
name, args = self._split_library_name_and_args(library)
lib = TestLibrary(name, args)
libdoc = LibraryDoc(name=lib.name,
doc=self._get_doc(lib),
version=lib.version,
scope=str(lib.scope),
doc_format=lib.doc_format)
libdoc.inits = self._get_initializers(lib)
libdoc.keywords = KeywordDocBuilder().build_keywords(lib)
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 "Documentation for test library ``%s``." % lib.name
def _get_initializers(self, lib):
if lib.init.arguments.maxargs:
return [KeywordDocBuilder().build_keyword(lib.init)]
return []
class ResourceDocBuilder(object):
def build(self, path):
res = self._import_resource(path)
libdoc = LibraryDoc(name=res.name, doc=self._get_doc(res),
type='resource')
libdoc.keywords = KeywordDocBuilder(resource=True).build_keywords(res)
return libdoc
@disable_curdir_processing
def _import_resource(self, path):
return UserLibrary(self._find_resource_file(path))
def _find_resource_file(self, path):
if os.path.isfile(path):
return os.path.normpath(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 candidate
raise DataError("Resource file '%s' does not exist." % path)
def _get_doc(self, res):
if res.doc:
return unescape(res.doc)
return "Documentation for resource file ``%s``." % res.name
class KeywordDocBuilder(object):
def __init__(self, resource=False):
self._resource = resource
def build_keywords(self, lib):
return [self.build_keyword(kw) for kw in lib.handlers]
def build_keyword(self, kw):
doc, tags = self._get_doc_and_tags(kw)
return KeywordDoc(name=kw.name, args=self._get_args(kw.arguments),
doc=doc, tags=tags)
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 and not isinstance(kw, UserErrorHandler):
return unescape(kw.doc)
return kw.doc
def _get_args(self, argspec):
required = argspec.positional[:argspec.minargs]
defaults = zip(argspec.positional[argspec.minargs:], argspec.defaults)
args = required + ['%s=%s' % item for item in defaults]
if argspec.varargs:
args.append('*%s' % argspec.varargs)
if argspec.kwargs:
args.append('**%s' % argspec.kwargs)
return args