l.r.i.s.ISourcePackage(IBugTarget, IHasBranches, IHasMergeProposals, IHasOfficialBugTags, IHasCodeImports, IHasTranslationTemplates) : interface documentation

Part of lp.registry.interfaces.sourcepackage View In Hierarchy

Known implementations: lp.registry.model.sourcepackage.SourcePackage

A SourcePackage. See the MagicSourcePackage specification. This interface preserves as much as possible of the old SourcePackage interface from the SourcePackage table, with the new table-less implementation.
Attribute id ID
Attribute path A path to this package, <distro>/<series>/<package>
Attribute title Title.
Attribute summary A description of the binary packages built from this package.
Attribute format Source Package Format. This is the format of the current source package release for this name in this distribution or distroseries. Calling this when there is no current sourcepackagerelease will raise an exception.
Attribute distinctreleases Return a distinct list of sourcepackagepublishinghistory for this source package.
Attribute sourcepackagename SourcePackageName
Attribute bugtasks Bug Tasks that reference this Source Package name in the context of this distribution.
Attribute product The best guess we have as to the Launchpad Project associated with this SourcePackage.
Attribute releases The full set of source package releases that have been published in this distroseries under this source package name. The list should be sorted by version number.
Attribute currentrelease The latest published SourcePackageRelease
Attribute direct_packaging Return the Packaging record that is explicitly for this distroseries and source package name, or None if such a record does not exist. You should probably use ISourcePackage.packaging, which will also look through the distribution ancestry to find a relevant packaging record.
Attribute packaging The best Packaging record we have for this source package. If we have one for this specific distroseries and sourcepackagename, it will be returned, otherwise we look for a match in parent and ubuntu distro seriess.
Attribute published_by_pocket The set of source package releases currently published in this distro series, organised by pocket. The result is a dictionary, with the pocket dbschema as a key, and a list of source package releases as the value.
Attribute linked_branches A mapping of pockets to officially linked branches, ordered by pocket enum value.
Attribute development_version This package on the distro's current series.
Attribute distribution_sourcepackage The IDistributionSourcePackage for this source package.
Method __getitem__ Return the source package release with the given version in this
Method __hash__ Sourcepackage hash method.
Method __eq__ Sourcepackage comparison method.
Method __ne__ Sourcepackage comparison method.
Method setPackaging Update the existing packaging record, or create a new packaging
Method getSuiteSourcePackage Return the ISuiteSourcePackage for this package in 'pocket'.
Method getPocketPath Get the path to the given pocket of this package.
Method getBranch Get the official branch for this package in the given pocket.
Method setBranch Set the official branch for the given pocket of this package.
Attribute shouldimport Whether we should import this or not.
Object latest_published_component Undocumented
Method get_default_archive Get the default archive of this package.
Method getLatestTranslationsUploads Find latest Translations tarballs as produced by Soyuz.
Method linkedBranches Get the official branches for this package.

Inherited from IBugTarget:

Attribute bugtargetdisplayname A display name for this bug target
Attribute bugtargetname The target as shown in mail notifications.
Method createBug Create a new bug on this target.

Inherited from IHasBugs (via IBugTarget):

Attribute open_bugtasks A list of open bugTasks for this target.
Attribute closed_bugtasks A list of closed bugTasks for this target.
Attribute inprogress_bugtasks A list of in-progress bugTasks for this target.
Attribute high_bugtasks A list of high importance BugTasks for this target.
Attribute critical_bugtasks A list of critical BugTasks for this target.
Attribute new_bugtasks A list of New BugTasks for this target.
Attribute unassigned_bugtasks A list of unassigned BugTasks for this target.
Attribute all_bugtasks A list of all BugTasks ever reported for this target.
Attribute has_bugtasks True if a BugTask has ever been reported for this target.
Method searchTasks Search the IBugTasks reported on this entity.
Method getBugCounts Return a dict with the number of bugs in each possible status.

Inherited from IHasBranches:

Method getBranches Returns all branches with the given lifecycle status.

Inherited from IHasMergeProposals:

Method getMergeProposals Returns all merge proposals of a given status.

Inherited from IHasOfficialBugTags:

Method getUsedBugTags Return the tags used by the context as a sorted list of strings.
Method getUsedBugTagsWithOpenCounts Return name and bug count of tags having open bugs.
Method _getOfficialTagClause Get the storm clause for finding this targets tags.

Inherited from IHasCodeImports:

Method newCodeImport Create a new code import.

Inherited from IHasTranslationTemplates:

Bool has_translation_templates Undocumented
Bool has_current_translation_templates Undocumented
Method getTemplatesCollection Return templates as a TranslationTemplatesCollection.
Method getCurrentTemplatesCollection Return TranslationTemplatesCollection of current templates.
Method getCurrentTranslationTemplates Return an iterator over all active translation templates.
Method getCurrentTranslationFiles Return an iterator over all active translation files.
Method getObsoleteTranslationTemplates Return an iterator over its not active translation templates.
Method getTranslationTemplates Return an iterator over all its translation templates.
Method getTranslationTemplateFormats A list of native formats for all current translation templates.
Method getTemplatesAndLanguageCounts List tuples of POTemplate and its language count.
id =
ID
path =
A path to this package, <distro>/<series>/<package>
title =
Title.
summary =
A description of the binary packages built from this package.
format =
Source Package Format. This is the format of the current source package release for this name in this distribution or distroseries. Calling this when there is no current sourcepackagerelease will raise an exception.
distinctreleases =
Return a distinct list of sourcepackagepublishinghistory for this source package.
sourcepackagename =
SourcePackageName
bugtasks =
Bug Tasks that reference this Source Package name in the context of this distribution.
product =
The best guess we have as to the Launchpad Project associated with this SourcePackage.
releases =
The full set of source package releases that have been published in this distroseries under this source package name. The list should be sorted by version number.
currentrelease =
The latest published SourcePackageRelease of a source package with this name in the distribution or distroseries, or None if no source package with that name is published in this distroseries.
direct_packaging =
Return the Packaging record that is explicitly for this distroseries and source package name, or None if such a record does not exist. You should probably use ISourcePackage.packaging, which will also look through the distribution ancestry to find a relevant packaging record.
packaging =
The best Packaging record we have for this source package. If we have one for this specific distroseries and sourcepackagename, it will be returned, otherwise we look for a match in parent and ubuntu distro seriess.
published_by_pocket =
The set of source package releases currently published in this distro series, organised by pocket. The result is a dictionary, with the pocket dbschema as a key, and a list of source package releases as the value.
linked_branches =
A mapping of pockets to officially linked branches, ordered by pocket enum value.
development_version =
This package on the distro's current series.
distribution_sourcepackage =
The IDistributionSourcePackage for this source package.
def __getitem__(version):
Return the source package release with the given version in this distro series, or None.
def __hash__():
Sourcepackage hash method.

This is required to make source packages usable as dictionary keeps since the __eq__ method is provided.

def __eq__(other):
Sourcepackage comparison method.

Sourcepackages compare equal only if their distroseries and sourcepackagename compare equal.

def __ne__(other):
Sourcepackage comparison method.

Sourcepackages compare not equal if either of their distroseries or sourcepackagename compare not equal.

def setPackaging(productseries, owner):
Update the existing packaging record, or create a new packaging record, that links the source package to the given productseries, and record that it was done by the owner.
def getSuiteSourcePackage(pocket):
Return the ISuiteSourcePackage for this package in 'pocket'.
ParameterspocketA DBItem of PackagePublishingPocket.
ReturnsAn ISuiteSourcePackage.
def getPocketPath(pocket):
Get the path to the given pocket of this package.
ParameterspocketA DBItem of PackagePublishingPocket.
ReturnsA string.
@operation_parameters(Choice(_('Pocket'), True, DBEnumeratedType))
@operation_returns_entry(Interface)
@export_read_operation()
def getBranch(pocket):
Get the official branch for this package in the given pocket.
ParameterspocketA PackagePublishingPocket.
ReturnsAn IBranch.
@operation_parameters(Choice(_('Pocket'), True, DBEnumeratedType), Reference(Interface, _('Branch'), False))
@call_with(REQUEST_USER)
@export_write_operation()
def setBranch(pocket, branch, registrant):
Set the official branch for the given pocket of this package.
ParameterspocketA PackagePublishingPocket.
branchThe branch to set as the official branch.
registrantThe individual who created this link.
ReturnsNone
shouldimport =
Whether we should import this or not. By 'import' we mean sourcerer analysis resulting in a manifest and a set of Bazaar branches which describe the source package release. The attribute is True or False.
latest_published_component =
Undocumented
def get_default_archive(component=None):
Get the default archive of this package.

If 'component' is a partner component, then the default archive is the partner archive. Otherwise, the primary archive of the associated distribution.

ParameterscomponentThe IComponent to base the default archive decision on. If None, defaults to the last published component.
ReturnsIArchive.
RaisesNoPartnerArchiveIf returning the partner archive is appropriate, but no partner archive exists.
def getLatestTranslationsUploads(): 
Find latest Translations tarballs as produced by Soyuz.

:return: A list of `ILibraryFileAlias`es, usually of size zero
    or one.  If not, they are sorted from oldest to newest.
@export_read_operation()
def linkedBranches():
Get the official branches for this package.

This operation returns a {Pocket-name : IBranch} dict.

ReturnsA {Pocket-name : IBranch} dict.
API Documentation for Launchpad, generated by pydoctor at 2010-09-27 00:00:11.