l.r.i.d.IDistributionPublic(IBugTarget, ICanGetMilestonesDirectly, IHasAppointedDriver, IHasBuildRecords, IHasDrivers, IHasMilestones, IHasSharingPolicies, IHasOOPSReferences, IHasOwner, IHasSprints, IHasTranslationImports, ITranslationPolicy, IKarmaContext, ILaunchpadUsage, IMakesAnnouncements, IOfficialBugTagTargetPublic, IPillar, IServiceUsage, ISpecificationTarget, IHasExpirableBugs) : interface documentation

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

Known subclasses: lp.registry.interfaces.webservice.IDistribution

Public IDistribution properties.
Attribute id The distro's unique number.
Attribute displayname Display name (deprecated)
Attribute drivers Presents the distro driver as a list for consistency with IProduct.drivers where the list might include a project driver.
Attribute disabled_mirrors All disabled and official mirrors of this Distribution.
Attribute unofficial_mirrors All unofficial mirrors of this Distribution.
Attribute pending_review_mirrors All mirrors of this Distribution that haven't been reviewed yet.
List architectures Undocumented
Attribute uploaders ArchivePermission records for uploaders with rights to upload to this distribution.
TextLine package_derivatives_email The email address to send information about updates to packages that are derived from another distribution. The sequence {package_name} is replaced with the actual package name.
Choice translation_focus The release series that translators should focus on.
Choice language_pack_admin The distribution language pack administrator.
Attribute all_distro_archive_ids A list containing the IDs of all the non-PPA archives.
Bool has_published_binaries True if this distribution has binaries published on disk.
Bool has_published_sources True if this distribution has sources published.
Method getArchiveIDList Return a list of archive IDs suitable for sqlvalues() or quote().
Method __getitem__ Returns a DistroSeries that matches name, or raises and
Method __iter__ Iterate over the series for this distribution.
Method getArchive Return the distribution archive with the given name.
Method getDevelopmentSeries Return the DistroSeries which are marked as in development.
Method getNonObsoleteSeries Return the non-OBSOLETE DistroSeries in this distribution.
Method resolveSeriesAlias Resolve a series alias.
Method getSeries Return the series with the name or version given.
Method getBranchTips Return a list of branches which have new tips since a date.
Method getMirrorByName Return the mirror with the given name for this distribution or None
Method getCountryMirror Return the country DNS mirror for a country and content type.
Method newMirror Create a new DistributionMirror for this distribution.
Method getSourcePackage Return a DistributionSourcePackage with the given name for this
Method getSourcePackageRelease Returns an IDistributionSourcePackageRelease
Method getCurrentSourceReleases Get the current release of a list of source packages.
Method getDistroSeriesAndPocket Return a (distroseries,pocket) tuple which is the given textual
Method getSeriesByStatus Query context distribution for distroseries with a given status.
Method searchSourcePackages Search for source packages that correspond to the given text.
Method searchSourcePackageCaches Search for source packages that correspond to the given text.
Method searchBinaryPackages Search for binary packages in this distribution.
Method guessPublishedSourcePackageName Return the "published" SourcePackageName related to pkgname.
Method getAllPPAs Return all PPAs for this distribution.
Method searchPPAs Return all PPAs matching the given text in this distribution.
Method getPendingAcceptancePPAs Return only pending acceptance PPAs in this distribution.
Method getPendingPublicationPPAs Return all PPAs in this distribution that are pending publication.
Method getArchiveByComponent Return the archive most appropriate for the component name.
Method getAllowedBugInformationTypes Get the information types that a bug in this distribution can have.
Method getDefaultBugInformationType Get the default information type of a new bug in this distro.
Method userCanEdit Can the user edit this distribution?

Inherited from IBugTarget:

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

Inherited from IHasBugs (via IBugTarget):

Method searchTasks Search the IBugTasks reported on this entity.
Method getBugTaskWeightFunction Return a function that is used to weight the bug tasks.

Inherited from ICanGetMilestonesDirectly:

Method getMilestone Return a milestone with the given name for this object, or None.

Inherited from IHasAppointedDriver:

Choice driver Undocumented

Inherited from IHasBuildRecords:

Method getBuildRecords Return build records in the context it is implemented.

Inherited from IHasDrivers:

Method personHasDriverRights Does the given person have launchpad.Driver rights on this object?

Inherited from IHasMilestones:

Bool has_milestones Undocumented

Inherited from IHasOOPSReferences:

Method findReferencedOOPS Find OOPS reports between start_date and end_date.

Inherited from IHasOwner:

Attribute owner The object's owner, which is an IPerson.

Inherited from IHasSprints:

Attribute coming_sprints A list of up to 5 events currently on, or soon to be on, that are relevant to this context.
Attribute sprints All sprints relevant to this context.
Attribute past_sprints Sprints that occured in the past.

Inherited from IHasTranslationImports:

Method getFirstEntryToImport Return the first entry of the queue ready to be imported.
Method getTranslationImportQueueEntries Return entries in the translation import queue for this entity.

Inherited from ITranslationPolicy:

Method getTranslationGroups List all applicable translation groups.
Method getTranslators Find the applicable `TranslationGroup`(s) and translators.
Method getEffectiveTranslationPermission Get the effective TranslationPermission.
Method invitesTranslationEdits Does this policy invite person to edit translations?
Method invitesTranslationSuggestions Does this policy invite person to enter suggestions?
Method allowsTranslationEdits Is person allowed to edit translations to language?
Method allowsTranslationSuggestions Is person allowed to enter suggestions for language?
Method sharesTranslationsWithOtherSide Should translations be shared across `TranslationSide`s?

Inherited from IKarmaContext:

Method getTopContributorsGroupedByCategory Return a dict mapping categories to the top contributors (and their
Method getTopContributors Return the people with the highest amount of Karma, and their

Inherited from ILaunchpadUsage:

Bool official_answers Undocumented
Bool official_blueprints Undocumented
Bool official_codehosting Undocumented
Bool official_malone Undocumented
Bool official_anything Undocumented
Bool enable_bug_expiration Undocumented

Inherited from IMakesAnnouncements:

Method announce Create a Announcement for this project.

Inherited from IHasAnnouncements (via IMakesAnnouncements):

Method getAnnouncement Return the requested announcement.
Method getAnnouncements Return a list of announcements visible to this user.

Inherited from IHasOfficialBugTags (via IOfficialBugTagTargetPublic):

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 IPillar:

Attribute pillar_category The category title applicable to the pillar

Inherited from IServiceUsage:

Choice answers_usage Where does this pillar have an Answers forum?
Choice blueprints_usage Where does this pillar host blueprints?
Choice codehosting_usage Where does this pillar host code?
Choice bug_tracking_usage Where does this pillar track bugs?
Bool uses_launchpad Undocumented

Inherited from ISpecificationTarget:

Method getSpecification Returns the specification with the given name, for this target,
Method getAllowedSpecificationInformationTypes Get the InformationTypes for this target's specifications.
Method getDefaultSpecificationInformationType Get the default InformationType for the target's specifications.

Inherited from IHasSpecifications (via ISpecificationTarget):

Method specifications Specifications for this target.
Method valid_specifications Valid specifications for this target.
id =
The distro's unique number.
displayname =
Display name (deprecated)
drivers =
Presents the distro driver as a list for consistency with IProduct.drivers where the list might include a project driver.
disabled_mirrors =
All disabled and official mirrors of this Distribution.
unofficial_mirrors =
All unofficial mirrors of this Distribution.
pending_review_mirrors =
All mirrors of this Distribution that haven't been reviewed yet.
architectures =
Undocumented
uploaders =
ArchivePermission records for uploaders with rights to upload to this distribution.
package_derivatives_email =
The email address to send information about updates to packages that are derived from another distribution. The sequence {package_name} is replaced with the actual package name.
translation_focus =
The release series that translators should focus on.
language_pack_admin =
The distribution language pack administrator.
all_distro_archive_ids =
A list containing the IDs of all the non-PPA archives.
has_published_binaries =
True if this distribution has binaries published on disk.
has_published_sources =
True if this distribution has sources published.
def getArchiveIDList(archive=None):
Return a list of archive IDs suitable for sqlvalues() or quote().

If the archive param is supplied, just its ID will be returned in a list of one item. If it is not supplied, return a list of all the IDs for all the archives for the distribution.

def __getitem__(name):
Returns a DistroSeries that matches name, or raises and exception if none exists.
def __iter__():
Iterate over the series for this distribution.
@operation_parameters(TextLine(_('Archive name'), True))
@operation_returns_entry(Interface)
@export_read_operation()
def getArchive(name):
Return the distribution archive with the given name.

Only distribution archives are considered -- PPAs will not be found.

ParametersnameThe name of the archive, e.g. 'partner'
@operation_returns_collection_of(Interface)
@export_operation_as('getDevelopmentSeries')
@export_read_operation()
def getDevelopmentSeries():
Return the DistroSeries which are marked as in development.
def getNonObsoleteSeries():
Return the non-OBSOLETE DistroSeries in this distribution.
def resolveSeriesAlias(name):
Resolve a series alias.
ParametersnameThe name to resolve.
RaisesNoSuchDistroSeriesIf there is no match.
@operation_parameters(TextLine(_('Name or version'), True))
@operation_returns_entry(Interface)
@call_with(True)
@export_read_operation()
def getSeries(name_or_version, follow_aliases=False):
Return the series with the name or version given.
Parametersname_or_versionThe IDistroSeries.name or IDistroSeries.version.
@operation_parameters(Datetime(_('Time of last change'), _('Return branches that have new tips since this timestamp.'), False))
@call_with(REQUEST_USER)
@export_operation_as('getBranchTips')
@export_read_operation()
@operation_for_version('devel')
def getBranchTips(user=None, since=None):
Return a list of branches which have new tips since a date.

Each branch information is a tuple of (branch_unique_name, tip_revision, (official_series*)).

So for each branch in the distribution, you'll get the branch unique name, the revision id of tip, and if the branch is official for some series, the list of series name.

Parametersuser: If specified, shows the branches visible to that user. if not specified, only branches visible to the anonymous user are shown.
sinceIf specified, limits results to branches modified since that date and time.
@operation_parameters(TextLine(_('Name'), True))
@operation_returns_entry(IDistributionMirror)
@export_read_operation()
def getMirrorByName(name):
Return the mirror with the given name for this distribution or None if it's not found.
@operation_parameters(copy_field(IDistributionMirror['country'], True), copy_field(IDistributionMirror['content'], True))
@operation_returns_entry(IDistributionMirror)
@export_read_operation()
def getCountryMirror(country, mirror_type):
Return the country DNS mirror for a country and content type.
def newMirror(owner, speed, country, content, display_name=None, description=None, http_base_url=None, ftp_base_url=None, rsync_base_url=None, enabled=False, official_candidate=False, whiteboard=None):
Create a new DistributionMirror for this distribution.

At least one of http_base_url or ftp_base_url must be provided in order to create a mirror.

@operation_parameters(TextLine(_('Package name'), True))
@operation_returns_entry(Interface)
@export_read_operation()
def getSourcePackage(name):
Return a DistributionSourcePackage with the given name for this distribution, or None.
def getSourcePackageRelease(sourcepackagerelease):
Returns an IDistributionSourcePackageRelease

Receives a sourcepackagerelease.

def getCurrentSourceReleases(source_package_names):
Get the current release of a list of source packages.
Parameterssource_package_namesa list of ISourcePackageName instances.
Returnsa dict where the key is a IDistributionSourcePackage and the value is a IDistributionSourcePackageRelease.
def getDistroSeriesAndPocket(distroseriesname, follow_aliases=False):
Return a (distroseries,pocket) tuple which is the given textual distroseriesname in this distribution.
def getSeriesByStatus(status):
Query context distribution for distroseries with a given status.
ParametersstatusSeries status to look for
Returnslist of IDistroSeries
@rename_parameters_as('source_match')
@operation_parameters(TextLine(_('Source package name substring match'), True))
@operation_returns_collection_of(Interface)
@export_read_operation()
def searchSourcePackages(text, has_packaging=None, publishing_distroseries=None):
Search for source packages that correspond to the given text.

This method just decorates the result of searchSourcePackageCaches() to return DistributionSourcePackages.

def searchSourcePackageCaches(text, has_packaging=None, publishing_distroseries=None):
Search for source packages that correspond to the given text.
ParameterstextThe text that will be matched.
has_packagingIf True, it will filter out packages with no packaging (i.e. no link to the upstream project). False will do the reverse filtering, and None will do no filtering on this field.
publishing_distroseriesIf it is not None, then it will filter out source packages that do not have a publishing history for the given distroseries.
ReturnsA result set containing (DistributionSourcePackageCache, SourcePackageName, rank) tuples ordered by rank.
def searchBinaryPackages(package_name, exact_match=False):
Search for binary packages in this distribution.

The returned results will consist of source packages that match (a substring of) their binary package names.

Parameterspackage_nameThe binary package name to match.
exact_matchIf False, substring matches are done on the binary package names; if True only a full string match is returned.
ReturnsA result set containing appropriate DistributionSourcePackage objects for the matching source.
def guessPublishedSourcePackageName(pkgname):
Return the "published" SourcePackageName related to pkgname.

If pkgname corresponds to a source package that was published in any of the distribution series, that's the SourcePackageName that is returned.

If there is any official source package branch linked, then that source package name is returned.

Otherwise, try to find a published binary package name and then return the source package name from which it comes from.

RaisesNotFoundErrorwhen pkgname doesn't correspond to either a published source or binary package name in this distribution.
def getAllPPAs():
Return all PPAs for this distribution.
def searchPPAs(text=None, show_inactive=False):
Return all PPAs matching the given text in this distribution.

'text', when passed, will restrict results to Archives with matching description (using substring) or matching Archive.owner (using available person fti/ftq).

'show_inactive', when False, will restrict results to Archive with at least one source publication in PENDING or PUBLISHED status.

def getPendingAcceptancePPAs():
Return only pending acceptance PPAs in this distribution.
def getPendingPublicationPPAs():
Return all PPAs in this distribution that are pending publication.

A PPA is said to be pending publication if it has publishing records in the pending state or if it had packages deleted from it.

def getArchiveByComponent(component_name):
Return the archive most appropriate for the component name.

Where different components may imply a different archive (e.g. partner), this method will return the archive for that component.

If the component_name supplied is unknown, None is returned.

def getAllowedBugInformationTypes(): 
Get the information types that a bug in this distribution can have.

:return: A sequence of `InformationType`s.
def getDefaultBugInformationType():
Get the default information type of a new bug in this distro.
ReturnsThe InformationType.
def userCanEdit(user):
Can the user edit this distribution?
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.