Robot Framework Integrated Development Environment (RIDE)
robotide.controller.project.Project Class Reference
Inheritance diagram for robotide.controller.project.Project:
robotide.controller.basecontroller._BaseController robotide.controller.basecontroller.WithNamespace

Public Member Functions

def __del__ (self)
 
def __init__ (self, namespace=None, settings=None, library_manager=None)
 
def all_testcases (self)
 
def change_format (self, controller, format)
 
def change_format_recursive (self, controller, format)
 
def close (self)
 
def find_controller_by_longname (self, longname, testname=None)
 
def get_all_keywords (self)
 
def get_files_without_format (self, controller=None)
 
def get_root_suite_dir_path (self)
 
def insert_into_suite_structure (self, resource)
 
def is_datafile_dirty (self, datafile)
 
def is_dirty (self)
 
def is_excluded (self, source)
 
def is_project_changed_from_disk (self)
 
def load_data (self, path, load_observer=None)
 
def load_datafile (self, path, load_observer)
 
def load_resource (self, path, load_observer)
 
def new_directory_project (self, path)
 
def new_file_project (self, path)
 
def new_resource (self, path, parent=None)
 
def remove_datafile (self, controller)
 
def remove_resource (self, controller)
 
def resource_import_modified (self, path, directory)
 
def save (self, controller)
 
def update_default_dir (self, path)
 
- Public Member Functions inherited from robotide.controller.basecontroller._BaseController
def execute (self, command)
 
def is_excluded (self)
 
def is_modifiable (self)
 
- Public Member Functions inherited from robotide.controller.basecontroller.WithNamespace
def clear_namespace_update_listeners (self)
 
def get_all_cached_library_names (self)
 
def get_all_keywords_from (self, *datafiles)
 
def get_namespace (self)
 
def is_library_import_ok (self, imp)
 
def is_library_keyword (self, datafile, value)
 
def is_user_keyword (self, datafile, value)
 
def is_variables_import_ok (self, imp)
 
def keyword_info (self, datafile, keyword_name)
 
def register_for_namespace_updates (self, listener)
 
def unregister_namespace_updates (self, listener)
 
def update_namespace (self)
 

Public Attributes

 external_resources
 
 name
 

Properties

 data = property
 
 datafiles = property
 
 default_dir = property
 
 display_name = property
 
 resource_file_controller_factory = property
 
 resources = property
 
 suite = property
 
- Properties inherited from robotide.controller.basecontroller._BaseController
 display_name = property
 

Private Member Functions

def _create_controllers (self, datafile, resources)
 
def _create_resource_controller (self, parsed_resource, parent=None, resource_created_callback=None)
 
def _get_all_dirty_controllers (self)
 
def _load_datafile (self, path, load_observer)
 
def _load_initfile (self, path, load_observer)
 
def _load_resource (self, path, load_observer)
 
def _new_project (self, datafile)
 
def _populate_from_datafile (self, path, datafile, load_observer)
 
def _remove_file (self, path)
 
def _set_namespace (self, namespace)
 
def _sort_external_resources (self)
 
def _suites (self)
 
def data (self)
 
def datafiles (self)
 
def default_dir (self)
 
def display_name (self)
 
def resource_file_controller_factory (self)
 
def resources (self)
 
def suite (self)
 

Static Private Member Functions

def _construct_library_manager (library_manager, settings)
 
def _inform_resource_created (controller)
 

Private Attributes

 _controller
 
 _library_manager
 
 _loader
 
 _name_space
 
 _resource_file_controller_factory
 
 _serializer
 
 _settings
 

Detailed Description

Definition at line 32 of file project.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.controller.project.Project.__init__ (   self,
  namespace = None,
  settings = None,
  library_manager = None 
)

Definition at line 34 of file project.py.

◆ __del__()

def robotide.controller.project.Project.__del__ (   self)

Definition at line 54 of file project.py.

Member Function Documentation

◆ _construct_library_manager()

def robotide.controller.project.Project._construct_library_manager (   library_manager,
  settings 
)
staticprivate

Definition at line 50 of file project.py.

◆ _create_controllers()

def robotide.controller.project.Project._create_controllers (   self,
  datafile,
  resources 
)
private

Definition at line 192 of file project.py.

◆ _create_resource_controller()

def robotide.controller.project.Project._create_resource_controller (   self,
  parsed_resource,
  parent = None,
  resource_created_callback = None 
)
private

Definition at line 217 of file project.py.

◆ _get_all_dirty_controllers()

def robotide.controller.project.Project._get_all_dirty_controllers (   self)
private

Definition at line 309 of file project.py.

◆ _inform_resource_created()

def robotide.controller.project.Project._inform_resource_created (   controller)
staticprivate

Definition at line 229 of file project.py.

◆ _load_datafile()

def robotide.controller.project.Project._load_datafile (   self,
  path,
  load_observer 
)
private

Definition at line 178 of file project.py.

◆ _load_initfile()

def robotide.controller.project.Project._load_initfile (   self,
  path,
  load_observer 
)
private

Definition at line 155 of file project.py.

◆ _load_resource()

def robotide.controller.project.Project._load_resource (   self,
  path,
  load_observer 
)
private

Definition at line 209 of file project.py.

◆ _new_project()

def robotide.controller.project.Project._new_project (   self,
  datafile 
)
private

Definition at line 125 of file project.py.

◆ _populate_from_datafile()

def robotide.controller.project.Project._populate_from_datafile (   self,
  path,
  datafile,
  load_observer 
)
private

Definition at line 185 of file project.py.

◆ _remove_file()

def robotide.controller.project.Project._remove_file (   self,
  path 
)
private

Definition at line 288 of file project.py.

◆ _set_namespace()

def robotide.controller.project.Project._set_namespace (   self,
  namespace 
)
private

Reimplemented from robotide.controller.basecontroller.WithNamespace.

Definition at line 63 of file project.py.

◆ _sort_external_resources()

def robotide.controller.project.Project._sort_external_resources (   self)
private

Definition at line 239 of file project.py.

◆ _suites()

def robotide.controller.project.Project._suites (   self)
private

Definition at line 312 of file project.py.

◆ all_testcases()

def robotide.controller.project.Project.all_testcases (   self)

Definition at line 246 of file project.py.

◆ change_format()

def robotide.controller.project.Project.change_format (   self,
  controller,
  format 
)

Definition at line 277 of file project.py.

◆ change_format_recursive()

def robotide.controller.project.Project.change_format_recursive (   self,
  controller,
  format 
)

Definition at line 292 of file project.py.

◆ close()

def robotide.controller.project.Project.close (   self)

Definition at line 58 of file project.py.

◆ data()

def robotide.controller.project.Project.data (   self)
private

Definition at line 89 of file project.py.

◆ datafiles()

def robotide.controller.project.Project.datafiles (   self)
private

Definition at line 101 of file project.py.

◆ default_dir()

def robotide.controller.project.Project.default_dir (   self)
private

Definition at line 76 of file project.py.

◆ display_name()

def robotide.controller.project.Project.display_name (   self)
private

Reimplemented from robotide.controller.basecontroller._BaseController.

Definition at line 70 of file project.py.

◆ find_controller_by_longname()

def robotide.controller.project.Project.find_controller_by_longname (   self,
  longname,
  testname = None 
)

Definition at line 116 of file project.py.

◆ get_all_keywords()

def robotide.controller.project.Project.get_all_keywords (   self)

Definition at line 242 of file project.py.

◆ get_files_without_format()

def robotide.controller.project.Project.get_files_without_format (   self,
  controller = None 
)

Definition at line 251 of file project.py.

◆ get_root_suite_dir_path()

def robotide.controller.project.Project.get_root_suite_dir_path (   self)

Definition at line 258 of file project.py.

◆ insert_into_suite_structure()

def robotide.controller.project.Project.insert_into_suite_structure (   self,
  resource 
)

Definition at line 232 of file project.py.

◆ is_datafile_dirty()

def robotide.controller.project.Project.is_datafile_dirty (   self,
  datafile 
)

Definition at line 269 of file project.py.

◆ is_dirty()

def robotide.controller.project.Project.is_dirty (   self)

Definition at line 261 of file project.py.

◆ is_excluded()

def robotide.controller.project.Project.is_excluded (   self,
  source 
)

Definition at line 152 of file project.py.

◆ is_project_changed_from_disk()

def robotide.controller.project.Project.is_project_changed_from_disk (   self)

Definition at line 322 of file project.py.

◆ load_data()

def robotide.controller.project.Project.load_data (   self,
  path,
  load_observer = None 
)

Definition at line 137 of file project.py.

◆ load_datafile()

def robotide.controller.project.Project.load_datafile (   self,
  path,
  load_observer 
)

Definition at line 164 of file project.py.

◆ load_resource()

def robotide.controller.project.Project.load_resource (   self,
  path,
  load_observer 
)

Definition at line 203 of file project.py.

◆ new_directory_project()

def robotide.controller.project.Project.new_directory_project (   self,
  path 
)

Definition at line 119 of file project.py.

◆ new_file_project()

def robotide.controller.project.Project.new_file_project (   self,
  path 
)

Definition at line 122 of file project.py.

◆ new_resource()

def robotide.controller.project.Project.new_resource (   self,
  path,
  parent = None 
)

Definition at line 132 of file project.py.

◆ remove_datafile()

def robotide.controller.project.Project.remove_datafile (   self,
  controller 
)

Definition at line 296 of file project.py.

◆ remove_resource()

def robotide.controller.project.Project.remove_resource (   self,
  controller 
)

Definition at line 302 of file project.py.

◆ resource_file_controller_factory()

def robotide.controller.project.Project.resource_file_controller_factory (   self)
private

Definition at line 113 of file project.py.

◆ resource_import_modified()

def robotide.controller.project.Project.resource_import_modified (   self,
  path,
  directory 
)

Definition at line 317 of file project.py.

◆ resources()

def robotide.controller.project.Project.resources (   self)
private

Definition at line 107 of file project.py.

◆ save()

def robotide.controller.project.Project.save (   self,
  controller 
)

Definition at line 305 of file project.py.

◆ suite()

def robotide.controller.project.Project.suite (   self)
private

Definition at line 95 of file project.py.

◆ update_default_dir()

def robotide.controller.project.Project.update_default_dir (   self,
  path 
)

Definition at line 79 of file project.py.

Member Data Documentation

◆ _controller

robotide.controller.project.Project._controller
private

Definition at line 43 of file project.py.

◆ _library_manager

robotide.controller.project.Project._library_manager
private

Definition at line 36 of file project.py.

◆ _loader

robotide.controller.project.Project._loader
private

Definition at line 42 of file project.py.

◆ _name_space

robotide.controller.project.Project._name_space
private

Definition at line 39 of file project.py.

◆ _resource_file_controller_factory

robotide.controller.project.Project._resource_file_controller_factory
private

Definition at line 46 of file project.py.

◆ _serializer

robotide.controller.project.Project._serializer
private

Definition at line 47 of file project.py.

◆ _settings

robotide.controller.project.Project._settings
private

Definition at line 41 of file project.py.

◆ external_resources

robotide.controller.project.Project.external_resources

Definition at line 45 of file project.py.

◆ name

robotide.controller.project.Project.name

Definition at line 44 of file project.py.

Property Documentation

◆ data

robotide.controller.project.Project.data = property
static

Definition at line 87 of file project.py.

◆ datafiles

robotide.controller.project.Project.datafiles = property
static

Definition at line 99 of file project.py.

◆ default_dir

robotide.controller.project.Project.default_dir = property
static

Definition at line 74 of file project.py.

◆ display_name

robotide.controller.project.Project.display_name = property
static

Definition at line 68 of file project.py.

◆ resource_file_controller_factory

robotide.controller.project.Project.resource_file_controller_factory = property
static

Definition at line 111 of file project.py.

◆ resources

robotide.controller.project.Project.resources = property
static

Definition at line 105 of file project.py.

◆ suite

robotide.controller.project.Project.suite = property
static

Definition at line 93 of file project.py.


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