Package ccm :: Class Project
[hide private]
[frames] | no frames]

Class Project

source code

  object --+        
           |        
FourPartName --+    
               |    
       CCMObject --+
                   |
                  Project

Wrapper class for Synergy project object.

Instance Methods [hide private]
 
__init__(self, session, fpn)
Create a FourPartName object based on a ifpn string.
source code
 
_gettasks(self) source code
 
add_task(self, task)
Add a task to the update properties.
source code
 
remove_task(self, task)
Remove a task to the update properties.
source code
 
add_folder(self, folder)
Add a folder to the update properties.
source code
 
remove_folder(self, folder)
Remove a folder to the update properties.
source code
 
_getfolders(self)
Wrapper method to return the folder list from the update properties - please use the folders attribute to access it.
source code
 
_getsubprojects(self)
Wrapper method to return the subprojects list - please use the subprojects attribute to access it.
source code
 
get_members(self, recursive=False, **kargs) source code
 
_getrelease(self)
Get the release of the current object.
source code
 
_setrelease(self, release)
Set the release of the current object.
source code
 
refresh(self)
Refresh project update properties.
source code
 
_getbaseline(self)
Get the baseline of the current project.
source code
 
set_baseline(self, baseline, recurse=False)
Set project baseline.
source code
 
set_update_method(self, name, recurse=False)
Set the update method for the project (and subproject if recurse is True).
source code
 
apply_update_properties(self, baseline=True, tasks_and_folders=True, recurse=True)
Apply update properties to subprojects.
source code
 
root_dir(self)
Return the directory attached to a project.
source code
 
snapshot(self, targetdir, recursive=False)
Take a snapshot of the project.
source code
 
checkout(self, release, version=None, purpose=None, subprojects=True)
Create a checkout of this project.
source code
 
work_area(self, maintain, recursive=None, relative=None, path=None, pst=None, wat=False)
Configure the work area.
source code
 
update(self, recurse=True, replaceprojects=True, keepgoing=False, result=None)
Update the project based on its reconfigure properties.
source code
 
reconcile(self, updatewa=True, recurse=True, consideruncontrolled=True, missingwafile=True, report=True)
Reconcile the project to force the work area to match the database.
source code
 
get_latest_baseline(self, filterstring="*", state="released") source code
 
create_baseline(self, baseline_name, release, baseline_tag, purpose="System Testing", state="published_baseline") source code
 
sync(self, recurse=False, static=False)
Synchronize project content.
source code
 
conflicts(self, recurse=False, tasks=False) source code
 
tasks(self) source code
 
folders(self)
Wrapper method to return the folder list from the update properties - please use the folders attribute to access it.
source code
 
subprojects(self)
Wrapper method to return the subprojects list - please use the subprojects attribute to access it.
source code

Inherited from CCMObject: __getitem__, __setitem__, create_attribute, exists, finduse, is_predecessor_of, is_recursive_predecessor_of, is_recursive_predecessor_of_fast, is_recursive_successor_of_fast, is_recursive_sucessor_of, keys, predecessors, relate, session, successors

Inherited from CCMObject (private): _getsession

Inherited from FourPartName: __eq__, __ne__, __repr__, __str__, family, instance, is_same_family, name, objectname, type, version

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__

Static Methods [hide private]

Inherited from FourPartName: convert, is_valid

Class Variables [hide private]
  release = property(_getrelease, _setrelease)
  baseline = property(_getbaseline, set_baseline)
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, session, fpn)
(Constructor)

source code 

Create a FourPartName object based on a ifpn string.

The string have to match the following patterns: - name-version:type:instance - name:version:releasedef:instance - Task database#id - Folder database#id

Anything else is considered as old release string format.

Overrides: CCMObject.__init__

_getrelease(self)

source code 
Get the release of the current object. Returns a Releasedef object.

set_baseline(self, baseline, recurse=False)

source code 
Set project baseline. raise a CCMException in case or error.

checkout(self, release, version=None, purpose=None, subprojects=True)

source code 

Create a checkout of this project.

This will only checkout the project in Synergy. It does not create a work area.

Parameters:
  • release - The Synergy release tag to use.
  • version - The new version to use for the project. This is applied to all subprojects.
  • purpose - The purpose of the checkout. Determines automatically the role from the purpose and switch it automatically (Could be any role from the DB).

work_area(self, maintain, recursive=None, relative=None, path=None, pst=None, wat=False)

source code 
Configure the work area. This allow to enable it or disable it, set the path, recursion...

sync(self, recurse=False, static=False)

source code 
Synchronize project content. By default it is not been done recusively. (Not unittested)