robotide.contrib.testrunner.runprofiles.BaseProfile Class Reference

Base class for all test runner profiles. More...

Inheritance diagram for robotide.contrib.testrunner.runprofiles.BaseProfile:

Public Member Functions
def	__getattr__ (self, name)
	Provides attribute access to profile's settings. More...
def	__init__ (self, plugin)
	plugin is required so that the profiles can save their settings More...
def	delete_pressed (self)
	Handle delete key pressing. More...
def	disable_toolbar (self)
def	enable_toolbar (self)
def	format_error (self, error, returncode)
def	get_command (self)
	Returns a command for this profile. More...
def	get_command_args (self)
	Return a list of command arguments unique to this profile. More...
def	get_settings (self)
	Return a list of settings unique to this profile. More...
def	get_toolbar (self, parent)
	Returns a panel with toolbar controls for this profile. More...
def	set_setting (self, name, value)
	Sets a plugin setting. More...

Static Public Attributes
dictionary	default_settings = {}
	plugin = None

Private Member Functions
def	_create_error_log_message (self, error, returncode)
def	_get_setting_name (self, name)
	Adds profile's name to the setting. More...

Private Attributes
	_panel

Detailed Description

Base class for all test runner profiles.

At a minimum each profile must set the name attribute, which is
how the profile will appear in the dropdown list.

In case some settings are needed, provide default_settings class attribute
with default values.

This class (BaseProfile) will _not_ appear as one of the choices.
Think of it as an abstract class, if Python 2.5 had such a thing.

Definition at line 59 of file runprofiles.py.

Constructor & Destructor Documentation

__init__()

def robotide.contrib.testrunner.runprofiles.BaseProfile.__init__	(		self,
			plugin
	)

plugin is required so that the profiles can save their settings

Reimplemented in robotide.contrib.testrunner.runprofiles.PybotProfile.

Definition at line 66 of file runprofiles.py.

Member Function Documentation

__getattr__()

def robotide.contrib.testrunner.runprofiles.BaseProfile.__getattr__	(		self,
			name
	)

Provides attribute access to profile's settings.

    If for example default_settings = {'setting1' = ""} is defined
    then setting1 value can be used like self.setting1
    set_setting is used to store the value.

Definition at line 129 of file runprofiles.py.

_create_error_log_message()

def robotide.contrib.testrunner.runprofiles.BaseProfile._create_error_log_message (   self,   error,   returncode  )

private

Reimplemented in robotide.contrib.testrunner.runprofiles.CustomScriptProfile, and robotide.contrib.testrunner.runprofiles.PybotProfile.

Definition at line 120 of file runprofiles.py.

_get_setting_name()

def robotide.contrib.testrunner.runprofiles.BaseProfile._get_setting_name (   self,   name  )

private

Adds profile's name to the setting.

Definition at line 143 of file runprofiles.py.

delete_pressed()

def robotide.contrib.testrunner.runprofiles.BaseProfile.delete_pressed

(

self

)

Handle delete key pressing.

Reimplemented in robotide.contrib.testrunner.runprofiles.PybotProfile.

Definition at line 87 of file runprofiles.py.

disable_toolbar()

def robotide.contrib.testrunner.runprofiles.BaseProfile.disable_toolbar

(

self

)

Reimplemented in robotide.contrib.testrunner.runprofiles.PybotProfile.

Definition at line 81 of file runprofiles.py.

enable_toolbar()

def robotide.contrib.testrunner.runprofiles.BaseProfile.enable_toolbar

(

self

)

Reimplemented in robotide.contrib.testrunner.runprofiles.PybotProfile.

Definition at line 76 of file runprofiles.py.

format_error()

def robotide.contrib.testrunner.runprofiles.BaseProfile.format_error	(		self,
			error,
			returncode
	)

Definition at line 117 of file runprofiles.py.

get_command()

def robotide.contrib.testrunner.runprofiles.BaseProfile.get_command

(

self

)

Returns a command for this profile.

Reimplemented in robotide.contrib.testrunner.runprofiles.CustomScriptProfile, and robotide.contrib.testrunner.runprofiles.PybotProfile.

Definition at line 91 of file runprofiles.py.

get_command_args()

def robotide.contrib.testrunner.runprofiles.BaseProfile.get_command_args

(

self

)

Return a list of command arguments unique to this profile.

    Returned arguments are in format accepted by Robot Framework's argument
    file.

Reimplemented in robotide.contrib.testrunner.runprofiles.PybotProfile.

Definition at line 99 of file runprofiles.py.

get_settings()

def robotide.contrib.testrunner.runprofiles.BaseProfile.get_settings

(

self

)

Return a list of settings unique to this profile.

    Returned settings can be used when running tests.

Reimplemented in robotide.contrib.testrunner.runprofiles.PybotProfile.

Definition at line 106 of file runprofiles.py.

get_toolbar()

def robotide.contrib.testrunner.runprofiles.BaseProfile.get_toolbar	(		self,
			parent
	)

Returns a panel with toolbar controls for this profile.

Reimplemented in robotide.contrib.testrunner.runprofiles.PybotProfile.

Definition at line 71 of file runprofiles.py.

set_setting()

def robotide.contrib.testrunner.runprofiles.BaseProfile.set_setting	(		self,
			name,
			value
	)

Sets a plugin setting.

    setting is automatically prefixed with profile's name and it can be
    accessed with direct attribute access. See also __getattr__.

Definition at line 114 of file runprofiles.py.

Member Data Documentation

_panel

robotide.contrib.testrunner.runprofiles.BaseProfile._panel

private

Definition at line 68 of file runprofiles.py.

default_settings

dictionary robotide.contrib.testrunner.runprofiles.BaseProfile.default_settings = {}

static

Definition at line 63 of file runprofiles.py.

plugin

robotide.contrib.testrunner.runprofiles.BaseProfile.plugin = None

static

Definition at line 62 of file runprofiles.py.

---

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

• src/robotide/contrib/testrunner/runprofiles.py