lp.soyuz.interfaces.archive.IArchiveEdit : API documentation

Method	newPackageUploader	Add permisson for a person to upload a package to this archive.
Method	newComponentUploader	Add permission for a person to upload to a component.
Method	newPocketUploader	Add permission for a person to upload to a pocket.
Method	newQueueAdmin	Add permission for a person to administer a distroseries queue.
Method	newPocketQueueAdmin	Add permission for a person to administer a distroseries queue.
Method	newPackagesetUploader	Add a package set based permission for a person.
Method	deletePackageUploader	Revoke permission for the person to upload the package.
Method	deleteComponentUploader	Revoke permission for the person to upload to the component.
Method	deletePocketUploader	Revoke permission for the person to upload to the pocket.
Method	deleteQueueAdmin	Revoke permission for the person to administer distroseries queues.
Method	deletePocketQueueAdmin	Revoke permission for the person to administer distroseries queues.
Method	deletePackagesetUploader	Revoke upload permissions for a person.
Method	enable	Enable the archive.
Method	disable	Disable the archive.
Method	addArchiveDependency	Record an archive dependency record for the context archive.
Method	removeArchiveDependency	Remove the `IArchiveDependency` record for the given dependency.
Method	newNamedAuthToken	Create a new named authorization token.
Method	newNamedAuthTokens	Create named authorization tokens in bulk.
Method	getNamedAuthToken	Return a named authorization token for the given name in this
Method	getNamedAuthTokens	Return a subset of active named authorization tokens for this
Method	revokeNamedAuthToken	Deactivate a named authorization token.
Method	revokeNamedAuthTokens	Deactivate named authorization tokens in bulk.
Method	markSuiteDirty	Mark a suite as dirty in this archive.
Method	_addArchiveDependency	Record an archive dependency record for the context archive.

@operation_parameters(Reference(IPerson), TextLine(_('Source Package Name'), True))
@export_factory_operation(Interface, )
def newPackageUploader(person, source_package_name):

Add permisson for a person to upload a package to this archive.

Parameters	person	An `IPerson` whom should be given permission.
	source_package_name	An `ISourcePackageName` or textual package name.
Returns	An `IArchivePermission` which is the newly-created permission.

@operation_parameters(Reference(IPerson), TextLine(_('Component Name'), True))
@export_factory_operation(Interface, )
def newComponentUploader(person, component_name):

Add permission for a person to upload to a component.

Parameters	person	An `IPerson` whom should be given permission.
	component	An `IComponent` or textual component name.
Returns	An `IArchivePermission` which is the newly-created permission.
Raises	InvalidComponent	if this archive is a PPA and the component is not 'main'.

@operation_parameters(Reference(IPerson), Choice(_('Pocket'), PackagePublishingPocket, True))
@export_factory_operation(Interface, )
@operation_for_version('devel')
def newPocketUploader(person, pocket):

Add permission for a person to upload to a pocket.

Parameters	person	An `IPerson` whom should be given permission.
	pocket	A `PackagePublishingPocket`.
Returns	An `IArchivePermission` which is the newly-created permission.
Raises	InvalidPocketForPartnerArchive	if this archive is a partner archive and the pocket is not RELEASE or PROPOSED.
	InvalidPocketForPPA	if this archive is a PPA and the pocket is not RELEASE.

@operation_parameters(Reference(IPerson), TextLine(_('Component Name'), True))
@export_factory_operation(Interface, )
def newQueueAdmin(person, component_name):

Add permission for a person to administer a distroseries queue.

The supplied person will gain permission to administer the distroseries queue for packages in the supplied component.

Parameters	person	An `IPerson` whom should be given permission.
	component	An `IComponent` or textual component name.
Returns	An `IArchivePermission` which is the newly-created permission.

@operation_parameters(Reference(IPerson), Choice(_('Pocket'), PackagePublishingPocket, True), Reference(IDistroSeries, _('Distro series'), True))
@export_factory_operation(Interface, )
@operation_for_version('devel')
def newPocketQueueAdmin(person, pocket, distroseries=None):

Add permission for a person to administer a distroseries queue.

The supplied person will gain permission to administer the distroseries queue for packages in the supplied series and pocket.

Parameters	person	An `IPerson` whom should be given permission.
	pocket	A `PackagePublishingPocket`.
	distroseries	An optional `IDistroSeries`.
Returns	An `IArchivePermission` which is the newly-created permission.

@operation_parameters(Reference(IPerson), Reference(Interface, _('Package set'), True), Bool(_('Explicit'), False))
@export_factory_operation(Interface, )
def newPackagesetUploader(person, packageset, explicit=False):

Add a package set based permission for a person.

Parameters	person	An `IPerson` for whom you want to add permission.
	packageset	An `IPackageset`.
	explicit	True if the package set in question requires specialist skills for proper handling.
Returns	The new `ArchivePermission`, or the existing one if it already exists.

@operation_parameters(Reference(IPerson), TextLine(_('Source Package Name'), True))
@export_write_operation()
def deletePackageUploader(person, source_package_name):

Revoke permission for the person to upload the package.

Parameters	person	An `IPerson` whose permission should be revoked.
	source_package_name	An `ISourcePackageName` or textual package name.

@operation_parameters(Reference(IPerson), TextLine(_('Component Name'), True))
@export_write_operation()
def deleteComponentUploader(person, component_name):

Revoke permission for the person to upload to the component.

Parameters	person	An `IPerson` whose permission should be revoked.
	component	An `IComponent` or textual component name.

@operation_parameters(Reference(IPerson), Choice(_('Pocket'), PackagePublishingPocket, True))
@export_write_operation()
@operation_for_version('devel')
def deletePocketUploader(person, pocket):

Revoke permission for the person to upload to the pocket.

Parameters	person	An `IPerson` whose permission should be revoked.
	distroseries	An `IDistroSeries`.
	pocket	A `PackagePublishingPocket`.

@operation_parameters(Reference(IPerson), TextLine(_('Component Name'), True))
@export_write_operation()
def deleteQueueAdmin(person, component_name):

Revoke permission for the person to administer distroseries queues.

The supplied person will lose permission to administer the distroseries queue for packages in the supplied component.

Parameters	person	An `IPerson` whose permission should be revoked.
	component	An `IComponent` or textual component name.

@operation_parameters(Reference(IPerson), Choice(_('Pocket'), PackagePublishingPocket, True), Reference(IDistroSeries, _('Distro series'), True))
@export_write_operation()
@operation_for_version('devel')
def deletePocketQueueAdmin(person, pocket, distroseries=None):

Revoke permission for the person to administer distroseries queues.

The supplied person will lose permission to administer the distroseries queue for packages in the supplied series and pocket.

Parameters	person	An `IPerson` whose permission should be revoked.
	pocket	A `PackagePublishingPocket`.
	distroseries	An optional `IDistroSeries`.

@operation_parameters(Reference(IPerson), Reference(Interface, _('Package set'), True), Bool(_('Explicit'), False))
@export_write_operation()
def deletePackagesetUploader(person, packageset, explicit=False):

Revoke upload permissions for a person.

Parameters	person	An `IPerson` for whom you want to revoke permission.
	packageset	An `IPackageset`.
	explicit	The value of the 'explicit' flag for the permission to be revoked.

def addArchiveDependency(dependency, pocket, component=None):

Record an archive dependency record for the context archive.

Parameters	dependency	is an `IArchive` object.
	pocket	is an `PackagePublishingPocket` enum.
	component	is an optional `IComponent` object, if not given the archive dependency will be tied to the component used for a corresponding source in primary archive.
Returns	a `IArchiveDependency` object targeted to the context `IArchive` requiring 'dependency' `IArchive`.
Raises	`ArchiveDependencyError` if given 'dependency' does not fit the context archive.

@operation_parameters(Reference(Interface, True), Choice(_('Pocket'), _('The pocket into which this entry is published'), PackagePublishingPocket, True), TextLine(_('Component'), False))
@export_operation_as('addArchiveDependency')
@export_factory_operation(Interface, )
@operation_for_version('devel')
def _addArchiveDependency(dependency, pocket, component=None):

Record an archive dependency record for the context archive.

Parameters	dependency	is an `IArchive` object.
	pocket	is an `PackagePublishingPocket` enum.
	component	is the name of a component. If not given, the archive dependency will be tied to the component used for a corresponding source in primary archive.
Returns	a `IArchiveDependency` object targeted to the context `IArchive` requiring 'dependency' `IArchive`.
Raises	`ArchiveDependencyError` if given 'dependency' does not fit the context archive.

@operation_parameters(Reference(Interface, True))
@export_write_operation()
@operation_for_version('devel')
def removeArchiveDependency(dependency):

Remove the IArchiveDependency record for the given dependency.

Parameters dependency is an IArchive object.

@call_with(True)
@operation_parameters(TextLine(_('Authorization token name'), True), TextLine(_('Optional secret for this named token'), False))
@export_write_operation()
@operation_for_version('devel')
def newNamedAuthToken(name, token=None, as_dict=False):

Create a new named authorization token.

Parameters	name	An identifier string for this token.
	token	Optional unicode text to use as the token. One will be generated if not given.
	as_dict	Optional boolean, controls whether the return value is a dictionary or a full object.
Returns	An `ArchiveAuthToken` object or a dictionary where the value of `token` is the secret and the value of `archive_url` is the externally-usable archive URL including basic auth.

@call_with(True)
@operation_parameters(List(_('Authorization token names'), TextLine(), True))
@export_write_operation()
@operation_for_version('devel')
def newNamedAuthTokens(names, as_dict=False):

Create named authorization tokens in bulk.

Parameters	names	A list of token names.
	as_dict	Optional boolean, controls whether the return value is a list of dictionaries or a list of full objects.
Returns	A list of `ArchiveAuthToken` objects or a dictionary of {name: {token, archive_url} where `name` is a token name, `token` is the secret and `archive_url` is the externally-usable archive URL including basic auth.

@call_with(True)
@operation_parameters(TextLine(_('Authorization token name'), True))
@export_read_operation()
@operation_for_version('devel')
def getNamedAuthToken(name, as_dict=False):

Return a named authorization token for the given name in this: archive.

Parameters	name	The identifier string for a token.
	as_dict	Optional boolean, controls whether the return value is a dictionary or a full object.
Returns	An `ArchiveAuthToken` object or a dictionary where the value of `token` is the secret and the value of `archive_url` is the externally-usable archive URL including basic auth.
Raises	NotFoundError	if no matching token could be found.

@call_with(True)
@operation_parameters(List(_('Authorization token names'), TextLine(), False))
@export_read_operation()
@operation_for_version('devel')
def getNamedAuthTokens(names=None, as_dict=False):

Return a subset of active named authorization tokens for this archive if names is specified, or all active named authorization tokens for this archive is names is null.

Parameters	names	An optional list of token names.
	as_dict	Optional boolean, controls whether the return value is a list of dictionares or a list of full objects.
Returns	A list of `ArchiveAuthToken` objects or a list of dictionaries where `token` is the secret and `archive_url` is the externally-usable archive URL including basic auth.

@operation_parameters(Reference(IDistroSeries, _('Distro series'), True), Choice(_('Pocket'), PackagePublishingPocket, True))
@export_write_operation()
@operation_for_version('devel')
def markSuiteDirty(distroseries, pocket):

Mark a suite as dirty in this archive.

The next publisher run will publish this suite regardless of whether it has any pending publications.

Parameters	distroseries	An `IDistroSeries`.
	pocket	A `PackagePublishingPocket`.

l.s.i.a.IArchiveEdit(Interface) : interface documentation