Inheritance diagram for cmstc.TagCollector:

Public Member Functions
def	__del__ (self)

def	__init__ (self, useCert=False)

def	approvePackage (self, package)

def	approveTagsets (self, tagset_ids, comment='')

def	bypassTagsets (self, tagset_ids, comment='')

def	commentTagsets (self, tagset_ids, comment)

def	createRelease (self, base_release_name, new_release_name, new_state, new_private, new_type, new_description, release_managers, copy_queues, tags)

def	deprecateReleases (self, releases)

def	getIBs (self, filt='', limit=10)

def	getPackageManagersRequested (self, package)

def	getPackagesPendingApproval (self)

def	getPackageTagDescriptionFirstLine (self, package, tag)

def	getPackageTagReleases (self, package, tag)

def	getPackageTags (self, package)

def	getPendingApprovalTags (self, args, allow_multiple_tags=False)

def	getReleaseArchitectures (self, release, default='0')

def	getReleasesTags (self, releases, diff=False)

def	getReleaseTags (self, release)

def	getTagsetInformation (self, tagset)

def	getTagsetsTagsPendingSignatures (self, user_name, show_all, author_tagsets, release_names=None)

def	getTagsetTags (self, tagset)

def	rejectTagsetsPendingApproval (self, tagset_ids, comment='')

def	rejectTagsetsPendingSignatures (self, tagset_ids, comment='')

def	removeTagsets (self, tagset_ids, comment='')

def	requestCustomIB (self, release_name, architectures, tags)

def	search (self, term)

def	signIn (self, username, password)

def	signInInteractive (self)

def	signOut (self)

def	signTagsets (self, tagset_ids, comment='')

def	signTagsetsAll (self, tagset_ids, comment='')

Public Attributes
	login

	useCert

Private Member Functions
def	_open (self, page, params=None, data=None)

def	_openjson (self, page, params=None, data=None)

Private Attributes
	_cj

	_opener

	_url

Detailed Description

CMS TagCollector Python API

Definition at line 24 of file cmstc.py.

Constructor & Destructor Documentation

def cmstc.TagCollector.__init__	(	self,
		useCert = `False`
	)

Definition at line 27 of file cmstc.py.

     def __init__(self,useCert=False):
         self._url = _tagcollector_url
         self.useCert = useCert
         self.login = False
         if self.useCert:
             self.login = True
             self._cj = cookielib.CookieJar()
             self._opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(self._cj))
 

def cmstc.TagCollector.__del__ ( self )

Definition at line 36 of file cmstc.py.

References cmstc.TagCollector.login, cmstc.TagCollector.signOut(), upload_popcon.ConditionsUploader.signOut(), and uploadConditions.ConditionsUploader.signOut().

     def __del__(self):
         if self.login: self.signOut()
 

Member Function Documentation

def cmstc.TagCollector._open	(	self,
		page,
		params = `None`,
		data = `None`
	)

private

Definition at line 39 of file cmstc.py.

References url_query.url_query._url, cmstc.TagCollector._url, conddblib.Connection._url, ws_sso_content_reader.getContent(), digitizers_cfi.strip, and cmstc.TagCollector.useCert.

     def _open(self, page, params = None, data = None):
         url = self._url + page + '?'
         if params:
             url += urllib.urlencode(params)
         if data:
             data = urllib.urlencode(data)
         if self.useCert:
             return ws_sso_content_reader.getContent(url, '~/.globus/usercert.pem', '~/.globus/userkey.pem', data)
         try:
             return self._opener.open(url, data).read()
         except urllib2.HTTPError as e:
             raise Exception(e.read().strip())
 

def cmstc.TagCollector._openjson	(	self,
		page,
		params = `None`,
		data = `None`
	)

private

Definition at line 52 of file cmstc.py.

References cmstc.TagCollector._open().

     def _openjson(self, page, params = None, data = None):
         return json.loads(self._open(page, params, data))
 

def cmstc.TagCollector.approvePackage	(	self,
		package
	)

Approve a New Package Request.
Requirement: Signed in as a Creator (i.e. people in the top-level .admin/developers file).
Warning: This does *not* create the package in CVS.

Definition at line 192 of file cmstc.py.

References cmstc.TagCollector._open().

     def approvePackage(self, package):
         """Approve a New Package Request.
         Requirement: Signed in as a Creator (i.e. people in the top-level .admin/developers file).
         Warning: This does *not* create the package in CVS."""
         self._open('approveNewPackageRequest', {'package_name': package})
 

def cmstc.TagCollector.approveTagsets	(	self,
		tagset_ids,
		comment = `''`
	)

Approve one or more tagsets.
Requirement: Signed in as a Release Manager for each tagset's release.

Definition at line 155 of file cmstc.py.

References cmstc.TagCollector._open().

     def approveTagsets(self, tagset_ids, comment = ''):
         """Approve one or more tagsets.
         Requirement: Signed in as a Release Manager for each tagset's release."""
         tagset_ids = json.dumps(tagset_ids)
         self._open('approveTagsets', {'tagset_ids': tagset_ids, 'comment': comment})
 

def cmstc.TagCollector.bypassTagsets	(	self,
		tagset_ids,
		comment = `''`
	)

Bypass one or more tagsets.
Requirement: Signed in as a Release Manager for each tagset's release.

Definition at line 161 of file cmstc.py.

References cmstc.TagCollector._open().

     def bypassTagsets(self, tagset_ids, comment = ''):
         """Bypass one or more tagsets.
         Requirement: Signed in as a Release Manager for each tagset's release."""
         tagset_ids = json.dumps(tagset_ids)
         self._open('bypassTagsets', {'tagset_ids': tagset_ids, 'comment': comment})
 

def cmstc.TagCollector.commentTagsets	(	self,
		tagset_ids,
		comment
	)

Comment one or more tagsets.
Requirement: Signed in.

Definition at line 128 of file cmstc.py.

References cmstc.TagCollector._open().

     def commentTagsets(self, tagset_ids, comment):
         """Comment one or more tagsets.
         Requirement: Signed in."""
         tagset_ids = json.dumps(tagset_ids)
         if len(comment) < 1:
             raise Exception("Error: Expected a comment.")
         self._open('commentTagsets', {'tagset_ids': tagset_ids, 'comment': comment})
 

def cmstc.TagCollector.createRelease	(	self,
		base_release_name,
		new_release_name,
		new_state,
		new_private,
		new_type,
		new_description,
		release_managers,
		copy_queues,
		tags
	)

Create a new release.
Requirement: Signed in as a release manager.

Definition at line 210 of file cmstc.py.

References cmstc.TagCollector._open(), and cmstc.TagCollector.login.

     def createRelease(self, base_release_name, new_release_name, new_state, new_private, new_type, new_description, release_managers, copy_queues, tags):
         """Create a new release.
         Requirement: Signed in as a release manager."""
         if self.login:
             self._open('copyRelease', {'release_name': base_release_name, 'new_release_name': new_release_name, 'new_state': new_state, 'new_private': new_private, 'new_type': new_type, 'new_description': new_description, 'release_managers': release_managers, 'copy_queues': copy_queues, 'tags': tags})
         else:
             raise Exception("Error: Not logged in?!")
 

def cmstc.TagCollector.deprecateReleases	(	self,
		releases
	)

Deprecate releases

Definition at line 204 of file cmstc.py.

References cmstc.TagCollector._open(), join(), and cmstc.TagCollector.login.

     def deprecateReleases(self, *releases):
         """ Deprecate releases"""
         if not self.login:
             raise Exception("Error: Not logged in?!")
         self._open('deprecateReleases', {"releases": ",".join(releases)})
 

def cmstc.TagCollector.getIBs	(	self,
		filt = `''`,
		limit = `10`
	)

Get the name and creation date of Integration Builds.
By default, it only returns the latest 10 IBs.
Optionally, filter by name.

Definition at line 198 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getIBs(self, filt = '', limit = 10):
         """Get the name and creation date of Integration Builds.
         By default, it only returns the latest 10 IBs.
         Optionally, filter by name."""
         return self._openjson('public/py_getIBs', {'filt': filt, 'limit': limit})
 

def cmstc.TagCollector.getPackageManagersRequested	(	self,
		package
	)

Get the Package Managers (administrators and developers) requested in a New Package Request.

Definition at line 183 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getPackageManagersRequested(self, package):
         """Get the Package Managers (administrators and developers) requested in a New Package Request."""
         return self._openjson('public/py_getPackageManagersRequested', {'package': package})
 

def cmstc.TagCollector.getPackagesPendingApproval ( self )

Get New Package Requests which are Pending Approval.

Definition at line 179 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getPackagesPendingApproval(self):
         """Get New Package Requests which are Pending Approval."""
         return self._openjson('public/py_getPackagesPendingApproval')
 

def cmstc.TagCollector.getPackageTagDescriptionFirstLine	(	self,
		package,
		tag
	)

Get the first line of the descriptions of a tag.

Definition at line 80 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getPackageTagDescriptionFirstLine(self, package, tag):
         """Get the first line of the descriptions of a tag."""
         return self._openjson('public/py_getPackageTagDescriptionFirstLine', {'package': package, 'tag': tag})
 

def cmstc.TagCollector.getPackageTagReleases	(	self,
		package,
		tag
	)

Get the releases where a tag is.

Definition at line 84 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getPackageTagReleases(self, package, tag):
         """Get the releases where a tag is."""
         return self._openjson('public/py_getPackageTagReleases', {'package': package, 'tag': tag})
 

def cmstc.TagCollector.getPackageTags	(	self,
		package
	)

Get the tags published in TagCollector for a package.
Note: TagCollector's published tags are a subset of CVS' tags.

Definition at line 75 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getPackageTags(self, package):
         """Get the tags published in TagCollector for a package.
         Note: TagCollector's published tags are a subset of CVS' tags."""
         return self._openjson('public/py_getPackageTags', {'package': package})
 

def cmstc.TagCollector.getPendingApprovalTags	(	self,
		args,
		allow_multiple_tags = `False`
	)

Prints Pending Approval tags of one or more releases,
one or more tagsets, or both (i.e. it joins all the tags).
Prints an error if several tags appear for a single package.
Suitable for piping to addpkg (note: at the moment,
addpkg does not read from stdin, use "-f" instead).

Definition at line 107 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getPendingApprovalTags(self, args, allow_multiple_tags = False):
         """Prints Pending Approval tags of one or more releases,
         one or more tagsets, or both (i.e. it joins all the tags).
         Prints an error if several tags appear for a single package.
         Suitable for piping to addpkg (note: at the moment,
         addpkg does not read from stdin, use "-f" instead)."""
         args = json.dumps(args)
         allow_multiple_tags = json.dumps(allow_multiple_tags)
         return self._openjson('public/py_getPendingApprovalTags', {'args': args, 'allow_multiple_tags': allow_multiple_tags})
 

def cmstc.TagCollector.getReleaseArchitectures	(	self,
		release,
		default = `'0'`
	)

Returns release architectures.

Definition at line 226 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getReleaseArchitectures(self, release, default='0'):
         """Returns release architectures."""
         return self._openjson('public/py_getReleaseArchitectures', {'release': release, 'default': default})

def cmstc.TagCollector.getReleasesTags	(	self,
		releases,
		diff = `False`
	)

Get the tags of one or more release.
Optionally, return only the tags that differ between releases.

Definition at line 88 of file cmstc.py.

References cmstc.TagCollector._openjson().

Referenced by cmstc.TagCollector.getReleaseTags().

     def getReleasesTags(self, releases, diff = False):
         """Get the tags of one or more release.
         Optionally, return only the tags that differ between releases."""
         releases = json.dumps(releases)
         diff = json.dumps(diff)
         return self._openjson('public/py_getReleasesTags', {'releases': releases, 'diff': diff})
 

def cmstc.TagCollector.getReleaseTags	(	self,
		release
	)

Get the tags of one release.

Definition at line 95 of file cmstc.py.

References cmstc.TagCollector.getReleasesTags().

     def getReleaseTags(self, release):
         """Get the tags of one release."""
         return self.getReleasesTags((release, ))
 

def cmstc.TagCollector.getTagsetInformation	(	self,
		tagset
	)

Get the information of one tagset.

Definition at line 103 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getTagsetInformation(self, tagset):
         """Get the information of one tagset."""
         return self._openjson('public/py_getTagsetInformation', {'tagset': tagset})
 

def cmstc.TagCollector.getTagsetsTagsPendingSignatures	(	self,
		user_name,
		show_all,
		author_tagsets,
		release_names = `None`
	)

Prints Pending Signature tags of one or more releases,
one or more tagsets, or both (i.e. it joins all the tags).
Prints an error if several tags appear for a single package.
Suitable for piping to addpkg (note: at the moment,
addpkg does not read from stdin, use "-f" instead).

Definition at line 117 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getTagsetsTagsPendingSignatures(self, user_name, show_all, author_tagsets, release_names = None):
         """Prints Pending Signature tags of one or more releases,
         one or more tagsets, or both (i.e. it joins all the tags).
         Prints an error if several tags appear for a single package.
         Suitable for piping to addpkg (note: at the moment,
         addpkg does not read from stdin, use "-f" instead)."""
         if not release_names == None:
             return self._openjson('public/py_getTagsetsTagsPendingSignatures', {'user_name': user_name, 'show_all': show_all, 'author_tagsets': author_tagsets, 'release_names': json.dumps(release_names)})
         else:
             return self._openjson('public/py_getTagsetsTagsPendingSignatures', {'user_name': user_name, 'show_all': show_all, 'author_tagsets': author_tagsets})
 

def cmstc.TagCollector.getTagsetTags	(	self,
		tagset
	)

Get the tags of one tagset.

Definition at line 99 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def getTagsetTags(self, tagset):
         """Get the tags of one tagset."""
         return self._openjson('public/py_getTagsetTags', {'tagset': tagset})
 

def cmstc.TagCollector.rejectTagsetsPendingApproval	(	self,
		tagset_ids,
		comment = `''`
	)

Reject one or more tagsets Pending Approval.
Requirement: Signed in as a Release Manager.

Definition at line 167 of file cmstc.py.

References cmstc.TagCollector._open().

     def rejectTagsetsPendingApproval(self, tagset_ids, comment = ''):
         """Reject one or more tagsets Pending Approval.
         Requirement: Signed in as a Release Manager."""
         tagset_ids = json.dumps(tagset_ids)
         self._open('rejectTagsetsPendingApproval', {'tagset_ids': tagset_ids, 'comment': comment})
 

def cmstc.TagCollector.rejectTagsetsPendingSignatures	(	self,
		tagset_ids,
		comment = `''`
	)

Reject one or more tagsets Pending Signatures.
Requirement: Signed in as a L2s or as a Release Manager
for the tagset's release or as the author of the tagset.

Definition at line 148 of file cmstc.py.

References cmstc.TagCollector._open().

     def rejectTagsetsPendingSignatures(self, tagset_ids, comment = ''):
         """Reject one or more tagsets Pending Signatures.
         Requirement: Signed in as a L2s or as a Release Manager
         for the tagset's release or as the author of the tagset."""
         tagset_ids = json.dumps(tagset_ids)
         self._open('rejectTagsetsPendingSignatures', {'tagset_ids': tagset_ids, 'comment': comment})
 

def cmstc.TagCollector.removeTagsets	(	self,
		tagset_ids,
		comment = `''`
	)

Remove one or more tagsets from the History (i.e. stack of the release).
Requirement: Signed in as a Release Manager.

Definition at line 173 of file cmstc.py.

References cmstc.TagCollector._open().

     def removeTagsets(self, tagset_ids, comment = ''):
         """Remove one or more tagsets from the History (i.e. stack of the release).
         Requirement: Signed in as a Release Manager."""
         tagset_ids = json.dumps(tagset_ids)
         self._open('removeTagsets', {'tagset_ids': tagset_ids, 'comment': comment})
 

def cmstc.TagCollector.requestCustomIB	(	self,
		release_name,
		architectures,
		tags
	)

Request a CustomIB.
Requirement: Signed in.

Definition at line 218 of file cmstc.py.

References cmstc.TagCollector._open(), and cmstc.TagCollector.login.

     def requestCustomIB(self, release_name, architectures, tags):
         """Request a CustomIB.
         Requirement: Signed in."""
         if self.login:
             self._open('requestCustomIB', {'release_name': release_name, 'architecture_names': architectures, 'tags': tags})
         else:
             raise Exception("Error: Not logged in?!")
 

def cmstc.TagCollector.search	(	self,
		term
	)

Searches for releases, packages, tagsets, users and categories.
Requirement: Signed in.

Definition at line 187 of file cmstc.py.

References cmstc.TagCollector._openjson().

     def search(self, term):
         """Searches for releases, packages, tagsets, users and categories.
         Requirement: Signed in."""
         return self._openjson('search', {'term': term})
 

def cmstc.TagCollector.signIn	(	self,
		username,
		password
	)

Definition at line 55 of file cmstc.py.

References cmstc.TagCollector._open(), cmstc.TagCollector.login, and cmstc.TagCollector.useCert.

Referenced by cmstc.TagCollector.signInInteractive().

     def signIn(self, username, password):
         if self.useCert: return
         """Sign in to TagCollector."""
         self._open('signIn', data = {'password': password, 'user_name': username})
         self.login = True
 

def cmstc.TagCollector.signInInteractive ( self )

Definition at line 61 of file cmstc.py.

References cmstc.TagCollector.signIn(), upload_popcon.ConditionsUploader.signIn(), uploadConditions.ConditionsUploader.signIn(), and cmstc.TagCollector.useCert.

     def signInInteractive(self):
         if self.useCert: return
         """Sign in to TagCollector, asking for the username and password."""
         username = raw_input('Username: ')
         password = getpass.getpass()
         self.signIn(username, password)
         return username
 

def cmstc.TagCollector.signOut ( self )

Definition at line 69 of file cmstc.py.

References cmstc.TagCollector._open(), cmstc.TagCollector.login, and cmstc.TagCollector.useCert.

Referenced by cmstc.TagCollector.__del__().

     def signOut(self):
         if self.useCert: return
         """Sign out of TagCollector."""
         self._open('signOut')
         self.login = False
 

def cmstc.TagCollector.signTagsets	(	self,
		tagset_ids,
		comment = `''`
	)

Sign one or more tagsets.
Requirement: Signed in as a L2.

Definition at line 136 of file cmstc.py.

References cmstc.TagCollector._open().

     def signTagsets(self, tagset_ids, comment = ''):
         """Sign one or more tagsets.
         Requirement: Signed in as a L2."""
         tagset_ids = json.dumps(tagset_ids)
         self._open('signTagsets', {'tagset_ids': tagset_ids, 'comment': comment})
 

def cmstc.TagCollector.signTagsetsAll	(	self,
		tagset_ids,
		comment = `''`
	)

Sign all one or more tagsets.
Requirement: Signed in as a top-level admin.

Definition at line 142 of file cmstc.py.

References cmstc.TagCollector._open().

     def signTagsetsAll(self, tagset_ids, comment = ''):
         """Sign all one or more tagsets.
         Requirement: Signed in as a top-level admin."""
         tagset_ids = json.dumps(tagset_ids)
         self._open('signTagsetsAll', {'tagset_ids': tagset_ids, 'comment': comment})
 