robot.model.keyword.Keywords Class Reference

A list-like object representing keywords in a suite, a test or a keyword. More...

Inheritance diagram for robot.model.keyword.Keywords:

Public Member Functions
def	__delitem__ (self, index)
def	__init__ (self, parent=None, keywords=None)
def	__setitem__ (self, index, item)
def	append (self, item)
def	clear (self)
def	create (self, *args, **kwargs)
def	create_setup (self, *args, **kwargs)
def	create_teardown (self, *args, **kwargs)
def	extend (self, items)
def	insert (self, index, item)
def	pop (self, *index)
def	raise_deprecation_error (cls)
def	remove (self, item)
def	reverse (self)
def	sort (self)
Public Member Functions inherited from robot.model.itemlist.ItemList
def	__add__ (self, other)
def	__contains__ (self, item)
def	__eq__ (self, other)
def	__getitem__ (self, index)
def	__iadd__ (self, other)
def	__imul__ (self, other)
def	__init__ (self, item_class, common_attrs=None, items=None)
def	__iter__ (self)
def	__len__ (self)
def	__lt__ (self, other)
def	__mul__ (self, other)
def	__repr__ (self)
def	__reversed__ (self)
def	__rmul__ (self, other)
def	__str__ (self)
def	count (self, item)
def	index (self, item, *start_and_end)
def	visit (self, visitor)

Static Public Attributes
tuple	deprecation_message

Properties
	all = property
	Iterates over all keywords, including setup and teardown. More...
	normal = property
	Iterates over normal keywords, omitting setup and teardown. More...
	setup = property
	teardown = property

Private Member Functions
def	all (self)
def	normal (self)
def	setup (self)
def	setup (self, kw)
def	teardown (self)
def	teardown (self, kw)

Static Private Attributes
list	__slots__ = []

Detailed Description

A list-like object representing keywords in a suite, a test or a keyword.

Read-only and deprecated since Robot Framework 4.0.

Definition at line 137 of file keyword.py.

Constructor & Destructor Documentation

__init__()

def robot.model.keyword.Keywords.__init__	(		self,
			parent = None,
			keywords = None
	)

Definition at line 144 of file keyword.py.

Member Function Documentation

__delitem__()

def robot.model.keyword.Keywords.__delitem__	(		self,
			index
	)

Reimplemented from robot.model.itemlist.ItemList.

Definition at line 216 of file keyword.py.

__setitem__()

def robot.model.keyword.Keywords.__setitem__	(		self,
			index,
			item
	)

Reimplemented from robot.model.itemlist.ItemList.

Definition at line 192 of file keyword.py.

all()

def robot.model.keyword.Keywords.all (   self )

private

Definition at line 182 of file keyword.py.

append()

def robot.model.keyword.Keywords.append	(		self,
			item
	)

Reimplemented from robot.model.itemlist.ItemList.

Definition at line 198 of file keyword.py.

clear()

def robot.model.keyword.Keywords.clear

(

self

)

Reimplemented from robot.model.itemlist.ItemList.

Definition at line 213 of file keyword.py.

create()

def robot.model.keyword.Keywords.create	(		self,
		*	args,
		**	kwargs
	)

Reimplemented from robot.model.itemlist.ItemList.

Definition at line 195 of file keyword.py.

create_setup()

def robot.model.keyword.Keywords.create_setup	(		self,
		*	args,
		**	kwargs
	)

Definition at line 161 of file keyword.py.

create_teardown()

def robot.model.keyword.Keywords.create_teardown	(		self,
		*	args,
		**	kwargs
	)

Definition at line 175 of file keyword.py.

extend()

def robot.model.keyword.Keywords.extend	(		self,
			items
	)

Reimplemented from robot.model.itemlist.ItemList.

Definition at line 201 of file keyword.py.

insert()

def robot.model.keyword.Keywords.insert	(		self,
			index,
			item
	)

Reimplemented from robot.model.itemlist.ItemList.

Definition at line 204 of file keyword.py.

normal()

def robot.model.keyword.Keywords.normal (   self )

private

Definition at line 189 of file keyword.py.

pop()

def robot.model.keyword.Keywords.pop	(		self,
		*	index
	)

Definition at line 207 of file keyword.py.

raise_deprecation_error()

def robot.model.keyword.Keywords.raise_deprecation_error

(

cls

)

Definition at line 226 of file keyword.py.

remove()

def robot.model.keyword.Keywords.remove	(		self,
			item
	)

Definition at line 210 of file keyword.py.

reverse()

def robot.model.keyword.Keywords.reverse

(

self

)

Reimplemented from robot.model.itemlist.ItemList.

Definition at line 222 of file keyword.py.

setup() [1/2]

def robot.model.keyword.Keywords.setup (   self )

private

Definition at line 153 of file keyword.py.

setup() [2/2]

def robot.model.keyword.Keywords.setup (   self,   kw  )

private

Definition at line 158 of file keyword.py.

sort()

def robot.model.keyword.Keywords.sort

(

self

)

Reimplemented from robot.model.itemlist.ItemList.

Definition at line 219 of file keyword.py.

teardown() [1/2]

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

private

Definition at line 167 of file keyword.py.

teardown() [2/2]

def robot.model.keyword.Keywords.teardown (   self,   kw  )

private

Definition at line 172 of file keyword.py.

Member Data Documentation

__slots__

list robot.model.keyword.Keywords.__slots__ = []

staticprivate

Definition at line 138 of file keyword.py.

deprecation_message

tuple robot.model.keyword.Keywords.deprecation_message

static

Initial value:

=  (
        "'keywords' attribute is read-only and deprecated since Robot Framework 4.0. "
        "Use 'body', 'setup' or 'teardown' instead."
    )

Definition at line 139 of file keyword.py.

Property Documentation

all

robot.model.keyword.Keywords.all = property

static

Iterates over all keywords, including setup and teardown.

Definition at line 180 of file keyword.py.

normal

robot.model.keyword.Keywords.normal = property

static

Iterates over normal keywords, omitting setup and teardown.

Definition at line 187 of file keyword.py.

setup

robot.model.keyword.Keywords.setup = property

static

Definition at line 151 of file keyword.py.

teardown

robot.model.keyword.Keywords.teardown = property

static

Definition at line 165 of file keyword.py.

---

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

• src/robot/model/keyword.py