imports.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 os
 
from robotide.lib.robot.utils import seq2str
 
from .itemlist import ItemList
 
 
class Import():
    ALLOWED_TYPES = ('Library', 'Resource', 'Variables')
 
    def __init__(self, type, name, args=(), alias=None, source=None):
        if type not in self.ALLOWED_TYPESALLOWED_TYPES:
            raise ValueError("Invalid import type '%s'. Should be one of %s."
                             % (type, seq2str(self.ALLOWED_TYPESALLOWED_TYPES, lastsep=' or ')))
        self.typetype = type
        self.namename = name
        self.argsargs = args
        self.aliasalias = alias
        self.sourcesource = source
 
    @property
    directory = property
    
    def directory(self):
        if not self.sourcesource:
            return None
        if os.path.isdir(self.sourcesource):
            return self.sourcesource
        return os.path.dirname(self.sourcesource)
 
    def report_invalid_syntax(self, message, level='ERROR'):
        from robotide.lib.robot.output import LOGGER
        LOGGER.write("Error in file '%s': %s"
                     % (self.sourcesource or '<unknown>', message), level)
 
 
class Imports(ItemList):
 
    def __init__(self, source, imports=None):
        ItemList.__init__(self, Import, {'source': source}, items=imports)
 
    def library(self, name, args=(), alias=None):
        self.createcreate('Library', name, args, alias)
 
    def resource(self, path):
        self.createcreate('Resource', path)
 
    def variables(self, path, args=()):
        self.createcreate('Variables', path, args)