config_elements.VCSConfigElement Class Reference

Inheritance diagram for config_elements.VCSConfigElement:

List of all members.

Public Member Functions
def	__init__
def	detect_presence
def	get_diff
def	get_path_spec
def	get_status
def	get_vcs_type_name
def	get_versioned_path_spec
def	install
def	is_vcs_element
def	path_exists
def	prepare_install
Public Attributes
	uri
	version
Private Member Functions
def	_get_vcsc

---

Detailed Description

Definition at line 169 of file config_elements.py.

---

Constructor & Destructor Documentation

def config_elements.VCSConfigElement.__init__	(		self,
			path,
			local_name,
			uri,
			version = '',
			properties = None
	)

Creates a config element for a VCS repository.

:param path: absolute or relative path, str
:param vcs_client: Object compatible with vcstools.VcsClientBase
:param local_name: display name for the element, str
:param uri: VCS uri to checkout/pull from, str
:param version: optional revision spec (tagname, SHAID, ..., str)

Definition at line 171 of file config_elements.py.

---

Member Function Documentation

def config_elements.VCSConfigElement._get_vcsc

(

self

)

[private]

Reimplemented in config_elements.AVCSConfigElement.

Definition at line 187 of file config_elements.py.

def config_elements.VCSConfigElement.detect_presence

(

self

)

Reimplemented in config_elements.AVCSConfigElement.

Definition at line 197 of file config_elements.py.

def config_elements.VCSConfigElement.get_diff	(		self,
			basepath = None
	)

Reimplemented from config_elements.ConfigElement.

Definition at line 307 of file config_elements.py.

def config_elements.VCSConfigElement.get_path_spec

(

self

)

PathSpec object with values as specified in file

Reimplemented from config_elements.ConfigElement.

Definition at line 276 of file config_elements.py.

def config_elements.VCSConfigElement.get_status	(		self,
			basepath = None,
			untracked = False
	)

Reimplemented from config_elements.ConfigElement.

Definition at line 310 of file config_elements.py.

def config_elements.VCSConfigElement.get_vcs_type_name

(

self

)

Reimplemented in config_elements.AVCSConfigElement.

Definition at line 193 of file config_elements.py.

def config_elements.VCSConfigElement.get_versioned_path_spec

(

self

)

PathSpec where VCS elements have the version looked up

Reimplemented from config_elements.ConfigElement.

Definition at line 287 of file config_elements.py.

def config_elements.VCSConfigElement.install	(		self,
			checkout = True,
			backup = True,
			backup_path = None,
			verbose = False
	)

Runs the equivalent of SCM checkout for new local repos or update for existing.

:param checkout: whether to use an update command or a checkout/clone command
:param backup: if checkout is True and folder exists, if backup is false folder will be DELETED.
:param backup_path: if checkout is true and backup is true, move folder to this location

Reimplemented from config_elements.ConfigElement.

Definition at line 253 of file config_elements.py.

def config_elements.VCSConfigElement.is_vcs_element

(

self

)

Reimplemented from config_elements.ConfigElement.

Definition at line 190 of file config_elements.py.

def config_elements.VCSConfigElement.path_exists

(

self

)

Definition at line 201 of file config_elements.py.

def config_elements.VCSConfigElement.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 from config_elements.ConfigElement.

Definition at line 206 of file config_elements.py.

---

Member Data Documentation

config_elements.VCSConfigElement::uri

Definition at line 179 of file config_elements.py.

config_elements.VCSConfigElement::version

Definition at line 179 of file config_elements.py.

---

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

• config_elements.py