robot.conf.settings._BaseSettings Class Reference

Inheritance diagram for robot.conf.settings._BaseSettings:

Public Member Functions
def	__contains__ (self, setting)
def	__getitem__ (self, name)
def	__init__ (self, options=None, **extra_options)
def	__setitem__ (self, name, value)
def	__str__ (self)

Public Attributes
	start_timestamp

Properties
	console_colors = property
	exclude = property
	flatten_keywords = property
	include = property
	log = property
	log_level = property
	output = property
	output_directory = property
	pre_rebot_modifiers = property
	pythonpath = property
	remove_keywords = property
	report = property
	rpa = property
	split_log = property
	statistics_config = property
	status_rc = property
	suite_names = property
	test_names = property
	xunit = property

Private Member Functions
def	_convert_to_integer (self, name, value)
def	_convert_to_positive_integer_or_default (self, name, value)
def	_escape_doc (self, value)
def	_filter_empty (self, items)
def	_format_tag_patterns (self, pattern)
def	_get_default_value (self, name)
def	_get_output_extension (self, extension, file_type)
def	_get_output_file (self, option)
	Returns path of the requested output file and creates needed dirs. More...
def	_process_cli_opts (self, opts)
def	_process_doc (self, value)
def	_process_log_level (self, level)
def	_process_max_assign_length (self, value)
def	_process_max_error_lines (self, value)
def	_process_metadata (self, value)
def	_process_output_name (self, option, name)
def	_process_pythonpath (self, paths)
def	_process_randomize_value (self, original)
def	_process_report_background (self, colors)
def	_process_tag_stat_combine (self, pattern)
def	_process_tag_stat_link (self, value)
def	_process_tagdoc (self, value)
def	_process_value (self, name, value)
def	_raise_invalid (self, option, error)
def	_split_from_colon (self, value)
def	_split_log_level (self, level)
def	_split_pythonpath (self, path)
def	_validate_expandkeywords (self, values)
def	_validate_flatten_keywords (self, values)
def	_validate_remove_keywords (self, values)
def	console_colors (self)
def	exclude (self)
def	flatten_keywords (self)
def	include (self)
def	log (self)
def	log_level (self)
def	output (self)
def	output_directory (self)
def	pre_rebot_modifiers (self)
def	pythonpath (self)
def	remove_keywords (self)
def	report (self)
def	rpa (self)
def	rpa (self, value)
def	split_log (self)
def	statistics_config (self)
def	status_rc (self)
def	suite_names (self)
def	test_names (self)
def	xunit (self)

Private Attributes
	_cli_opts
	_opts

Static Private Attributes
dictionary	_cli_opts
list	_output_opts

Detailed Description

Definition at line 37 of file settings.py.

Constructor & Destructor Documentation

__init__()

def robot.conf.settings._BaseSettings.__init__	(		self,
			options = None,
		**	extra_options
	)

Definition at line 81 of file settings.py.

Member Function Documentation

__contains__()

def robot.conf.settings._BaseSettings.__contains__	(		self,
			setting
	)

Definition at line 366 of file settings.py.

__getitem__()

def robot.conf.settings._BaseSettings.__getitem__	(		self,
			name
	)

Definition at line 212 of file settings.py.

__setitem__()

def robot.conf.settings._BaseSettings.__setitem__	(		self,
			name,
			value
	)

Definition at line 98 of file settings.py.

__str__()

def robot.conf.settings._BaseSettings.__str__

(

self

)

Definition at line 369 of file settings.py.

_convert_to_integer()

def robot.conf.settings._BaseSettings._convert_to_integer (   self,   name,   value  )

private

Definition at line 306 of file settings.py.

_convert_to_positive_integer_or_default()

def robot.conf.settings._BaseSettings._convert_to_positive_integer_or_default (   self,   name,   value  )

private

Definition at line 302 of file settings.py.

_escape_doc()

def robot.conf.settings._BaseSettings._escape_doc (   self,   value  )

private

Reimplemented in robot.conf.settings.RobotSettings.

Definition at line 160 of file settings.py.

_filter_empty()

def robot.conf.settings._BaseSettings._filter_empty (   self,   items  )

private

Definition at line 420 of file settings.py.

_format_tag_patterns()

def robot.conf.settings._BaseSettings._format_tag_patterns (   self,   pattern  )

private

Definition at line 284 of file settings.py.

_get_default_value()

def robot.conf.settings._BaseSettings._get_default_value (   self,   name  )

private

Definition at line 312 of file settings.py.

_get_output_extension()

def robot.conf.settings._BaseSettings._get_output_extension (   self,   extension,   file_type  )

private

Definition at line 245 of file settings.py.

_get_output_file()

def robot.conf.settings._BaseSettings._get_output_file (   self,   option  )

private

Returns path of the requested output file and creates needed dirs.

    `option` can be 'Output', 'Log', 'Report', 'XUnit' or 'DebugFile'.

Definition at line 225 of file settings.py.

_process_cli_opts()

def robot.conf.settings._BaseSettings._process_cli_opts (   self,   opts  )

private

Definition at line 88 of file settings.py.

_process_doc()

def robot.conf.settings._BaseSettings._process_doc (   self,   value  )

private

Definition at line 150 of file settings.py.

_process_log_level()

def robot.conf.settings._BaseSettings._process_log_level (   self,   level  )

private

Definition at line 163 of file settings.py.

_process_max_assign_length()

def robot.conf.settings._BaseSettings._process_max_assign_length (   self,   value  )

private

Definition at line 190 of file settings.py.

_process_max_error_lines()

def robot.conf.settings._BaseSettings._process_max_error_lines (   self,   value  )

private

Definition at line 181 of file settings.py.

_process_metadata()

def robot.conf.settings._BaseSettings._process_metadata (   self,   value  )

private

Definition at line 256 of file settings.py.

_process_output_name()

def robot.conf.settings._BaseSettings._process_output_name (   self,   option,   name  )

private

Definition at line 238 of file settings.py.

_process_pythonpath()

def robot.conf.settings._BaseSettings._process_pythonpath (   self,   paths  )

private

Definition at line 315 of file settings.py.

_process_randomize_value()

def robot.conf.settings._BaseSettings._process_randomize_value (   self,   original  )

private

Definition at line 194 of file settings.py.

_process_report_background()

def robot.conf.settings._BaseSettings._process_report_background (   self,   colors  )

private

Definition at line 268 of file settings.py.

_process_tag_stat_combine()

def robot.conf.settings._BaseSettings._process_tag_stat_combine (   self,   pattern  )

private

Definition at line 277 of file settings.py.

_process_tag_stat_link()

def robot.conf.settings._BaseSettings._process_tag_stat_link (   self,   value  )

private

Definition at line 295 of file settings.py.

_process_tagdoc()

def robot.conf.settings._BaseSettings._process_tagdoc (   self,   value  )

private

Definition at line 265 of file settings.py.

_process_value()

def robot.conf.settings._BaseSettings._process_value (   self,   name,   value  )

private

Definition at line 103 of file settings.py.

_raise_invalid()

def robot.conf.settings._BaseSettings._raise_invalid (   self,   option,   error  )

private

Definition at line 363 of file settings.py.

_split_from_colon()

def robot.conf.settings._BaseSettings._split_from_colon (   self,   value  )

private

Definition at line 260 of file settings.py.

_split_log_level()

def robot.conf.settings._BaseSettings._split_log_level (   self,   level  )

private

Definition at line 168 of file settings.py.

_split_pythonpath()

def robot.conf.settings._BaseSettings._split_pythonpath (   self,   path  )

private

Definition at line 321 of file settings.py.

_validate_expandkeywords()

def robot.conf.settings._BaseSettings._validate_expandkeywords (   self,   values  )

private

Definition at line 357 of file settings.py.

_validate_flatten_keywords()

def robot.conf.settings._BaseSettings._validate_flatten_keywords (   self,   values  )

private

Definition at line 351 of file settings.py.

_validate_remove_keywords()

def robot.conf.settings._BaseSettings._validate_remove_keywords (   self,   values  )

private

Definition at line 344 of file settings.py.

console_colors()

def robot.conf.settings._BaseSettings.console_colors (   self )

private

Definition at line 487 of file settings.py.

exclude()

def robot.conf.settings._BaseSettings.exclude (   self )

private

Definition at line 438 of file settings.py.

flatten_keywords()

def robot.conf.settings._BaseSettings.flatten_keywords (   self )

private

Definition at line 475 of file settings.py.

include()

def robot.conf.settings._BaseSettings.include (   self )

private

Definition at line 432 of file settings.py.

log()

def robot.conf.settings._BaseSettings.log (   self )

private

Definition at line 387 of file settings.py.

log_level()

def robot.conf.settings._BaseSettings.log_level (   self )

private

Definition at line 405 of file settings.py.

output()

def robot.conf.settings._BaseSettings.output (   self )

private

Definition at line 381 of file settings.py.

output_directory()

def robot.conf.settings._BaseSettings.output_directory (   self )

private

Definition at line 375 of file settings.py.

pre_rebot_modifiers()

def robot.conf.settings._BaseSettings.pre_rebot_modifiers (   self )

private

Definition at line 481 of file settings.py.

pythonpath()

def robot.conf.settings._BaseSettings.pythonpath (   self )

private

Definition at line 444 of file settings.py.

remove_keywords()

def robot.conf.settings._BaseSettings.remove_keywords (   self )

private

Definition at line 469 of file settings.py.

report()

def robot.conf.settings._BaseSettings.report (   self )

private

Definition at line 393 of file settings.py.

rpa() [1/2]

def robot.conf.settings._BaseSettings.rpa (   self )

private

Definition at line 493 of file settings.py.

rpa() [2/2]

def robot.conf.settings._BaseSettings.rpa (   self,   value  )

private

Definition at line 498 of file settings.py.

split_log()

def robot.conf.settings._BaseSettings.split_log (   self )

private

Definition at line 411 of file settings.py.

statistics_config()

def robot.conf.settings._BaseSettings.statistics_config (   self )

private

Definition at line 456 of file settings.py.

status_rc()

def robot.conf.settings._BaseSettings.status_rc (   self )

private

Definition at line 450 of file settings.py.

suite_names()

def robot.conf.settings._BaseSettings.suite_names (   self )

private

Reimplemented in robot.conf.settings.RobotSettings.

Definition at line 417 of file settings.py.

test_names()

def robot.conf.settings._BaseSettings.test_names (   self )

private

Reimplemented in robot.conf.settings.RobotSettings.

Definition at line 426 of file settings.py.

xunit()

def robot.conf.settings._BaseSettings.xunit (   self )

private

Definition at line 399 of file settings.py.

Member Data Documentation

_cli_opts [1/2]

robot.conf.settings._BaseSettings._cli_opts

staticprivate

Definition at line 41 of file settings.py.

_cli_opts [2/2]

robot.conf.settings._BaseSettings._cli_opts

private

Definition at line 84 of file settings.py.

_opts

robot.conf.settings._BaseSettings._opts

private

Definition at line 83 of file settings.py.

_output_opts

robot.conf.settings._BaseSettings._output_opts

staticprivate

Definition at line 79 of file settings.py.

start_timestamp

robot.conf.settings._BaseSettings.start_timestamp

Definition at line 82 of file settings.py.

Property Documentation

console_colors

robot.conf.settings._BaseSettings.console_colors = property

static

Definition at line 485 of file settings.py.

exclude

robot.conf.settings._BaseSettings.exclude = property

static

Definition at line 436 of file settings.py.

flatten_keywords

robot.conf.settings._BaseSettings.flatten_keywords = property

static

Definition at line 473 of file settings.py.

include

robot.conf.settings._BaseSettings.include = property

static

Definition at line 430 of file settings.py.

log

robot.conf.settings._BaseSettings.log = property

static

Definition at line 385 of file settings.py.

log_level

robot.conf.settings._BaseSettings.log_level = property

static

Definition at line 403 of file settings.py.

output

robot.conf.settings._BaseSettings.output = property

static

Definition at line 379 of file settings.py.

output_directory

robot.conf.settings._BaseSettings.output_directory = property

static

Definition at line 373 of file settings.py.

pre_rebot_modifiers

robot.conf.settings._BaseSettings.pre_rebot_modifiers = property

static

Definition at line 479 of file settings.py.

pythonpath

robot.conf.settings._BaseSettings.pythonpath = property

static

Definition at line 442 of file settings.py.

remove_keywords

robot.conf.settings._BaseSettings.remove_keywords = property

static

Definition at line 467 of file settings.py.

report

robot.conf.settings._BaseSettings.report = property

static

Definition at line 391 of file settings.py.

rpa

robot.conf.settings._BaseSettings.rpa = property

static

Definition at line 491 of file settings.py.

split_log

robot.conf.settings._BaseSettings.split_log = property

static

Definition at line 409 of file settings.py.

statistics_config

robot.conf.settings._BaseSettings.statistics_config = property

static

Definition at line 454 of file settings.py.

status_rc

robot.conf.settings._BaseSettings.status_rc = property

static

Definition at line 448 of file settings.py.

suite_names

robot.conf.settings._BaseSettings.suite_names = property

static

Definition at line 415 of file settings.py.

test_names

robot.conf.settings._BaseSettings.test_names = property

static

Definition at line 424 of file settings.py.

xunit

robot.conf.settings._BaseSettings.xunit = property

static

Definition at line 397 of file settings.py.

---

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

• src/robot/conf/settings.py