runkwregister.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 warnings
 
from robot.utils import NormalizedDict
 
 
class _RunKeywordRegister:
 
    def __init__(self):
        self._libs_libs = {}
 
    
    def register_run_keyword(self, libname, keyword, args_to_process,
                             deprecation_warning=True, dry_run=False):
        if deprecation_warning:
            warnings.warn(
                "The API to register run keyword variants and to disable variable "
                "resolving in keyword arguments will change in the future. "
                "For more information see "
                "https://github.com/robotframework/robotframework/issues/2190. "
                "Use with `deprecation_warning=False` to avoid this warning.",
                UserWarning
            )
        if libname not in self._libs_libs:
            self._libs_libs[libname] = NormalizedDict(ignore=['_'])
        self._libs_libs[libname][keyword] = (int(args_to_process), dry_run)
 
    def get_args_to_process(self, libname, kwname):
        if libname in self._libs_libs and kwname in self._libs_libs[libname]:
            return self._libs_libs[libname][kwname][0]
        return -1
 
    def get_dry_run(self, libname, kwname):
        if libname in self._libs_libs and kwname in self._libs_libs[libname]:
            return self._libs_libs[libname][kwname][1]
        return False
 
    def is_run_keyword(self, libname, kwname):
        return self.get_args_to_processget_args_to_process(libname, kwname) >= 0
 
 
RUN_KW_REGISTER = _RunKeywordRegister()