Robot Framework Integrated Development Environment (RIDE)
robotide.contrib.testrunner.runprofiles.PybotProfile Class Reference

A runner profile which uses robot. More...

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

Public Member Functions

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 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 get_toolbar_items (self, parent)
 
def OnArgumentsChanged (self, evt)
 
def OnCollapsiblePaneChanged (self, evt=None)
 
def OnExcludeCheckbox (self, evt)
 
def OnExcludeTagsChanged (self, evt)
 
def OnIncludeCheckbox (self, evt)
 
def OnIncludeTagsChanged (self, evt)
 
def OnOutputDirectoryChanged (self, evt)
 
def OnSaveLogsCheckbox (self, evt)
 
def OnSuiteNameOutputsCheckBox (self, evt)
 
def OnTimestampOutputsCheckbox (self, evt)
 
- Public Member Functions inherited from robotide.contrib.testrunner.runprofiles.BaseProfile
def __getattr__ (self, name)
 Provides attribute access to profile's settings. More...
 
def format_error (self, error, returncode)
 
def set_setting (self, name, value)
 Sets a plugin setting. More...
 

Static Public Attributes

dictionary default_settings
 
string name = "robot"
 
- Static Public Attributes inherited from robotide.contrib.testrunner.runprofiles.BaseProfile
dictionary default_settings = {}
 
 plugin = None
 

Private Member Functions

def _create_error_log_message (self, error, returncode)
 
def _enable_toolbar (self, enable=True)
 
def _get_arguments (self)
 
def _get_arguments_panel (self, parent)
 
def _get_log_options_panel (self, parent)
 
def _get_tags_panel (self, parent)
 Create a panel to input include/exclude tags. More...
 
def _handle_select_directory (self, event)
 
def _parse_posix_command (self)
 
def _parse_windows_command (self)
 
def _save_filenames (self)
 
def _validate_arguments (self, args)
 

Static Private Member Functions

def _create_checkbox (parent, value, title, handler)
 
def _create_text_ctrl (parent, value, value_for_error, text_change_handler, enable=True)
 
def _get_invalid_message (args)
 
def _get_tags_from_string (tag_string)
 

Private Attributes

 _args_text_ctrl
 
 _defined_arguments
 
 _exclude_tags_text_ctrl
 
 _include_tags_text_ctrl
 
 _mysettings
 
 _output_directory_text_ctrl
 
 _toolbar
 

Static Private Attributes

 _quotes_re
 

Detailed Description

A runner profile which uses robot.

It is assumed that robot is on the path

Definition at line 158 of file runprofiles.py.

Constructor & Destructor Documentation

◆ __init__()

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

plugin is required so that the profiles can save their settings

Reimplemented from robotide.contrib.testrunner.runprofiles.BaseProfile.

Definition at line 175 of file runprofiles.py.

Member Function Documentation

◆ _create_checkbox()

def robotide.contrib.testrunner.runprofiles.PybotProfile._create_checkbox (   parent,
  value,
  title,
  handler 
)
staticprivate

Definition at line 632 of file runprofiles.py.

◆ _create_error_log_message()

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

◆ _create_text_ctrl()

def robotide.contrib.testrunner.runprofiles.PybotProfile._create_text_ctrl (   parent,
  value,
  value_for_error,
  text_change_handler,
  enable = True 
)
staticprivate

Definition at line 639 of file runprofiles.py.

◆ _enable_toolbar()

def robotide.contrib.testrunner.runprofiles.PybotProfile._enable_toolbar (   self,
  enable = True 
)
private

Definition at line 207 of file runprofiles.py.

◆ _get_arguments()

def robotide.contrib.testrunner.runprofiles.PybotProfile._get_arguments (   self)
private

Definition at line 283 of file runprofiles.py.

◆ _get_arguments_panel()

def robotide.contrib.testrunner.runprofiles.PybotProfile._get_arguments_panel (   self,
  parent 
)
private

Definition at line 502 of file runprofiles.py.

◆ _get_invalid_message()

def robotide.contrib.testrunner.runprofiles.PybotProfile._get_invalid_message (   args)
staticprivate

Definition at line 546 of file runprofiles.py.

◆ _get_log_options_panel()

def robotide.contrib.testrunner.runprofiles.PybotProfile._get_log_options_panel (   self,
  parent 
)
private

Definition at line 432 of file runprofiles.py.

◆ _get_tags_from_string()

def robotide.contrib.testrunner.runprofiles.PybotProfile._get_tags_from_string (   tag_string)
staticprivate

Definition at line 399 of file runprofiles.py.

◆ _get_tags_panel()

def robotide.contrib.testrunner.runprofiles.PybotProfile._get_tags_panel (   self,
  parent 
)
private

Create a panel to input include/exclude tags.

Definition at line 573 of file runprofiles.py.

◆ _handle_select_directory()

def robotide.contrib.testrunner.runprofiles.PybotProfile._handle_select_directory (   self,
  event 
)
private

Definition at line 480 of file runprofiles.py.

◆ _parse_posix_command()

def robotide.contrib.testrunner.runprofiles.PybotProfile._parse_posix_command (   self)
private

Definition at line 372 of file runprofiles.py.

◆ _parse_windows_command()

def robotide.contrib.testrunner.runprofiles.PybotProfile._parse_windows_command (   self)
private

Definition at line 330 of file runprofiles.py.

◆ _save_filenames()

def robotide.contrib.testrunner.runprofiles.PybotProfile._save_filenames (   self)
private

Definition at line 290 of file runprofiles.py.

◆ _validate_arguments()

def robotide.contrib.testrunner.runprofiles.PybotProfile._validate_arguments (   self,
  args 
)
private

◆ delete_pressed()

def robotide.contrib.testrunner.runprofiles.PybotProfile.delete_pressed (   self)

Handle delete key pressing.

Reimplemented from robotide.contrib.testrunner.runprofiles.BaseProfile.

Definition at line 214 of file runprofiles.py.

◆ disable_toolbar()

def robotide.contrib.testrunner.runprofiles.PybotProfile.disable_toolbar (   self)

Reimplemented from robotide.contrib.testrunner.runprofiles.BaseProfile.

Definition at line 202 of file runprofiles.py.

◆ enable_toolbar()

def robotide.contrib.testrunner.runprofiles.PybotProfile.enable_toolbar (   self)

Reimplemented from robotide.contrib.testrunner.runprofiles.BaseProfile.

Definition at line 197 of file runprofiles.py.

◆ get_command()

def robotide.contrib.testrunner.runprofiles.PybotProfile.get_command (   self)

Returns a command for this profile.

Reimplemented from robotide.contrib.testrunner.runprofiles.BaseProfile.

Reimplemented in robotide.contrib.testrunner.runprofiles.CustomScriptProfile.

Definition at line 222 of file runprofiles.py.

◆ get_command_args()

def robotide.contrib.testrunner.runprofiles.PybotProfile.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 from robotide.contrib.testrunner.runprofiles.BaseProfile.

Definition at line 247 of file runprofiles.py.

◆ get_settings()

def robotide.contrib.testrunner.runprofiles.PybotProfile.get_settings (   self)

Return a list of settings unique to this profile.

    Returned settings can be used when running tests.

Reimplemented from robotide.contrib.testrunner.runprofiles.BaseProfile.

Definition at line 407 of file runprofiles.py.

◆ get_toolbar()

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

Returns a panel with toolbar controls for this profile.

Reimplemented from robotide.contrib.testrunner.runprofiles.BaseProfile.

Definition at line 180 of file runprofiles.py.

◆ get_toolbar_items()

def robotide.contrib.testrunner.runprofiles.PybotProfile.get_toolbar_items (   self,
  parent 
)

◆ OnArgumentsChanged()

def robotide.contrib.testrunner.runprofiles.PybotProfile.OnArgumentsChanged (   self,
  evt 
)

Definition at line 528 of file runprofiles.py.

◆ OnCollapsiblePaneChanged()

def robotide.contrib.testrunner.runprofiles.PybotProfile.OnCollapsiblePaneChanged (   self,
  evt = None 
)

Definition at line 613 of file runprofiles.py.

◆ OnExcludeCheckbox()

def robotide.contrib.testrunner.runprofiles.PybotProfile.OnExcludeCheckbox (   self,
  evt 
)

Definition at line 621 of file runprofiles.py.

◆ OnExcludeTagsChanged()

def robotide.contrib.testrunner.runprofiles.PybotProfile.OnExcludeTagsChanged (   self,
  evt 
)

Definition at line 628 of file runprofiles.py.

◆ OnIncludeCheckbox()

def robotide.contrib.testrunner.runprofiles.PybotProfile.OnIncludeCheckbox (   self,
  evt 
)

Definition at line 617 of file runprofiles.py.

◆ OnIncludeTagsChanged()

def robotide.contrib.testrunner.runprofiles.PybotProfile.OnIncludeTagsChanged (   self,
  evt 
)

Definition at line 625 of file runprofiles.py.

◆ OnOutputDirectoryChanged()

def robotide.contrib.testrunner.runprofiles.PybotProfile.OnOutputDirectoryChanged (   self,
  evt 
)

Definition at line 476 of file runprofiles.py.

◆ OnSaveLogsCheckbox()

def robotide.contrib.testrunner.runprofiles.PybotProfile.OnSaveLogsCheckbox (   self,
  evt 
)

Definition at line 499 of file runprofiles.py.

◆ OnSuiteNameOutputsCheckBox()

def robotide.contrib.testrunner.runprofiles.PybotProfile.OnSuiteNameOutputsCheckBox (   self,
  evt 
)

Definition at line 493 of file runprofiles.py.

◆ OnTimestampOutputsCheckbox()

def robotide.contrib.testrunner.runprofiles.PybotProfile.OnTimestampOutputsCheckbox (   self,
  evt 
)

Definition at line 496 of file runprofiles.py.

Member Data Documentation

◆ _args_text_ctrl

robotide.contrib.testrunner.runprofiles.PybotProfile._args_text_ctrl
private

Definition at line 512 of file runprofiles.py.

◆ _defined_arguments

robotide.contrib.testrunner.runprofiles.PybotProfile._defined_arguments
private

Definition at line 177 of file runprofiles.py.

◆ _exclude_tags_text_ctrl

robotide.contrib.testrunner.runprofiles.PybotProfile._exclude_tags_text_ctrl
private

Definition at line 593 of file runprofiles.py.

◆ _include_tags_text_ctrl

robotide.contrib.testrunner.runprofiles.PybotProfile._include_tags_text_ctrl
private

Definition at line 589 of file runprofiles.py.

◆ _mysettings

robotide.contrib.testrunner.runprofiles.PybotProfile._mysettings
private

Definition at line 183 of file runprofiles.py.

◆ _output_directory_text_ctrl

robotide.contrib.testrunner.runprofiles.PybotProfile._output_directory_text_ctrl
private

Definition at line 443 of file runprofiles.py.

◆ _quotes_re

robotide.contrib.testrunner.runprofiles.PybotProfile._quotes_re
staticprivate

Definition at line 162 of file runprofiles.py.

◆ _toolbar

robotide.contrib.testrunner.runprofiles.PybotProfile._toolbar
private

Definition at line 178 of file runprofiles.py.

◆ default_settings

dictionary robotide.contrib.testrunner.runprofiles.PybotProfile.default_settings
static
Initial value:
= {"arguments": "",
"output_directory": "",
"include_tags": "",
"exclude_tags": "",
"are_log_names_with_suite_name": False,
"are_log_names_with_timestamp": False,
"are_saving_logs": False,
"apply_include_tags": False,
"apply_exclude_tags": False}

Definition at line 165 of file runprofiles.py.

◆ name

string robotide.contrib.testrunner.runprofiles.PybotProfile.name = "robot"
static

Definition at line 164 of file runprofiles.py.


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