Source code for robot.libdocpkg.builder

#  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

from robot.errors import DataError
from robot.utils import JYTHON, JAVA_VERSION, get_error_message

from .robotbuilder import LibraryDocBuilder, ResourceDocBuilder
from .specbuilder import SpecDocBuilder
from .jsonbuilder import JsonDocBuilder
if JYTHON:
    if JAVA_VERSION < (1, 9):
        from .javabuilder import JavaDocBuilder
    else:
        from .java9builder import JavaDocBuilder
else:
[docs] def JavaDocBuilder(): raise DataError('Documenting Java test libraries requires Jython.')
RESOURCE_EXTENSIONS = ('resource', 'robot', 'txt', 'tsv', 'rst', 'rest') SPEC_EXTENSIONS = ('xml', 'libspec')
[docs]def LibraryDocumentation(library_or_resource, name=None, version=None, doc_format=None): builder = DocumentationBuilder(library_or_resource) try: libdoc = builder.build(library_or_resource) except DataError: raise except: raise DataError("Building library '%s' failed: %s" % (library_or_resource, get_error_message())) if name: libdoc.name = name if version: libdoc.version = version if doc_format: libdoc.doc_format = doc_format return libdoc
[docs]def DocumentationBuilder(library_or_resource): extension = os.path.splitext(library_or_resource)[1][1:].lower() if extension in RESOURCE_EXTENSIONS: return ResourceDocBuilder() if extension in SPEC_EXTENSIONS: return SpecDocBuilder() if extension == 'json': return JsonDocBuilder() if extension == 'java': return JavaDocBuilder() return LibraryDocBuilder()