Each Config element provides actions on a local folder. More...
Public Member Functions | |
| def | __eq__ |
| def | __init__ |
| def | __str__ |
| def | backup |
| def | get_diff |
| def | get_local_name |
| def | get_path |
| def | get_path_spec |
| def | get_properties |
| def | get_status |
| def | get_versioned_path_spec |
| def | install |
| def | is_vcs_element |
| def | prepare_install |
Public Attributes | |
| local_name | |
| path | |
| properties | |
Detailed Description
Each Config element provides actions on a local folder.
Base class for Config provides methods with not implemented exceptions. Also a few shared methods.
Definition at line 61 of file config_elements.py.
Constructor & Destructor Documentation
| def config_elements.ConfigElement.__init__ | ( | self, | |
| path, | |||
| local_name, | |||
properties = None |
|||
| ) |
Definition at line 64 of file config_elements.py.
Member Function Documentation
| def config_elements.ConfigElement.__eq__ | ( | self, | |
| other | |||
| ) |
Definition at line 123 of file config_elements.py.
| def config_elements.ConfigElement.__str__ | ( | self | ) |
Definition at line 121 of file config_elements.py.
| def config_elements.ConfigElement.backup | ( | self, | |
| backup_path | |||
| ) |
Definition at line 115 of file config_elements.py.
| def config_elements.ConfigElement.get_diff | ( | self, | |
basepath = None |
|||
| ) |
Reimplemented in config_elements.VCSConfigElement.
Definition at line 111 of file config_elements.py.
| def config_elements.ConfigElement.get_local_name | ( | self | ) |
What the user specified in his config
Definition at line 73 of file config_elements.py.
| def config_elements.ConfigElement.get_path | ( | self | ) |
A normalized absolute path
Definition at line 70 of file config_elements.py.
| def config_elements.ConfigElement.get_path_spec | ( | self | ) |
PathSpec object with values as specified in file
Reimplemented in config_elements.VCSConfigElement, config_elements.SetupConfigElement, and config_elements.OtherConfigElement.
Definition at line 99 of file config_elements.py.
| def config_elements.ConfigElement.get_properties | ( | self | ) |
Any meta information attached
Definition at line 102 of file config_elements.py.
| def config_elements.ConfigElement.get_status | ( | self, | |
basepath = None, |
|||
untracked = False |
|||
| ) |
Reimplemented in config_elements.VCSConfigElement.
Definition at line 113 of file config_elements.py.
PathSpec where VCS elements have the version looked up
Reimplemented in config_elements.VCSConfigElement, config_elements.SetupConfigElement, and config_elements.OtherConfigElement.
Definition at line 105 of file config_elements.py.
| def config_elements.ConfigElement.install | ( | self, | |
checkout = True, |
|||
backup = False, |
|||
backup_path = None, |
|||
verbose = False |
|||
| ) |
Attempt to make it so that self.path is the result of checking out / updating from remote repo. No user Interaction allowed here (for concurrent mode). :param checkout: whether to checkout or update :param backup: if checking out, what to do if path exists. If true, backup_path must be set.
Reimplemented in config_elements.VCSConfigElement, config_elements.SetupConfigElement, and config_elements.OtherConfigElement.
Definition at line 89 of file config_elements.py.
| def config_elements.ConfigElement.is_vcs_element | ( | self | ) |
Reimplemented in config_elements.VCSConfigElement.
Definition at line 108 of file config_elements.py.
| def config_elements.ConfigElement.prepare_install | ( | self, | |
backup_path = None, |
|||
arg_mode = 'abort', |
|||
robust = False |
|||
| ) |
Check whether install can be performed, asking user for decision if necessary. :param arg_mode: one of prompt, backup, delete, skip. Determines how to handle error cases :param backup_path: if arg_mode==backup, determines where to backup to :param robust: if true, operation will be aborted without changes to the filesystem and without user interaction :returns: A preparation_report instance, telling whether to checkout or to update, how to deal with existing tree, and where to backup to.
Reimplemented in config_elements.VCSConfigElement.
Definition at line 76 of file config_elements.py.
Member Data Documentation
Definition at line 64 of file config_elements.py.
Definition at line 64 of file config_elements.py.
Definition at line 64 of file config_elements.py.
The documentation for this class was generated from the following file: