Base model for a single keyword. More...

Inheritance diagram for robot.model.keyword.Keyword:

Public Member Functions
def	__bool__ (self)

def	__init__ (self, name='', doc='', args=(), assign=(), tags=(), timeout=None, type=BodyItem.KEYWORD, parent=None)

def	__str__ (self)

def	tags (self, tags)
	Keyword tags as a :class:`~.model.tags.Tags` object. More...

def	visit (self, visitor)
	:mod:`Visitor interface <robot.model.visitor>` entry-point. More...

Public Member Functions inherited from robot.model.modelobject.ModelObject
def	__repr__ (self)

def	config (self, **attributes)
	Configure model object with given attributes. More...

def	copy (self, **attributes)
	Return shallow copy of this object. More...

def	deepcopy (self, **attributes)
	Return deep copy of this object. More...

Public Attributes
	args

	assign

	doc

	parent

	tags

	timeout

	type

Static Public Attributes
tuple	repr_args = ('name', 'args', 'assign')

Static Public Attributes inherited from robot.model.body.BodyItem
string	BREAK = 'BREAK'

string	CONTINUE = 'CONTINUE'

string	ELSE = 'ELSE'

string	ELSE_IF = 'ELSE IF'

string	EXCEPT = 'EXCEPT'

string	FINALLY = 'FINALLY'

string	FOR = 'FOR'

string	IF = 'IF'

string	IF_ELSE_ROOT = 'IF/ELSE ROOT'

string	ITERATION = 'ITERATION'

string	KEYWORD = 'KEYWORD'

string	MESSAGE = 'MESSAGE'

string	RETURN = 'RETURN'

string	SETUP = 'SETUP'

string	TEARDOWN = 'TEARDOWN'

string	TRY = 'TRY'

string	TRY_EXCEPT_ROOT = 'TRY/EXCEPT ROOT'

	type = None

string	WHILE = 'WHILE'

Static Public Attributes inherited from robot.model.modelobject.ModelObject
tuple	repr_args = ()

Properties
	has_teardown = property
	Check does a keyword have a teardown without creating a teardown object. More...

	name = property

	teardown = property
	Keyword teardown as a :class:`Keyword` object. More...

Properties inherited from robot.model.body.BodyItem
	has_setup = property

	has_teardown = property

	id = property
	Item id in format like `s1-t3-k1`. More...

Private Member Functions
def	has_teardown (self)

def	name (self)

def	name (self, name)

def	teardown (self)

def	teardown (self, teardown)

Private Attributes
	_name

	_teardown

Static Private Attributes
list	__slots__ = ['_name', 'doc', 'args', 'assign', 'timeout', 'type', '_teardown']

Detailed Description

Base model for a single keyword.

Extended by :class:`robot.running.model.Keyword` and
:class:`robot.result.model.Keyword`.

Definition at line 32 of file keyword.py.

Constructor & Destructor Documentation

◆ init()

def robot.model.keyword.Keyword.__init__	(	self,
		name = `''`,
		doc = `''`,
		args = `()`,
		assign = `()`,
		tags = `()`,
		timeout = `None`,
		type = `BodyItem.KEYWORD`,
		parent = `None`
	)

Definition at line 36 of file keyword.py.

Member Function Documentation

◆ bool()

def robot.model.keyword.Keyword.__bool__ ( self )

Definition at line 125 of file keyword.py.

◆ str()

def robot.model.keyword.Keyword.__str__ ( self )

Definition at line 128 of file keyword.py.

◆ has_teardown()

def robot.model.keyword.Keyword.has_teardown ( self )

private

Reimplemented from robot.model.body.BodyItem.

Definition at line 112 of file keyword.py.

◆ name() [1/2]

def robot.model.keyword.Keyword.name ( self )

private

Reimplemented in robot.result.model.Keyword.

Definition at line 51 of file keyword.py.

◆ name() [2/2]

def robot.model.keyword.Keyword.name	(	self,
		name
	)

private

Reimplemented in robot.result.model.Keyword.

Definition at line 56 of file keyword.py.

◆ tags()

def robot.model.keyword.Keyword.tags	(	self,
		tags
	)

Keyword tags as a :class:~.model.tags.Tags object.

Definition at line 117 of file keyword.py.

◆ teardown() [1/2]

def robot.model.keyword.Keyword.teardown ( self )

private

Definition at line 89 of file keyword.py.

◆ teardown() [2/2]

def robot.model.keyword.Keyword.teardown	(	self,
		teardown
	)

private

Definition at line 96 of file keyword.py.

◆ visit()

def robot.model.keyword.Keyword.visit	(	self,
		visitor
	)

:mod:Visitor interface <robot.model.visitor> entry-point.

Definition at line 121 of file keyword.py.

Member Data Documentation

◆ slots

list robot.model.keyword.Keyword.__slots__ = ['_name', 'doc', 'args', 'assign', 'timeout', 'type', '_teardown']

staticprivate

Definition at line 34 of file keyword.py.

◆ _name

robot.model.keyword.Keyword._name

private

Definition at line 38 of file keyword.py.

◆ _teardown

robot.model.keyword.Keyword._teardown

private

Definition at line 45 of file keyword.py.

◆ args

robot.model.keyword.Keyword.args

Definition at line 40 of file keyword.py.

◆ assign

robot.model.keyword.Keyword.assign

Definition at line 41 of file keyword.py.

◆ doc

robot.model.keyword.Keyword.doc

Definition at line 39 of file keyword.py.

◆ parent

robot.model.keyword.Keyword.parent

Definition at line 46 of file keyword.py.

◆ repr_args

tuple robot.model.keyword.Keyword.repr_args = ('name', 'args', 'assign')

static

Definition at line 33 of file keyword.py.

◆ tags

robot.model.keyword.Keyword.tags

Definition at line 42 of file keyword.py.

◆ timeout

robot.model.keyword.Keyword.timeout

Definition at line 43 of file keyword.py.

◆ type

robot.model.keyword.Keyword.type

Definition at line 44 of file keyword.py.

Property Documentation

◆ has_teardown

robot.model.keyword.Keyword.has_teardown = property

static

Check does a keyword have a teardown without creating a teardown object.

    A difference between using ``if kw.has_teardown:`` and ``if kw.teardown:``
    is that accessing the :attr:`teardown` attribute creates a :class:`Keyword`
    object representing a teardown even when the keyword actually does not
    have one. This typically does not matter, but with bigger suite structures
    having lot of keywords it can have a considerable effect on memory usage.

    New in Robot Framework 4.1.2.

Definition at line 110 of file keyword.py.

◆ name

robot.model.keyword.Keyword.name = property

static

Definition at line 49 of file keyword.py.

◆ teardown

robot.model.keyword.Keyword.teardown = property

static

Keyword teardown as a :class:Keyword object.

    Teardown can be modified by setting attributes directly::

        keyword.teardown.name = 'Example'
        keyword.teardown.args = ('First', 'Second')

    Alternatively the :meth:`config` method can be used to set multiple
    attributes in one call::

        keyword.teardown.config(name='Example', args=('First', 'Second'))

    The easiest way to reset the whole teardown is setting it to ``None``.
    It will automatically recreate the underlying ``Keyword`` object::

        keyword.teardown = None

    This attribute is a ``Keyword`` object also when a keyword has no teardown
    but in that case its truth value is ``False``. If there is a need to just
    check does a keyword have a teardown, using the :attr:`has_teardown`
    attribute avoids creating the ``Keyword`` object and is thus more memory
    efficient.

    New in Robot Framework 4.0. Earlier teardown was accessed like
    ``keyword.keywords.teardown``. :attr:`has_teardown` is new in Robot
    Framework 4.1.2.

Definition at line 87 of file keyword.py.

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

src/robot/model/keyword.py

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __bool__()

◆ __str__()

◆ has_teardown()

◆ name() [1/2]

◆ name() [2/2]

◆ tags()

◆ teardown() [1/2]

◆ teardown() [2/2]

◆ visit()

Member Data Documentation

◆ __slots__

◆ _name

◆ _teardown

◆ args

◆ assign

◆ doc

◆ parent

◆ repr_args

◆ tags

◆ timeout

◆ type

Property Documentation

◆ has_teardown

◆ name

◆ teardown

◆ init()

◆ bool()

◆ str()

◆ slots