lp.snappy.interfaces.snap.ISnapView : API documentation

Int	id	Undocumented
Attribute	source	The source branch for this snap package (VCS-agnostic).
Attribute	available_processors	The architectures that are available to be enabled or disabled for this snap package.
Method	setProcessors	Set the architectures for which the snap package should be built.
Method	getAllowedArchitectures	Return all distroarchseries that this package can build for.
Method	requestBuild	Request that the snap package be built.
Method	requestBuilds	Request that the snap package be built for relevant architectures.
Method	requestBuildsFromJob	Synchronous part of `Snap.requestBuilds`.
Method	getBuildRequest	Get an asynchronous build request by ID.
Method	getBuildSummariesForSnapBuildIds	Return a dictionary containing a summary of the build statuses.
Method	getBuildSummaries	Return a dictionary containing a summary of build information.

source =

The source branch for this snap package (VCS-agnostic).

available_processors =

The architectures that are available to be enabled or disabled for this snap package.

@call_with(True, REQUEST_USER)
@operation_parameters(List(Reference(IProcessor), True))
@export_write_operation()
@operation_for_version('devel')
def setProcessors(processors, check_permissions=False, user=None):

Set the architectures for which the snap package should be built.

def getAllowedArchitectures():

Return all distroarchseries that this package can build for.

Returns Sequence of IDistroArchSeries instances.

@call_with(REQUEST_USER)
@operation_parameters(Reference(IArchive), Reference(IDistroArchSeries), Choice(PackagePublishingPocket), Dict(_('Source snap channels to use for this build.'), _("A dictionary mapping snap names to channels to use for this build. Currently only 'core', 'core18', and 'snapcraft' keys are supported."), TextLine(), False))
@export_factory_operation(Interface, )
@operation_for_version('devel')
def requestBuild(requester, archive, distro_arch_series, pocket, channels=None, build_request=None):

Request that the snap package be built.

Parameters	requester	The person requesting the build.
	archive	The IArchive to associate the build with.
	distro_arch_series	The architecture to build for.
	pocket	The pocket that should be targeted.
	channels	A dictionary mapping snap names to channels to use for this build.
	build_request	The `ISnapBuildRequest` job being processed, if any.
Returns	`ISnapBuild`.

@call_with(REQUEST_USER)
@operation_parameters(Reference(IArchive), Choice(PackagePublishingPocket), Dict(_('Source snap channels to use for this build.'), _("A dictionary mapping snap names to channels to use for this build. Currently only 'core', 'core18', and 'snapcraft' keys are supported."), TextLine(), False))
@export_factory_operation(ISnapBuildRequest, )
@operation_for_version('devel')
def requestBuilds(requester, archive, pocket, channels=None):

Request that the snap package be built for relevant architectures.

This is an asynchronous operation; once the operation has finished, the resulting build request's C{status} will be "Completed" and its C{builds} collection will return the resulting builds.

Parameters	requester	The person requesting the builds.
	archive	The IArchive to associate the builds with.
	pocket	The pocket that should be targeted.
	channels	A dictionary mapping snap names to channels to use for these builds.
Returns	An `ISnapBuildRequest`.

def requestBuildsFromJob(requester, archive, pocket, channels=None, architectures=None, allow_failures=False, fetch_snapcraft_yaml=True, build_request=None, logger=None):

Synchronous part of Snap.requestBuilds.

Request that the snap package be built for relevant architectures.

Parameters	requester	The person requesting the builds.
	archive	The IArchive to associate the builds with.
	pocket	The pocket that should be targeted.
	channels	A dictionary mapping snap names to channels to use for these builds.
	architectures	If not None, limit builds to architectures with these architecture tags (in addition to any other applicable constraints).
	allow_failures	If True, log exceptions other than "already pending" from individual build requests; if False, raise them to the caller.
	fetch_snapcraft_yaml	If True, fetch snapcraft.yaml from the appropriate branch or repository and use it to decide which builds to request; if False, fall back to building for all supported architectures.
	build_request	The `ISnapBuildRequest` job being processed, if any.
	logger	An optional logger.
Returns	A sequence of `ISnapBuild` instances.
Raises	CannotRequestAutoBuilds	if fetch_snapcraft_yaml is False and self.distro_series is not set.

def getBuildRequest(job_id):

Get an asynchronous build request by ID.

Parameters	job_id	The ID of the build request.
Returns	`ISnapBuildRequest`.

@operation_parameters(List(_('A list of snap build IDs.'), Int()))
@export_read_operation()
@operation_for_version('devel')
def getBuildSummariesForSnapBuildIds(snap_build_ids):

Return a dictionary containing a summary of the build statuses.

Parameters	snap_build_ids	A list of snap build IDs.
	source_ids	(type: `list`)
Returns	A dict consisting of the overall status summaries for the given snap builds.

@call_with(REQUEST_USER)
@operation_parameters(List(_('A list of snap build request IDs.'), Int(), False), List(_('A list of snap build IDs.'), Int(), False))
@export_read_operation()
@operation_for_version('devel')
def getBuildSummaries(request_ids=None, build_ids=None, user=None):

Return a dictionary containing a summary of build information.

Parameters	request_ids	A list of snap build request IDs.
	build_ids	A list of snap build IDs.
	user	The `IPerson` requesting this information.
Returns	A dict of {"requests", "builds"}, consisting of the overall status summaries for the given snap build requests and snap builds respectively.

l.s.i.s.ISnapView(Interface) : interface documentation