Represents a single executable keyword. More...

Inheritance diagram for robot.running.model.Keyword:

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

def	run (self, context, run=True, templated=None)

Public Member Functions inherited from robot.model.keyword.Keyword
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
	lineno

Public Attributes inherited from robot.model.keyword.Keyword
	args

	assign

	doc

	parent

	tags

	timeout

	type

Properties
	source = property

Properties inherited from robot.model.keyword.Keyword
	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	source (self)

Static Private Attributes
list	__slots__ = ['lineno']

Additional Inherited Members
Static Public Attributes inherited from robot.model.keyword.Keyword
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 = ()

Detailed Description

Represents a single executable keyword.

These keywords never have child keywords or messages. The actual keyword
that is executed depends on the context where this model is executed.

See the base class for documentation of attributes not documented here.

Definition at line 64 of file model.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 67 of file model.py.

Member Function Documentation

◆ run()

def robot.running.model.Keyword.run	(	self,
		context,
		run = `True`,
		templated = `None`
	)

Definition at line 78 of file model.py.

◆ source()

def robot.running.model.Keyword.source ( self )

private

Definition at line 75 of file model.py.

Member Data Documentation

◆ slots

list robot.running.model.Keyword.__slots__ = ['lineno']

staticprivate

Definition at line 65 of file model.py.

◆ lineno

robot.running.model.Keyword.lineno

Definition at line 70 of file model.py.

Property Documentation

◆ source

robot.running.model.Keyword.source = property

static

Definition at line 73 of file model.py.

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

src/robot/running/model.py

Public Member Functions

Public Attributes

Properties

Private Member Functions

Static Private Attributes

Additional Inherited Members