niryo_libraries.niryo_robot_programs_manager.ProgramsFileManager.ProgramsFileManager

class documentation

class ProgramsFileManager(object):

Constructor: ProgramsFileManager(progs_dir, language, extension, runnable)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method create Undocumented
Method execute Undocumented
Method exists Check if a file with a certain name exists
Method get_all_names Get all filenames available in storage
Method get_all_names_with_description Undocumented
Method get_all_names_with_subdirectory Undocumented
Method get_saved_at Return the modification time of the file :param name: the program's file name :type name: str :return: the modification time of the file :rtype: str
Method read Read
Method read_description Read description
Method remove Remove file
Method stop_execution Undocumented
Class Variable associated_path Undocumented
Property runnable Undocumented
Static Method _generate_raw_text Undocumented
Method _filename_from_name Undocumented
Method _init_extension_n_suffix Undocumented
Method _name_from_filename Undocumented
Method _path_from_name Undocumented
Method _read_raw_file Read file
Instance Variable _extension Undocumented
Instance Variable _language Undocumented
Instance Variable _progs_dir Undocumented
Instance Variable _runnable Undocumented
Instance Variable _suffix Undocumented
def __init__(self, progs_dir, language, extension, runnable):

Undocumented

def create(self, name, code, description, allow_overwrite):

Undocumented

def execute(self, _name):

Undocumented

def exists(self, name):

Check if a file with a certain name exists

Parameters
name:strfile name
Returns
boolTrue if file exists, else False
def get_all_names(self, with_suffix=False):

Get all filenames available in storage

Parameters
with_suffix
Returns
list[str]list of filenames
Raises
Unknown exceptionProgramFileException: if any error
def get_all_names_with_description(self):

Undocumented

def get_all_names_with_subdirectory(self):

Undocumented

def get_saved_at(self, name):

Return the modification time of the file :param name: the program's file name :type name: str :return: the modification time of the file :rtype: str

def read(self, name):

Read

Parameters
name:str
Returns
(str, str)Code, description
def read_description(self, name):

Read description

def remove(self, name):

Remove file

Parameters
name:strfile name
Returns
None
Raises
Unknown exceptionProgramFileException: if any error
def stop_execution(self):

Undocumented

associated_path: str =

Undocumented

@property
runnable =

Undocumented

@staticmethod
def _generate_raw_text(code, description):

Undocumented

def _filename_from_name(self, name):

Undocumented

def _init_extension_n_suffix(self, extension):

Undocumented

def _name_from_filename(self, filename):

Undocumented

def _path_from_name(self, name):

Undocumented

def _read_raw_file(self, name):

Read file

Parameters
name:strfile name
Returns
strThe file
Raises
Unknown exceptionProgramFileException: if any error
_extension =

Undocumented

_language =

Undocumented

_progs_dir =

Undocumented

_runnable =

Undocumented

_suffix =

Undocumented