Public Member Functions
def	__init__ (self)

def	get_args_to_process (self, libname, kwname)

def	get_dry_run (self, libname, kwname)

def	is_run_keyword (self, libname, kwname)

def	register_run_keyword (self, libname, keyword, args_to_process, deprecation_warning=True, dry_run=False)
	Deprecated API for registering "run keyword variants". More...

Private Attributes
	_libs

Detailed Description

Definition at line 21 of file runkwregister.py.

Constructor & Destructor Documentation

◆ init()

def robot.running.runkwregister._RunKeywordRegister.__init__ ( self )

Definition at line 23 of file runkwregister.py.

Member Function Documentation

◆ get_args_to_process()

def robot.running.runkwregister._RunKeywordRegister.get_args_to_process	(	self,
		libname,
		kwname
	)

Definition at line 72 of file runkwregister.py.

◆ get_dry_run()

def robot.running.runkwregister._RunKeywordRegister.get_dry_run	(	self,
		libname,
		kwname
	)

Definition at line 77 of file runkwregister.py.

◆ is_run_keyword()

def robot.running.runkwregister._RunKeywordRegister.is_run_keyword	(	self,
		libname,
		kwname
	)

Definition at line 82 of file runkwregister.py.

◆ register_run_keyword()

def robot.running.runkwregister._RunKeywordRegister.register_run_keyword	(	self,
		libname,
		keyword,
		args_to_process,
		deprecation_warning = `True`,
		dry_run = `False`
	)

Deprecated API for registering "run keyword variants".

    Registered keywords are handled specially by Robot so that:

    - Their arguments are not resolved normally (use ``args_to_process``
      to control that). This mainly means replacing variables and handling
      escapes.
    - They are not stopped by timeouts.
    - If there are conflicts with keyword names, these keywords have
      *lower* precedence than other keywords.

    This API is pretty bad and will be reimplemented in the future.
    It is thus not considered stable, but external libraries can use it
    if they really need it and are aware of forthcoming breaking changes.

    Something like this is needed at least internally also in the future.
    For external libraries we hopefully could provide a better API for
    running keywords so that they would not need this in the first place.

    For more details see the following issues and issues linked from it:
    https://github.com/robotframework/robotframework/issues/2190

    :param libname: Name of the library the keyword belongs to.
    :param keyword: Name of the keyword itself.
    :param args_to_process: How many arguments to process normally before
        passing them to the keyword. Other arguments are not touched at all.
    :param dry_run: When true, this keyword is executed in dry run. Keywords
        to actually run are got based on the ``name`` argument these
        keywords must have.
    :param deprecation_warning: Set to ``False```to avoid the warning.

Definition at line 57 of file runkwregister.py.

Member Data Documentation

◆ _libs

robot.running.runkwregister._RunKeywordRegister._libs

private

Definition at line 24 of file runkwregister.py.

The documentation for this class was generated from the following file:

src/robot/running/runkwregister.py

Public Member Functions

Private Attributes