Find a branch by its ~owner/product/name unique name.
+Return None if no match was found.
+ +Find a branch by URL.
+Either from the external specified in Branch.url, from the URL on +http://bazaar.launchpad.net/ or the lp: URL.
+This is a frontend shim to IBranchLookup.getByUrl to allow it to be +exported over the API. If you want to call this from within the +Launchpad app, use the IBranchLookup version instead.
+Return None if no match was found.
+ +Finds branches by URL.
+Either from the external specified in Branch.url, from the URL on +http://bazaar.launchpad.net/, or from the lp: URL.
+This is a frontend shim to IBranchLookup.getByUrls to allow it to be +exported over the API. If you want to call this from within the +Launchpad app, use the IBranchLookup version instead.
+param urls: | An iterable of URLs expressed as strings. | +
---|---|
return: | A dictionary mapping URLs to branches. If the URL has no +associated branch, the URL will map to None. | +
A list of URLs of branches
+These can be URLs external to Launchpad, lp: URLs, or http://bazaar.launchpad.net/ URLs, or any mix of all these different kinds.
+ +Find a branch by its path.
+The path is the same as its lp: URL, but without the leading lp:, so +it may be in any of these forms:
++Unique names: + ~OWNER/PROJECT/NAME + ~OWNER/DISTRO/SERIES/SOURCE/NAME + ~OWNER/+junk/NAME +Aliases linked to other objects: + PROJECT + PROJECT/SERIES + DISTRO/SOURCE + DISTRO/SUITE/SOURCE ++
Return None if no match was found.
+ +Return a collection of branches.
+param user: | An IPerson. Only branches visible by this user will +be returned. | +
---|---|
param order_by: | An item from the BranchListingSort enumeration, +or None to return an unordered result set. | +
param modified_since_date: | |
If not None, return only branches whose +date_last_modified is greater than this date. | +|
param eager_load: | |
If True (the default because this is used in the +web service and it needs the related objects to create links) +eager load related objects (products, code imports etc). | +
Modified since date
+Return only branches whose date_last_modified is greater than or equal to this date.
+ +Return the named branches visible to both user and person.
+Anonymous requesters don't get any information.
+param user: | The user requesting the information. If the user is None +then we return an empty dict. | +
---|---|
param person: | The person whose branch visibility we wish to check. | +
param branch_names: | |
The unique names of the branches to check. | +
Return a dict with the following values: +person_name: the displayname of the person. +visible_branches: a list of the unique names of the branches which +the requester and specified person can both see.
+This API call is provided for use by the client Javascript. It is not +designed to efficiently scale to handle requests for large numbers of +branches.
+ +Return the merge proposals that resulted in this revision.
+param merged_revision: | |
---|---|
The revision_id of the revision that resulted +from this merge proposal. | +|
param visible_by_user: | |
The user to whom the proposals must be +visible. If None, only public proposals will be returned. | +
A set of IBugTracker's.
+Each BugTracker is a distinct instance of a bug tracking tool. For +example, bugzilla.mozilla.org is distinct from bugzilla.gnome.org.
+ +Get a BugTracker by its name.
+If no tracker with the given name exists, return default.
+ +Make sure that there is a bugtracker for the given base url.
+If not, create one using the given attributes.
+ +Location
+The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.
+ +Title
+A descriptive label for this tracker to show in listings.
+ +Summary
+A brief introduction or overview of this bug tracker instance.
+ +Contact details
+The contact details for the external bug tracker (so that, for example, its administrators can be contacted about a security breach).
+ +Name
+A URL-friendly name for the bug tracker, such as "mozilla-bugs".
+ +Collections of builders.
+IBuilderSet provides access to all Builders in the system, +and also acts as a Factory to allow the creation of new Builders. +Methods on this interface should deal with the set of Builders: +methods that affect a single Builder should be on IBuilder.
+ +Return the number of pending builds for each processor.
+return: | a dict of tuples with the queue size and duration for +each processor and virtualisation. For example: ++{ + 'virt': { + '386': (1, datetime.timedelta(0, 60)), + 'amd64': (2, datetime.timedelta(0, 30)), + }, + 'nonvirt':... +} ++ The tuple contains the size of the queue, as an integer, +and the sum of the jobs 'estimated_duration' in queue, +as a timedelta or None for empty queues. + |
+
---|
Create a new builder.
+The builder will be set to manual. An admin needs to verify its +configuration and set it to automatic before jobs will be +dispatched.
+ +Processors
+Processors identifying jobs which can be built by this device.
+ +URL
+The URL to the build machine, used as a unique identifier. Includes protocol, host and port only, e.g.: http://farm.com:8221/
+ +Name
+The builder name used for reference purposes
+ +Title
+The builder title. Should be just a few words.
+ +Publicly Visible
+Whether or not to present the builder publicly.
+ +Virtualized
+Whether or not the builder is a virtual Xen instance.
+ +VM host
+The machine hostname hosting the virtual buildd-worker, e.g.: foobar-host.ppa
+ +Open resources
+Resource tags offered by this builder, that can be required by a build and if required must match.
+ +Restricted resources
+Resource tags offered by this builder, indicating that the builder may only be used by builds that explicitly require these tags.
+ +Return the ICharmBase for this distro series.
+raises NoSuchCharmBase: | |
---|---|
if no base exists for this distro series. | +
Source snap channels for builds
+A dictionary mapping snap names to channels to use when building charm recipes that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.
+ +Owner
+The owner of this charm recipe.
+ +Charm recipe name
+The name of the charm recipe.
+ +Description
+A description of the charm recipe.
+ +Git branch
+The Git branch containing a charm recipe.
+ +Build path
+Subdirectory within the branch containing metadata.yaml.
+ +Automatically build when branch changes
+Whether this charm recipe is built automatically when its branch changes.
+ +Source snap channels for automatic builds
+A dictionary mapping snap names to channels to use when building this charm recipe. +Supported snap names: 'charmcraft', 'core', 'core18', 'core20', 'core22', 'core24'
+ +Automatically upload to store
+Whether builds of this charm recipe are automatically uploaded to the store.
+ +Registered store name
+The registered name of this charm in the store.
+ +Store channels
+Channels to release this charm to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.
+ +Information type
+The type of information contained in this charm recipe.
+ +Find a repository by its ID.
+Return None if no match was found.
+ +Find a repository by its path.
+Any of these forms may be used:
++Unique names: + ~OWNER/PROJECT/+git/NAME + ~OWNER/DISTRO/+source/SOURCE/+git/NAME + ~OWNER/+git/NAME +Owner-target default aliases: + ~OWNER/PROJECT + ~OWNER/DISTRO/+source/SOURCE +Official aliases: + PROJECT + DISTRO/+source/SOURCE ++
Return None if no match was found.
+ +Get all repositories for a target.
+param user: | An IPerson. Only repositories visible by this user +will be returned. | +
---|---|
param target: | An IHasGitRepositories, or None to get repositories +for all targets. | +
param order_by: | An item from the GitListingSort enumeration, or +None to return an unordered result set. | +
param modified_since_date: | |
If not None, return only repositories +whose date_last_modified is greater than this date. | +|
return: | A collection of IGitRepository objects. | +
Modified since date
+Return only repositories whose date_last_modified is greater than or equal to this date.
+ +Get number of repositories qualifying for a repack.
+return: | The number of IGitRepository objects qualifying +for a repack. | +
---|
Return the named repositories visible to both user and person.
+Anonymous requesters don't get any information.
+param user: | The user requesting the information. If the user is +None then we return an empty dict. | +
---|---|
param person: | The person whose repository visibility we wish to +check. | +
param repository_names: | |
The unique names of the repositories to +check. | +
Return a dict with the following values: +person_name: the displayname of the person. +visible_repositories: a list of the unique names of the repositories +which the requester and specified person can both see.
+This API call is provided for use by the client Javascript. It is +not designed to efficiently scale to handle requests for large +numbers of repositories.
+ +Get the default repository for a target.
+param target: | An IHasGitRepositories. | +
---|---|
raises GitTargetError: | |
if target is an IPerson. | +|
return: | An IGitRepository, or None. | +
Get a person's default repository for a target.
+param owner: | An IPerson. | +
---|---|
param target: | An IHasGitRepositories. | +
raises GitTargetError: | |
if target is an IPerson. | +|
return: | An IGitRepository, or None. | +
Get the top badly packed repositories.
+param limit: | The number of badly packed repositories +that the endpoint should return - it is 50 by default. | +
---|---|
return: | A list of the worst badly packed repositories. | +
Create a Git repository and return it.
+param repository_type: | |
---|---|
The GitRepositoryType of the new +repository. | +|
param registrant: | |
The IPerson who registered the new repository. | +|
param owner: | The IPerson who owns the new repository. | +
param target: | The IProduct, IDistributionSourcePackage, +IOCIProjectName, or IPerson that the new repository is +associated with. | +
param name: | The repository name. | +
param information_type: | |
Set the repository's information type to +one different from the target's default. The type must conform +to the target's code sharing policy. (optional) | +|
param with_hosting: | |
Create the repository on the hosting service. | +
Owner
+The owner of this Git repository. This controls who can modify the repository.
+ +Target
+The target of the repository.
+ +Name
+The repository name. Keep very short, unique, and descriptive, because it will be used in URLs.
+ +Information type
+The type of information contained in this repository.
+ +Set the default repository for a target.
+param target: | An IHasGitRepositories. | +
---|---|
param repository: | |
An IGitRepository, or None to unset the default +repository. | +|
raises GitTargetError: | |
if target is an IPerson. | +
Set a person's default repository for a target.
+param owner: | An IPerson. | +
---|---|
param target: | An IHasGitRepositories. | +
param repository: | |
An IGitRepository, or None to unset the default +repository. | +|
param user: | The IPerson who is making the change. | +
raises GitTargetError: | |
if target is an IPerson. | +
The collection of languages.
+The standard get method will return only the visible languages. +If you want to access all languages known to Launchpad, use +the getAllLanguages method.
+ +Owner
+The owner of this live filesystem image.
+ +Distro Series
+The series for which the image should be built.
+ +Name
+The name of the live filesystem image.
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Search bugtasks matching the specified criteria.
+The only criteria currently supported is to search for a bugtask with +the specified bug id.
+return: | a list of matching bugs represented as json data | +
---|
Create a bug (with an appropriate bugtask) and return it.
+param target: | The Project, Distribution or DistributionSourcePackage +affected by this bug. | +
---|---|
param title: | The title shown in bug listings. | +
param description: | |
The description of the issue. | +|
param information_type: | |
Set the bug's information type to one +different from the project's default. The type must conform +to the project's bug sharing policy. (optional) | +|
param tags: | A list of bug tags. (optional) | +
param security_related: | |
Is this bug's information type +Private Security? (deprecated) | +|
param tags: | Is this bug's information type Private +user data. (deprecated) | +
Things to note when using this factory:
+++ ++
+- The reporter will be subscribed to the bug.
+- Only people that the project shares with will see the bug +when the bug's information type is Proprietary, Private, or +Private Security.
+
Summary
+A one-line summary of the problem.
+ +Description
+A detailed description of the problem, +including the steps required to reproduce it.
+ +Tags
+Space-separated keywords for classifying this bug report.
+ +Information Type
+The type of information contained in this bug report.
+ +This bug report should be private
+Private bug reports are visible only to their subscribers.
+ +Return the single package set with the given name (if any).
+param distroseries: | |
---|---|
the distroseries to which the new packageset +is related. | +|
param name: | the name of the package set sought. | +
return: | An IPackageset instance. | +
raise NoSuchPackageSet: | |
if no package set is found. | +
Distribution series
+The distroseries to which this package set is related.
+ +Return the package sets associated with the given distroseries.
+param distroseries: | |
---|---|
A DistroSeries. | +|
return: | An iterable collection of IPackageset instances. | +
Distribution series
+The distroseries to which this package set is related.
+ +Get the package sets that include this source package.
+Return all package sets that directly or indirectly include the +given source package name.
+param sourcepackagename: | |
---|---|
the included source package name; can be +either a string or a ISourcePackageName. | +|
param distroseries: | |
the IDistroSeries in which to look for sets. +If omitted, matching package sets from all series will be +returned. | +|
param direct_inclusion: | |
if this flag is set to True, then only +package sets that directly include this source package name will +be considered. | +|
raises NoSuchSourcePackageName: | |
if a source package with the given +name cannot be found. | +|
return: | A (potentially empty) sequence of IPackageset instances. | +
Distribution series
+The distroseries to which this package set is related.
+ +Create a new package set.
+param name: | the name of the package set to be created. | +
---|---|
param description: | |
the description for the package set to be created. | +|
param owner: | the owner of the package set to be created. | +
param distroseries: | |
the distroseries to which the new packageset +is related. | +|
param related_set: | |
the newly created package set is to be related to +related_set (by being placed in the same package group). | +|
raises DuplicatePackagesetName: | |
if a package set with the same name +exists in distroseries already. | +|
return: | a newly created IPackageset. | +
Person
+The person who owns this package set.
+ +Distroseries
+The distribution series to which the packageset is related.
+ +Related package set
+The new package set will share the package set group with this one.
+ +Return the person with the given email address.
+Return None if there is no person with the given email address.
+ +Return all non-merged Persons and Teams whose name, displayname or +email address match <text>.
+The results will be ordered using the default ordering specified in +Person._defaultOrder.
+While we don't have Full Text Indexes in the emailaddress table, we'll +be trying to match the text only against the beginning of an email +address.
+ +Return all non-merged Persons with at least one email address whose +name, displayname or email address match <text>.
+If text is an empty string, all persons with at least one email +address will be returned.
+The results will be ordered using the default ordering specified in +Person._defaultOrder.
+If exclude_inactive_accounts is True, any accounts whose +account_status is any of INACTIVE_ACCOUNT_STATUSES will not be in the +returned set.
+If must_have_email is True, only people with one or more email +addresses are returned.
+While we don't have Full Text Indexes in the emailaddress table, we'll +be trying to match the text only against the beginning of an email +address.
+If created_before or created_after are not None, they are used to +restrict the search to the dates provided.
+ +Return all Teams whose name, displayname or email address +match <text>.
+The results will be ordered using the default ordering specified in +Person._defaultOrder.
+While we don't have Full Text Indexes in the emailaddress table, we'll +be trying to match the text only against the beginning of an email +address.
+ +Get the person for a given OpenID identifier.
+param openid_identifier: | |
---|---|
full OpenID identifier URL for the user. | +|
return: | the corresponding IPerson or None if the identifier is +unknown | +
Restricted person creation API for SSO.
+This method can only be called by the Ubuntu SSO service. It +finds the username for an account by OpenID identifier.
+param user: | the IPerson performing the operation. Only the +ubuntu-sso celebrity is allowed. | +
---|---|
param openid_identifier: | |
OpenID identifier suffix for the user. +This is not the full URL, just the unique suffix portion. | +
Restricted SSH key creation API for SSO.
+This method can only be called by the Ubuntu SSO service. It finds and +returns all the SSH keys belonging to the account identified by the +openid_identifier parameter.
+param user: | the IPerson performing the operation. Only the +ubuntu-sso celebrity is allowed. | +
---|---|
param openid_identifier: | |
OpenID identifier suffix for the user. +This is not the full URL, just the unique suffix portion. | +
Name
+A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.
+ +Display Name
+Your name as you would like it displayed throughout Launchpad. Most people use their full name here.
+ +Team Description
+Obsolete. Use description.
+ +Subscription period
+Number of days a new subscription lasts before expiring. You can customize the length of an individual subscription when approving it. Leave this empty or set to 0 for subscriptions to never expire.
+ +Self renewal period
+Number of days members can renew their own membership. The number can be from 1 to 3650 (10 years).
+ +Membership policy
+Obsolete: use membership_policy
+ +Restricted person creation API for Software Center Agent.
+This method can only be called by Software Center Agent. It gets +a person by OpenID identifier or creates a new Launchpad person +from the OpenID identifier, email address and display name.
+param user: | the IPerson performing the operation. Only the +software-center-agent celebrity is allowed. | +
---|---|
param openid_identifier: | |
OpenID identifier suffix for the user. +This is not the full URL, just the unique suffix portion. | +|
param email_address: | |
the email address of the user. | +|
param full_name: | |
the full name of the user. | +
Restricted person creation API for SSO.
+This method can only be called by the Ubuntu SSO service. It +reserves a username for an account by OpenID identifier, as long as +the user has no Launchpad account.
+param user: | the IPerson performing the operation. Only the +ubuntu-sso celebrity is allowed. | +
---|---|
param openid_identifier: | |
OpenID identifier suffix for the user. +This is not the full URL, just the unique suffix portion. | +|
param name: | the desired username. | +
raises: | InvalidName if the username doesn't meet character +constraints. | +
raises: | NameAlreadyTaken if the username is already in use. | +
raises: | NotPlaceholderAccount if the OpenID identifier has a +non-placeholder Launchpad account. | +
Name
+A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.
+ +Restricted SSH key creation API for SSO.
+This method can only be called by the Ubuntu SSO service. It adds a new +SSH key to the account identified by 'openid_identifier' based on the +'key_text' parameter.
+param user: | the IPerson performing the operation. Only the +ubuntu-sso celebrity is allowed. | +
---|---|
param openid_identifier: | |
OpenID identifier suffix for the user. +This is not the full URL, just the unique suffix portion. | +|
param key_text: | The full text of the SSH Key. | +
raises NoSuchAccount: | |
If the openid_identifier specified does not +match any account. | +|
raises SSHKeyAdditionError: | |
If the ssh key_text is invalid. | +
Restricted SSH key deletion API for SSO.
+This method can only be called by the Ubuntu SSO service. It deletes an +SSH key from the account identified by 'openid_identifier' based on the +'key_text' parameter.
+param user: | the IPerson performing the operation. Only the +ubuntu-sso celebrity is allowed. | +
---|---|
param openid_identifier: | |
OpenID identifier suffix for the user. +This is not the full URL, just the unique suffix portion. | +|
param key_text: | The full text of the SSH Key. | +
raises NoSuchAccount: | |
If the openid_identifier specified does not +match any account. | +|
raises KeyAdditionError: | |
If the key text is invalid. | +
Search for polls.
+param team: | An optional ITeam to filter by. | +
---|---|
param status: | A collection containing as many values as you want +from PollStatus. Defaults to PollStatus.ALL. | +
param order_by: | An optional PollSort item indicating how to sort +the results. Defaults to PollSort.NEWEST_FIRST. | +
param when: | Used only by tests, to filter for polls open at a +specific date. | +
Poll statuses
+A list of one or more of 'open', 'closed', or 'not-yet-opened'. Defaults to all statuses.
+ +Return the IProcessor instance with the matching name.
+param name: | The name to look for. | +
---|---|
raise ProcessorNotFound: | |
if there is no processor with that name. | +|
return: | A IProcessor instance if found | +
Search through the Registry database for products that match the +query terms. text is a piece of text in the title / summary / +description fields of product.
+This call eager loads data appropriate for web API; caution may be +needed for other callers.
+ +Return the latest projects registered in Launchpad.
+The supplied user determines which objects are visible.
+If the quantity is not specified or is a value that is not 'None' +then the set of projects returned is limited to that value (the +default quantity is 5). If quantity is 'None' then all projects are +returned. For the web service it is not possible to specify the +quantity, so all projects are returned, latest first.
+ +Create and return a brand new Product.
+See IProduct for a description of the parameters.
+ +Name
+At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs as shown above.
+ +Display Name
+The name of the project as it would appear in a +paragraph.
+ +Title
+The project title. Should be just a few words.
+ +Summary
+A short paragraph to introduce the project's work.
+ +Description
+Details about the project's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.
+ +Part of
+Project group. This is an overarching initiative that includes several related projects. For example, the Mozilla Project produces Firefox, Thunderbird and Gecko. This information is used to group those projects in a coherent way. If you make this project part of a group, the group preferences and decisions around bug tracking, translation and security policy will apply to this project.
+ +Homepage URL
+The project home page. Please include +the http://
+ +Screenshots URL
+The full URL for screenshots of this project, +if available. Please include the http://
+ +Download URL
+The full URL where downloads for this project +are located, if available. Please include the http://
+ +Freshmeat Project
+The Freshmeat project name for +this project, if it is in freshmeat. [DEPRECATED]
+ +Wiki URL
+The full URL of this project's wiki, if it has +one. Please include the http://
+ +Sourceforge Project
+The SourceForge project name for +this project, if it is in sourceforge.
+ +Programming Languages
+A comma delimited list of programming +languages used for this project.
+ +Project reviewed
+Whether or not this project has been reviewed. If you looked at the project and how it uses Launchpad, you reviewed it.
+ +Description of additional licences
+Description of licences that do not appear in the list above.
+ +Registrant
+This person registered the project in Launchpad.
+ +Bug Supervisor
+The Launchpad id of the person or team (preferred) responsible for bug management.
+ +Driver
+This person or team will be able to set feature goals for and approve bug targeting or backporting for ANY major series in this project. You might want to leave this blank and just appoint a team for each specific series, rather than having one project team that does it all.
+ +Return the questions from the collection matching search criteria.
+param search_text: | |
---|---|
A string that is matched against the question +title and description. If None, the search_text is not included as +a filter criteria. | +|
param status: | A sequence of QuestionStatus Items. If None or an empty +sequence, the status is not included as a filter criteria. | +
param language: | An ILanguage or a sequence of ILanguage objects to +match against the question's language. If None or an empty +sequence, the language is not included as a filter criteria. | +
param sort: | An attribute of QuestionSort. If None, a default value is +used. When there is a search_text value, the default is to sort by +RELEVANCY, otherwise results are sorted NEWEST_FIRST. | +
Return the question with the given id.
+Return :default: if no such question exists.
+ +Return the ISnapBase with this name.
+raises NoSuchSnapBase: | |
---|---|
if no base exists with this name. | +
Get the default base.
+This will be used to pick the default distro series for snaps that +do not specify a base.
+ +Source snap channels for builds
+A dictionary mapping snap names to channels to use when building snaps that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.
+ +Features supported by this base
+A dictionary designating the features supported by the base. Key is the name of a feature, value is a boolean indicating whether the feature is supported or not.
+ +Set the default base.
+This will be used to pick the default distro series for snaps that +do not specify a base.
+param snap_base: | |
---|---|
An ISnapBase, or None to unset the default base. | +
Return all snap packages that build from the given URL.
+This currently only works for packages that build directly from a +URL, rather than being linked to a Bazaar branch or Git repository +hosted in Launchpad.
+param url: | A URL. | +
---|---|
param owner: | Only return packages owned by this user. | +
param visible_by_user: | |
If not None, only return packages visible by +this user; otherwise, only return publicly-visible packages. | +
Return all snap packages that build from a URL with this prefix.
+This currently only works for packages that build directly from a +URL, rather than being linked to a Bazaar branch or Git repository +hosted in Launchpad.
+param url_prefix: | |
---|---|
A URL prefix. | +|
param owner: | Only return packages owned by this user. | +
param visible_by_user: | |
If not None, only return packages visible by +this user; otherwise, only return publicly-visible packages. | +
Return all snap packages that build from a URL with any of these +prefixes.
+This currently only works for packages that build directly from a +URL, rather than being linked to a Bazaar branch or Git repository +hosted in Launchpad.
+param url_prefixes: | |
---|---|
A list of URL prefixes. | +|
param owner: | Only return packages owned by this user. | +
param visible_by_user: | |
If not None, only return packages visible by +this user; otherwise, only return publicly-visible packages. | +
Return all snap packages with the given store package name.
+param store_name: | |
---|---|
A registered store package name. | +|
param owner: | Only return packages owned by this user. | +
param visible_by_user: | |
If not None, only return packages visible by +this user; otherwise, only return publicly-visible packages. | +
Owner
+The owner of this snap package.
+ +Distro Series
+The series for which the snap package should be built. If not set, Launchpad will infer an appropriate series from snapcraft.yaml.
+ +Snap recipe name
+The name of the snap build recipe.
+ +Description
+A description of the snap package.
+ +Bazaar branch
+A Bazaar branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Git repository
+A Git repository with a branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Git repository URL
+The URL of a Git repository with a branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Git branch path
+The path of the Git branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Git branch
+The Git branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Automatically build when branch changes
+Whether this snap package is built automatically when the branch containing its snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe changes.
+ +Source archive for automatic builds
+The archive from which automatic builds of this snap package should be built.
+ +Pocket for automatic builds
+The package stream within the source archive and distribution series to use when building the snap package. If the source archive is a PPA, then the PPA's archive dependencies will be used to select the pocket in the distribution's primary archive.
+ +Automatically upload to store
+Whether builds of this snap package are automatically uploaded to the store.
+ +Store series
+The series in which this snap package should be published in the store.
+ +Registered store package name
+The registered name of this snap package in the store.
+ +Store channels
+Channels to release this snap package to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.
+ +Information type
+The type of information contained in this Snap recipe.
+ +Return the ISnappySeries with this name.
+raises NoSuchSnappySeries: | |
---|---|
if no snappy series exists with this name. | +
Name
+May contain lower-case letters, numbers, and dashes. It will be used in the specification url. Examples: mozilla-type-ahead-find, postgres-smart-serial.
+ +Title
+Describe the feature as clearly as possible in up to 70 characters. This title is displayed in every feature list or report.
+ +Specification URL
+The URL of the specification. This is usually a wiki page.
+ +Summary
+A single-paragraph description of the feature. This will also be displayed in most feature listings.
+ +Definition Status
+The current status of the process to define the feature and get approval for the implementation plan.
+ +Assignee
+The person responsible for implementing the feature.
+ +Drafter
+The person responsible for drafting the specification.
+ +Status Whiteboard
+Any notes on the status of this spec you would like to make. Your changes will override the current text.
+ +Return all entries this import queue has.
+arg target: | IPerson, IProduct, IProductSeries, IDistribution, +IDistroSeries or ISourcePackage the import entries are attached to +or None to get all entries available. | +
---|---|
arg import_status: | |
RosettaImportStatus entry. | +|
arg file_extensions: | |
Sequence of filename suffixes to match, usually +'po' or 'pot'. | +
If any of target, status or file_extension are given, the returned +entries are filtered based on those values.
+ +Return the first entry of the queue ready to be imported.
+param target: | IPerson, IProduct, IProductSeries, IDistribution, +IDistroSeries or ISourcePackage the import entries are attached to +or None to get all entries available. | +
---|
List Product`s and `DistroSeries with pending imports.
+arg status: | Filter by RosettaImportStatus. | +
---|
All returned items will implement IHasTranslationImports.
+ +Creation date
+When the token was created.
+ +Expiry date
+When the token should expire or was revoked.
+ +Date last used
+When the token was last used.
+ +Description
+A short description of the token.
+ +Owner
+The person who created the token.
+ +Revoked by
+The person who revoked the token, if any.
+ +Scopes
+A list of scopes granted by the token.
+ +Target
+The target for which the token was issued.
+ +Description
+A short description of the token.
+ +Issue a personal access token for this target.
+Access tokens can be used to push to repositories over HTTPS. These may +be used in webservice API requests for certain methods in the target's +repositories.
+They are either non-expiring or with an expiry time given by +date_expires.
+return: | The secret for a new personal access token (Launchpad only +records the hash of this secret and not the secret itself, so the +caller must be careful to save this). | +
---|
Target archive
+The archive that has this dependency.
+ +Target snap base
+The snap base that has this dependency.
+ +Return build records in the context it is implemented.
+It excludes build records generated by Gina (imported from a external +repository), where IBuild.datebuilt is null and IBuild.buildstate +is BuildStatus.FULLYBUILT.
+The result is simply not filtered if the optional filters are omitted +by call sites.
+param build_state: | |
---|---|
optional BuildStatus value for filtering build +records; | +|
param name: | optional string for filtering build source package name. +Sub-string matching is allowed via SQL LIKE. | +
param pocket: | optional PackagePublishingPocket value for filtering +build records; | +
param arch_tag: | optional string for filtering build source packages +by their architecture tag; | +
param user: | optional IPerson corresponding to the user performing +the request. It will filter out build records for which the user +have no 'view' permission. | +
param binary_only: | |
optional boolean indicating whether only +BinaryPackageBuild objects should be returned, or more general +PackageBuild objects (which may include, for example, +SourcePackageRecipeBuild objects. | +|
return: | a result set containing IPackageBuild records ordered by +descending IPackageBuild.date_finished except when builds are +filtered by BuildStatus.NEEDSBUILD, in this case records +are ordered by descending BuildQueue.lastscore +(dispatching order). | +
Build status
+The status of this build record
+ +The pocket into which this entry is published
+ +The pocket into which this entry is published
+ +The ArchivePermission records for uploaders to the package set.
+param packageset: | |
---|---|
An IPackageset. | +|
param direct_permissions: | |
If True, only consider permissions granted +directly for the package set at hand. Otherwise, include any +uploaders for package sets that include this one. | +|
return: | ArchivePermission records for all the uploaders who are +authorized to upload to the named source package set. | +
The ArchivePermission records for the person's package sets.
+param person: | An IPerson for whom you want to find out which +package sets they have access to. | +
---|---|
return: | ArchivePermission records for all the package sets that +'person' is allowed to upload to. | +
The package set based permissions for a given source and uploader.
+param sourcepackagename: | |
---|---|
the source package name; can be +either a string or a ISourcePackageName. | +|
param person: | An IPerson for whom you want to find out which +package sets they have access to. | +
raises NoSuchSourcePackageName: | |
if a source package with the +given name could not be found. | +|
return: | ArchivePermission records for the package sets that +include the given source package name and to which the given +person may upload. | +
All package set based permissions for the given source.
+This method is meant to aid the process of "debugging" package set +based archive permission since It allows the listing of permissions +for the given source package in this archive (irrespective of the +principal).
+param sourcepackagename: | |
---|---|
the source package name; can be +either a string or a ISourcePackageName. | +|
param direct_permissions: | |
If set only package sets that directly +include the given source will be considered. | +|
raises NoSuchSourcePackageName: | |
if a source package with the +given name could not be found. | +|
return: | ArchivePermission records for the package sets that +include the given source package name and apply to the +archive in question. | +
True if the person is allowed to upload the given source package.
+If the source package name is included by any package set with +an explicit permission then only such explicit permissions will +be considered.
+param sourcepackagename: | |
---|---|
the source package name; can be +either a string or a ISourcePackageName. | +|
param person: | An IPerson for whom you want to find out which +package sets they have access to. | +
param distroseries: | |
The IDistroSeries for which to check +permissions. If none is supplied then currentseries in +the archive's distribution is assumed. | +|
raises NoSuchSourcePackageName: | |
if a source package with the +given name could not be found. | +|
return: | True if the person is allowed to upload the source package. | +
Return a dictionary containing the build counters for an archive.
+This is necessary currently because the IArchive.failed_builds etc. +counters are not in use.
+The returned dictionary contains the following keys and values:
++++
+- 'total': total number of builds (includes SUPERSEDED);
+- 'pending': number of builds in BUILDING or NEEDSBUILD state;
+- 'failed': number of builds in FAILEDTOBUILD, MANUALDEPWAIT, +CHROOTWAIT and FAILEDTOUPLOAD state;
+- 'succeeded': number of SUCCESSFULLYBUILT builds.
+- 'superseded': number of SUPERSEDED builds.
+
param include_needsbuild: | |
---|---|
Indicates whether to include builds with +the status NEEDSBUILD in the pending and total counts. This is +useful in situations where a build that hasn't started isn't +considered a build by the user. | +|
type include_needsbuild: | |
bool | +|
return: | a dictionary with the 4 keys specified above. | +
rtype: | dict. | +
Return a dictionary containing a summary of the build statuses.
+Only information for sources belonging to the current archive will +be returned. See +IPublishingSet.getBuildStatusSummariesForSourceIdsAndArchive() for +details.
+param source_ids: | |
---|---|
A list of source publishing history record ids. | +|
type source_ids: | |
list | +|
return: | A dict consisting of the overall status summaries for the +given ids that belong in the archive. | +
Return the IArchiveDependency object for the given dependency.
+param dependency: | |
---|---|
is an IArchive object. | +|
return: | IArchiveDependency or None if a corresponding object +could not be found. | +
Return the IArchivePermission records applicable to the person.
+param person: | An IPerson | +
---|---|
return: | A list of IArchivePermission records. | +
Return IArchivePermission records for the package's uploaders.
+param source_package_name: | |
---|---|
An ISourcePackageName or textual name +for the source package. | +|
return: | A list of IArchivePermission records. | +
Return IArchivePermission records for the component's uploaders.
+param component_name: | |
---|---|
An IComponent or textual name for the +component. | +|
return: | A list of IArchivePermission records. | +
Return IArchivePermission records for authorized queue admins.
+param component_name: | |
---|---|
An IComponent or textual name for the +component. | +|
return: | A list of IArchivePermission records. | +
Return IArchivePermission for the person's queue admin +components.
+param person: | An IPerson. | +
---|---|
return: | A list of IArchivePermission records. | +
Package Publishing Status
+The status of this publishing record
+ +The pocket into which this entry is published
+ +Exact Match
+Whether or not to filter source names by exact matching.
+ +Created Since Date
+Return entries whose date_created is greater than or equal to this date.
+ +Order by creation date
+Return newest results first. This is recommended for applications that need to catch up with publications since their last run. If not specified, results are ordered by source package name (lexicographically), then by descending version and then descending ID.
+ +All IBinaryPackagePublishingHistory target to this archive.
+param name: | binary name filter (exact match or SQL LIKE controlled +by 'exact_match' argument). | +
---|---|
param version: | binary version filter (always exact match). | +
param status: | PackagePublishingStatus filter, can be a list. | +
param distroarchseries: | |
IDistroArchSeries filter, can be a list. | +|
param pocket: | PackagePublishingPocket filter. | +
param exact_match: | |
either or not filter source names by exact +matching. | +|
param created_since_date: | |
Only return publications created on or +after this date. | +|
param ordered: | Normally publications are ordered by binary package +name and then ID order (creation order). If this parameter is +False then the results will be unordered. This will make the +operation much quicker to return results if you don't care about +ordering. | +
param order_by_date: | |
Order publications by descending creation date +and then by descending ID. This is suitable for applications +that need to catch up with publications since their last run. | +|
param include_removed: | |
If True, include publications that have been +removed from disk as well as those that have not. | +|
param only_unpublished: | |
If True, only include publications that +have never been published to disk. | +|
param component_name: | |
component filter. Only return binaries that are +in this component. | +|
return: | A collection containing BinaryPackagePublishingHistory. | +
Package Publishing Status
+The status of this publishing record
+ +The pocket into which this entry is published
+ +Created Since Date
+Return entries whose date_created is greater than or equal to this date.
+ +Ordered
+Return ordered results by default, but specifying False will return results more quickly.
+ +Order by creation date
+Return newest results first. This is recommended for applications that need to catch up with publications since their last run.
+ +Return the pockets that 'person' can upload to this archive.
+param person: | An IPerson wishing to upload to an archive. | +
---|---|
return: | A set of PackagePublishingPocket items that 'person' +can upload to. | +
Return all IArchivePermission records for this archive.
+return: | A list of IArchivePermission records. | +
---|
Return IArchivePermission records for the pocket's uploaders.
+param pocket: | A PackagePublishingPocket. | +
---|---|
return: | A list of IArchivePermission records. | +
Return IArchivePermission records for authorized queue admins.
+param pocket: | A PackagePublishingPocket. | +
---|---|
param distroseries: | |
An optional IDistroSeries. | +|
return: | A list of IArchivePermission records. | +
Return IArchivePermission for the person's queue admin pockets.
+param person: | An IPerson. | +
---|---|
return: | A list of IArchivePermission records. | +
Get the public key used to sign this repository.
+If the repository has a signing key but it cannot be retrieved from +the keyserver, then the response will have an appropriate 4xx or 5xx +HTTP status code. Otherwise, returns the ASCII-armoured public key +material as a text string, or None if the repository has no signing +key.
+ +param name: | The identifier string for a token. | +
---|---|
param as_dict: | Optional boolean, controls whether the return value is +a dictionary or a full object. | +
return: | 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. | +
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.
+param names: | An optional list of token names. | +
---|---|
param as_dict: | Optional boolean, controls whether the return value is +a list of dictionaries or a list of full objects. | +
return: | 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. | +
Add permission for a person to upload a package to this archive.
+param person: | An IPerson whom should be given permission. | +
---|---|
param source_package_name: | |
An ISourcePackageName or textual package +name. | +|
return: | An IArchivePermission which is the newly-created +permission. | +
Add permission for a person to upload to a component.
+param person: | An IPerson whom should be given permission. | +
---|---|
param component: | |
An IComponent or textual component name. | +|
return: | An IArchivePermission which is the newly-created +permission. | +
raises InvalidComponent: | |
if this archive is a PPA and the component +is not 'main'. | +
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.
+param person: | An IPerson whom should be given permission. | +
---|---|
param component: | |
An IComponent or textual component name. | +|
return: | An IArchivePermission which is the newly-created +permission. | +
Add a package set based permission for a person.
+param person: | An IPerson for whom you want to add permission. | +
---|---|
param packageset: | |
An IPackageset. | +|
param explicit: | True if the package set in question requires +specialist skills for proper handling. | +
return: | The new ArchivePermission, or the existing one if it +already exists. | +
Revoke permission for the person to upload the package.
+param person: | An IPerson whose permission should be revoked. | +
---|---|
param source_package_name: | |
An ISourcePackageName or textual package +name. | +
Revoke permission for the person to upload to the component.
+param person: | An IPerson whose permission should be revoked. | +
---|---|
param component: | |
An IComponent or textual 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.
+param person: | An IPerson whose permission should be revoked. | +
---|---|
param component: | |
An IComponent or textual component name. | +
Revoke upload permissions for a person.
+param person: | An IPerson for whom you want to revoke permission. | +
---|---|
param packageset: | |
An IPackageset. | +|
param explicit: | The value of the 'explicit' flag for the permission +to be revoked. | +
Synchronise (copy) named sources into this archive from another.
+DEPRECATED: syncSource and syncSources are deprecated, and will +be removed entirely in the future. Use the asynchronous +copyPackage method instead, and poll getPublishedSources if you +need to await completion.
+It will copy the most recent PUBLISHED versions of the named +sources to the destination archive if necessary.
+This operation will only succeeds when all requested packages +are synchronised between the archives. If any of the requested +copies cannot be performed, the whole operation will fail. There +will be no partial changes of the destination archive.
+If the source or target distribution has a development series alias, +then it may be used as the source or target distroseries name +respectively; but note that this will always be resolved to the true +development series of that distribution, which may not match the +alias in the respective published archives.
+param source_names: | |
---|---|
a list of string names of packages to copy. | +|
param from_archive: | |
the source archive from which to copy. | +|
param to_pocket: | |
the target pocket (as a string). | +|
param to_series: | |
the target distroseries (as a string). | +|
param from_series: | |
the source distroseries (as a string). | +|
param include_binaries: | |
optional boolean, controls whether or not +the published binaries for each given source should also be +copied along with the source. | +|
param person: | the IPerson who requests the sync. | +
raises NoSuchSourcePackageName: | |
if the source name is invalid | +|
raises PocketNotFound: | |
if the pocket name is invalid | +|
raises NoSuchDistroSeries: | |
if the distro series name is invalid | +|
raises CannotCopy: | |
if there is a problem copying. | +
Distroseries name
+The distro series to copy packages into.
+ +Distroseries name
+The distro series to copy packages from.
+ +Include Binaries
+Whether or not to copy binaries already built for this source
+ +Synchronise (copy) a single named source into this archive.
+DEPRECATED: syncSource and syncSources are deprecated, and will +be removed entirely in the future. Use the asynchronous +copyPackage method instead, and poll getPublishedSources if you +need to await completion.
+Copy a specific version of a named source to the destination +archive if necessary.
+If the source distribution has a development series alias, then it +may be used as the source distroseries name; but note that this will +always be resolved to the true development series of that +distribution, which may not match the alias in the published source +archive.
+param source_name: | |
---|---|
a string name of the package to copy. | +|
param version: | the version of the package to copy. | +
param from_archive: | |
the source archive from which to copy. | +|
param to_pocket: | |
the target pocket (as a string). | +|
param to_series: | |
the target distroseries (as a string). | +|
param include_binaries: | |
optional boolean, controls whether or not +the published binaries for each given source should also be +copied along with the source. | +|
param person: | the IPerson who requests the sync. | +
raises NoSuchSourcePackageName: | |
if the source name is invalid | +|
raises PocketNotFound: | |
if the pocket name is invalid | +|
raises NoSuchDistroSeries: | |
if the distro series name is invalid | +|
raises CannotCopy: | |
if there is a problem copying. | +
Include Binaries
+Whether or not to copy binaries already built for this source
+ +Create a new subscription to this archive.
+Create an ArchiveSubscriber record which allows an IPerson to +access a private repository.
+param subscriber: | |
---|---|
An IPerson who is allowed to access the +repository for this archive. | +|
param registrant: | |
An IPerson who created this subscription. | +|
param date_expires: | |
When the subscription should expire; None if +it should not expire (default). | +|
param description: | |
An option textual description of the subscription +being created. | +|
return: | The IArchiveSubscriber that was created. | +
Subscriber
+The person who is subscribed.
+ +Date of Expiration
+The timestamp when the subscription will expire.
+ +Description
+Free text describing this subscription.
+ +Add the processor to the set of enabled restricted processors.
+DEPRECATED. Use setProcessors instead.
+param processor: | |
---|---|
is an IProcessor object. | +
Copy a single named source into this archive.
+Asynchronously copy a specific version of a named source to the +destination archive if necessary. Calls to this method will return +immediately if the copy passes basic security checks and the copy +will happen sometime later with full checking.
+If the source or target distribution has a development series alias, +then it may be used as the source or target distroseries name +respectively; but note that this will always be resolved to the true +development series of that distribution, which may not match the +alias in the respective published archives.
+param source_name: | |
---|---|
a string name of the package to copy. | +|
param version: | the version of the package to copy. | +
param from_archive: | |
the source archive from which to copy. | +|
param to_pocket: | |
the target pocket (as a string). | +|
param to_series: | |
the target distroseries (as a string). | +|
param include_binaries: | |
optional boolean, controls whether or not +the published binaries for each given source should also be +copied along with the source. | +|
param person: | the IPerson who requests the sync. | +
param sponsored: | |
the IPerson who is being sponsored. Specifying +this will ensure that the person's email address is used as the +"From:" on the announcement email and will also be recorded as +the creator of the new source publication. | +|
param unembargo: | |
if True, allow copying restricted files from a +private archive to a public archive, and re-upload them to the +public librarian when doing so. | +|
param auto_approve: | |
if True and the IPerson requesting the sync +has queue admin permissions on the target, accept the copy +immediately rather than setting it to unapproved. | +|
param silent: | Suppress any emails that the copy would generate. +Only usable with queue admin permissions on the target. | +
param from_pocket: | |
the source pocket (as a string). If omitted, +copy from any pocket with a matching version. | +|
param from_series: | |
the source distroseries (as a string). If +omitted, copy from any series with a matching version. | +|
param phased_update_percentage: | |
the phased update percentage to +apply to the copied publication. | +|
param move: | if True, delete the source publication after copying it +to the destination. | +
raises NoSuchSourcePackageName: | |
if the source name is invalid | +|
raises PocketNotFound: | |
if the pocket name is invalid | +|
raises NoSuchDistroSeries: | |
if the distro series name is invalid | +|
raises CannotCopy: | |
if there is a problem copying. | +
Include Binaries
+Whether or not to copy binaries already built for this source
+ +Sponsored Person
+The person who is being sponsored for this copy.
+ +Automatic approval
+Automatically approve this copy (queue admins only).
+ +Silent
+Don't notify anyone about this copy. For use by queue admins only.
+ +Phased update percentage
+The percentage of users for whom this package should be recommended, or None to publish the update for everyone.
+ +Move
+If true, delete the source publication after copying it to the destination.
+ +Copy multiple named sources into this archive from another.
+Asynchronously copy the most recent PUBLISHED versions of the named +sources to the destination archive if necessary. Calls to this +method will return immediately if the copy passes basic security +checks and the copy will happen sometime later with full checking.
+Partial changes of the destination archive can happen because each +source is copied in its own transaction.
+If the source or target distribution has a development series alias, +then it may be used as the source or target distroseries name +respectively; but note that this will always be resolved to the true +development series of that distribution, which may not match the +alias in the respective published archives.
+param source_names: | |
---|---|
a list of string names of packages to copy. | +|
param from_archive: | |
the source archive from which to copy. | +|
param to_pocket: | |
the target pocket (as a string). | +|
param to_series: | |
the target distroseries (as a string). | +|
param from_series: | |
the source distroseries (as a string). | +|
param include_binaries: | |
optional boolean, controls whether or not +the published binaries for each given source should also be +copied along with the source. | +|
param person: | the IPerson who requests the sync. | +
param sponsored: | |
the IPerson who is being sponsored. Specifying +this will ensure that the person's email address is used as the +"From:" on the announcement email and will also be recorded as +the creator of the new source publication. | +|
param unembargo: | |
if True, allow copying restricted files from a +private archive to a public archive, and re-upload them to the +public librarian when doing so. | +|
param auto_approve: | |
if True and the IPerson requesting the sync +has queue admin permissions on the target, accept the copies +immediately rather than setting it to unapproved. | +|
param silent: | Suppress any emails that the copy would generate. +Only usable with queue admin permissions on the target. | +
raises NoSuchSourcePackageName: | |
if the source name is invalid | +|
raises PocketNotFound: | |
if the pocket name is invalid | +|
raises NoSuchDistroSeries: | |
if the distro series name is invalid | +|
raises CannotCopy: | |
if there is a problem copying. | +
Distroseries name
+The distro series to copy packages into.
+ +Distroseries name
+The distro series to copy packages from.
+ +Include Binaries
+Whether or not to copy binaries already built for this source
+ +Sponsored Person
+The person who is being sponsored for this copy.
+ +Automatic approval
+Automatically approve this copy (queue admins only).
+ +Silent
+Don't notify anyone about this copy. For use by queue admins only.
+ +Add permission for a person to upload to a pocket.
+param person: | An IPerson whom should be given permission. | +
---|---|
param pocket: | A PackagePublishingPocket. | +
return: | 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. | +|
raises InvalidPocketForPPA: | |
if this archive is a PPA and the pocket +is not RELEASE. | +
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.
+param person: | An IPerson whom should be given permission. | +
---|---|
param pocket: | A PackagePublishingPocket. | +
param distroseries: | |
An optional IDistroSeries. | +|
return: | An IArchivePermission which is the newly-created +permission. | +
Revoke permission for the person to upload to the pocket.
+param person: | An IPerson whose permission should be revoked. | +
---|---|
param distroseries: | |
An IDistroSeries. | +|
param pocket: | A PackagePublishingPocket. | +
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.
+param person: | An IPerson whose permission should be revoked. | +
---|---|
param pocket: | A PackagePublishingPocket. | +
param distroseries: | |
An optional IDistroSeries. | +
Record an archive dependency record for the context archive.
+param dependency: | |
---|---|
is an IArchive object. | +|
param pocket: | is an PackagePublishingPocket enum. | +
param 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. | +|
raise: | ArchiveDependencyError if given 'dependency' does not fit +the context archive. | +
return: | a IArchiveDependency object targeted to the context +IArchive requiring 'dependency' IArchive. | +
The pocket into which this entry is published
+ +Remove the IArchiveDependency record for the given dependency.
+param dependency: | |
---|---|
is an IArchive object. | +
Create a new named authorization token.
+param name: | An identifier string for this token. | +
---|---|
param token: | Optional unicode text to use as the token. One will be +generated if not given. | +
param as_dict: | Optional boolean, controls whether the return value is +a dictionary or a full object. | +
return: | 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. | +
Create named authorization tokens in bulk.
+param names: | A list of token names. | +
---|---|
param as_dict: | Optional boolean, controls whether the return value is +a list of dictionaries or a list of full objects. | +
return: | 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. | +
Deactivate a named authorization token.
+param name: | The identifier string for a token. | +
---|---|
raises NotFoundError: | |
if no matching token could be found. | +
Deactivate named authorization tokens in bulk.
+param names: | A list of token names. | +
---|
Remove a copy notification that's displayed on the +packages page.
+Copy notifications are shown on the +packages page when a +PlainPackageCopyJob is in progress or failed. Calling this +method will delete failed jobs so they no longer appear on the +page.
+You need to have upload privileges on the PPA to use this.
+param job_id: | The ID of the PlainPackageCopyJob to be removed. | +
---|
Mark a suite as dirty in this archive.
+The next publisher run will publish this suite regardless of whether +it has any pending publications.
+param distroseries: | |
---|---|
An IDistroSeries. | +|
param pocket: | A PackagePublishingPocket. | +
Authorized size
+Maximum size, in MiB, allowed for the archive.
+ +Build debug symbols
+Create debug symbol packages for builds in the archive.
+ +Description
+A short description of the archive. URLs are allowed and will be rendered as links.
+ +Display name
+A short title for the archive.
+ +Enabled restricted processors
+DEPRECATED. Use processors instead.
+ +External dependencies
+Newline-separated list of repositories to be used to retrieve any external build-dependencies when building packages in the archive, in the format: +deb http[s]://[user:pass@]<host>[/path] %(series)s[-pocket] [components] +The series variable is replaced with the series name of the context build. +NOTE: This is for migration of OEM PPAs only!
+ +Name
+At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs.
+ +Owner
+The archive owner.
+ +Permit uploads to obsolete series
+Allow uploads targeted to obsolete series.
+ +Private
+Restrict access to the archive to its owner and subscribers. This can only be changed if the archive has never had any sources published.
+ +Processors
+The architectures on which the archive can build.
+ +Publishing enabled
+Whether or not to update the apt repository. If disabled, nothing will be published. If the archive is private then additionally no builds will be dispatched.
+ +Publish debug symbols
+Publish debug symbol packages in the apt repository.
+ +Reference
+A string to uniquely identify the archive.
+ +Relative build score
+A delta to apply to all build scores for the archive. Builds with a higher score will build sooner.
+ +Require virtualized builders
+Only build the archive's packages on virtual builders.
+ +Archive signing key fingerprint
+A OpenPGP signing key fingerprint (40 chars) for this PPA or None if there is no signing key available.
+ +Suppress subscription notifications
+Whether subscribers to private PPAs get emails about their subscriptions. Has no effect on a public PPA.
+ +Authorized size
+Maximum size, in MiB, allowed for the archive.
+ +Build debug symbols
+Create debug symbol packages for builds in the archive.
+ +Description
+A short description of the archive. URLs are allowed and will be rendered as links.
+ +Display name
+A short title for the archive.
+ +External dependencies
+Newline-separated list of repositories to be used to retrieve any external build-dependencies when building packages in the archive, in the format: +deb http[s]://[user:pass@]<host>[/path] %(series)s[-pocket] [components] +The series variable is replaced with the series name of the context build. +NOTE: This is for migration of OEM PPAs only!
+ +Name
+At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs.
+ +Owner
+The archive owner.
+ +Permit uploads to obsolete series
+Allow uploads targeted to obsolete series.
+ +Private
+Restrict access to the archive to its owner and subscribers. This can only be changed if the archive has never had any sources published.
+ +Publishing enabled
+Whether or not to update the apt repository. If disabled, nothing will be published. If the archive is private then additionally no builds will be dispatched.
+ +Publish debug symbols
+Publish debug symbol packages in the apt repository.
+ +Relative build score
+A delta to apply to all build scores for the archive. Builds with a higher score will build sooner.
+ +Require virtualized builders
+Only build the archive's packages on virtual builders.
+ +Archive signing key fingerprint
+A OpenPGP signing key fingerprint (40 chars) for this PPA or None if there is no signing key available.
+ +Suppress subscription notifications
+Whether subscribers to private PPAs get emails about their subscriptions. Has no effect on a public PPA.
+ +Archive
+The archive that this permission is for.
+ +Date Created
+The timestamp when the permission was created.
+ +Distro series
+The distro series that this permission is for (only for pocket permissions).
+ +Explicit
+Set this flag for package sets with high-profile packages requiring specialist skills for proper handling.
+ +Person
+The person or team being granted the permission.
+ +The pocket that this permission is for.
+ +Archive
+The archive that this permission is for.
+ +Date Created
+The timestamp when the permission was created.
+ +Distro series
+The distro series that this permission is for (only for pocket permissions).
+ +Explicit
+Set this flag for package sets with high-profile packages requiring specialist skills for proper handling.
+ +Person
+The person or team being granted the permission.
+ +The pocket that this permission is for.
+ +Cancel a subscription.
+param cancelled_by: | |
---|---|
An IPerson who is cancelling the subscription. | +
Sets cancelled_by to the supplied person and date_cancelled to +the current date/time.
+ +Archive
+The archive for this subscription.
+ +Date Created
+The timestamp when the subscription was created.
+ +Date of Expiration
+The timestamp when the subscription will expire.
+ +Description
+Free text describing this subscription.
+ +Registrant
+The person who registered this subscription.
+ +Status
+The status of this subscription.
+ +Subscriber
+The person who is subscribed.
+ +Date of Expiration
+The timestamp when the subscription will expire.
+ +Description
+Free text describing this subscription.
+ +Status
+The status of this subscription.
+ +The latest source publication corresponding to this build.
+Unlike current_source_publication, this returns publications even if +they are no longer active.
+return: | An ISourcePackagePublishingHistory, or None if no +corresponding source publication can be located (which is a bug, +but is true for some old production builds). | +
---|
Restore the build record to its initial state.
+Build record loses its history, is moved to NEEDSBUILD and a new +non-scored BuildQueue entry is created for it.
+ +Cancel the build if it is either pending or in progress.
+Check the can_be_cancelled property prior to calling this method to +find out if cancelling the build is possible.
+If the build is in progress, it is marked as CANCELLING until the +buildd manager terminates the build and marks it CANCELLED. If the +build is not in progress, it is marked CANCELLED immediately and is +removed from the build queue.
+If the build is not in a cancellable state, this method is a no-op.
+ +Archive
+The Archive context for this build.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Builder
+The builder assigned to this job.
+ +buildinfo file URL
+The URL for the .buildinfo file for this build.
+ +Status
+The current status of the job.
+ +Can be cancelled
+Whether this build record can be cancelled.
+ +Can be rescored
+Whether this build record can be rescored manually.
+ +Can be retried
+Whether this build record can be retried.
+ +Changes file URL
+The URL for the changes file for this build. Will be None if the build was imported by Gina.
+ +Source publication
+The current source publication for this build.
+ +Date finished
+The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.
+ +Date started
+The timestamp when the build farm job was started.
+ +Date finished
+The timestamp when the build farm job was finished.
+ +Date created
+The timestamp when the build farm job was created.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Duration
+Duration interval, calculated when the result gets collected.
+ +External dependencies
+Newline-separated list of repositories to be used to retrieve any external build-dependencies when performing this build, in the format: +deb http[s]://[user:pass@]<host>[/path] series[-pocket] [components] +This is intended for bootstrapping build-dependency loops.
+ +The build targeted pocket.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Status
+The current status of the job.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +External dependencies
+Newline-separated list of repositories to be used to retrieve any external build-dependencies when performing this build, in the format: +deb http[s]://[user:pass@]<host>[/path] series[-pocket] [components] +This is intended for bootstrapping build-dependency loops.
+ +The build targeted pocket.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Get the download count of this binary package in this archive.
+This is currently only meaningful for PPAs.
+ +Get detailed download counts for this binary.
+param start_date: | |
---|---|
The optional first date to return. | +|
param end_date: | The optional last date to return. | +
Get the daily download counts for this binary.
+param start_date: | |
---|---|
The optional first date to return. | +|
param end_date: | The optional last date to return. | +
URLs for this binary publication's binary files.
+param include_meta: | |
---|---|
Return a list of dicts with keys url, size, +sha1, and sha256 for each URL instead of a simple list. | +|
return: | A collection of URLs for this binary. | +
Delete this source and its binaries.
+param removed_by: | |
---|---|
IPerson responsible for the removal. | +|
param removal_comment: | |
optional text describing the removal reason. | +
Change the component/section/priority/phase of this publication.
+It is changed only if the argument is not None.
+Passing new_phased_update_percentage=100 has the effect of setting +the phased update percentage to None (i.e. recommended for all +users).
+Return the overridden publishing record, a +IBinaryPackagePublishingHistory.
+ +Archive
+The context archive for this publication.
+ +Build
+The build that produced this binary package.
+ +Publication Creator
+The IPerson who created this publication.
+ +Date Created
+The date on which this record was created
+ +Date Made Pending
+The date on which this record was set as pending removal
+ +Date Published
+The date on which this record was published
+ +Date Removed
+The date on which this record was removed from the published set
+ +Date Superseded
+The date on which this record was marked superseded
+ +Display Name
+Text representation of the current record.
+ +Distro Arch Series
+The distroarchseries being published into
+ +Debug Package
+Is this a debug package publication?
+ +The pocket into which this entry is published
+ +Removal Comment
+Reason why this publication is going to be removed.
+ +Removed By
+The Person responsible for the removal
+ +Scheduled Deletion Date
+The date on which this record is scheduled for deletion
+ +Source Package Name
+The source package name that built this binary.
+ +Source Package Version
+The source package version that built this binary.
+ +Status
+The status of this publishing record
+ +Date Created
+The date on which this record was created
+ +Date Made Pending
+The date on which this record was set as pending removal
+ +Date Published
+The date on which this record was published
+ +Date Removed
+The date on which this record was removed from the published set
+ +Date Superseded
+The date on which this record was marked superseded
+ +Display Name
+Text representation of the current record.
+ +Distro Arch Series
+The distroarchseries being published into
+ +Removal Comment
+Reason why this publication is going to be removed.
+ +Removed By
+The Person responsible for the removal
+ +Scheduled Deletion Date
+The date on which this record is scheduled for deletion
+ +Status
+The status of this publishing record
+ +Return a public URL for the branch using the given protocol.
+param scheme: | a protocol name accepted by the public +code-hosting API. (As a legacy issue, 'sftp' is also +accepted). | +
---|
Return true if the reviewer is a trusted reviewer.
+The reviewer is trusted if they are either own the branch, or are in +the team that owns the branch, or they are in the review team for the +branch.
+ +Can this branch be deleted in its current state.
+A branch is considered deletable if it has no revisions and is not +linked to any bugs, specs, productseries, or code imports.
+ +Active
+Deliver details of subscribed events.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +Set the target of the branch to be project or source_package.
+Only one of project or source_package can be set, and if neither +is set, the branch gets moved into the junk namespace of the branch +owner.
+raise: | BranchTargetError if both project and source_package are +set, or if either the project or source_package fail to be +adapted to an IBranchTarget. | +
---|
Link a bug to this branch.
+param bug: | IBug to link. | +
---|---|
param registrant: | |
IPerson linking the bug. | +
Unlink a bug to this branch.
+param bug: | IBug to unlink. | +
---|---|
param user: | IPerson unlinking the bug. | +
Link an ISpecification to a branch.
+param spec: | ISpecification to link. | +
---|---|
param registrant: | |
IPerson unlinking the spec. | +
Unlink an ISpecification to a branch.
+param spec: | ISpecification to unlink. | +
---|---|
param user: | IPerson unlinking the spec. | +
Create a new BranchMergeProposal with this branch as the source.
+Both the target_branch and the prerequisite_branch, if it is there, +must be branches with the same target as the source branch.
+Personal branches (a.k.a. junk branches) cannot specify landing +targets.
+ +Needs review
+If True the proposal needs review.Otherwise, it will be work in progress.
+ +Initial comment
+Registrant's initial description of proposal.
+ +Commit message
+Message to use when committing this merge.
+ +Subscribe this person to the branch.
+param person: | The Person to subscribe. | +
---|---|
param notification_level: | |
The kinds of branch changes that cause +notification. | +|
param max_diff_lines: | |
The maximum number of lines of diff that may +appear in a notification. | +|
param code_review_level: | |
The kinds of code review activity that cause +notification. | +|
param subscribed_by: | |
The person who is subscribing the subscriber. +Most often the subscriber themselves. | +|
return: | new or existing BranchSubscription. | +
Remove the person's subscription to this branch.
+param person: | The person or team to unsubscribe from the branch. | +
---|---|
param unsubscribed_by: | |
The person doing the unsubscribing. | +
Set the information type for this branch.
+param information_type: | |
---|---|
The InformationType to transition to. | +|
param who: | The IPerson who is making the change. | +
param verify_policy: | |
Check if the new information type complies +with the IBranchNamespacePolicy. | +
Information Type
+The type of information contained in this branch.
+ +Reset this branch's scan data and request a rescan.
+A convenience function wrapper around unscan().
+ +Bazaar Identity
+The bzr branch path as accessed by Launchpad. If the branch is associated with a product as the primary development focus, then the result should be lp:product. If the branch is related to a series, then lp:product/series. Otherwise the result is lp:~user/product/branch-name.
+ +Dependent Branches
+A collection of the merge proposals that are dependent on this branch.
+ +Description
+A short description of the changes in this branch.
+ +Display name
+The branch unique_name.
+ +Keep branch confidential
+Make this branch visible only to its subscribers.
+ +Information Type
+The type of information contained in this branch.
+ +Landing Candidates
+A collection of the merge proposals where this branch is the target branch.
+ +Landing Targets
+A collection of the merge proposals where this branch is the source branch.
+ +Last scanned revision ID
+The head revision ID of the branch when last successfully scanned.
+ +Name
+Keep very short, unique, and descriptive, because it will be used in URLs. Examples: main, devel, release-1.0, gnome-vfs.
+ +Owner
+Either yourself or an exclusive team you are a member of. This controls who can modify the branch.
+ +Branch is confidential
+This branch is visible only to its subscribers.
+ +Project
+The project this branch belongs to.
+ +Review Team
+The reviewer of a branch is the person or exclusive team that is responsible for reviewing proposals and merging into this branch.
+ +Revision count
+The revision number of the tip of the branch.
+ +Unique name
+Unique name of the branch, including the owner and project names.
+ +Branch URL
+The external location where the Bazaar branch is hosted. It is None when the branch is hosted by Launchpad.
+ +Whiteboard
+Notes on the current status of the branch.
+ +Description
+A short description of the changes in this branch.
+ +Keep branch confidential
+Make this branch visible only to its subscribers.
+ +Name
+Keep very short, unique, and descriptive, because it will be used in URLs. Examples: main, devel, release-1.0, gnome-vfs.
+ +Review Team
+The reviewer of a branch is the person or exclusive team that is responsible for reviewing proposals and merging into this branch.
+ +Branch URL
+The external location where the Bazaar branch is hosted. It is None when the branch is hosted by Launchpad.
+ +Whiteboard
+Notes on the current status of the branch.
+ +Return the CodeReviewComment with the specified ID.
+raises WrongBranchMergeProposal: | |
---|---|
if the comment with this ID is not +on this merge proposal. | +
Return the draft inline comments related to this MP.
+The return value is a dictionary (object) where the keys are the +diff lines and their values are the actual draft comment created +by the given person.
+param previewdiff_id: | |
---|---|
The ID of the target PreviewDiff. | +|
param person: | The IPerson owner of the draft comments. | +
Return a list of inline comments related to this MP.
+The return value is an list of dictionaries (objects), each one +representing a comment with 'line_number', 'person', 'text' and +'date' attributes.
+param previewdiff_id: | |
---|---|
The ID of the target PreviewDiff. | +
Create an ICodeReviewComment associated with this merge proposal.
+param owner: | The person who the message is from. | +
---|---|
param subject: | The subject line to use for the message. | +
param content: | The text to use for the message content. If +unspecified, the text of the merge proposal is used. | +
param parent: | The previous CodeReviewComment in the thread. If +unspecified, the root message is used. | +
param previewdiff_id: | |
the inline comments PreviewDiff ID context. | +|
param inline_comments: | |
a dictionary containing the draft inline +comments keyed by the diff line number. | +
Set the state of the merge proposal to the specified status.
+param status: | The new status of the merge proposal. | +
---|---|
param user: | The user making the change. | +
param revision_id: | |
The revision id to provide to the underlying +status change method. | +
Set the specified person as a reviewer.
+If they are not already a reviewer, a vote is created. Otherwise, +the details are updated.
+ +Save ICodeReviewInlineCommentDraft
+param previewdiff_id: | |
---|---|
The ID of the target PreviewDiff. | +|
param person: | The IPerson making the comments. | +
param comments: | The comments. | +
Schedule updates of the diffs for this proposal.
+This can be used if the previous attempt to generate diffs crashed, +or if Launchpad failed to notice that the current diffs are outdated +for some reason.
+param return_jobs: | |
---|---|
If True, return the created jobs. | +
Set the visible attribute on a code review comment.
+This is restricted to Launchpad admins, registry experts, and +comment authors, and will return a HTTP Error 401: Unauthorized +error for non-admin callers.
+raises WrongBranchMergeProposal: | |
---|---|
if the comment with this ID is not +on this merge proposal. | +
The email address for this proposal.
+Any emails sent to this address will resultin comments being added.
+ +Commit message
+The commit message that should be used when merging the source branch.
+ +Date merged
+The date that the source branch was merged into the target branch
+ +Description
+A detailed description of the changes that are being addressed by the branch being proposed to be merged.
+ +Merge reporter
+The user that marked the branch as merged.
+ +Merged revision ID
+The revision ID on the target branch which contains the merge from the source branch (currently Git only).
+ +Merged revision number
+The revision number on the target branch which contains the merge from the source branch (Bazaar only).
+ +Prerequisite branch
+The branch that the source branch branched from. If this branch is the same as the target branch, then leave this field blank.
+ +Prerequisite Git branch path
+The path of the Git branch that the source branch branched from. If this branch is the same as the target branch, then leave this field blank.
+ +Prerequisite Git repository
+The Git repository containing the branch that the source branch branched from. If this branch is the same as the target branch, then leave this field blank.
+ +Proposal is confidential
+If True, this proposal is visible only to subscribers.
+ +Status
+The current state of the proposal.
+ +Person
+The person who registered the merge proposal.
+ +Review person or team
+The person that accepted (or rejected) the code for merging.
+ +Source branch
+The branch that has code to land.
+ +Source Git branch path
+The path of the Git branch that has code to land.
+ +Source Git repository
+The Git repository that has code to land.
+ +Superseded by
+The branch merge proposal that supersedes this one.
+ +Supersedes
+The branch merge proposal that this one supersedes.
+ +Target branch
+The branch that the source branch will be merged into.
+ +Target Git branch path
+The path of the Git branch that the source branch will be merged into.
+ +Target Git repository
+The Git repository that the source branch will be merged into.
+ +Commit message
+The commit message that should be used when merging the source branch.
+ +Description
+A detailed description of the changes that are being addressed by the branch being proposed to be merged.
+ +Generated Diff Size Limit
+Diffs greater than the specified number of lines will not be sent to the subscriber. The subscriber will still receive an email with the new revision details even if the diff is larger than the specified number of lines.
+ +Notification Level
+Attribute notifications are sent when branch details are changed such as lifecycle status and name. Revision notifications are generated when new branch revisions are found due to the branch being updated through either pushes to the hosted branches or the mirrored branches being updated.
+ +Person
+Enter the launchpad id, or email address of the person you wish to subscribe to this branch. If you are unsure, use the "Choose..." option to find the person in Launchpad. You can only subscribe someone who is a registered user of the system.
+ +Code review Level
+Control the kind of review activity that triggers notifications.
+ +Subscribed by
+The person who created this subscription.
+ +Generated Diff Size Limit
+Diffs greater than the specified number of lines will not be sent to the subscriber. The subscriber will still receive an email with the new revision details even if the diff is larger than the specified number of lines.
+ +Notification Level
+Attribute notifications are sent when branch details are changed such as lifecycle status and name. Revision notifications are generated when new branch revisions are found due to the branch being updated through either pushes to the hosted branches or the mirrored branches being updated.
+ +Code review Level
+Control the kind of review activity that triggers notifications.
+ +Date Changed
+The date on which this activity occurred.
+ +Message
+Additional information about what changed.
+ +New Value
+The value after the change.
+ +Old Value
+The value before the change.
+ +Person
+The person's Launchpad ID or email address.
+ +What Changed
+The property of the bug that changed.
+ +A file attachment to an IBug.
+Launchpadlib example of accessing content of an attachment:
++for attachment in bug.attachments: + buffer = attachment.data.open() + for line in buffer: + print(line) + buffer.close() ++
Launchpadlib example of accessing metadata about an attachment:
++attachment = bug.attachments[0] +print("title:", attachment.title) +print("ispatch:", attachment.type) ++
For information about the file-like object returned by +attachment.data.open() see lazr.restfulclient's documentation of the +HostedFile object.
+Details about the message associated with an attachment can be found on +the "message" attribute:
++message = attachment.message +print("subject:", message.subject) +print("owner:", message.owner.display_name) +print("created:", message.date_created) ++ +
Title
+A short and descriptive description of the attachment
+ +Attachment Type
+The type of the attachment, for example Patch or Unspecified.
+ +Title
+A short and descriptive description of the attachment
+ +Attachment Type
+The type of the attachment, for example Patch or Unspecified.
+ +Can this bug nominated for this target?
+nomination_target: | |
---|---|
An IDistroSeries or IProductSeries. | +
Returns True or False.
+ +Return the IBugNomination for the target.
+If no nomination is found, a NotFoundError is raised.
+param nomination_target: | |
---|---|
An IDistroSeries or IProductSeries. | +
Return a list of all IBugNominations for this bug.
+The list is ordered by IBugNominations.target.bugtargetdisplayname.
+param target: | An IProduct or IDistribution. Only nominations +for this target are returned. | +
---|---|
param nominations: | |
The list of nominations to search through. +If none is given, the bug's nominations are looked through. +This can be useful when having to call this method multiple +times, to avoid getting the list of nominations each time. | +
Is this bug eligible for expiration and was it last updated +more than X days ago?
+If days_old is None the default number of days without activity +is used.
+Returns True or False.
+ +Associate a branch with this bug.
+param branch: | The branch being linked to. | +
---|---|
param registrant: | |
The user linking the branch. | +
Unlink a branch from this bug.
+param branch: | The branch being unlinked from. | +
---|---|
param user: | The user unlinking the branch. | +
Nominate a bug for an IDistroSeries or IProductSeries.
+owner: | An IPerson. | +
---|---|
target: | An IDistroSeries or IProductSeries. | +
This method creates and returns a BugNomination. (See +lp.bugs.model.bugnomination.BugNomination.)
+ +Create a new bug task on this bug.
+raises IllegalTarget: | |
---|---|
if the bug task cannot be added to the bug. | +
Target
+The software in which this bug should be fixed.
+ +Attach a file to this bug.
+owner: | An IPerson. | +
---|---|
data: | A file-like object, or a bytes. | +
description: | A brief description of the attachment. | +
comment: | An IMessage or string. | +
filename: | A string. | +
url: | External URL of the attachment | +
is_patch: | A boolean. | +
Bug System
+You can register new bug trackers from the Launchpad Bugs home page.
+ +Remote Bug
+The bug number of this bug in the remote bug tracker.
+ +Subscribe person to the bug.
+param person: | the subscriber. | +
---|---|
param subscribed_by: | |
the person who created the subscription. | +|
param suppress_notify: | |
a flag to suppress notify call. | +|
param level: | The BugNotificationLevel for the new subscription. | +
return: | an IBugSubscription. | +
Lock the bug metadata edits to the relevant roles.
+param status: | The lock status of the bug - one of the values +in the BugLockStatus enum. | +
---|---|
param reason: | The reason for locking this bug. | +
param who: | The IPerson who is making the change. | +
Lock Status
+The lock status of this bug.
+ +Lock Reason
+The reason for locking this bug.
+ +Unlock the bug metadata edits to the default roles.
+param who: | The IPerson who is making the change. | +
---|
Set the information type for this bug.
+information_type: | |
---|---|
The InformationType to transition to. | +|
who: | The IPerson who is making the change. | +
Information Type
+The type of information contained in this bug report.
+ +Remove a muted subscription for person.
+Returns previously muted direct subscription, if any.
+ +Description
+A detailed description of the problem, +including the steps required to reproduce it.
+ +Information Type
+The type of information contained in this bug report.
+ +Lock Reason
+The reason for locking this bug.
+ +Lock Status
+The lock status of this bug.
+ +Nickname
+A short and unique name. +Add one only if you often need to retype the URL +but have trouble remembering the bug number.
+ +This bug report should be private
+Private bug reports are visible only to their subscribers.
+ +Tags
+Space-separated keywords for classifying this bug report.
+ +Summary
+A one-line summary of the problem.
+ +Who Made Private
+The person who set this bug private.
+ +Description
+A detailed description of the problem, +including the steps required to reproduce it.
+ +Lock Reason
+The reason for locking this bug.
+ +Nickname
+A short and unique name. +Add one only if you often need to retype the URL +but have trouble remembering the bug number.
+ +This bug report should be private
+Private bug reports are visible only to their subscribers.
+ +Tags
+Space-separated keywords for classifying this bug report.
+ +Summary
+A one-line summary of the problem.
+ +An entity which can be linked to bugs.
+Examples include an ISpecification.
+ +A nomination for a bug to be fixed in a specific series.
+A nomination can apply to an IDistroSeries or an IProductSeries.
+ +Approve this bug for fixing in a series.
+approver: | The IPerson that approves this nomination and that +will own the created bugtasks. | +
---|
The status is set to APPROVED and the appropriate IBugTask(s) +are created for the nomination target.
+A nomination in any state can be approved. If the nomination is +/already/ approved, this method is a noop.
+ +Decline this bug for fixing in a series.
+decliner: | The IPerson that declines this nomination. | +
---|
The status is set to DECLINED.
+If called on a nomination that is in APPROVED state, a +BugNominationStatusError is raised. If the nomination was +already DECLINED, this method is a noop.
+ +Date Submitted
+The date on which this nomination was submitted.
+ +Date Decided
+The date on which this nomination was approved or declined.
+ +Bug notification level
+The volume and type of bug notifications this subscription will generate.
+ +Person
+The person's Launchpad ID or email address.
+ +Subscribed by
+The person who created this subscription.
+ +Bug notification level
+The volume and type of bug notifications this subscription will generate.
+ +Bug notification level
+The volume and type of bug notifications this subscription will generate.
+ +Find all tags
+If enabled, all tags must match, else at least one tag must match.
+ +Bug notification level
+The volume and type of bug notifications this subscription will generate.
+ +Find all tags
+If enabled, all tags must match, else at least one tag must match.
+ +An entity on which a bug can be reported.
+Examples include an IDistribution, an IDistroSeries and an +IProduct.
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Is the person a contributor to bugs in this task's pillar?
+param user: | The user doing the search. Private bugs that this +user doesn't have access to won't be included in the search. | +
---|---|
param person: | The person to check to see if they are a contributor. | +
Return a dict with the following values: +is_contributor: True if the user has any bugs assigned to them in +the context of this bug task's pillar, either directly or by team +participation. +person_name: the displayname of the person +pillar_name: the displayname of the bug task's pillar
+This API call is provided for use by the client Javascript where the +calling context does not have access to the person or pillar names.
+ +Remote Bug Details
+Select the bug watch that represents this task in the relevant bug tracker. If none of the bug watches represents this particular bug task, leave it as (None). Linking the remote bug watch with the task in this way means that a change in the remote bug status will change the status of this bug task in Launchpad.
+ +Date Assigned
+The date on which this task was assigned to someone.
+ +Date Closed
+The date on which this task was marked Fix Released, Invalid, Won't Fix, Expired or Opinion.
+ +Date Confirmed
+The date on which this task was marked Confirmed.
+ +Date Created
+The date on which this task was created.
+ +Date Fix Committed
+The date on which this task was marked Fix Committed.
+ +Date Fix Released
+The date on which this task was marked Fix Released.
+ +Date In Progress
+The date on which this task was marked In Progress.
+ +Date Incomplete
+The date on which this task was marked Incomplete.
+ +Date left closed
+The date on which this task was last reopened.
+ +Date left new
+The date on which this task was marked with a status higher than New.
+ +Date Triaged
+The date on which this task was marked Triaged.
+ +Importance explanation
+The explanation for the current importance of this bugtask.
+ +Status explanation
+The explanation for the current status of this bugtask.
+ +Target
+The software in which this bug should be fixed.
+ +Remote Bug Details
+Select the bug watch that represents this task in the relevant bug tracker. If none of the bug watches represents this particular bug task, leave it as (None). Linking the remote bug watch with the task in this way means that a change in the remote bug status will change the status of this bug task in Launchpad.
+ +Importance explanation
+The explanation for the current importance of this bugtask.
+ +Status explanation
+The explanation for the current status of this bugtask.
+ +Target
+The software in which this bug should be fixed.
+ +The software component in the remote bug tracker.
+Most bug trackers organize bug reports by the software 'component' +they affect. This class provides a mapping of this upstream component +to the corresponding source package in the distro.
+ +Distribution Source Package
+The distribution source package object that should be linked to this component.
+ +Is Visible?
+Should the component be shown in the Launchpad web interface?
+ +Name
+The name of a software component as shown in Launchpad.
+ +Distribution Source Package
+The distribution source package object that should be linked to this component.
+ +Is Visible?
+Should the component be shown in the Launchpad web interface?
+ +Name
+The name of a software component as shown in Launchpad.
+ +A collection of components in a remote bug tracker.
+Some bug trackers organize sets of components into higher level groups, +such as Bugzilla's 'product'.
+ +Name
+The name of the bug tracker product.
+ +Name
+The name of the bug tracker product.
+ +A remote bug system.
+Launchpadlib example: What bug tracker is used for a distro source +package?
++product = source_package.upstream_product +if product: + tracker = product.bug_tracker + if not tracker: + project = product.project_group + if project: + tracker = project.bug_tracker +if tracker: + print "%s at %s" %(tracker.bug_tracker_type, tracker.base_url) ++ +
Retrieve a given component group registered with the bug tracker.
+param component_group_name: | |
---|---|
Name of the component group to retrieve. | +
Returns the component linked to this source package, if any.
+If no components have been linked, returns value of None.
+ +Location
+The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.
+ +Location aliases
+A list of URLs or email addresses that all lead to the same bug tracker, or commonly seen typos, separated by whitespace.
+ +Contact details
+The contact details for the external bug tracker (so that, for example, its administrators can be contacted about a security breach).
+ +Name
+A URL-friendly name for the bug tracker, such as "mozilla-bugs".
+ +Summary
+A brief introduction or overview of this bug tracker instance.
+ +Title
+A descriptive label for this tracker to show in listings.
+ +Location
+The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.
+ +Location aliases
+A list of URLs or email addresses that all lead to the same bug tracker, or commonly seen typos, separated by whitespace.
+ +Contact details
+The contact details for the external bug tracker (so that, for example, its administrators can be contacted about a security breach).
+ +Name
+A URL-friendly name for the bug tracker, such as "mozilla-bugs".
+ +Summary
+A brief introduction or overview of this bug tracker instance.
+ +Title
+A descriptive label for this tracker to show in listings.
+ +Bug System
+You can register new bug trackers from the Launchpad Bugs home page.
+ +Remote Bug
+The bug number of this bug in the remote bug tracker.
+ +Bug System
+You can register new bug trackers from the Launchpad Bugs home page.
+ +Remote Bug
+The bug number of this bug in the remote bug tracker.
+ +Restore the build record to its initial state.
+Build record loses its history, is moved to NEEDSBUILD and a new +non-scored BuildQueue entry is created for it.
+ +Cancel the build if it is either pending or in progress.
+Check the can_be_cancelled property prior to calling this method to +find out if cancelling the build is possible.
+If the build is in progress, it is marked as CANCELLING until the +buildd manager terminates the build and marks it CANCELLED. If the +build is not in progress, it is marked CANCELLED immediately and is +removed from the build queue.
+If the build is not in a cancellable state, this method is a no-op.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Builder
+The builder assigned to this job.
+ +Status
+The current status of the job.
+ +Can be cancelled
+Whether this build record can be cancelled.
+ +Can be rescored
+Whether this build record can be rescored manually.
+ +Can be retried
+Whether this build record can be retried.
+ +Date finished
+The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.
+ +Date started
+The timestamp when the build farm job was started.
+ +Date finished
+The timestamp when the build farm job was finished.
+ +Date created
+The timestamp when the build farm job was created.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Duration
+Duration interval, calculated when the result gets collected.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Status
+The current status of the job.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Builder information and state.
+Builder instance represents a single machine within the +Launchpad Auto Build System. It should specify a 'processor' on which the +machine is based and is able to build packages for; a URL, by which the +machine is accessed through an XML-RPC interface; name, title for entity +identification and browsing purposes; an LP-like owner which has +unrestricted access to the instance; the machine status +representation, including the field/properties: virtualized, +open_resources, restricted_resources, builderok, status, failnotes and +currentjob.
+ +Return build records in the context it is implemented.
+It excludes build records generated by Gina (imported from a external +repository), where IBuild.datebuilt is null and IBuild.buildstate +is BuildStatus.FULLYBUILT.
+The result is simply not filtered if the optional filters are omitted +by call sites.
+param build_state: | |
---|---|
optional BuildStatus value for filtering build +records; | +|
param name: | optional string for filtering build source package name. +Sub-string matching is allowed via SQL LIKE. | +
param pocket: | optional PackagePublishingPocket value for filtering +build records; | +
param arch_tag: | optional string for filtering build source packages +by their architecture tag; | +
param user: | optional IPerson corresponding to the user performing +the request. It will filter out build records for which the user +have no 'view' permission. | +
param binary_only: | |
optional boolean indicating whether only +BinaryPackageBuild objects should be returned, or more general +PackageBuild objects (which may include, for example, +SourcePackageRecipeBuild objects. | +|
return: | a result set containing IPackageBuild records ordered by +descending IPackageBuild.date_finished except when builds are +filtered by BuildStatus.NEEDSBUILD, in this case records +are ordered by descending BuildQueue.lastscore +(dispatching order). | +
Build status
+The status of this build record
+ +The pocket into which this entry is published
+ +Publicly Visible
+Whether or not to present the builder publicly.
+ +Builder State OK
+Whether or not the builder is ok
+ +Clean status
+The readiness of the builder to take a job. Only internal build infrastructure bots need to or should write to this.
+ +Current build
+The job currently running on this builder.
+ +Date clean status changed
+The date the builder's clean status last changed.
+ +Failure Notes
+The reason for a builder not being ok
+ +Failure Count
+Number of consecutive failures for this builder.
+ +Manual Mode
+The auto-build system does not dispatch jobs automatically for builders in manual mode.
+ +Name
+The builder name used for reference purposes
+ +Open resources
+Resource tags offered by this builder, that can be required by a build and if required must match.
+ +Owner
+Builder owner, a Launchpad member which will be responsible for this device.
+ +Processor
+DEPRECATED: Processor identifying jobs which can be built by this device. Use processors instead to handle multiple supported architectures.
+ +Processors
+Processors identifying jobs which can be built by this device.
+ +Restricted resources
+Resource tags offered by this builder, indicating that the builder may only be used by builds that explicitly require these tags.
+ +Title
+The builder title. Should be just a few words.
+ +URL
+The URL to the build machine, used as a unique identifier. Includes protocol, host and port only, e.g.: http://farm.com:8221/
+ +Version
+The version of launchpad-buildd on the worker.
+ +Virtualized
+Whether or not the builder is a virtual Xen instance.
+ +VM host
+The machine hostname hosting the virtual buildd-worker, e.g.: foobar-host.ppa
+ +VM reset protocol
+The protocol version for resetting the VM.
+ +Publicly Visible
+Whether or not to present the builder publicly.
+ +Builder State OK
+Whether or not the builder is ok
+ +Clean status
+The readiness of the builder to take a job. Only internal build infrastructure bots need to or should write to this.
+ +Failure Notes
+The reason for a builder not being ok
+ +Failure Count
+Number of consecutive failures for this builder.
+ +Manual Mode
+The auto-build system does not dispatch jobs automatically for builders in manual mode.
+ +Name
+The builder name used for reference purposes
+ +Open resources
+Resource tags offered by this builder, that can be required by a build and if required must match.
+ +Owner
+Builder owner, a Launchpad member which will be responsible for this device.
+ +Processor
+DEPRECATED: Processor identifying jobs which can be built by this device. Use processors instead to handle multiple supported architectures.
+ +Processors
+Processors identifying jobs which can be built by this device.
+ +Restricted resources
+Resource tags offered by this builder, indicating that the builder may only be used by builds that explicitly require these tags.
+ +Title
+The builder title. Should be just a few words.
+ +URL
+The URL to the build machine, used as a unique identifier. Includes protocol, host and port only, e.g.: http://farm.com:8221/
+ +Version
+The version of launchpad-buildd on the worker.
+ +Virtualized
+Whether or not the builder is a virtual Xen instance.
+ +VM host
+The machine hostname hosting the virtual buildd-worker, e.g.: foobar-host.ppa
+ +VM reset protocol
+The protocol version for resetting the VM.
+ +URLs for all the files produced by this build.
+return: | A collection of URLs for this build. | +
---|
Restore the build record to its initial state.
+Build record loses its history, is moved to NEEDSBUILD and a new +non-scored BuildQueue entry is created for it.
+ +Cancel the build if it is either pending or in progress.
+Check the can_be_cancelled property prior to calling this method to +find out if cancelling the build is possible.
+If the build is in progress, it is marked as CANCELLING until the +buildd manager terminates the build and marks it CANCELLED. If the +build is not in progress, it is marked CANCELLED immediately and is +removed from the build queue.
+If the build is not in a cancellable state, this method is a no-op.
+ +Archive
+The Archive context for this build.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Builder
+The builder assigned to this job.
+ +Status
+The current status of the job.
+ +Can be cancelled
+Whether this build record can be cancelled.
+ +Can be rescored
+Whether this build record can be rescored manually.
+ +Can be retried
+Whether this build record can be retried.
+ +Date finished
+The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.
+ +Date started
+The timestamp when the build farm job was started.
+ +Date finished
+The timestamp when the build farm job was finished.
+ +Date created
+The timestamp when the build farm job was created.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +Duration
+Duration interval, calculated when the result gets collected.
+ +The build targeted pocket.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Status
+The current status of the job.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +The build targeted pocket.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Source snap channels for builds
+A dictionary mapping snap names to channels to use when building charm recipes that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.
+ +Processors
+The architectures that the charm base supports.
+ +Registrant
+The person who registered this base.
+ +Source snap channels for builds
+A dictionary mapping snap names to channels to use when building charm recipes that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.
+ +URLs for all the files produced by this build.
+return: | A collection of URLs for this build. | +
---|
Restore the build record to its initial state.
+Build record loses its history, is moved to NEEDSBUILD and a new +non-scored BuildQueue entry is created for it.
+ +Cancel the build if it is either pending or in progress.
+Check the can_be_cancelled property prior to calling this method to +find out if cancelling the build is possible.
+If the build is in progress, it is marked as CANCELLING until the +buildd manager terminates the build and marks it CANCELLED. If the +build is not in progress, it is marked CANCELLED immediately and is +removed from the build queue.
+If the build is not in a cancellable state, this method is a no-op.
+ +Schedule an upload of this build to the store.
+raises CannotScheduleStoreUpload: | |
---|---|
if the build is not in a state +where an upload can be scheduled. | +
Archive
+The Archive context for this build.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Builder
+The builder assigned to this job.
+ +Status
+The current status of the job.
+ +Can be cancelled
+Whether this build record can be cancelled.
+ +Can be rescored
+Whether this build record can be rescored manually.
+ +Can be retried
+Whether this build record can be retried.
+ +Source snap channels to use for this build.
+A dictionary mapping snap names to channels to use for this build. +Supported snap names: 'charmcraft', 'core', 'core18', 'core20', 'core22', 'core24'
+ +Date finished
+The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.
+ +Date started
+The timestamp when the build farm job was started.
+ +Date finished
+The timestamp when the build farm job was finished.
+ +Date created
+The timestamp when the build farm job was created.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +Duration
+Duration interval, calculated when the result gets collected.
+ +The build targeted pocket.
+ +Revision ID
+The revision ID of the branch used for this build, if available.
+ +Store upload error message
+The error message, if any, from the last attempt to upload this charm recipe build to Charmhub.
+ +Store revision
+The revision assigned to this charm recipe build by Charmhub.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Status
+The current status of the job.
+ +Source snap channels to use for this build.
+A dictionary mapping snap names to channels to use for this build. +Supported snap names: 'charmcraft', 'core', 'core18', 'core20', 'core22', 'core24'
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +The build targeted pocket.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Active
+Deliver details of subscribed events.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +Begin authorizing uploads of this charm recipe to Charmhub.
+raises CannotAuthorizeCharmhubUploads: | |
---|---|
if the charm recipe is not +properly configured for Charmhub uploads. | +|
raises BadRequestPackageUploadResponse: | |
if Charmhub returns an +error or a response without a macaroon when asked to issue a +macaroon. | +|
raises BadCandidMacaroon: | |
if the macaroon returned by Charmhub has +unsuitable Candid caveats. | +|
return: | The serialized macaroon returned by the store. The caller +should acquire a discharge macaroon for this caveat from Candid +and then call completeAuthorization. | +
Complete authorizing uploads of this charm recipe to Charmhub.
+param unbound_discharge_macaroon_raw: | |
---|---|
The serialized unbound +discharge macaroon returned by Candid. | +|
raises CannotAuthorizeCharmhubUploads: | |
if the charm recipe is not +properly configured for Charmhub uploads. | +
Request that the charm recipe be built.
+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.
+param requester: | |
---|---|
The person requesting the builds. | +|
param channels: | A dictionary mapping snap names to channels to use +for these builds. | +
param architectures: | |
If not None, limit builds to architectures +with these architecture tags (in addition to any other +applicable constraints). | +|
return: | An ICharmRecipeBuildRequest. | +
Source snap channels to use for these builds.
+A dictionary mapping snap names to channels to use for these builds. +Supported snap names: 'charmcraft', 'core', 'core18', 'core20', 'core22', 'core24'
+ +Automatically build when branch changes
+Whether this charm recipe is built automatically when its branch changes.
+ +Source snap channels for automatic builds
+A dictionary mapping snap names to channels to use when building this charm recipe. +Supported snap names: 'charmcraft', 'core', 'core18', 'core20', 'core22', 'core24'
+ +Build path
+Subdirectory within the branch containing metadata.yaml.
+ +All builds of this charm recipe.
+All builds of this charm recipe, sorted in descending order of finishing (or starting if not completed successfully).
+ +Can upload to Charmhub
+Whether everything is set up to allow uploading builds of this charm recipe to Charmhub.
+ +Completed builds of this charm recipe.
+Completed builds of this charm recipe, sorted in descending order of finishing.
+ +Description
+A description of the charm recipe.
+ +Git branch
+The Git branch containing a charm recipe.
+ +Information type
+The type of information contained in this charm recipe.
+ +Charm recipe name
+The name of the charm recipe.
+ +Owner
+The owner of this charm recipe.
+ +Pending builds of this charm recipe.
+Pending builds of this charm recipe, sorted in descending order of creation.
+ +Private
+Whether this charm recipe is private.
+ +Registrant
+The person who registered this charm recipe.
+ +Require virtualized builders
+Only build this charm recipe on virtual builders.
+ +Store channels
+Channels to release this charm to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.
+ +Registered store name
+The registered name of this charm in the store.
+ +Automatically upload to store
+Whether builds of this charm recipe are automatically uploaded to the store.
+ +Automatically build when branch changes
+Whether this charm recipe is built automatically when its branch changes.
+ +Source snap channels for automatic builds
+A dictionary mapping snap names to channels to use when building this charm recipe. +Supported snap names: 'charmcraft', 'core', 'core18', 'core20', 'core22', 'core24'
+ +Build path
+Subdirectory within the branch containing metadata.yaml.
+ +Description
+A description of the charm recipe.
+ +Git branch
+The Git branch containing a charm recipe.
+ +Information type
+The type of information contained in this charm recipe.
+ +Charm recipe name
+The name of the charm recipe.
+ +Owner
+The owner of this charm recipe.
+ +Private
+Whether this charm recipe is private.
+ +Require virtualized builders
+Only build this charm recipe on virtual builders.
+ +Store channels
+Channels to release this charm to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.
+ +Registered store name
+The registered name of this charm in the store.
+ +Automatically upload to store
+Whether builds of this charm recipe are automatically uploaded to the store.
+ +Request that an import be tried soon.
+This method will schedule an import to happen soon for this branch.
+The import must be in the Reviewed state, if not then a +CodeImportNotInReviewedState error will be thrown. If using the +API then a status code of 400 will result.
+If the import is already running then a CodeImportAlreadyRunning +error will be thrown. If using the API then a status code of +400 will result.
+The two cases can be distinguished over the API by seeing if the +exception names appear in the body of the response.
+If used over the API and the request has already been made then this +method will silently do nothing. +If called internally then the error_if_already_requested parameter +controls whether a CodeImportAlreadyRequested exception will be +thrown in that situation.
+return: | None | +
---|
Branch
+The Bazaar branch produced by the import system.
+ +Module
+The path to import within the repository. Usually, it is the name of the project.
+ +Repository
+The CVSROOT. Example: :pserver:anonymous@anoncvs.gnome.org:/cvs/gnome
+ +Git repository
+The Git repository produced by the import system.
+ +Type of RCS
+The revision control system to import from.
+ +Review Status
+Only reviewed imports are processed.
+ +Type of target RCS
+The revision control system to import to.
+ +URL
+The URL of the VCS branch.
+ +URL
+The URL of the VCS branch.
+ +Message content
+The new message content string
+ +DB ID
+The tracking number for this comment.
+ +Message revision history
+Revision history of this message, sorted in ascending order.
+ +A reference to a vote on a IBranchMergeProposal.
+There is at most one reference to a vote for each reviewer on a given +branch merge proposal.
+ +Change a pending review into a review for claimant.
+Pending team reviews can be claimed by members of that team. This +allows reviews to be moved of the general team todo list, and onto a +personal todo list.
+param claimant: | The person claiming the team review. | +
---|---|
raises ClaimReviewFailed: | |
If the claimant already has a +personal review, if the reviewer is not a team, if the +claimant is not in the reviewer team, or if the review is +not pending. | +
Reassign a pending review to someone else.
+Pending reviews can be reassigned to someone else.
+param reviewer: | The person to assign the pending review to. | +
---|---|
raises ReviewNotPending: | |
If the review is not pending. | +|
raises ReassignReviewFailed: | |
If the reviewer is an individual and +already has a personal review. | +
Review type
+Lowercase keywords describing the type of review.
+ +Reviewer
+A person who you want to review this.
+ +Review type
+Lowercase keywords describing the type of review.
+ +Reviewer
+A person who you want to review this.
+ +A Commercial Subscription for a Product.
+If the product has a licence which does not qualify for free +hosting, a subscription needs to be purchased.
+ +Date Created
+The date the first subscription was applied.
+ +Expiration Date
+The expiration date of the subscription.
+ +Date Modified
+The date the subscription was modified.
+ +Beginning of Subscription
+The date the subscription starts.
+ +Distribution which has commercial subscription
+Distribution for which this commercial subscription is applied.
+ +Active
+Whether this subscription is active.
+ +Product which has commercial subscription
+Project for which this commercial subscription is applied.
+ +Purchaser
+Person who purchased the voucher.
+ +Registrant
+Person who redeemed the voucher.
+ +Expiration Date
+The expiration date of the subscription.
+ +Date Modified
+The date the subscription was modified.
+ +Beginning of Subscription
+The date the subscription starts.
+ +CVSS
+The CVSS vector strings from various authorities that publish it.
+ +Title
+A description of the CVE issue. This will be updated regularly from the CVE database.
+ +Discovered by
+The name of person(s) or organization that discovered the CVE
+ +Display Name
+A very brief name describing the ref and state.
+ +CVE Sequence Number
+Should take the form XXXX-XXXX, all digits.
+ +Current CVE State
+Whether or not the vulnerability has been reviewed and assigned a full CVE number, or is still considered a Candidate, or is deprecated.
+ +Title
+A title for the CVE
+ +URL
+Return a URL to the site that has the CVE data for this CVE reference.
+ +Title
+A description of the CVE issue. This will be updated regularly from the CVE database.
+ +Display Name
+A very brief name describing the ref and state.
+ +CVE Sequence Number
+Should take the form XXXX-XXXX, all digits.
+ +Current CVE State
+Whether or not the vulnerability has been reviewed and assigned a full CVE number, or is still considered a Candidate, or is deprecated.
+ +Title
+A title for the CVE
+ +URL
+Return a URL to the site that has the CVE data for this CVE reference.
+ +An operating system distribution.
+Launchpadlib example: retrieving the current version of a package in a +particular distroseries.
++ubuntu = launchpad.distributions["ubuntu"] +archive = ubuntu.main_archive +series = ubuntu.current_series +print(archive.getPublishedSources(exact_match=True, + source_name="apport", + distro_series=series)[0].source_package_version) ++ +
Return all the subscriptions with the specified levels.
+return: | A sequence of IStructuralSubscription. | +
---|
Return the questions from the collection matching search criteria.
+param search_text: | |
---|---|
A string that is matched against the question +title and description. If None, the search_text is not included as +a filter criteria. | +|
param status: | A sequence of QuestionStatus Items. If None or an empty +sequence, the status is not included as a filter criteria. The +default is to match all status except Expired and Invalid. | +
param language: | An ILanguage or a sequence of ILanguage objects to +match against the question's language. If None or an empty +sequence, the language is not included as a filter criteria. | +
param owner: | The IPerson that created the question. | +
param needs_attention_from: | |
Selects questions that need attention +from an IPerson. These are the questions in the NEEDSINFO or +ANSWERED state owned by the person. The questions not owned by the +person but on which the person requested more information or gave +an answer and that are back in the OPEN state are also included. | +|
param sort: | An attribute of QuestionSort. If None, a default value is +used. When there is a search_text value, the default is to sort by +RELEVANCY, otherwise results are sorted NEWEST_FIRST. | +
Return the question by its id, if it is applicable to this target.
+question_id: | A question id. | +
---|
If there is no such question number for this target, return None
+ +Return questions similar to phrase.
+Return a list of question similar to the provided phrase. These +questions will be found using a fuzzy search. The list is +ordered from the most similar question to the least similar question.
+param phrase: | A phrase such as the summary of a question. | +
---|
Return the list of Persons that provide support for a language.
+An answer contact supports questions in their preferred languages.
+ +Return a list of languages spoken by at the answer contacts.
+An answer contact is considered to speak a given language if that +language is listed as one of their preferred languages.
+ +Can the user add or remove the answer contact.
+Users can add or remove themselves or one of the teams they +administered. Admins and target owners can add/remove anyone.
+param person: | The IPerson that is or will be an answer contact. | +
---|---|
param subscribed_by: | |
The IPerson making the change. | +
Return entries in the translation import queue for this entity.
+arg import_status: | |
---|---|
RosettaImportStatus DB Schema entry. | +|
arg file_extension: | |
String with the file type extension, usually 'po' +or 'pot'. | +
If one of both of 'import_status' or 'file_extension' are given, the +returned entries are filtered based on those values.
+ +Status
+Show only entries with this status
+ +Filename extension
+Show only entries with this filename suffix
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Return build records in the context it is implemented.
+It excludes build records generated by Gina (imported from a external +repository), where IBuild.datebuilt is null and IBuild.buildstate +is BuildStatus.FULLYBUILT.
+The result is simply not filtered if the optional filters are omitted +by call sites.
+param build_state: | |
---|---|
optional BuildStatus value for filtering build +records; | +|
param name: | optional string for filtering build source package name. +Sub-string matching is allowed via SQL LIKE. | +
param pocket: | optional PackagePublishingPocket value for filtering +build records; | +
param arch_tag: | optional string for filtering build source packages +by their architecture tag; | +
param user: | optional IPerson corresponding to the user performing +the request. It will filter out build records for which the user +have no 'view' permission. | +
param binary_only: | |
optional boolean indicating whether only +BinaryPackageBuild objects should be returned, or more general +PackageBuild objects (which may include, for example, +SourcePackageRecipeBuild objects. | +|
return: | a result set containing IPackageBuild records ordered by +descending IPackageBuild.date_finished except when builds are +filtered by BuildStatus.NEEDSBUILD, in this case records +are ordered by descending BuildQueue.lastscore +(dispatching order). | +
Build status
+The status of this build record
+ +The pocket into which this entry is published
+ +Return the distribution archive with the given name.
+Only distribution archives are considered -- PPAs will not be found.
+param name: | The name of the archive, e.g. 'partner' | +
---|
Return the series with the name or version given.
+param name_or_version: | |
---|---|
The IDistroSeries.name or +IDistroSeries.version. | +
Location
+The country in which this mirror is based.
+ +Content
+Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.
+ +Search for source packages that correspond to the given text.
+This method just decorates the result of searchSourcePackageCaches() +to return DistributionSourcePackages.
+ +Find OOPS reports between start_date and end_date.
+param start_date: | |
---|---|
Do not look in objects whose last modification time +is before this date. | +|
param end_date: | Do not look in objects whose last modification time +is after this date. | +
return: | A set of OOPS id's - strings of the form 'OOPS-w+'. | +
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.
+param: | user: If specified, shows the branches visible to that user. +if not specified, only branches visible to the anonymous user are +shown. | +
---|---|
param since: | If specified, limits results to branches modified since +that date and time. | +
Time of last change
+Return branches that have new tips since this timestamp.
+ +Return the best mirrors to be used by someone in the given country.
+The list of mirrors is composed by the official mirrors located in +the given country (or in the country's continent if the country +doesn't have any) plus the main mirror of that type.
+ +Location
+The country in which this mirror is based.
+ +Content
+Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.
+ +Add a bug subscription for this structure.
+This method is used to create a new IStructuralSubscription for the +target. This initially has a single filter which will allow all +notifications will be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription. | +
Add a bug subscription filter for this structure.
+This method is used to create a new IBugSubscriptionFilter for the +target. It will initially allow all notifications to be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription filter. | +
Remove a subscription to bugs from this structure.
+This will delete all associated filters.
+subscriber: | The IPerson who will be unsubscribed. If omitted, +unsubscribed_by will be used. | +
---|---|
unsubscribed_by: | |
The IPerson removing the subscription. | +
Add a new answer contact.
+param person: | An IPerson. | +
---|---|
param subscribed_by: | |
The user making the change. | +|
return: | True if the person was added, False if the person already is +an answer contact. | +
raises AddAnswerContactError: | |
When the person or team does no have a +preferred language. | +
Remove an answer contact.
+param person: | An IPerson. | +
---|---|
param subscribed_by: | |
The user making the change. | +|
return: | True if the person was removed, False if the person wasn't an +answer contact. | +
Active
+Deliver details of subscribed events.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +The OCI project name.
+The name that groups a set of OCI recipes together.
+ +Description for this OCI project.
+A short description of this OCI project.
+ +The registry url.
+The url of the OCI registry to use.
+ +OCI registry region.
+The region of the OCI registry.
+ +Username
+The username for the OCI registry.
+ +Password
+The password for the OCI registry.
+ +Active
+Whether or not this item is active.
+ +All specifications
+A list of all specifications, regardless of status or approval or completion, for this object.
+ +Branch sharing policy
+Sharing policy for this pillar's branches.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Bug sharing policy
+Sharing policy for this pillar's bugs.
+ +Bug Supervisor
+The Launchpad id of the person or team (preferred) responsible for bug management.
+ +Code Administrator
+The distribution source code administrator.
+ +Commercial subscriptions
+An object which contains the timeframe and the voucher code of a subscription.
+ +Commercial subscription is due
+Whether the distribution's licensing requires a new commercial subscription to use launchpad.
+ +Current series
+The current development series of this distribution. Note that all maintainerships refer to the current series. When people ask about the state of packages in the distribution, we should interpret that query in the context of the currentseries.
+ +Date created
+The date this distribution was registered.
+ +Default traversal policy
+The type of object that /{distro}/{name} URLs for this distribution resolve to.
+ +Description
+Details about the distributions's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.
+ +Alias for development series
+If set, an alias for the current development series in this distribution.
+ +Display Name
+The displayable name of the distribution.
+ +Web site URL
+The distro's web site URL.
+ +Driver
+The person or team responsible for decisions about features and bugs that will be targeted for any series in this distribution. Note that you can also specify a driver on each series whose permissions will be limited to that specific series.
+ +Homepage Content
+The content of this distribution's home page. Edit this and it will be displayed for all the world to see. It is NOT a wiki so you cannot undo changes.
+ +Icon
+A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this distribution. The icon will be displayed everywhere we list the distribution and link to it.
+ +Information Type
+The type of data contained in this item.
+ +Logo
+An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this distribution. It should be no bigger than 50kb in size.
+ +Members
+The distro's members team.
+ +Mirror Administrator
+The person or team that has the rights to review and mark this distribution's mirrors as official.
+ +Brand
+A large image of exactly 192x192 pixels, that will be displayed on this distribution's home page in Launchpad. It should be no bigger than 100kb in size.
+ +Name
+The distro's name.
+ +OCI Project Administrator
+The person or team that has the rights to manage OCI Projects for this distribution.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Owner
+The restricted team, moderated team, or person who maintains the distribution information in Launchpad.
+ +Distribution is confidential
+If set, this distribution is visible only to those with access grants.
+ +Redirect the default traversal
+If true, the default traversal is for migration and redirects to a different canonical URL.
+ +Redirect release pocket uploads
+Redirect release pocket uploads to proposed pocket
+ +Registrant
+The distro's registrant.
+ +Security Administrator
+The distribution security administrator.
+ +Blueprint sharing policy
+Sharing policy for this project's specifications.
+ +Summary
+A short paragraph to introduce the goals and highlights of the distribution.
+ +Title
+The distro's title.
+ +Translation group
+The translation group that helps review translations for this project or distribution. The group's role depends on the permissions policy selected below.
+ +Translation permissions policy
+The policy this project or distribution uses to balance openness and control for their translations.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +Valid specifications
+All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal
+ +VCS
+Version control system for this distribution's code.
+ +Active
+Whether or not this item is active.
+ +Branch sharing policy
+Sharing policy for this pillar's branches.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Bug sharing policy
+Sharing policy for this pillar's bugs.
+ +Bug Supervisor
+The Launchpad id of the person or team (preferred) responsible for bug management.
+ +Code Administrator
+The distribution source code administrator.
+ +Commercial subscriptions
+An object which contains the timeframe and the voucher code of a subscription.
+ +Current series
+The current development series of this distribution. Note that all maintainerships refer to the current series. When people ask about the state of packages in the distribution, we should interpret that query in the context of the currentseries.
+ +Date created
+The date this distribution was registered.
+ +Default traversal policy
+The type of object that /{distro}/{name} URLs for this distribution resolve to.
+ +Description
+Details about the distributions's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.
+ +Alias for development series
+If set, an alias for the current development series in this distribution.
+ +Display Name
+The displayable name of the distribution.
+ +Web site URL
+The distro's web site URL.
+ +Driver
+The person or team responsible for decisions about features and bugs that will be targeted for any series in this distribution. Note that you can also specify a driver on each series whose permissions will be limited to that specific series.
+ +Homepage Content
+The content of this distribution's home page. Edit this and it will be displayed for all the world to see. It is NOT a wiki so you cannot undo changes.
+ +Icon
+A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this distribution. The icon will be displayed everywhere we list the distribution and link to it.
+ +Information Type
+The type of data contained in this item.
+ +Logo
+An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this distribution. It should be no bigger than 50kb in size.
+ +Members
+The distro's members team.
+ +Mirror Administrator
+The person or team that has the rights to review and mark this distribution's mirrors as official.
+ +Brand
+A large image of exactly 192x192 pixels, that will be displayed on this distribution's home page in Launchpad. It should be no bigger than 100kb in size.
+ +Name
+The distro's name.
+ +OCI Project Administrator
+The person or team that has the rights to manage OCI Projects for this distribution.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Owner
+The restricted team, moderated team, or person who maintains the distribution information in Launchpad.
+ +Redirect the default traversal
+If true, the default traversal is for migration and redirects to a different canonical URL.
+ +Redirect release pocket uploads
+Redirect release pocket uploads to proposed pocket
+ +Security Administrator
+The distribution security administrator.
+ +Blueprint sharing policy
+Sharing policy for this project's specifications.
+ +Summary
+A short paragraph to introduce the goals and highlights of the distribution.
+ +Title
+The distro's title.
+ +Translation group
+The translation group that helps review translations for this project or distribution. The group's role depends on the permissions policy selected below.
+ +Translation permissions policy
+The policy this project or distribution uses to balance openness and control for their translations.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +VCS
+Version control system for this distribution's code.
+ +Return this mirror's overall freshness.
+For ARCHIVE mirrors, the overall freshness is the worst freshness of +all of this mirror's content objects (MirrorDistroArchSeries, +MirrorDistroSeriesSource or MirrorCDImageDistroSeriess).
+For RELEASE mirrors, the overall freshness is either UP (up to +date), if the mirror contains all ISO images that it should or +UNKNOWN if it doesn't contain one or more ISO images.
+ +Base URL
+The HTTP or FTP base URL of this mirror
+ +Content
+Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.
+ +Location
+The country in which this mirror is based.
+ +Country DNS Mirror
+Whether this is a country mirror in DNS.
+ +Date Created
+The date on which this mirror was registered.
+ +Date reviewed
+The date on which this mirror was last reviewed by a mirror admin.
+ +Organisation
+The name of the organization hosting this mirror.
+ +Distribution
+The distribution that is mirrored
+ +FTP URL
+ + +HTTP URL
+ + +Name
+A short and unique name for this mirror.
+ +Owner
+The person who is set as the current administrator of thismirror.
+ +Reviewer
+The person who last reviewed this mirror.
+ +Rsync URL
+e.g.: rsync://archive.ubuntu.com/ubuntu/
+ +Status
+The current status of a mirror's registration.
+ +Whiteboard
+Notes on the current status of the mirror (only visible to admins and the mirror's registrant).
+ +Base URL
+The HTTP or FTP base URL of this mirror
+ +Content
+Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.
+ +Location
+The country in which this mirror is based.
+ +Country DNS Mirror
+Whether this is a country mirror in DNS.
+ +Organisation
+The name of the organization hosting this mirror.
+ +FTP URL
+ + +HTTP URL
+ + +Name
+A short and unique name for this mirror.
+ +Owner
+The person who is set as the current administrator of thismirror.
+ +Rsync URL
+e.g.: rsync://archive.ubuntu.com/ubuntu/
+ +Status
+The current status of a mirror's registration.
+ +Whiteboard
+Notes on the current status of the mirror (only visible to admins and the mirror's registrant).
+ +Represents a source package in a distribution.
+Create IDistributionSourcePackages by invoking +IDistribution.getSourcePackage().
+ +Return the questions from the collection matching search criteria.
+param search_text: | |
---|---|
A string that is matched against the question +title and description. If None, the search_text is not included as +a filter criteria. | +|
param status: | A sequence of QuestionStatus Items. If None or an empty +sequence, the status is not included as a filter criteria. The +default is to match all status except Expired and Invalid. | +
param language: | An ILanguage or a sequence of ILanguage objects to +match against the question's language. If None or an empty +sequence, the language is not included as a filter criteria. | +
param owner: | The IPerson that created the question. | +
param needs_attention_from: | |
Selects questions that need attention +from an IPerson. These are the questions in the NEEDSINFO or +ANSWERED state owned by the person. The questions not owned by the +person but on which the person requested more information or gave +an answer and that are back in the OPEN state are also included. | +|
param sort: | An attribute of QuestionSort. If None, a default value is +used. When there is a search_text value, the default is to sort by +RELEVANCY, otherwise results are sorted NEWEST_FIRST. | +
Return the question by its id, if it is applicable to this target.
+question_id: | A question id. | +
---|
If there is no such question number for this target, return None
+ +Return questions similar to phrase.
+Return a list of question similar to the provided phrase. These +questions will be found using a fuzzy search. The list is +ordered from the most similar question to the least similar question.
+param phrase: | A phrase such as the summary of a question. | +
---|
Return the list of Persons that provide support for a language.
+An answer contact supports questions in their preferred languages.
+ +Return a list of languages spoken by at the answer contacts.
+An answer contact is considered to speak a given language if that +language is listed as one of their preferred languages.
+ +Can the user add or remove the answer contact.
+Users can add or remove themselves or one of the teams they +administered. Admins and target owners can add/remove anyone.
+param person: | The IPerson that is or will be an answer contact. | +
---|---|
param subscribed_by: | |
The IPerson making the change. | +
Return all the subscriptions with the specified levels.
+return: | A sequence of IStructuralSubscription. | +
---|
Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Returns all merge proposals of a given status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param eager_load: | |
If True, load related objects for the whole +collection. | +|
returns: | A list of IBranchMergeProposal. | +
Returns all branches with the given lifecycle status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param modified_since: | |
If set, filters the branches being returned +to those that have been modified since the specified date/time. | +|
param eager_load: | |
If True load related objects for the whole +collection. | +|
returns: | A list of IBranch. | +
Add a new answer contact.
+param person: | An IPerson. | +
---|---|
param subscribed_by: | |
The user making the change. | +|
return: | True if the person was added, False if the person already is +an answer contact. | +
raises AddAnswerContactError: | |
When the person or team does no have a +preferred language. | +
Remove an answer contact.
+param person: | An IPerson. | +
---|---|
param subscribed_by: | |
The user making the change. | +|
return: | True if the person was removed, False if the person wasn't an +answer contact. | +
Add a bug subscription for this structure.
+This method is used to create a new IStructuralSubscription for the +target. This initially has a single filter which will allow all +notifications will be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription. | +
Add a bug subscription filter for this structure.
+This method is used to create a new IBugSubscriptionFilter for the +target. It will initially allow all notifications to be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription filter. | +
Remove a subscription to bugs from this structure.
+This will delete all associated filters.
+subscriber: | The IPerson who will be unsubscribed. If omitted, +unsubscribed_by will be used. | +
---|---|
unsubscribed_by: | |
The IPerson removing the subscription. | +
Active
+Deliver details of subscribed events.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +Create a new code import.
+param registrant: | |
---|---|
The IPerson to record as the registrant of the +import. | +|
param branch_name: | |
The name of the branch or repository to create. | +|
param rcs_type: | The type of the foreign VCS. | +
param target_rcs_type: | |
The type of the branch or repository to +create (Bazaar or Git). | +|
param url: | The URL to import from if the VCS type uses a single URL +(i.e. isn't CVS). | +
param cvs_root: | The CVSROOT for a CVS import. | +
param cvs_module: | |
The module to import for a CVS import. | +|
param owner: | Who should own the created branch or repository, or +None for it to be the same as the registrant, or the caller over +the API. | +
returns: | An instance of ICodeImport. | +
After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Return build records in the context it is implemented.
+It excludes build records generated by Gina (imported from a external +repository), where IBuild.datebuilt is null and IBuild.buildstate +is BuildStatus.FULLYBUILT.
+The result is simply not filtered if the optional filters are omitted +by call sites.
+param build_state: | |
---|---|
optional BuildStatus value for filtering build +records; | +|
param name: | optional string for filtering build source package name. +Sub-string matching is allowed via SQL LIKE. | +
param pocket: | optional PackagePublishingPocket value for filtering +build records; | +
param arch_tag: | optional string for filtering build source packages +by their architecture tag; | +
param user: | optional IPerson corresponding to the user performing +the request. It will filter out build records for which the user +have no 'view' permission. | +
param binary_only: | |
optional boolean indicating whether only +BinaryPackageBuild objects should be returned, or more general +PackageBuild objects (which may include, for example, +SourcePackageRecipeBuild objects. | +|
return: | a result set containing IPackageBuild records ordered by +descending IPackageBuild.date_finished except when builds are +filtered by BuildStatus.NEEDSBUILD, in this case records +are ordered by descending BuildQueue.lastscore +(dispatching order). | +
Build status
+The status of this build record
+ +The pocket into which this entry is published
+ +Return the chroot URL for this series, pocket, and image type.
+The pocket defaults to "Release"; the image type defaults to "Chroot +tarball".
+ +Get the filter for packages to build for this architecture, if any.
+Packages are normally built for all available architectures, subject +to any constraints in their Architecture field. If a filter is +set, then it applies the additional constraint that packages not +included by the filter will not be built for this architecture.
+ +Set the chroot tarball used for builds in this architecture.
+The SHA-1 checksum must match the chroot file.
+The pocket defaults to "Release"; the image type defaults to "Chroot +tarball".
+ +Set the chroot tarball from a live filesystem build.
+The pocket defaults to "Release"; the image type defaults to "Chroot +tarball".
+ +Remove the chroot tarball used for builds in this architecture.
+The pocket defaults to "Release"; the image type defaults to "Chroot +tarball".
+ +Set a filter for packages to build for this architecture.
+Packages are normally built for all available architectures, subject +to any constraints in their Architecture field. If a filter is +set, then it applies the additional constraint that packages not +included by the filter will not be built for this architecture.
+If the sense of the filter is "Include", then the filter only +includes packages in the given package set. If the sense of the +filter is "Exclude", then the filter only includes packages not in +the given package set.
+Later changes to the given package set will also affect any filters +using it.
+param packageset: | |
---|---|
An IPackageset to use as a filter. | +|
param sense: | A DistroArchSeriesFilterSense item indicating +whether the filter includes or excludes packages. | +
param creator: | The IPerson who is creating this filter. | +
Remove any filter for packages to build for this architecture.
+This causes packages to be built for this architecture when they +might previously have been filtered, subject to any constraints in +their Architecture field.
+ +Architecture Tag
+The architecture tag, or short piece of text that identifies this architecture. All binary packages in the archive will use this tag in their filename. Please get it correct. It should really never be changed!
+ +Build chroot URL
+The URL to the current build chroot for this distroarchseries.
+ +Display name
+The display name of this distroarchseries.
+ +Enabled
+Whether or not this DistroArchSeries is enabled for build creation and publication.
+ +Is Nominated Arch Independent
+True if this distroarchseries is the NominatedArchIndep one.
+ +Main Archive
+The main archive of the distroarchseries.
+ +Official Support
+Indicate whether or not this port has official support from the vendor of the distribution.
+ +Package Count
+A cache of the number of packages published in the RELEASE pocket of this port.
+ +PPA support available
+Indicate whether or not this port has support for building PPA packages.
+ +Title
+The title of this distroarchseries.
+ +Architecture Tag
+The architecture tag, or short piece of text that identifies this architecture. All binary packages in the archive will use this tag in their filename. Please get it correct. It should really never be changed!
+ +Display name
+The display name of this distroarchseries.
+ +Enabled
+Whether or not this DistroArchSeries is enabled for build creation and publication.
+ +Is Nominated Arch Independent
+True if this distroarchseries is the NominatedArchIndep one.
+ +Main Archive
+The main archive of the distroarchseries.
+ +Official Support
+Indicate whether or not this port has official support from the vendor of the distribution.
+ +Package Count
+A cache of the number of packages published in the RELEASE pocket of this port.
+ +Title
+The title of this distroarchseries.
+ +A filter for packages to be included in or excluded from a DAS.
+Since package sets can include other package sets, a single package set +is flexible enough for this. However, one might reasonably want to +either include some packages ("this architecture is obsolescent or +experimental and we only want to build a few packages for it") or +exclude some packages ("this architecture can't handle some packages so +we want to make them go away centrally").
+ +Creator
+The user who created this filter.
+ +Date created
+The time when this filter was created.
+ +Date last modified
+The time when this filter was last modified.
+ +Distro arch series
+The distro arch series that this filter is for.
+ +Package set
+The package set to be included in or excluded from this distro arch series.
+ +Sense
+Whether the filter represents packages to include or exclude from the distro arch series.
+ +Comment text
+The comment text for the related distro series difference.
+ +Source package name
+Name of the source package that this comment is for.
+ +Blocklists this version or all versions of this source package and +adds a comment on this difference.
+param commenter: | |
---|---|
The requestor IPerson. | +|
param comment: | The comment string. | +
param all: | Indicates whether all versions of this package should +be blocklisted or just the current (default). | +
return: | The created DistroSeriesDifferenceComment object. | +
Removes this difference from the blocklist and adds a comment on +this difference.
+The status will be updated based on the versions.
+param commenter: | |
---|---|
The requestor IPerson. | +|
param comment: | The comment string. | +
return: | The created DistroSeriesDifferenceComment object. | +
Requests IPackageDiffs for the derived and parent version.
+raises DistroSeriesDifferenceError: | |
---|---|
When package diffs +cannot be requested. | +
Base version
+The common base version of the package for differences with different versions in the parent and derived series.
+ +Derived series
+The distribution series which identifies the derived series with the difference.
+ +Package diff status
+The status of the diff between the base version and the derived version.
+ +Package diff url
+The url for the diff between the base version and the derived version.
+ +Parent package diff status
+The status of the diff between the base version and the parent version.
+ +Parent package diff url
+The url for the diff between the base version and the parent version.
+ +Parent series
+The distribution series which identifies the parent series with the difference.
+ +Parent source version
+The version of the most recent source publishing in the parent series.
+ +Source version
+The version of the most recent source publishing in the derived series.
+ +Distro series difference status.
+The current status of this difference.
+ +Return all the subscriptions with the specified levels.
+return: | A sequence of IStructuralSubscription. | +
---|
Return entries in the translation import queue for this entity.
+arg import_status: | |
---|---|
RosettaImportStatus DB Schema entry. | +|
arg file_extension: | |
String with the file type extension, usually 'po' +or 'pot'. | +
If one of both of 'import_status' or 'file_extension' are given, the +returned entries are filtered based on those values.
+ +Status
+Show only entries with this status
+ +Filename extension
+Show only entries with this filename suffix
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Return an iterator over all its translation templates.
+The returned templates are either obsolete or current.
+return: | A sequence of IPOTemplate. | +
---|
Return build records in the context it is implemented.
+It excludes build records generated by Gina (imported from a external +repository), where IBuild.datebuilt is null and IBuild.buildstate +is BuildStatus.FULLYBUILT.
+The result is simply not filtered if the optional filters are omitted +by call sites.
+param build_state: | |
---|---|
optional BuildStatus value for filtering build +records; | +|
param name: | optional string for filtering build source package name. +Sub-string matching is allowed via SQL LIKE. | +
param pocket: | optional PackagePublishingPocket value for filtering +build records; | +
param arch_tag: | optional string for filtering build source packages +by their architecture tag; | +
param user: | optional IPerson corresponding to the user performing +the request. It will filter out build records for which the user +have no 'view' permission. | +
param binary_only: | |
optional boolean indicating whether only +BinaryPackageBuild objects should be returned, or more general +PackageBuild objects (which may include, for example, +SourcePackageRecipeBuild objects. | +|
return: | a result set containing IPackageBuild records ordered by +descending IPackageBuild.date_finished except when builds are +filtered by BuildStatus.NEEDSBUILD, in this case records +are ordered by descending BuildQueue.lastscore +(dispatching order). | +
Build status
+The status of this build record
+ +The pocket into which this entry is published
+ +Return a source package in this distro series by name.
+The name given may be a string or an ISourcePackageName-providing +object. The source package may not be published in the distro series.
+ +Get package upload records for this distribution series.
+param status: | Filter results by this PackageUploadStatus, or list +of statuses. | +
---|---|
param created_since_date: | |
If specified, only returns items uploaded +since the timestamp supplied. | +|
param archive: | Filter results for this IArchive. | +
param pocket: | Filter results by this PackagePublishingPocket or a +list of PackagePublishingPocket. | +
param custom_type: | |
Filter results by this +PackageUploadCustomFormat. | +|
param name: | Filter results by this file name or package name. | +
param version: | Filter results by this version number string. | +
param exact_match: | |
If True, look for exact string matches on the +name and version filters. If False, look for a substring +match so that e.g. a package "kspreadsheetplusplus" would match +the search string "spreadsheet". Defaults to False. | +|
return: | A result set containing IPackageUpload. | +
Created Since Timestamp
+Return items that are more recent than this timestamp.
+ +Package Upload Status
+Return only items that have this status.
+ +Archive
+Return only items for this archive.
+ +Return only items targeted to this pocket
+ +Custom Type
+Return only items with custom files of this type.
+ +Exact match
+Whether to filter name and version by exact matching.
+ +Return the differences between this series and the specified +parent_series (or all the parent series if parent_series is None).
+param parent_series: | |
---|---|
The parent series for which the differences +should be returned. All parents are considered if this is None. | +|
param difference_type: | |
The type of the differences to return. | +|
param source_package_name_filter: | |
A package name to use as a filter +for the differences. | +|
param status: | The status of the differences to return. | +
param child_version_higher: | |
Only return differences for which the +child's version is higher than the parent's version. | +
Get IDistroSeriesDifferenceComment items.
+param since: | Ignore comments older than this timestamp. | +
---|---|
param source_package_name: | |
Return only comments for a source package +with this name. | +|
return: | A Storm result set of IDistroSeriesDifferenceComment +objects for this distroseries, ordered from oldest to newest +comment. | +
Minimum creation timestamp
+Ignore comments that are older than this.
+ +Name of source package
+Only return comments for this source package.
+ +Return statistics for translation templates in this series.
+The return value is a list of dicts for each template in the series, +each of which has this form:
++{ + "sourcepackage": ..., + "translation_domain": ..., + "name": ..., + "total": ..., + "enabled": ..., + "languagepack": ..., + "priority": ..., + "date_last_updated": ..., +} ++ +
Add a bug subscription for this structure.
+This method is used to create a new IStructuralSubscription for the +target. This initially has a single filter which will allow all +notifications will be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription. | +
Add a bug subscription filter for this structure.
+This method is used to create a new IBugSubscriptionFilter for the +target. It will initially allow all notifications to be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription filter. | +
Remove a subscription to bugs from this structure.
+This will delete all associated filters.
+subscriber: | The IPerson who will be unsubscribed. If omitted, +unsubscribed_by will be used. | +
---|---|
unsubscribed_by: | |
The IPerson removing the subscription. | +
Name
+Only letters, numbers, and simple punctuation are allowed.
+ +Date Targeted
+Example: 2005-11-24
+ +Summary
+A summary of the features and status of this milestone.
+ +Code name
+An alternative name for the milestone.
+ +Initialize this series from parents.
+This method performs checks and then creates a job to populate +the new distroseries.
+param parents: | The list of parent ids this series will derive +from. | +
---|---|
param architectures: | |
The architectures to copy to the derived +series. If not specified, all of the architectures are copied. | +|
param archindep_archtag: | |
The architecture tag used to build +architecture-independent packages. If not specified, one from +the parents' will be used. | +|
param packagesets: | |
The packagesets to copy to the derived series. +If not specified, all of the packagesets are copied. | +|
param rebuild: | Whether binaries will be copied to the derived +series. If it's true, they will not be, and if it's false, they +will be. | +
param overlays: | A list of booleans indicating, for each parent, if +the parent/child relationship should be an overlay. | +
param overlay_pockets: | |
The list of pockets names to use for overlay +relationships. | +|
param overlay_components: | |
The list of components names to use for +overlay relationships. | +
Active
+Whether or not this series is stable and supported, or under current development. This excludes series which are experimental or obsolete.
+ +Advertise by-hash directories
+Advertise by-hash directories with a flag in the Release file so +that apt uses them by default. Only effective if +publish_by_hash is also set.
+ +All specifications
+A list of all specifications, regardless of status or approval or completion, for this object.
+ +Enabled architectures
+All architectures in this series with the 'enabled' flag set.
+ +Don't upgrade to backports automatically
+Set NotAutomatic: yes and ButAutomaticUpgrades: yes in Release +files generated for the backports pocket. This tells apt to +automatically upgrade within backports, but not into it.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Email changes to
+The mailing list or other email address that Launchpad should notify about new uploads.
+ +Description
+A detailed description of this series, with information on the architectures covered, the availability of security updates and any other relevant information.
+ +Display name
+The series displayname.
+ +Distribution
+The distribution for which this is a series.
+ +Driver
+The person or team responsible for decisions about features and bugs that will be targeted to this series of the distribution.
+ +Series full name
+The series full name, e.g. Ubuntu Warty
+ +Include long descriptions in Packages rather than in Translation-en
+If True, write long descriptions to the per-architecture +Packages files; if False, write them to a Translation-en +file common across architectures instead. Using a common +file reduces the bandwidth footprint of enabling multiarch +on clients, which requires downloading Packages files for +multiple architectures.
+ +Compression types to use for published index files
+A list of compression types to use for published index files +(Packages, Sources, etc.).
+ +Request a full language pack export
+Whether next language pack generation will be a full export. This +information is useful when update packs are too big and want to +merge all those changes in the base pack.
+ +Name
+The name of this series.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Owning team of the derived series
+This attribute mirrors the owner of the distribution.
+ +Parent series
+The series from which this one was branched.
+ +Don't upgrade to proposed updates automatically
+Set NotAutomatic: yes and ButAutomaticUpgrades: yes in Release +files generated for the proposed pocket. This tells apt to +automatically upgrade within proposed, but not into it.
+ +Publish by-hash directories
+Publish archive index files in by-hash directories so that apt +can retrieve them based on their hash, avoiding race conditions +between InRelease and other files during mirror updates.
+ +Publish I18n index
+Publish archive i18n/Index file, which is believed to be unused.
+ +Strict dependencies of supported components
+If True, packages in supported components (main and restricted) +may not build-depend on packages in unsupported components. Do +not rely on the name of this attribute, even for reading; it is +currently subject to change.
+ +Summary
+A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".
+ +Supported
+Whether or not this series is currently supported.
+ +Title
+The title of this series. It should be distinctive and designed to look good at the top of a page.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +Valid specifications
+All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal
+ +Version
+The version string for this series.
+ +Active
+Whether or not this series is stable and supported, or under current development. This excludes series which are experimental or obsolete.
+ +Advertise by-hash directories
+Advertise by-hash directories with a flag in the Release file so +that apt uses them by default. Only effective if +publish_by_hash is also set.
+ +Don't upgrade to backports automatically
+Set NotAutomatic: yes and ButAutomaticUpgrades: yes in Release +files generated for the backports pocket. This tells apt to +automatically upgrade within backports, but not into it.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Email changes to
+The mailing list or other email address that Launchpad should notify about new uploads.
+ +Description
+A detailed description of this series, with information on the architectures covered, the availability of security updates and any other relevant information.
+ +Display name
+The series displayname.
+ +Distribution
+The distribution for which this is a series.
+ +Driver
+The person or team responsible for decisions about features and bugs that will be targeted to this series of the distribution.
+ +Series full name
+The series full name, e.g. Ubuntu Warty
+ +Include long descriptions in Packages rather than in Translation-en
+If True, write long descriptions to the per-architecture +Packages files; if False, write them to a Translation-en +file common across architectures instead. Using a common +file reduces the bandwidth footprint of enabling multiarch +on clients, which requires downloading Packages files for +multiple architectures.
+ +Compression types to use for published index files
+A list of compression types to use for published index files +(Packages, Sources, etc.).
+ +Request a full language pack export
+Whether next language pack generation will be a full export. This +information is useful when update packs are too big and want to +merge all those changes in the base pack.
+ +Name
+The name of this series.
+ +Don't upgrade to proposed updates automatically
+Set NotAutomatic: yes and ButAutomaticUpgrades: yes in Release +files generated for the proposed pocket. This tells apt to +automatically upgrade within proposed, but not into it.
+ +Publish by-hash directories
+Publish archive index files in by-hash directories so that apt +can retrieve them based on their hash, avoiding race conditions +between InRelease and other files during mirror updates.
+ +Publish I18n index
+Publish archive i18n/Index file, which is believed to be unused.
+ +Strict dependencies of supported components
+If True, packages in supported components (main and restricted) +may not build-depend on packages in unsupported components. Do +not rely on the name of this attribute, even for reading; it is +currently subject to change.
+ +Summary
+A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".
+ +Supported
+Whether or not this series is currently supported.
+ +Title
+The title of this series. It should be distinctive and designed to look good at the top of a page.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +Version
+The version string for this series.
+ +A document containing the answer to a commonly asked question.
+The answer can be in the document itself or can be hosted on a separate +web site and referred to by URL.
+ +Content
+The answer for this FAQ in plain text. You may choose to include a URL to an external FAQ.
+ +FAQ Number
+The unique number identifying the FAQ in Launchpad.
+ +Keywords
+One or more terms that relate to this FAQ.
+ +Last Updated By
+The last person who modified the document.
+ +Target
+Product or distribution containing this FAQ.
+ +Title
+The title describing this FAQ, often a question.
+ +Content
+The answer for this FAQ in plain text. You may choose to include a URL to an external FAQ.
+ +Keywords
+One or more terms that relate to this FAQ.
+ +Title
+The title describing this FAQ, often a question.
+ +Get the access grants specific to this reference.
+Other grants may apply via wildcard rules.
+ +Check a person's permissions on this reference.
+param person: | An IPerson to check. | +
---|---|
return: | A list of zero or more of "create", "push", and +"force-push", indicating the requested person's effective +permissions on this reference. | +
Set the access grants specific to this reference.
+Other grants may apply via wildcard rules.
+ +Grants
+The new list of grants for this reference.
+For example:
++[ + { + "grantee_type": "Repository owner", + "can_create": true, + "can_push": true, + "can_force_push": true + }, + { + "grantee_type": "Person", + "grantee_link": "/~example-person", + "can_push": true + } +] ++ +
Create a new BranchMergeProposal with this reference as the source.
+Both the merge_target and the merge_prerequisite, if it is there, +must be references whose repositories have the same target as the +source.
+References in personal repositories cannot specify merge proposals.
+ +Needs review
+If True, the proposal needs review. Otherwise, it will be work in progress.
+ +Initial comment
+Registrant's initial description of proposal.
+ +Commit message
+Message to use when committing this merge.
+ +Commit SHA-1
+The full SHA-1 object name of the commit object referenced by this reference.
+ +Dependent landings
+A collection of the merge proposals that are dependent on this reference.
+ +Landing candidates
+A collection of the merge proposals where this reference is the target.
+ +Landing targets
+A collection of the merge proposals where this reference is the source.
+ +Path
+The full path of this reference, e.g. refs/heads/master.
+ +Repository
+The Git repository containing this reference.
+ +Return personal access tokens for this target.
+param visible_by_user: | |
---|---|
If given, return only access tokens visible +by this user. | +|
param include_expired: | |
If True, include expired access tokens. +This must only be used for non-authentication purposes, such as +deleting database rows. | +
Check a person's permissions on some references in this repository.
+param person: | An IPerson to check. | +
---|---|
param paths: | An iterable of reference paths. | +
return: | A dict mapping reference paths to lists of zero or more of +"create", "push", and "force-push", indicating the requested +person's effective permissions on each of the requested +references. | +
Can this repository be deleted in its current state?
+A repository is considered deletable if it is not linked to any +merge proposals.
+ +Return true if the reviewer is a trusted reviewer.
+The reviewer is trusted if they either own the repository, or are in +the team that owns the repository, or they are in the review team +for the repository.
+ +Look up a single reference in this repository by path.
+param path: | A string to look up as a path. | +
---|---|
return: | An IGitRef, or None. | +
Retrieves the list of reports that exist for a commit.
++++
++ + + + param commit_sha1: + + The commit sha1 for the report. +
Scopes: repository:build_status
+ +Active
+Deliver details of subscribed events.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +Issue an access token for this repository.
+Access tokens can be used to push to this repository over HTTPS. +They are only valid for a single repository, and have a short expiry +period (currently fixed at one week), so at the moment they are only +suitable in some limited situations. By default they are currently +implemented as macaroons.
+If description and scopes are both given, then issue a personal +access token instead, either non-expiring or with an expiry time +given by date_expires. These may be used in webservice API +requests for certain methods on this repository.
+This interface is experimental, and may be changed or removed +without notice.
+return: | If description and scopes are both given, the secret +for a new personal access token (Launchpad only records the hash +of this secret and not the secret itself, so the caller must be +careful to save this; personal access tokens are in development +and may not entirely work yet). Otherwise, a serialised +macaroon. | +
---|
Trigger a repack repository operation.
+Raises Unauthorized if the repack was attempted by a person +that is not an admin or a registry expert.
+ +Trigger a gc run for a given git repository.
+Raises Unauthorized if the repack was attempted by a person +that is not an admin or a registry expert.
+ +Rules
+The new list of rules for this repository.
+For example:
++[ + { + "ref_pattern": "refs/heads/*", + "grants": [ + { + "grantee_type": "Repository owner", + "can_create": true, + "can_push": true, + "can_force_push": true + } + ] + }, + { + "ref_pattern": "refs/heads/stable/*", + "grants": [ + { + "grantee_type": "Person", + "grantee_link": "/~example-stable-team", + "can_create": true, + "can_push": true + } + ] + } +] ++ +
Create a new status report.
++++
++ + + + param title: The name of the new report. ++ param commit_sha1: + The commit sha1 for the report. ++ param url: The external link of the status report. ++ param result_summary: + The description of the new report. ++ + param result: The result of the new report. +
Scopes: repository:build_status
+ +URL
+The external url of the report.
+ +Force a rescan of this repository as a celery task.
+This may be helpful in cases where a previous scan crashed.
+ +Subscribe this person to the repository.
+param person: | The Person to subscribe. | +
---|---|
param notification_level: | |
The kinds of repository changes that +cause notification. | +|
param max_diff_lines: | |
The maximum number of lines of diff that may +appear in a notification. | +|
param code_review_level: | |
The kinds of code review activity that +cause notification. | +|
param subscribed_by: | |
The person who is subscribing the subscriber. +Most often the subscriber themselves. | +|
return: | A new or existing GitSubscription. | +
Remove the person's subscription to this repository.
+param person: | The person or team to unsubscribe from the repository. | +
---|---|
param unsubscribed_by: | |
The person doing the unsubscribing. | +
Fork this repository to the given user's account.
+param requester: | |
---|---|
The IPerson performing this fork. | +|
param new_owner: | |
The IPerson that will own the forked repository. | +|
return: | The newly created GitRepository. | +
Builder constraints
+Builder resource tags required by builds of this repository.
+ +Date last repacked
+The date that this repository was last repacked.
+ +Date last scanned
+The date when pack statistics were last updated for this repository.
+ +Default branch
+The full path to the default branch for this repository, e.g. refs/heads/master.
+ +Dependent landings
+A collection of the merge proposals that are dependent on this repository.
+ +Description
+A short description of this repository.
+ +Display name
+Display name of the repository.
+ +HTTPS URL
+An HTTPS URL for this repository, or None in the case of private repositories.
+ +Git identity
+If this is the default repository for some target, then this is 'lp:' plus a shortcut version of the path via that target. Otherwise it is simply 'lp:' plus the unique name.
+ +SSH URL
+A git+ssh:// URL for this repository.
+ +Information type
+The type of information contained in this repository.
+ +Landing candidates
+A collection of the merge proposals where this repository is the target.
+ +Landing targets
+A collection of the merge proposals where this repository is the source.
+ +Loose object count
+The number of loose objects for this repository.
+ +Name
+The repository name. Keep very short, unique, and descriptive, because it will be used in URLs.
+ +Owner
+The owner of this Git repository. This controls who can modify the repository.
+ +Owner default
+Whether this repository is the default for its owner and target.
+ +Pack count
+The number of packs for this repository.
+ +Private
+This repository is visible only to its subscribers.
+ +Registrant
+The person who registered this Git repository.
+ +Repository type
+The way this repository is hosted: directly on Launchpad, or imported from somewhere else.
+ +Review Team
+The reviewer of a repository is the person or exclusive team that is responsible for reviewing proposals and merging into this repository.
+ +Target
+The target of the repository.
+ +Target default
+Whether this repository is the default for its target.
+ +Unique name
+Unique name of the repository, including the owner and project names.
+ +Builder constraints
+Builder resource tags required by builds of this repository.
+ +Default branch
+The full path to the default branch for this repository, e.g. refs/heads/master.
+ +Description
+A short description of this repository.
+ +Information type
+The type of information contained in this repository.
+ +Name
+The repository name. Keep very short, unique, and descriptive, because it will be used in URLs.
+ +Owner
+The owner of this Git repository. This controls who can modify the repository.
+ +Review Team
+The reviewer of a repository is the person or exclusive team that is responsible for reviewing proposals and merging into this repository.
+ +Target
+The target of the repository.
+ +Generated Diff Size Limit
+Diffs greater than the specified number of lines will not be sent to the subscriber. The subscriber will still receive an email with the new revision details even if the diff is larger than the specified number of lines.
+ +Notification Level
+Attribute notifications are sent when repository details are changed such as lifecycle status and name. Revision notifications are generated when new revisions are found.
+ +Person
+Enter the launchpad id, or email address of the person you wish to subscribe to this repository. If you are unsure, use the "Choose..." option to find the person in Launchpad. You can only subscribe someone who is a registered user of the system.
+ +Code review Level
+Control the kind of review activity that triggers notifications.
+ +Subscribed by
+The person who created this subscription.
+ +Generated Diff Size Limit
+Diffs greater than the specified number of lines will not be sent to the subscriber. The subscriber will still receive an email with the new revision details even if the diff is larger than the specified number of lines.
+ +Notification Level
+Attribute notifications are sent when repository details are changed such as lifecycle status and name. Revision notifications are generated when new revisions are found.
+ +Code review Level
+Control the kind of review activity that triggers notifications.
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +An object that has related Git repositories.
+A project contains Git repositories, a source package on a distribution +contains Git repositories, and a person contains "personal" Git +repositories.
+ +An entity that has a translation import queue.
+Examples include ProductSeries, SourcePackage, DistroSeries, +and Person.
+ +Return entries in the translation import queue for this entity.
+arg import_status: | |
---|---|
RosettaImportStatus DB Schema entry. | +|
arg file_extension: | |
String with the file type extension, usually 'po' +or 'pot'. | +
If one of both of 'import_status' or 'file_extension' are given, the +returned entries are filtered based on those values.
+ +Status
+Show only entries with this status
+ +Filename extension
+Show only entries with this filename suffix
+ +Plural form expression
+The expression that relates a number of items to the appropriate plural form.
+ +Number of plural forms
+The number of plural forms this language has.
+ +Text direction
+The direction of text in this language.
+ +Visible
+Whether this language is visible by default.
+ +Plural form expression
+The expression that relates a number of items to the appropriate plural form.
+ +Number of plural forms
+The number of plural forms this language has.
+ +Text direction
+The direction of text in this language.
+ +Visible
+Whether this language is visible by default.
+ +URLs for all the files produced by this build.
+return: | A collection of URLs for this build. | +
---|
Restore the build record to its initial state.
+Build record loses its history, is moved to NEEDSBUILD and a new +non-scored BuildQueue entry is created for it.
+ +Cancel the build if it is either pending or in progress.
+Check the can_be_cancelled property prior to calling this method to +find out if cancelling the build is possible.
+If the build is in progress, it is marked as CANCELLING until the +buildd manager terminates the build and marks it CANCELLED. If the +build is not in progress, it is marked CANCELLED immediately and is +removed from the build queue.
+If the build is not in a cancellable state, this method is a no-op.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Builder
+The builder assigned to this job.
+ +Status
+The current status of the job.
+ +Can be cancelled
+Whether this build record can be cancelled.
+ +Can be rescored
+Whether this build record can be rescored manually.
+ +Can be retried
+Whether this build record can be retried.
+ +Date finished
+The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.
+ +Date started
+The timestamp when the build farm job was started.
+ +Date finished
+The timestamp when the build farm job was finished.
+ +Date created
+The timestamp when the build farm job was created.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +Duration
+Duration interval, calculated when the result gets collected.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Status
+The current status of the job.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Active
+Deliver details of subscribed events.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +Request that the live filesystem be built.
+param requester: | |
---|---|
The person requesting the build. | +|
param archive: | The IArchive to associate the build with. | +
param distro_arch_series: | |
The architecture to build for. | +|
param pocket: | The pocket that should be targeted. | +
param unique_key: | |
An optional unique key for this build; if set, +this identifies a class of builds for this live filesystem. | +|
param metadata_override: | |
An optional JSON string with a dict of +data about the image; this will be merged into the metadata dict +for the live filesystem. | +|
param version: | A version string for this build; if not set, a +version string will be generated from the date and time when the +build was requested. | +
return: | ILiveFSBuild. | +
All builds of this live filesystem.
+All builds of this live filesystem, sorted in descending order of finishing (or starting if not completed successfully).
+ +Completed builds of this live filesystem.
+Completed builds of this live filesystem, sorted in descending order of finishing.
+ +Distro Series
+The series for which the image should be built.
+ +Binary file retention period
+Keep binary files attached to builds of this live filesystem for at least this many days. If unset, disable pruning.
+ +Name
+The name of the live filesystem image.
+ +Owner
+The owner of this live filesystem image.
+ +Pending builds of this live filesystem.
+Pending builds of this live filesystem, sorted in descending order of creation.
+ +Registrant
+The person who registered this live filesystem image.
+ +Relative build score
+A delta to apply to all build scores for the live filesystem. Builds with a higher score will build sooner.
+ +Require virtualized builders
+Only build this live filesystem image on virtual builders.
+ +Distro Series
+The series for which the image should be built.
+ +Binary file retention period
+Keep binary files attached to builds of this live filesystem for at least this many days. If unset, disable pruning.
+ +Name
+The name of the live filesystem image.
+ +Owner
+The owner of this live filesystem image.
+ +Relative build score
+A delta to apply to all build scores for the live filesystem. Builds with a higher score will build sooner.
+ +Require virtualized builders
+Only build this live filesystem image on virtual builders.
+ +Message content
+The new message content string
+ +Message revision history
+Revision history of this message, sorted in ascending order.
+ +Message visibility.
+Whether or not the message is visible.
+ +Return all the subscriptions with the specified levels.
+return: | A sequence of IStructuralSubscription. | +
---|
Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Return the milestone tags in alphabetical order.
+See above the IMilestone.setTags docstring for an explanation of +why this is not a property.
+ +Add a bug subscription for this structure.
+This method is used to create a new IStructuralSubscription for the +target. This initially has a single filter which will allow all +notifications will be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription. | +
Add a bug subscription filter for this structure.
+This method is used to create a new IBugSubscriptionFilter for the +target. It will initially allow all notifications to be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription filter. | +
Remove a subscription to bugs from this structure.
+This will delete all associated filters.
+subscriber: | The IPerson who will be unsubscribed. If omitted, +unsubscribed_by will be used. | +
---|---|
unsubscribed_by: | |
The IPerson removing the subscription. | +
Create a new ProductRelease.
+param owner: | IPerson object who manages the release. | +
---|---|
param datereleased: | |
Date of the product release. | +|
param changelog: | |
Detailed changes in each version. | +|
param release_notes: | |
Overview of changes in each version. | +|
returns: | IProductRelease object. | +
Date released
+The date this release was published. Before release, this should have an estimated release date.
+ +Changelog
+A description of every change in the release.
+ +Release notes
+A description of important new features (though the changelog below might repeat some of this information).
+ +Set the milestone tags.
+param: | tags The list of tags to be associated with milestone. | +
---|---|
param: | user The user who is updating tags for this milestone. | +
Note that this is not a property because, while the current user +is needed to store tags metadata, it is desirable to avoid +using thread locals to get the current request in models.
+ +Tags for this milestone
+Space-separated keywords for classifying this milestone.
+ +Code name
+An alternative name for the milestone.
+ +Date Targeted
+Example: 2005-11-24
+ +Active
+Whether or not this object should be shown in web forms for targeting.
+ +Name
+Only letters, numbers, and simple punctuation are allowed.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Summary
+A summary of the features and status of this milestone.
+ +Code name
+An alternative name for the milestone.
+ +Date Targeted
+Example: 2005-11-24
+ +Active
+Whether or not this object should be shown in web forms for targeting.
+ +Name
+Only letters, numbers, and simple punctuation are allowed.
+ +Summary
+A summary of the features and status of this milestone.
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Return all the subscriptions with the specified levels.
+return: | A sequence of IStructuralSubscription. | +
---|
Add a bug subscription for this structure.
+This method is used to create a new IStructuralSubscription for the +target. This initially has a single filter which will allow all +notifications will be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription. | +
Add a bug subscription filter for this structure.
+This method is used to create a new IBugSubscriptionFilter for the +target. It will initially allow all notifications to be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription filter. | +
Remove a subscription to bugs from this structure.
+This will delete all associated filters.
+subscriber: | The IPerson who will be unsubscribed. If omitted, +unsubscribed_by will be used. | +
---|---|
unsubscribed_by: | |
The IPerson removing the subscription. | +
OCI Recipe name.
+The name of the new OCI Recipe.
+ +Build file path.
+The relative path to the file within this recipe's branch that defines how to build the recipe.
+ +Build ARGs to be used when building the recipe
+A dict of VARIABLE=VALUE to be used as ARG when building the recipe.
+ +Description for this recipe.
+A short description of this recipe.
+ +OCI recipe
+The OCI recipe to change the status of.
+ +Official status
+Whether the OCI recipe should be official or not.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Name
+The name of this OCI project.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Registrant
+The person that registered this project.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Name
+The name of this OCI project.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +A series of an Open Container Initiative project.
+This is used to allow tracking bugs against multiple versions of images.
+ +Date created
+The date on which this series was created in Launchpad.
+ +Name
+The name of this series.
+ +Registrant
+The person that registered this series.
+ +Summary
+A brief summary of this series.
+ +Name
+The name of this series.
+ +Summary
+A brief summary of this series.
+ +Image name
+The intended name of the image on the registry.
+ +Registry URL
+The registry URL for the credentials of this push rule
+ +Username
+The username for the credentials, if available.
+ +Image name
+The intended name of the image on the registry.
+ +URLs for all the files produced by this build.
+return: | A collection of URLs for this build. | +
---|
Restore the build record to its initial state.
+Build record loses its history, is moved to NEEDSBUILD and a new +non-scored BuildQueue entry is created for it.
+ +Cancel the build if it is either pending or in progress.
+Check the can_be_cancelled property prior to calling this method to +find out if cancelling the build is possible.
+If the build is in progress, it is marked as CANCELLING until the +buildd manager terminates the build and marks it CANCELLED. If the +build is not in progress, it is marked CANCELLED immediately and is +removed from the build queue.
+If the build is not in a cancellable state, this method is a no-op.
+ +Schedule an upload of this build to each configured registry.
+raises CannotScheduleRegistryUpload: | |
---|---|
if the build is not in a state +where an upload can be scheduled. | +
Archive
+The Archive context for this build.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Builder
+The builder assigned to this job.
+ +Status
+The current status of the job.
+ +Can be cancelled
+Whether this build record can be cancelled.
+ +Can be rescored
+Whether this build record can be rescored manually.
+ +Can be retried
+Whether this build record can be retried.
+ +Date finished
+The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.
+ +Date started
+The timestamp when the build farm job was started.
+ +Date finished
+The timestamp when the build farm job was finished.
+ +Date created
+The timestamp when the build farm job was created.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +Duration
+Duration interval, calculated when the result gets collected.
+ +The build targeted pocket.
+ +Registry upload error summary
+The error summary, if any, from the last attempt to upload this build to a registry.
+ +Detailed registry upload errors
+A list of errors, as described in https://docs.docker.com/registry/spec/api/#errors, from the last attempt to upload this build to a registry.
+ +Requester
+The person who requested this OCI recipe build.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Status
+The current status of the job.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +The build targeted pocket.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Active
+Deliver details of subscribed events.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +Registry URL
+URL for the target registry
+ +Image name
+Name of the image to push to on the registry
+ +Registry credentials
+The credentials to use in pushing the image to the registry
+ +Request that the OCI recipe is built for all available +architectures.
+param requester: | |
---|---|
The person requesting the build. | +|
return: | A IOCIRecipeBuildRequest instance. | +
Allow external network access
+Allow access to external network resources via a proxy. Resources hosted on Launchpad itself are always allowed.
+ +Build ARG variables
+The dictionary of ARG variables to be used when building this recipe.
+ +Build daily
+If True, this recipe should be built daily.
+ +Build file path
+The relative path to the file within this recipe's branch that defines how to build the recipe.
+ +Build directory context
+Directory to use for build context and OCIRecipe.build_file location.
+ +Description
+A short description of this recipe.
+ +Git branch
+The Git branch containing a Dockerfile at the location defined by the build_file attribute.
+ +Image name
+Image name to use on upload to registry. Defaults to recipe name if not set. Only used when Distribution credentials are set.
+ +Information type
+The type of information contained in this OCI recipe.
+ +Name
+The name of this recipe.
+ +OCI project
+The OCI project that this recipe is for.
+ +Owner
+The owner of this OCI recipe.
+ +Processors
+The architectures for which the OCI recipe should be built.
+ +Push rules for this OCI recipe.
+All of the push rules for registry upload that apply to this recipe.
+ +Registrant
+The user who registered this recipe.
+ +Allow external network access
+Allow access to external network resources via a proxy. Resources hosted on Launchpad itself are always allowed.
+ +Build ARG variables
+The dictionary of ARG variables to be used when building this recipe.
+ +Build daily
+If True, this recipe should be built daily.
+ +Build file path
+The relative path to the file within this recipe's branch that defines how to build the recipe.
+ +Build directory context
+Directory to use for build context and OCIRecipe.build_file location.
+ +Description
+A short description of this recipe.
+ +Git branch
+The Git branch containing a Dockerfile at the location defined by the build_file attribute.
+ +Image name
+Image name to use on upload to registry. Defaults to recipe name if not set. Only used when Distribution credentials are set.
+ +Information type
+The type of information contained in this OCI recipe.
+ +Name
+The name of this recipe.
+ +Owner
+The owner of this OCI recipe.
+ +Template is active
+If unchecked, people can no longer change the template's translations.
+ +Description
+Please provide a brief description of the content of this translation template, for example, telling translators if this template contains strings for end-users or other developers.
+ +Include translations for this template in language packs?
+Check this box if this template is part of a language pack so its translations should be exported that way.
+ +Template name
+The name of this PO template, for example 'evolution-2.2'. Each translation template has a unique name in its package. It's important to get this correct, because Launchpad will recommend alternative translations based on the name.
+ +Owner
+The owner of the template in Launchpad can edit the template and change it's status, and can also upload new versions of the template when a new release is made or when the translation strings have been changed during development.
+ +Priority
+A number that describes how important this template is. Often there are multiple templates, and you can use this as a way of indicating which are more important and should be translated first. Pick any number - higher priority templates will generally be listed first.
+ +Translation domain
+The translation domain for a translation template. Used with PO file format when generating MO files for inclusion in language pack or MO tarball exports.
+ +Template is active
+If unchecked, people can no longer change the template's translations.
+ +Description
+Please provide a brief description of the content of this translation template, for example, telling translators if this template contains strings for end-users or other developers.
+ +Include translations for this template in language packs?
+Check this box if this template is part of a language pack so its translations should be exported that way.
+ +Template name
+The name of this PO template, for example 'evolution-2.2'. Each translation template has a unique name in its package. It's important to get this correct, because Launchpad will recommend alternative translations based on the name.
+ +Owner
+The owner of the template in Launchpad can edit the template and change it's status, and can also upload new versions of the template when a new release is made or when the translation strings have been changed during development.
+ +Priority
+A number that describes how important this template is. Often there are multiple templates, and you can use this as a way of indicating which are more important and should be translated first. Pick any number - higher priority templates will generally be listed first.
+ +Translation domain
+The translation domain for a translation template. Used with PO file format when generating MO files for inclusion in language pack or MO tarball exports.
+ +URLs for all the source files attached to this upload.
+return: | A collection of URLs for this upload. | +
---|
URLs for all the binary files attached to this upload.
+return: | A collection of URLs for this upload. | +
---|
URLs for all the custom files attached to this upload.
+return: | A collection of URLs for this upload. | +
---|
The properties of the binaries associated with this queue item.
+return: | A list of dictionaries, each containing the properties of a +single binary. | +
---|
Call setAccepted, do a flush, and send notification email.
+Override the source package contained in this queue item.
+param new_component: | |
---|---|
An IComponent to replace the existing one +in the upload's source. | +|
param new_section: | |
An ISection to replace the existing one +in the upload's source. | +|
param allowed_components: | |
A sequence of components that the +callsite is allowed to override from and to. | +|
param user: | The user requesting the override change, used if +allowed_components is None. | +
raises QueueInconsistentStateError: | |
if either the existing +or the new_component are not in the allowed_components +sequence. | +
The override values may be None, in which case they are not +changed.
+return: | True if the source was overridden. | +
---|
Override binary packages in a binary queue item.
+param changes: | A sequence of mappings of changes to apply. Each +change mapping may have a "name" item which specifies the binary +package name to override; otherwise, the change applies to all +binaries in the upload. It may also have "component", "section", +and "priority" items which replace the corresponding existing +one in the upload's overridden binaries. Any missing items are +left unchanged. | +
---|---|
param allowed_components: | |
A sequence of components that the +callsite is allowed to override from and to. | +|
param user: | The user requesting the override change, used if +allowed_components is None. | +
raises QueueInconsistentStateError: | |
if either the existing +or the new_component are not in the allowed_components +sequence. | +|
return: | True if any binaries were overridden. | +
A sequence of changes to apply.
+Each item may have a 'name' item which specifies the binary package name to override; otherwise, the change applies to all binaries in the upload. It may also have 'component', 'section', and 'priority' items which replace the corresponding existing one in the upload's overridden binaries.
+ +Archive
+The archive for this upload.
+ +Changes file URL
+Librarian URL for the changes file associated with this upload. Will be None if the upload was copied from another series.
+ +Copy source archive
+The archive from which this package was copied, if any.
+ +Date created
+The date this package upload was done.
+ +Series
+The distroseries targeted by this upload.
+ +The pocket
+The pocket targeted by this upload.
+ +Queue status
+The status of this upload.
+ +Date created
+The date this package upload was done.
+ +Series
+The distroseries targeted by this upload.
+ +The pocket
+The pocket targeted by this upload.
+ +Get all package sets that include this one.
+Return all package sets that directly or indirectly include this one.
+param direct_inclusion: | |
---|---|
if this flag is set to True only sets +directly including this one will be considered. | +|
return: | A (potentially empty) sequence of IPackageset instances. | +
Get all package sets that are included by this one.
+Return all package sets that are directly or indirectly +included by this one.
+param direct_inclusion: | |
---|---|
if this flag is set to True only sets +directly included by this one will be considered. | +|
return: | A (potentially empty) sequence of IPackageset instances. | +
Get all source names associated with this package set.
+This method returns the source package names that are directly +or indirectly associated with the package set at hand. Indirect +associations may be defined through package set successors.
+Please note: this method was mainly introduced in order to +facilitate the listing of source package names via the LP +web services API. It returns string names as opposed to +ISourcePackageName instances.
+param direct_inclusion: | |
---|---|
if this flag is set to True only sources +directly included by this package set will be considered. | +|
return: | A (potentially empty) sequence of string source package +names. | +
Get source package names also included by another package set.
+What source package names does this package set have in common with +the other_package_set?
+Please note: this method was mainly introduced in order to +facilitate the listing of source package names via the LP +web services API. It returns string names as opposed to +ISourcePackageName instances.
+param other_package_set: | |
---|---|
the other package set | +|
param direct_inclusion: | |
if this flag is set to True only directly +included sources will be considered. | +|
return: | A (potentially empty) sequence of string source package +names. | +
Get source package names not included by another package set.
+Which source package names included by this package are not +included by the other_package_set?
+Please note: this method was mainly introduced in order to +facilitate the listing of source package names via the LP +web services API. It returns string names as opposed to +ISourcePackageName instances.
+param other_package_set: | |
---|---|
the other package set | +|
param direct_inclusion: | |
if this flag is set to True only directly +included sources will be considered. | +|
return: | A (potentially empty) sequence of string source package +names. | +
Get all other package sets in this set's PackagesetGroup.
+Returns all package sets that are related to this one, but not +this one itself.
+return: | A (potentially empty) sequence of IPackageset instances. | +
---|
Add the named source packages to this package set.
+Any passed source package names will become directly associated +with the package set at hand.
+This function is idempotent in the sense that source package names +that are already directly associated with a package set will be +ignored.
+This method facilitates the addition of source package names to +package sets via the LP web services API. It takes string names +as opposed to ISourcePackageName instances. Non-existing source +package names will be ignored.
+param names: | an iterable with string source package names | +
---|
Remove the named source packages from this package set.
+Only source package names directly included by this package +set can be removed. Any others will be ignored.
+This method facilitates the removal of source package names from +package sets via the LP web services API. It takes string names +as opposed to ISourcePackageName instances.
+param names: | an iterable with string source package names | +
---|
Add the named package sets as subsets to this package set.
+Any passed source package names will become directly associated +with the package set at hand.
+This function is idempotent in the sense that package subsets +that are already directly associated with a package set will be +ignored.
+This method facilitates the addition of package subsets via the +LP web services API. It takes string names as opposed to +IPackageset instances.
+param names: | an iterable with string package set names | +
---|
Remove the named package subsets from this package set.
+Only package subsets directly included by this package +set can be removed. Any others will be ignored.
+This method facilitates the removal of package subsets via the +LP web services API. It takes string names as opposed to +IPackageset instances.
+param names: | an iterable with string package set names | +
---|
Date Created
+The creation date/time for the package set at hand.
+ +Description
+The description for the package set at hand.
+ +Distribution series
+The distroseries to which this package set is related.
+ +Person
+The person who owns this package set.
+ +Build score
+Build score bonus for packages in this package set.
+ +Description
+The description for the package set at hand.
+ +Person
+The person who owns this package set.
+ +Build score
+Build score bonus for packages in this package set.
+ +Return entries in the translation import queue for this entity.
+arg import_status: | |
---|---|
RosettaImportStatus DB Schema entry. | +|
arg file_extension: | |
String with the file type extension, usually 'po' +or 'pot'. | +
If one of both of 'import_status' or 'file_extension' are given, the +returned entries are filtered based on those values.
+ +Status
+Show only entries with this status
+ +Filename extension
+Show only entries with this filename suffix
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Returns merge proposals where a person was asked to review.
+This does not include merge proposals that were requested from +teams that the person is part of. If status is not passed then +it will return proposals that are in the "Needs Review" state.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
returns: | A list of IBranchMergeProposal. | +
Returns all merge proposals of a given status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param eager_load: | |
If True, load related objects for the whole +collection. | +|
returns: | A list of IBranchMergeProposal. | +
Returns all branches with the given lifecycle status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param modified_since: | |
If set, filters the branches being returned +to those that have been modified since the specified date/time. | +|
param eager_load: | |
If True load related objects for the whole +collection. | +|
returns: | A list of IBranch. | +
Return private archive URLs that this person can see.
+For each of the private archives (PPAs) that this person can see, +return a URL that includes the HTTP basic auth data. The URL +returned is suitable for including in a sources.list file.
+ +Return the packages for which this person is a bug subscriber.
+Returns a list of IDistributionSourcePackage's, ordered alphabetically +(A to Z) by name.
+ +Return the people whose membership on this team match :status:.
+If no orderby is provided, Person.sortingColumns is used.
+ +Return a PPA with the given name if it exists.
+param name: | A string with the exact name of the ppa being looked up. | +
---|---|
raises: | NoSuchPPA if a suitable PPA could not be found. | +
return: | a PPA IArchive record corresponding to the name. | +
Search the person's questions.
+param search_text: | |
---|---|
A string that is matched against the question +title and description. If None, the search_text is not included as +a filter criteria. | +|
param status: | A sequence of QuestionStatus Items. If None or an empty +sequence, the status is not included as a filter criteria. The +default is to match all status except Expired and Invalid. | +
param language: | An ILanguage or a sequence of ILanguage objects to +match against the question's language. If None or an empty +sequence, the language is not included as a filter criteria. | +
param participation: | |
A list of QuestionParticipation that defines the +set of relationship to questions that will be searched. If None or +an empty sequence, all relationships are considered. | +|
param needs_attention: | |
If this flag is true, only questions that +need attention the person will be included. These are the +questions in the NEEDSINFO or ANSWERED state owned by the person. +The questions not owned by the person but on which the person +requested more information or gave an answer and that are back in +the OPEN state are also included. | +|
param sort: | An attribute of QuestionSort. If None, a default value is +used. When there is a search_text value, the default is to sort by +RELEVANCY, otherwise results are sorted NEWEST_FIRST. | +
Return a list of IQuestionTargets that a person is subscribed to.
+This will return IQuestionTargets that the person is registered as an +answer contact because they subscribed themselves.
+ +Return a list of IQuestionTargets that are indirect subscriptions.
+This will return IQuestionTargets that the person or team is +registered as an answer contact because of their membership in a team.
+ +Projects owned by this person or teams to which they belong.
+param match_name: | |
---|---|
string optional project name to screen the results. | +
Return the teams that this person owns.
+The iterator includes the teams that the user owns, but it not +a member of.
+ +Join the given team if its membership_policy is not RESTRICTED.
+Join the given team according to the policies and defaults of that +team:
+If may_subscribe_to_list is True, then also attempt to +subscribe to the team's mailing list, depending on the list +status and the person's auto-subscribe settings.
+param requester: | |
---|---|
The person who requested the membership on +behalf of a team or None when a person requests the +membership for themselves. | +|
param may_subscribe_to_list: | |
If True, also try subscribing to +the team mailing list. | +
Leave the given team.
+This is a convenience method for retractTeamMembership() that allows +a user to leave the given team, or to cancel a PENDING membership +request.
+param team: | The team to leave. | +
---|
Add the given person as a member of this team.
+param person: | If the given person is already a member of this +team we'll simply change its membership status. Otherwise a new +TeamMembership is created with the given status. | +
---|---|
param reviewer: | The user who made the given person a member of this +team. | +
param comment: | String that will be assigned to the +proponent_comment, reviewer_comment, or acknowledger comment. | +
param status: | TeamMembershipStatus value must be either +Approved, Proposed or Admin. +If the new member is a team, the status will be changed to +Invited unless the user is also an admin of that team. | +
param force_team_add: | |
If the person is actually a team and +force_team_add is False, the team will actually be invited to +join this one. Otherwise the team is added as if it were a +person. | +|
param may_subscribe_to_list: | |
If the person is not a team, and +may_subscribe_to_list is True, then the person may be subscribed +to the team's mailing list, depending on the list status and the +person's auto-subscribe settings. | +|
return: | A tuple containing a boolean indicating when the +membership status changed and the current TeamMembershipStatus. +This depends on the desired status passed as an argument, the +membership policy and the user's privileges. | +
Accept an invitation to become a member of the given team.
+There must be a TeamMembership for this person and the given team with +the INVITED status. The status of this TeamMembership will be changed +to APPROVED.
+ +Decline an invitation to become a member of the given team.
+There must be a TeamMembership for this person and the given team with +the INVITED status. The status of this TeamMembership will be changed +to INVITATION_DECLINED.
+ +Retract this team's membership in the given team.
+If there's a membership entry for this team on the given team and +its status is either APPROVED, ADMIN, PENDING, or INVITED, the status +is changed and the relevant entries in TeamParticipation.
+APPROVED and ADMIN status are changed to DEACTIVATED. +PENDING status is changed to DECLINED. +INVITED status is changes to INVITATION_DECLINED.
+param team: | The team to leave. | +
---|---|
param user: | The user making the retraction. | +
param comment: | An optional explanation about why the change was made. | +
Create a PPA.
+param distribution: | |
---|---|
The distribution that this archive is for. | +|
param name: | The name of the new PPA to create. | +
param displayname: | |
The displayname for the new PPA. | +|
param description: | |
The description for the new PPA. | +|
param private: | Whether or not to create a private PPA. Defaults to +False, which means the PPA will be public. | +
param suppress_subscription_notifications: | |
Whether or not to suppress +emails to new subscribers about their subscriptions. Only +meaningful for private PPAs. | +|
raises: | PPACreationError if an error is encountered | +
return: | a PPA IArchive record. | +
Create a SourcePackageRecipe owned by this person.
+param name: | the name to use for referring to the recipe. | +
---|---|
param description: | |
A description of the recipe. | +|
param recipe_text: | |
The text of the recipe. | +|
param distroseries: | |
The distroseries to use. | +|
param registrant: | |
The person who created this recipe. | +|
param daily_build_archive: | |
The archive to use for daily builds. | +|
param build_daily: | |
If True, build this recipe daily (if changed). | +|
return: | a SourcePackageRecipe. | +
Get a text line that is suitable to be used for a sources.list +entry.
+It will create a new IArchiveAuthToken if one doesn't already exist.
+It raises Unauthorized if the context user does not have a +valid subscription for the target archive or the caller is not +context user itself.
+ +Add a language to this person's preferences.
+param language: | An object providing ILanguage. | +
---|
If the given language is one of the user's preferred languages +already, nothing will happen.
+ +Remove a language from this person's preferences.
+param language: | An object providing ILanguage. | +
---|
If the given language is not present, nothing will happen.
+ +All specifications
+A list of all specifications, regardless of status or approval or completion, for this object.
+ +Default PPA
+The PPA named 'ppa' owned by this person.
+ +Confirmed emails of this person.
+Confirmed emails are the ones in the VALIDATED state
+ +Description
+Details about interests and goals. Use plain text, paragraphs are preserved and URLs are linked.
+ +Display Name
+Your name as you would like it displayed throughout Launchpad. Most people use their full name here.
+ +Homepage Content
+Obsolete. Use description.
+ +ID
+Internal immutable identifier for this person. Only visible by privileged users.
+ +Karma
+The cached total karma for this person.
+ +Logo
+An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to you. Traditionally this is a logo, a small picture or a personal mascot. It should be no bigger than 50kb in size.
+ +Mailing List Auto-subscription Policy
+This attribute determines whether a person is automatically subscribed to a team's mailing list when the person joins said team.
+ +Active TeamMemberships for this object's members.
+Active TeamMemberships are the ones with the ADMIN or APPROVED status. The results are ordered using Person.sortingColumns.
+ +Mugshot
+A large image of exactly 192x192 pixels, that will be displayed on your home page in Launchpad. Traditionally this is a great big picture of your grinning face. Make the most of it! It should be no bigger than 100kb in size.
+ +Name
+A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.
+ +Open membership invitations.
+All TeamMemberships which represent an invitation (to join a team) sent to this person.
+ +All participants of this team.
+List of all direct and indirect people and teams who, one way or another, are a part of this team. If you want a method to check if a given person is a member of a team, you should probably look at IPerson.inTeam().
+ +PPAs for this person.
+PPAs owned by the context person ordered by name.
+ +Preferred email address
+The preferred email address for this person. The one we'll use to communicate with them.
+ +This team is private
+Private teams are visible only to their members.
+ +All subteams of this team.
+A subteam is any team that is a member (either directly or +indirectly) of this team. As an example, let's say we have +this hierarchy of teams:
+In this case, both 'Rosetta pt Translators' and 'Rosetta pt_BR +Translators' are subteams of the 'Rosetta Translators' team, +and all members of both subteams are considered members of +"Rosetta Translators".
+ +All superteams of this team.
+A superteam is any team that this team is a member of. For +example, let's say we have this hierarchy of teams, and we are +the "Rosetta pt_BR Translators":
+In this case, we will return both 'Rosetta pt Translators' and +'Rosetta Translators', because we are member of both of them.
+ +Valid specifications
+All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal
+ +Visibility
+Anyone can see a public team's data. Only team members can see private team data.
+ +Description
+Details about interests and goals. Use plain text, paragraphs are preserved and URLs are linked.
+ +Display Name
+Your name as you would like it displayed throughout Launchpad. Most people use their full name here.
+ +Homepage Content
+Obsolete. Use description.
+ +Logo
+An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to you. Traditionally this is a logo, a small picture or a personal mascot. It should be no bigger than 50kb in size.
+ +Mailing List Auto-subscription Policy
+This attribute determines whether a person is automatically subscribed to a team's mailing list when the person joins said team.
+ +Mugshot
+A large image of exactly 192x192 pixels, that will be displayed on your home page in Launchpad. Traditionally this is a great big picture of your grinning face. Make the most of it! It should be no bigger than 100kb in size.
+ +Name
+A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.
+ +Visibility
+Anyone can see a public team's data. Only team members can see private team data.
+ +An object that might be a project, a project group, or a distribution.
+This is a polymorphic object served by the pillar set. Check the +individual object to see what type it is.
+ +Active
+Whether or not this item is active.
+ +Active
+Whether or not this item is active.
+ +An object for searching across projects, project groups, and distros.
+Projects, project groups, and distributions are collectively known as +"pillars". This object lets you do a combined search across all +types of pillars. It also gives you access to pillars that have +been flagged by administrators as "featured" pillars.
+ +Return Projects/Project groups/Distros matching :text:.
+If :limit: is None, the default batch size will be used.
+The results are ordered descending by rank.
+ +Users can spoil their votes?
+Allow users to leave the ballot blank (i.e. cast a vote for "None of the above")
+ +The unique name of this poll
+A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.
+ +Users can spoil their votes?
+Allow users to leave the ballot blank (i.e. cast a vote for "None of the above")
+ +The unique name of this poll
+A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.
+ +A diff generated to show actual diff between two branches.
+This diff will be used primarily for branch merge proposals where we are +trying to determine the effective changes of landing the source branch on +the target branch.
+ +Date Created
+When this diff was created.
+ +DB ID
+The tracking number for this diff.
+ +Title
+PreviewDiff title.
+ +Description
+The Processor Description
+ +Name
+The Processor Name
+ +Supports non-virtualized builds
+Whether the processor has non-virtualized builders. If not, all builds for this processor will build on virtualized builders, even for non-virtualized archives.
+ +Supports virtualized builds
+Whether the processor has virtualized builders. If not, archives that require virtualized builds won't build on this processor.
+ +Title
+The Processor Title
+ +A Product.
+The Launchpad Registry describes the open source world as ProjectGroups +and Products. Each ProjectGroup may be responsible for several Products. +For example, the Mozilla Project has Firefox, Thunderbird and The +Mozilla App Suite as Products, among others.
+ +Return all the subscriptions with the specified levels.
+return: | A sequence of IStructuralSubscription. | +
---|
Return the questions from the collection matching search criteria.
+param search_text: | |
---|---|
A string that is matched against the question +title and description. If None, the search_text is not included as +a filter criteria. | +|
param status: | A sequence of QuestionStatus Items. If None or an empty +sequence, the status is not included as a filter criteria. The +default is to match all status except Expired and Invalid. | +
param language: | An ILanguage or a sequence of ILanguage objects to +match against the question's language. If None or an empty +sequence, the language is not included as a filter criteria. | +
param owner: | The IPerson that created the question. | +
param needs_attention_from: | |
Selects questions that need attention +from an IPerson. These are the questions in the NEEDSINFO or +ANSWERED state owned by the person. The questions not owned by the +person but on which the person requested more information or gave +an answer and that are back in the OPEN state are also included. | +|
param sort: | An attribute of QuestionSort. If None, a default value is +used. When there is a search_text value, the default is to sort by +RELEVANCY, otherwise results are sorted NEWEST_FIRST. | +
Return the question by its id, if it is applicable to this target.
+question_id: | A question id. | +
---|
If there is no such question number for this target, return None
+ +Return questions similar to phrase.
+Return a list of question similar to the provided phrase. These +questions will be found using a fuzzy search. The list is +ordered from the most similar question to the least similar question.
+param phrase: | A phrase such as the summary of a question. | +
---|
Return the list of Persons that provide support for a language.
+An answer contact supports questions in their preferred languages.
+ +Return a list of languages spoken by at the answer contacts.
+An answer contact is considered to speak a given language if that +language is listed as one of their preferred languages.
+ +Can the user add or remove the answer contact.
+Users can add or remove themselves or one of the teams they +administered. Admins and target owners can add/remove anyone.
+param person: | The IPerson that is or will be an answer contact. | +
---|---|
param subscribed_by: | |
The IPerson making the change. | +
Return entries in the translation import queue for this entity.
+arg import_status: | |
---|---|
RosettaImportStatus DB Schema entry. | +|
arg file_extension: | |
String with the file type extension, usually 'po' +or 'pot'. | +
If one of both of 'import_status' or 'file_extension' are given, the +returned entries are filtered based on those values.
+ +Status
+Show only entries with this status
+ +Filename extension
+Show only entries with this filename suffix
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Returns all merge proposals of a given status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param eager_load: | |
If True, load related objects for the whole +collection. | +|
returns: | A list of IBranchMergeProposal. | +
Returns all branches with the given lifecycle status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param modified_since: | |
If set, filters the branches being returned +to those that have been modified since the specified date/time. | +|
param eager_load: | |
If True load related objects for the whole +collection. | +|
returns: | A list of IBranch. | +
Return basic timeline data useful for creating a diagram.
+The number of milestones returned per series is limited.
+ +Find OOPS reports between start_date and end_date.
+param start_date: | |
---|---|
Do not look in objects whose last modification time +is before this date. | +|
param end_date: | Do not look in objects whose last modification time +is after this date. | +
return: | A set of OOPS id's - strings of the form 'OOPS-w+'. | +
Return personal access tokens for this target.
+param visible_by_user: | |
---|---|
If given, return only access tokens visible +by this user. | +|
param include_expired: | |
If True, include expired access tokens. +This must only be used for non-authentication purposes, such as +deleting database rows. | +
Add a bug subscription for this structure.
+This method is used to create a new IStructuralSubscription for the +target. This initially has a single filter which will allow all +notifications will be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription. | +
Add a bug subscription filter for this structure.
+This method is used to create a new IBugSubscriptionFilter for the +target. It will initially allow all notifications to be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription filter. | +
Remove a subscription to bugs from this structure.
+This will delete all associated filters.
+subscriber: | The IPerson who will be unsubscribed. If omitted, +unsubscribed_by will be used. | +
---|---|
unsubscribed_by: | |
The IPerson removing the subscription. | +
Add a new answer contact.
+param person: | An IPerson. | +
---|---|
param subscribed_by: | |
The user making the change. | +|
return: | True if the person was added, False if the person already is +an answer contact. | +
raises AddAnswerContactError: | |
When the person or team does no have a +preferred language. | +
Remove an answer contact.
+param person: | An IPerson. | +
---|---|
param subscribed_by: | |
The user making the change. | +|
return: | True if the person was removed, False if the person wasn't an +answer contact. | +
Issue a personal access token for this target.
+Access tokens can be used to push to repositories over HTTPS. These may +be used in webservice API requests for certain methods in the target's +repositories.
+They are either non-expiring or with an expiry time given by +date_expires.
+return: | The secret for a new personal access token (Launchpad only +records the hash of this secret and not the secret itself, so the +caller must be careful to save this). | +
---|
Active
+Deliver details of subscribed events.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +Create a new code import.
+param registrant: | |
---|---|
The IPerson to record as the registrant of the +import. | +|
param branch_name: | |
The name of the branch or repository to create. | +|
param rcs_type: | The type of the foreign VCS. | +
param target_rcs_type: | |
The type of the branch or repository to +create (Bazaar or Git). | +|
param url: | The URL to import from if the VCS type uses a single URL +(i.e. isn't CVS). | +
param cvs_root: | The CVSROOT for a CVS import. | +
param cvs_module: | |
The module to import for a CVS import. | +|
param owner: | Who should own the created branch or repository, or +None for it to be the same as the registrant, or the caller over +the API. | +
returns: | An instance of ICodeImport. | +
Creates a new IProductSeries for this IProduct.
+param owner: | The registrant of this series. | +
---|---|
param name: | The unique name of this series. | +
param summary: | The summary of the purpose and focus of development +of this series. | +
param branch: | The bazaar branch that contains the code for +this series. | +
param releasefileglob: | |
The public URL pattern where release files can +be automatically downloaded from and linked to this series. | +
Name
+The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.
+ +Summary
+A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".
+ +Branch
+The Bazaar branch for this series. Leave blank if this series is not maintained in Bazaar.
+ +Release URL pattern
+A URL pattern that matches releases that are part of this series. Launchpad automatically scans this site to import new releases. Example: http://ftp.gnu.org/gnu/emacs/emacs-21.*.tar.gz
+ +Active
+Whether or not this item is active.
+ +All specifications
+A list of all specifications, regardless of status or approval or completion, for this object.
+ +Branch sharing policy
+Sharing policy for this project's branches.
+ +Brand
+A large image of exactly 192x192 pixels, that will be displayed on this project's home page in Launchpad. It should be no bigger than 100kb in size.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Bug sharing policy
+Sharing policy for this project's bugs.
+ +Bug Supervisor
+The Launchpad id of the person or team (preferred) responsible for bug management.
+ +Commercial subscriptions
+An object which contains the timeframe and the voucher code of a subscription.
+ +Commercial subscription is due
+Whether the project's licensing requires a new commercial subscription to use launchpad.
+ +Date Created
+The date this project was created in Launchpad.
+ +Description
+Details about the project's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.
+ +Development focus
+The series that represents the master or trunk branch. The Bazaar URL lp:<project> points to the development focus series branch.
+ +Display Name
+The name of the project as it would appear in a +paragraph.
+ +Download URL
+The full URL where downloads for this project +are located, if available. Please include the http://
+ +Driver
+This person or team will be able to set feature goals for and approve bug targeting or backporting for ANY major series in this project. You might want to leave this blank and just appoint a team for each specific series, rather than having one project team that does it all.
+ +Freshmeat Project
+The Freshmeat project name for +this project, if it is in freshmeat. [DEPRECATED]
+ +Homepage URL
+The project home page. Please include +the http://
+ +Icon
+A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this project. The icon will be displayed next to the project name everywhere in Launchpad that we refer to the project and link to it.
+ +Information Type
+The type of data contained in this item.
+ +Is Permitted
+Whether the project's licensing qualifies for free hosting or the project has an up-to-date subscription.
+ +Licence approved
+The project is legitimate and its licence appears valid. Not applicable to 'Other/Proprietary'.
+ +Description of additional licences
+Description of licences that do not appear in the list above.
+ +Logo
+An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this project. It should be no bigger than 50kb in size.
+ +Name
+At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs as shown above.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Maintainer
+The restricted team, moderated team, or person who maintains the project information in Launchpad.
+ +Product is confidential
+This product is visible only to those with access grants.
+ +Programming Languages
+A comma delimited list of programming +languages used for this project.
+ +Part of
+Project group. This is an overarching initiative that includes several related projects. For example, the Mozilla Project produces Firefox, Thunderbird and Gecko. This information is used to group those projects in a coherent way. If you make this project part of a group, the group preferences and decisions around bug tracking, translation and security policy will apply to this project.
+ +Project reviewed
+Whether or not this project has been reviewed. If you looked at the project and how it uses Launchpad, you reviewed it.
+ +Qualifies for free hosting
+Whether the project's licensing qualifies it for free use of launchpad.
+ +Registrant
+This person registered the project in Launchpad.
+ +Remote bug tracker project id
+Some bug trackers host multiple projects at the same URL and require an identifier for the specific project.
+ +Notes for the project reviewer
+Notes on the project's licence, editable only by reviewers (Admins and Commercial Admins).
+ +Screenshots URL
+The full URL for screenshots of this project, +if available. Please include the http://
+ +Sourceforge Project
+The SourceForge project name for +this project, if it is in sourceforge.
+ +Blueprint sharing policy
+Sharing policy for this project's specifications.
+ +Summary
+A short paragraph to introduce the project's work.
+ +Title
+The project title. Should be just a few words.
+ +Translation focus
+Project series that translators should focus on.
+ +Translation group
+The translation group that helps review translations for this project or distribution. The group's role depends on the permissions policy selected below.
+ +Translation permissions policy
+The policy this project or distribution uses to balance openness and control for their translations.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +Valid specifications
+All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal
+ +VCS
+Version control system for this project's code.
+ +Wiki URL
+The full URL of this project's wiki, if it has +one. Please include the http://
+ +Active
+Whether or not this item is active.
+ +Branch sharing policy
+Sharing policy for this project's branches.
+ +Brand
+A large image of exactly 192x192 pixels, that will be displayed on this project's home page in Launchpad. It should be no bigger than 100kb in size.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Bug sharing policy
+Sharing policy for this project's bugs.
+ +Bug Supervisor
+The Launchpad id of the person or team (preferred) responsible for bug management.
+ +Commercial subscriptions
+An object which contains the timeframe and the voucher code of a subscription.
+ +Description
+Details about the project's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.
+ +Development focus
+The series that represents the master or trunk branch. The Bazaar URL lp:<project> points to the development focus series branch.
+ +Display Name
+The name of the project as it would appear in a +paragraph.
+ +Download URL
+The full URL where downloads for this project +are located, if available. Please include the http://
+ +Driver
+This person or team will be able to set feature goals for and approve bug targeting or backporting for ANY major series in this project. You might want to leave this blank and just appoint a team for each specific series, rather than having one project team that does it all.
+ +Freshmeat Project
+The Freshmeat project name for +this project, if it is in freshmeat. [DEPRECATED]
+ +Homepage URL
+The project home page. Please include +the http://
+ +Icon
+A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this project. The icon will be displayed next to the project name everywhere in Launchpad that we refer to the project and link to it.
+ +Information Type
+The type of data contained in this item.
+ +Licence approved
+The project is legitimate and its licence appears valid. Not applicable to 'Other/Proprietary'.
+ +Description of additional licences
+Description of licences that do not appear in the list above.
+ +Logo
+An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this project. It should be no bigger than 50kb in size.
+ +Name
+At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs as shown above.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Maintainer
+The restricted team, moderated team, or person who maintains the project information in Launchpad.
+ +Programming Languages
+A comma delimited list of programming +languages used for this project.
+ +Part of
+Project group. This is an overarching initiative that includes several related projects. For example, the Mozilla Project produces Firefox, Thunderbird and Gecko. This information is used to group those projects in a coherent way. If you make this project part of a group, the group preferences and decisions around bug tracking, translation and security policy will apply to this project.
+ +Project reviewed
+Whether or not this project has been reviewed. If you looked at the project and how it uses Launchpad, you reviewed it.
+ +Remote bug tracker project id
+Some bug trackers host multiple projects at the same URL and require an identifier for the specific project.
+ +Notes for the project reviewer
+Notes on the project's licence, editable only by reviewers (Admins and Commercial Admins).
+ +Screenshots URL
+The full URL for screenshots of this project, +if available. Please include the http://
+ +Sourceforge Project
+The SourceForge project name for +this project, if it is in sourceforge.
+ +Blueprint sharing policy
+Sharing policy for this project's specifications.
+ +Summary
+A short paragraph to introduce the project's work.
+ +Translation focus
+Project series that translators should focus on.
+ +Translation group
+The translation group that helps review translations for this project or distribution. The group's role depends on the permissions policy selected below.
+ +Translation permissions policy
+The policy this project or distribution uses to balance openness and control for their translations.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +VCS
+Version control system for this project's code.
+ +Wiki URL
+The full URL of this project's wiki, if it has +one. Please include the http://
+ +A specific release (i.e. version) of a product.
+For example: Mozilla 1.7.2 or Apache 2.0.48.
+ +Add file to the library and link to this IProductRelease.
+The signature file will also be added if available.
+param filename: | Name of the file being uploaded. | +
---|---|
param file_content: | |
io.BytesIO or binary file object. | +|
param content_type: | |
A MIME content type string. | +|
param uploader: | The person who uploaded the file. | +
param signature_filename: | |
Name of the uploaded gpg signature file. | +|
param signature_content: | |
io.BytesIO or binary file object. | +|
param file_type: | |
An UpstreamFileType enum value. | +|
param description: | |
Info about the file. | +|
returns: | IProductReleaseFile object. | +
raises: | InvalidFilename if the filename is invalid or a duplicate +of a file previously added to the release. | +
Description
+A detailed description of the file contents
+ +Delete this release.
+This method must not be used if this release has any +release files associated with it.
+ +Changelog
+A description of every change in the release.
+ +Date Created
+The date this project release was created in Launchpad.
+ +Date released
+The date this release was published. Before release, this should have an estimated release date.
+ +Project release files
+A list of files for this release.
+ +Milestone for this release
+A release requires a corresponding milestone that is not attached to another release.
+ +The registrant of this release.
+The person or who registered this release.
+ +Release notes
+A description of important new features (though the changelog below might repeat some of this information).
+ +Version
+The specific version number assigned to this release. Letters and numbers are acceptable, for releases like "1.2rc3".
+ +Changelog
+A description of every change in the release.
+ +Date released
+The date this release was published. Before release, this should have an estimated release date.
+ +Milestone for this release
+A release requires a corresponding milestone that is not attached to another release.
+ +The registrant of this release.
+The person or who registered this release.
+ +Release notes
+A description of important new features (though the changelog below might repeat some of this information).
+ +Upload date
+The date this file was uploaded
+ +Description
+A detailed description of the file contents
+ +File
+The file contents.
+ +Project release
+The parent product release.
+ +File signature
+The file signature.
+ +Description
+A detailed description of the file contents
+ +Project release
+The parent product release.
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Return all the subscriptions with the specified levels.
+return: | A sequence of IStructuralSubscription. | +
---|
Return entries in the translation import queue for this entity.
+arg import_status: | |
---|---|
RosettaImportStatus DB Schema entry. | +|
arg file_extension: | |
String with the file type extension, usually 'po' +or 'pot'. | +
If one of both of 'import_status' or 'file_extension' are given, the +returned entries are filtered based on those values.
+ +Status
+Show only entries with this status
+ +Filename extension
+Show only entries with this filename suffix
+ +Return an iterator over all its translation templates.
+The returned templates are either obsolete or current.
+return: | A sequence of IPOTemplate. | +
---|
Return basic timeline data useful for creating a diagram.
+The number of milestones returned is limited.
+ +Add a bug subscription for this structure.
+This method is used to create a new IStructuralSubscription for the +target. This initially has a single filter which will allow all +notifications will be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription. | +
Add a bug subscription filter for this structure.
+This method is used to create a new IBugSubscriptionFilter for the +target. It will initially allow all notifications to be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription filter. | +
Remove a subscription to bugs from this structure.
+This will delete all associated filters.
+subscriber: | The IPerson who will be unsubscribed. If omitted, +unsubscribed_by will be used. | +
---|---|
unsubscribed_by: | |
The IPerson removing the subscription. | +
Name
+Only letters, numbers, and simple punctuation are allowed.
+ +Date Targeted
+Example: 2005-11-24
+ +Summary
+A summary of the features and status of this milestone.
+ +Code name
+An alternative name for the milestone.
+ +Active
+Whether or not this series is stable and supported, or under current development. This excludes series which are experimental or obsolete.
+ +All specifications
+A list of all specifications, regardless of status or approval or completion, for this object.
+ +Branch
+The Bazaar branch for this series. Leave blank if this series is not maintained in Bazaar.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Display Name
+Display name. In this case we have removed the underlying database field, and this attribute just returns the name.
+ +Release manager
+The person or team responsible for decisions about features and bugs that will be targeted to this series. If you don't nominate someone here, then the owners and drivers of the project and project group will automatically have those permissions.
+ +Name
+The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Owner
+Project owner, either a valid Person or Team
+ +Release URL pattern
+A URL pattern that matches releases that are part of this series. Launchpad automatically scans this site to import new releases. Example: http://ftp.gnu.org/gnu/emacs/emacs-21.*.tar.gz
+ +Summary
+A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".
+ +Title
+The product series title. Should be just a few words.
+ +Import settings
+Specify which files will be imported from the source code branch.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +Valid specifications
+All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal
+ +Active
+Whether or not this series is stable and supported, or under current development. This excludes series which are experimental or obsolete.
+ +Branch
+The Bazaar branch for this series. Leave blank if this series is not maintained in Bazaar.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Display Name
+Display name. In this case we have removed the underlying database field, and this attribute just returns the name.
+ +Release manager
+The person or team responsible for decisions about features and bugs that will be targeted to this series. If you don't nominate someone here, then the owners and drivers of the project and project group will automatically have those permissions.
+ +Name
+The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.
+ +Owner
+Project owner, either a valid Person or Team
+ +Release URL pattern
+A URL pattern that matches releases that are part of this series. Launchpad automatically scans this site to import new releases. Example: http://ftp.gnu.org/gnu/emacs/emacs-21.*.tar.gz
+ +Summary
+A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".
+ +Title
+The product series title. Should be just a few words.
+ +Import settings
+Specify which files will be imported from the source code branch.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +Return all the subscriptions with the specified levels.
+return: | A sequence of IStructuralSubscription. | +
---|
Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Returns all merge proposals of a given status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param eager_load: | |
If True, load related objects for the whole +collection. | +|
returns: | A list of IBranchMergeProposal. | +
Returns all branches with the given lifecycle status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param modified_since: | |
If set, filters the branches being returned +to those that have been modified since the specified date/time. | +|
param eager_load: | |
If True load related objects for the whole +collection. | +|
returns: | A list of IBranch. | +
Add a bug subscription for this structure.
+This method is used to create a new IStructuralSubscription for the +target. This initially has a single filter which will allow all +notifications will be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription. | +
Add a bug subscription filter for this structure.
+This method is used to create a new IBugSubscriptionFilter for the +target. It will initially allow all notifications to be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription filter. | +
Remove a subscription to bugs from this structure.
+This will delete all associated filters.
+subscriber: | The IPerson who will be unsubscribed. If omitted, +unsubscribed_by will be used. | +
---|---|
unsubscribed_by: | |
The IPerson removing the subscription. | +
Active
+Whether or not this item is active.
+ +All specifications
+A list of all specifications, regardless of status or approval or completion, for this object.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +If I’m reporting a bug, I should include, if possible
+These guidelines will be shown to anyone reporting a bug.
+ +Bug Tracker
+The bug tracker the projects in this project group use.
+ +Date Created
+The date this project group was created in Launchpad.
+ +Description
+Details about the project group's work, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.
+ +Display Name
+Appropriately capitalised, and typically ending in "Project". Examples: the Apache Project, the Mozilla Project, the Gimp Project.
+ +Driver
+This is a project group-wide appointment. Think carefully here! This person or team will be able to set feature goals and approve bug targeting and backporting for ANY series in ANY project in this group. You can also appoint drivers at the level of a specific project or series. So you may just want to leave this space blank, and instead let the individual projects and series have drivers.
+ +Freshmeat Project Name
+The Freshmeat project name for this project group, if it is in Freshmeat. [DEPRECATED]
+ +Homepage Content
+The content of this project group's home page. Edit this and it will be displayed for all the world to see. It is NOT a wiki so you cannot undo changes.
+ +Homepage URL
+The project group home page. Please include the http://
+ +Icon
+A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this project group. The icon will be displayed in Launchpad everywhere that we link to this project group. For example in listings or tables of active project groups.
+ +Logo
+An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this project group. It should be no bigger than 50kb in size.
+ +Brand
+A large image of exactly 192x192 pixels, that will be displayed on this project group's home page in Launchpad. It should be no bigger than 100kb in size.
+ +Name
+A unique name, used in URLs, identifying the project group. All lowercase, no special characters. Examples: apache, mozilla, gimp.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Maintainer
+The restricted team, moderated team, or person who maintains the project group information in Launchpad.
+ +Registrant
+Project group registrant. Must be a valid Launchpad Person.
+ +Reviewed
+Whether or not this project group has been reviewed.
+ +SourceForge Project Name
+The SourceForge project name for this project group, if it is in SourceForge.
+ +Project Group Summary
+A short paragraph to introduce the project group's work.
+ +Title
+The full name of the project group, which can contain spaces, special characters, etc.
+ +Translation group
+The translation group that helps review translations for this project or distribution. The group's role depends on the permissions policy selected below.
+ +Translation permissions policy
+The policy this project or distribution uses to balance openness and control for their translations.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +Valid specifications
+All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal
+ +Wiki URL
+The URL of this project group's wiki, if it has one. Please include the http://
+ +Active
+Whether or not this item is active.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +If I’m reporting a bug, I should include, if possible
+These guidelines will be shown to anyone reporting a bug.
+ +Bug Tracker
+The bug tracker the projects in this project group use.
+ +Description
+Details about the project group's work, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.
+ +Display Name
+Appropriately capitalised, and typically ending in "Project". Examples: the Apache Project, the Mozilla Project, the Gimp Project.
+ +Driver
+This is a project group-wide appointment. Think carefully here! This person or team will be able to set feature goals and approve bug targeting and backporting for ANY series in ANY project in this group. You can also appoint drivers at the level of a specific project or series. So you may just want to leave this space blank, and instead let the individual projects and series have drivers.
+ +Freshmeat Project Name
+The Freshmeat project name for this project group, if it is in Freshmeat. [DEPRECATED]
+ +Homepage Content
+The content of this project group's home page. Edit this and it will be displayed for all the world to see. It is NOT a wiki so you cannot undo changes.
+ +Homepage URL
+The project group home page. Please include the http://
+ +Icon
+A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this project group. The icon will be displayed in Launchpad everywhere that we link to this project group. For example in listings or tables of active project groups.
+ +Logo
+An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this project group. It should be no bigger than 50kb in size.
+ +Brand
+A large image of exactly 192x192 pixels, that will be displayed on this project group's home page in Launchpad. It should be no bigger than 100kb in size.
+ +Name
+A unique name, used in URLs, identifying the project group. All lowercase, no special characters. Examples: apache, mozilla, gimp.
+ +Maintainer
+The restricted team, moderated team, or person who maintains the project group information in Launchpad.
+ +Reviewed
+Whether or not this project group has been reviewed.
+ +SourceForge Project Name
+The SourceForge project name for this project group, if it is in SourceForge.
+ +Project Group Summary
+A short paragraph to introduce the project group's work.
+ +Title
+The full name of the project group, which can contain spaces, special characters, etc.
+ +Translation group
+The translation group that helps review translations for this project or distribution. The group's role depends on the permissions policy selected below.
+ +Translation permissions policy
+The policy this project or distribution uses to balance openness and control for their translations.
+ +Type of service for translations application
+Where does this pillar do translations?
+ +Wiki URL
+The URL of this project group's wiki, if it has one. Please include the http://
+ +Return all the subscriptions with the specified levels.
+return: | A sequence of IStructuralSubscription. | +
---|
Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Add a bug subscription for this structure.
+This method is used to create a new IStructuralSubscription for the +target. This initially has a single filter which will allow all +notifications will be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription. | +
Add a bug subscription filter for this structure.
+This method is used to create a new IBugSubscriptionFilter for the +target. It will initially allow all notifications to be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription filter. | +
Remove a subscription to bugs from this structure.
+This will delete all associated filters.
+subscriber: | The IPerson who will be unsubscribed. If omitted, +unsubscribed_by will be used. | +
---|---|
unsubscribed_by: | |
The IPerson removing the subscription. | +
Create a new ProductRelease.
+param owner: | IPerson object who manages the release. | +
---|---|
param datereleased: | |
Date of the product release. | +|
param changelog: | |
Detailed changes in each version. | +|
param release_notes: | |
Overview of changes in each version. | +|
returns: | IProductRelease object. | +
Date released
+The date this release was published. Before release, this should have an estimated release date.
+ +Changelog
+A description of every change in the release.
+ +Release notes
+A description of important new features (though the changelog below might repeat some of this information).
+ +Code name
+An alternative name for the milestone.
+ +Date Targeted
+Example: 2005-11-24
+ +Active
+Whether or not this object should be shown in web forms for targeting.
+ +Name
+Only letters, numbers, and simple punctuation are allowed.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Summary
+A summary of the features and status of this milestone.
+ +Code name
+An alternative name for the milestone.
+ +Date Targeted
+Example: 2005-11-24
+ +Active
+Whether or not this object should be shown in web forms for targeting.
+ +Name
+Only letters, numbers, and simple punctuation are allowed.
+ +Summary
+A summary of the features and status of this milestone.
+ +Mark this question as INVALID.
+Add an IQuestionMessage with action REJECT. The question status is +changed to INVALID. The created message is set as the question answer +and its owner as the question answerer. The datelastresponse and +date_solved are updated to the message creation.
+Only answer contacts for the question target, the target owner or a +member of the admin team can reject a request. All questions can be +rejected.
+Return the created IQuestionMessage.
+This method should fire an IObjectCreatedEvent for the created +IQuestionMessage and an IObjectModifiedEvent for the question.
+user: | The user rejecting the request. | +
---|---|
comment: | A string or IMessage containing an explanation of the +rejection. | +
datecreated: | Date for the message. Defaults to the current time. | +
Subscribe person to the question.
+param person: | the subscriber. | +
---|---|
param subscribed_by: | |
the person who created the subscription. | +|
return: | an IQuestionSubscription. | +
Unsubscribe person from the question.
+param person: | the subscriber. | +
---|---|
param unsubscribed_by: | |
the person who removed the subscription. | +
Set the visible attribute on a question message.
+This is restricted to Launchpad admins and registry members, and will +return a HTTP Error 401: Unauthorized error for non-admin callers.
+ +Answer
+The IQuestionMessage that contains the answer confirmed by the owner as providing a solution to their problem.
+ +Answered By
+The person who last provided a response intended to resolve the question.
+ +Assignee
+The person responsible for helping to resolve the question.
+ +Date Due
+The date by which we should have resolved this question.
+ +Date Last Queried
+The date on which we last heard from the customer (owner).
+ +Date last Responded
+The date on which we last communicated with the customer. The combination of datelastquery and datelastresponse tells us in whose court the ball is.
+ +Date Answered
+The date on which the question owner confirmed that the question is Solved.
+ +Description
+Include as much detail as possible: what you’re trying to achieve, what steps you take, what happens, and what you think should happen instead.
+ +Question Number
+The tracking number for this question.
+ +Language
+The language in which this question is written.
+ +Messages
+The list of messages that were exchanged as part of this question , sorted from first to last.
+ +This question is about
+The distribution, source package, or project the question pertains to.
+ +Summary
+A one-line summary of the issue or problem.
+ +Assignee
+The person responsible for helping to resolve the question.
+ +Description
+Include as much detail as possible: what you’re trying to achieve, what steps you take, what happens, and what you think should happen instead.
+ +Language
+The language in which this question is written.
+ +This question is about
+The distribution, source package, or project the question pertains to.
+ +Summary
+A one-line summary of the issue or problem.
+ +Message content
+The new message content string
+ +Human readable Message index.
+The message's index in the question's list of messages.
+ +Question status after message
+The status of the question after the transition related the action operated by this message.
+ +The question related to this message.
+An IQuestion object.
+ +Message revision history
+Revision history of this message, sorted in ascending order.
+ +Message visibility.
+Whether or not the message is visible.
+ +Person
+The person's Launchpad ID or email address.
+ +Return the questions from the collection matching search criteria.
+param search_text: | |
---|---|
A string that is matched against the question +title and description. If None, the search_text is not included as +a filter criteria. | +|
param status: | A sequence of QuestionStatus Items. If None or an empty +sequence, the status is not included as a filter criteria. The +default is to match all status except Expired and Invalid. | +
param language: | An ILanguage or a sequence of ILanguage objects to +match against the question's language. If None or an empty +sequence, the language is not included as a filter criteria. | +
param owner: | The IPerson that created the question. | +
param needs_attention_from: | |
Selects questions that need attention +from an IPerson. These are the questions in the NEEDSINFO or +ANSWERED state owned by the person. The questions not owned by the +person but on which the person requested more information or gave +an answer and that are back in the OPEN state are also included. | +|
param sort: | An attribute of QuestionSort. If None, a default value is +used. When there is a search_text value, the default is to sort by +RELEVANCY, otherwise results are sorted NEWEST_FIRST. | +
Return the question by its id, if it is applicable to this target.
+question_id: | A question id. | +
---|
If there is no such question number for this target, return None
+ +Return questions similar to phrase.
+Return a list of question similar to the provided phrase. These +questions will be found using a fuzzy search. The list is +ordered from the most similar question to the least similar question.
+param phrase: | A phrase such as the summary of a question. | +
---|
Return the list of Persons that provide support for a language.
+An answer contact supports questions in their preferred languages.
+ +Return a list of languages spoken by at the answer contacts.
+An answer contact is considered to speak a given language if that +language is listed as one of their preferred languages.
+ +Can the user add or remove the answer contact.
+Users can add or remove themselves or one of the teams they +administered. Admins and target owners can add/remove anyone.
+param person: | The IPerson that is or will be an answer contact. | +
---|---|
param subscribed_by: | |
The IPerson making the change. | +
Add a new answer contact.
+param person: | An IPerson. | +
---|---|
param subscribed_by: | |
The user making the change. | +|
return: | True if the person was added, False if the person already is +an answer contact. | +
raises AddAnswerContactError: | |
When the person or team does no have a +preferred language. | +
Remove an answer contact.
+param person: | An IPerson. | +
---|---|
param subscribed_by: | |
The user making the change. | +|
return: | True if the person was removed, False if the person wasn't an +answer contact. | +
Retrieves the list of URLs for artifacts that exist for this report.
++++
++ + + + param artifact_type: + + The type of artifact for the report. +
Scopes: repository:build_status
+ +Set a new log on an existing status report.
++++
++ + + + + param log_data: The contents of the log, either as bytes or as a file +object. +
Scopes: repository:build_status
+ +Attach a new artifact to an existing status report.
++++
++ + + + param data: The contents of the artifact, either as bytes or as a file +object. ++ param artifact_type: + + The type of the artifact. This may currently +only be RevisionStatusArtifactType.BINARY, but more types may +be added in future. +
Scopes: repository:build_status
+ +Updates a status report.
++++
++ + + + param title: A short title for the report. ++ param url: The external url of the report. ++ param result_summary: + A short summary of the result. ++ param result: The result of the report. ++ param properties: + + A dictionary of general-purpose metadata. +
Scopes: repository:build_status
+ +URL
+The external url of the report.
+ +URL
+The external url of the report.
+ +Find projects for which person has one or more access policy grants.
+param user: | the user making the request. If the user is an admin, then +all projects are returned, else only those for which the user is a +maintainer or driver. | +
---|---|
return: | a collection of projects | +
param user: | the user making the request. If the user is an admin, then +all distributions are returned, else only those for which the user +is a maintainer or driver. | +
---|---|
return: | a collection of distributions | +
Return the bugs shared between the pillar and person.
+The result includes bugtasks rather than bugs since this is what the +pillar filtering is applied to. The shared bug can be obtained simply +by reading the bugtask.bug attribute.
+param user: | the user making the request. Only bugs visible to the +user will be included in the result. | +
---|---|
return: | a collection of bug tasks. | +
Return the branches shared between the pillar and person.
+param user: | the user making the request. Only branches visible to the +user will be included in the result. | +
---|---|
return: | a collection of branches | +
Return the Git repositories shared between the pillar and person.
+param user: | the user making the request. Only Git repositories +visible to the user will be included in the result. | +
---|---|
return: | a collection of Git repositories. | +
Return the specifications shared between the pillar and person.
+param user: | the user making the request. Only branches visible to the +user will be included in the result. | +
---|---|
return: | a collection of specifications. | +
Return people/teams who can see pillar artifacts.
+Ensure grantee has the grants for information types on a pillar.
+param pillar: | the pillar for which to grant access | +
---|---|
param grantee: | the person or team to grant | +
param user: | the user making the request | +
param permissions: | |
a dict of {InformationType: SharingPermission} +if SharingPermission is ALL, then create an access policy grant +if SharingPermission is SOME, then remove any access policy grants +if SharingPermission is NONE, then remove all grants for the access +policy | +
Remove a grantee from a pillar.
+param pillar: | the pillar from which to remove access | +
---|---|
param grantee: | the person or team to remove | +
param user: | the user making the request | +
param information_types: | |
if None, remove all access, otherwise just +remove the specified access_policies | +
Remove a grantee's access to the specified artifacts.
+param pillar: | the pillar from which to remove access | +
---|---|
param grantee: | the person or team for whom to revoke access | +
param user: | the user making the request | +
param bugs: | the bugs for which to revoke access | +
param branches: | the branches for which to revoke access | +
param gitrepositories: | |
the Git repositories for which to revoke access | +|
param snaps: | The snap recipes for which to revoke access | +
param specifications: | |
the specifications for which to revoke access | +|
param ocirecipes: | |
The OCI recipes for which to revoke access | +|
param vulnerabilities: | |
The vulnerabilities for which to revoke access | +
Ensure a grantee has an access grant to the specified artifacts.
+param grantees: | the people or teams for whom to grant access | +
---|---|
param user: | the user making the request | +
param bugs: | the bugs for which to grant access | +
param branches: | the branches for which to grant access | +
param gitrepositories: | |
the Git repositories for which to grant access | +|
param snaps: | the snap recipes for which to grant access | +
param specifications: | |
the specifications for which to grant access | +|
param ocirecipes: | |
the OCI recipes for which to grant access | +|
param vulnerabilities: | |
the vulnerabilities for which to grant access | +
Update the sharing policies for a pillar.
+param pillar: | the pillar to update | +
---|---|
param branch_sharing_policy: | |
the new branch sharing policy | +|
param bug_sharing_policy: | |
the new bug sharing policy | +|
param specification_sharing_policy: | |
new specification sharing policy | +
Name
+The name of the service, used to generate the url.
+ +Name
+The name of the service, used to generate the url.
+ +Return the IArchiveDependency object for the given dependency.
+param dependency: | |
---|---|
an IArchive. | +|
return: | an IArchiveDependency, or None if a corresponding object +could not be found. | +
Add an archive dependency for this snap base.
+param dependency: | |
---|---|
an IArchive. | +|
param pocket: | a PackagePublishingPocket. | +
param component: | |
an optional component name; if not given, the +archive dependency will use the component used for dependencies +on the primary archive. | +|
raise: | ArchiveDependencyError if the given dependency does not +fit this snap base. | +
return: | an IArchiveDependency. | +
Remove the archive dependency on the given archive.
+param dependency: | |
---|---|
an IArchive. | +
Source snap channels for builds
+A dictionary mapping snap names to channels to use when building snaps that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.
+ +Features supported by this base
+A dictionary designating the features supported by the base. Key is the name of a feature, value is a boolean indicating whether the feature is supported or not.
+ +Is default?
+Whether this base is the default for snaps that do not specify a base.
+ +Processors
+The architectures that the snap base supports.
+ +Registrant
+The person who registered this base.
+ +Source snap channels for builds
+A dictionary mapping snap names to channels to use when building snaps that specify this base. The special '_byarch' key may have a mapping of architecture names to mappings of snap names to channels, which if present override the channels declared at the top level when building for those architectures.
+ +Features supported by this base
+A dictionary designating the features supported by the base. Key is the name of a feature, value is a boolean indicating whether the feature is supported or not.
+ +URLs for all the files produced by this build.
+return: | A collection of URLs for this build. | +
---|
Restore the build record to its initial state.
+Build record loses its history, is moved to NEEDSBUILD and a new +non-scored BuildQueue entry is created for it.
+ +Cancel the build if it is either pending or in progress.
+Check the can_be_cancelled property prior to calling this method to +find out if cancelling the build is possible.
+If the build is in progress, it is marked as CANCELLING until the +buildd manager terminates the build and marks it CANCELLED. If the +build is not in progress, it is marked CANCELLED immediately and is +removed from the build queue.
+If the build is not in a cancellable state, this method is a no-op.
+ +Schedule an upload of this build to the store.
+raises CannotScheduleStoreUpload: | |
---|---|
if the build is not in a state +where an upload can be scheduled. | +
Build Log URL
+A URL for the build log. None if there is no log available.
+ +Builder
+The builder assigned to this job.
+ +Status
+The current status of the job.
+ +Can be cancelled
+Whether this build record can be cancelled.
+ +Can be rescored
+Whether this build record can be rescored manually.
+ +Can be retried
+Whether this build record can be retried.
+ +Source snap channels to use for this build.
+A dictionary mapping snap names to channels to use for this build. +Supported snap names: 'core', 'core18', 'core20', 'core22', 'core24', 'snapcraft', 'snapd'
+ +Date finished
+The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.
+ +Date started
+The timestamp when the build farm job was started.
+ +Date finished
+The timestamp when the build farm job was finished.
+ +Date created
+The timestamp when the build farm job was created.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +Duration
+Duration interval, calculated when the result gets collected.
+ +The pocket for which to build.
+The package stream within the source archive and distribution series to use when building the snap package. If the source archive is a PPA, then the PPA's archive dependencies will be used to select the pocket in the distribution's primary archive.
+ +Revision ID
+The revision ID of the branch used for this build, if available.
+ +Store upload error message
+The error message, if any, from the last attempt to upload this snap build to the store. (Deprecated; use store_upload_error_messages instead.)
+ +Store upload error messages
+A list of dict(message, link) where message is an error description and link, if any, is an external link to extra details, from the last attempt to upload this snap build to the store.
+ +Store revision
+The revision assigned to this package by the store.
+ +Store URL
+The URL to use for managing this package in the store.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Status
+The current status of the job.
+ +Source snap channels to use for this build.
+A dictionary mapping snap names to channels to use for this build. +Supported snap names: 'core', 'core18', 'core20', 'core22', 'core24', 'snapcraft', 'snapd'
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +param store_upload_revision: | |
---|---|
The revision assigned by the store. | +|
param user: | The IPerson requesting this information. | +
return: | An 'ISnapBuild' or None. | +
Return a dictionary containing a summary of build information.
+param request_ids: | |
---|---|
A list of snap build request IDs. | +|
param build_ids: | |
A list of snap build IDs. | +|
param user: | The IPerson requesting this information. | +
return: | A dict of {"requests", "builds"}, consisting of the overall +status summaries for the given snap build requests and snap +builds respectively. | +
Active
+Deliver details of subscribed events.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +Create and return automatic builds for this snap package.
+This webservice API method is deprecated. It is normally better to +use the requestBuilds method instead, which can make dispatching +decisions based on the contents of snapcraft.yaml.
+param allow_failures: | |
---|---|
If True, log exceptions other than "already +pending" from individual build requests; if False, raise them to +the caller. | +|
param 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. | +|
param logger: | An optional logger. | +
raises CannotRequestAutoBuilds: | |
if no auto_build_archive or +auto_build_pocket is set. | +|
raises IncompatibleArguments: | |
if no distro_series is set. | +|
return: | A sequence of ISnapBuild instances. | +
Begin authorizing uploads of this snap package to the store.
+This is intended for use by third-party sites integrating with +Launchpad. Most users should visit <snap URL>/+authorize instead.
+param success_url: | |
---|---|
The URL to redirect to when authorization is +complete. If None (only allowed for internal use), defaults to +the canonical URL of the snap. | +|
raises CannotAuthorizeStoreUploads: | |
if the snap package is not +properly configured for store uploads. | +|
raises BadRequestPackageUploadResponse: | |
if the store returns an +error or a response without a macaroon when asked to issue a +package_upload macaroon. | +|
raises SnapAuthorizationBadGeneratedMacaroon: | |
if the package_upload +macaroon returned by the store has unsuitable SSO caveats. | +|
return: | The SSO caveat ID from the package_upload macaroon returned +by the store. The third-party site should acquire a discharge +macaroon for this caveat using OpenID and then call +completeAuthorization. | +
Complete authorizing uploads of this snap package to the store.
+This is intended for use by third-party sites integrating with +Launchpad.
+param root_macaroon: | |
---|---|
A serialized root macaroon returned by the +store. Only required if not already set by beginAuthorization. | +|
param discharge_macaroon: | |
The serialized discharge macaroon +returned by SSO via OpenID. Only required if the root macaroon +has a third-party caveat addressed to SSO. | +|
raises CannotAuthorizeStoreUploads: | |
if the snap package is not +properly configured for store uploads. | +
Serialized root macaroon
+Only required if not already set by beginAuthorization.
+ +Serialized discharge macaroon
+Only required if root macaroon has SSO third-party caveat.
+ +Request that the snap package be built.
+param requester: | |
---|---|
The person requesting the build. | +|
param archive: | The IArchive to associate the build with. | +
param distro_arch_series: | |
The architecture to build for. | +|
param pocket: | The pocket that should be targeted. | +
param snap_base: | |
The ISnapBase to use for this build. | +|
param channels: | A dictionary mapping snap names to channels to use +for this build. | +
param build_request: | |
The ISnapBuildRequest job being processed, +if any. | +|
param target_architectures: | |
The optional list of target architectures +to build the snap for. | +|
return: | ISnapBuild. | +
Source snap channels to use for this build.
+A dictionary mapping snap names to channels to use for this build. +Supported snap names: 'core', 'core18', 'core20', 'core22', 'core24', 'snapcraft', 'snapd'
+ +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.
+param requester: | |
---|---|
The person requesting the builds. | +|
param archive: | The IArchive to associate the builds with. | +
param pocket: | The pocket that should be targeted. | +
param channels: | A dictionary mapping snap names to channels to use +for these builds. | +
return: | An ISnapBuildRequest. | +
Source snap channels to use for this build.
+A dictionary mapping snap names to channels to use for this build. +Supported snap names: 'core', 'core18', 'core20', 'core22', 'core24', 'snapcraft', 'snapd'
+ +Allow external network access
+Allow access to external network resources via a proxy. Resources hosted on Launchpad itself are always allowed.
+ +Automatically build when branch changes
+Whether this snap package is built automatically when the branch containing its snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe changes.
+ +Source archive for automatic builds
+The archive from which automatic builds of this snap package should be built.
+ +Source snap channels for automatic builds
+A dictionary mapping snap names to channels to use when building this snap package. +Supported snap names: 'core', 'core18', 'core20', 'core22', 'core24', 'snapcraft', 'snapd'
+ +Pocket for automatic builds
+The package stream within the source archive and distribution series to use when building the snap package. If the source archive is a PPA, then the PPA's archive dependencies will be used to select the pocket in the distribution's primary archive.
+ +Bazaar branch
+A Bazaar branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Build source tarball
+Whether builds of this snap package should also build a tarball containing all source code, including external dependencies.
+ +All builds of this snap package.
+All builds of this snap package, sorted in descending order of finishing (or starting if not completed successfully).
+ +Can upload to store
+Whether everything is set up to allow uploading builds of this snap package to the store.
+ +Completed builds of this snap package.
+Completed builds of this snap package, sorted in descending order of finishing.
+ +Description
+A description of the snap package.
+ +Distro Series
+The series for which the snap package should be built. If not set, Launchpad will infer an appropriate series from snapcraft.yaml.
+ +Git branch path
+The path of the Git branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Git branch
+The Git branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Git repository
+A Git repository with a branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Git repository URL
+The URL of a Git repository with a branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Information type
+The type of information contained in this Snap recipe.
+ +Snap recipe name
+The name of the snap build recipe.
+ +Owner
+The owner of this snap package.
+ +Pending builds of this snap package.
+Pending builds of this snap package, sorted in descending order of creation.
+ +Private
+Whether or not this snap is private.
+ +Enable Ubuntu Pro
+Allow building this snap recipe using dependencies from Ubuntu Pro, if configured for the corresponding snap base.
+ +Processors
+The architectures for which the snap package should be built.
+ +Registrant
+The person who registered this snap package.
+ +Require virtualized builders
+Only build this snap package on virtual builders.
+ +Store channels
+Channels to release this snap package to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.
+ +Registered store package name
+The registered name of this snap package in the store.
+ +Store series
+The series in which this snap package should be published in the store.
+ +Automatically upload to store
+Whether builds of this snap package are automatically uploaded to the store.
+ +Allow external network access
+Allow access to external network resources via a proxy. Resources hosted on Launchpad itself are always allowed.
+ +Automatically build when branch changes
+Whether this snap package is built automatically when the branch containing its snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe changes.
+ +Source archive for automatic builds
+The archive from which automatic builds of this snap package should be built.
+ +Source snap channels for automatic builds
+A dictionary mapping snap names to channels to use when building this snap package. +Supported snap names: 'core', 'core18', 'core20', 'core22', 'core24', 'snapcraft', 'snapd'
+ +Pocket for automatic builds
+The package stream within the source archive and distribution series to use when building the snap package. If the source archive is a PPA, then the PPA's archive dependencies will be used to select the pocket in the distribution's primary archive.
+ +Bazaar branch
+A Bazaar branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Build source tarball
+Whether builds of this snap package should also build a tarball containing all source code, including external dependencies.
+ +Description
+A description of the snap package.
+ +Distro Series
+The series for which the snap package should be built. If not set, Launchpad will infer an appropriate series from snapcraft.yaml.
+ +Git branch path
+The path of the Git branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Git branch
+The Git branch containing a snap/snapcraft.yaml, build-aux/snap/snapcraft.yaml, snapcraft.yaml, or .snapcraft.yaml recipe at the top level.
+ +Information type
+The type of information contained in this Snap recipe.
+ +Snap recipe name
+The name of the snap build recipe.
+ +Owner
+The owner of this snap package.
+ +Private
+Whether or not this snap is private.
+ +Enable Ubuntu Pro
+Allow building this snap recipe using dependencies from Ubuntu Pro, if configured for the corresponding snap base.
+ +Require virtualized builders
+Only build this snap package on virtual builders.
+ +Store channels
+Channels to release this snap package to after uploading it to the store. A channel is defined by a combination of an optional track, a risk, and an optional branch, e.g. '2.1/stable/fix-123', '2.1/stable', 'stable/fix-123', or 'stable'.
+ +Registered store package name
+The registered name of this snap package in the store.
+ +Store series
+The series in which this snap package should be published in the store.
+ +Automatically upload to store
+Whether builds of this snap package are automatically uploaded to the store.
+ +Can infer distro series?
+True if inferring a distro series from snapcraft.yaml is supported for this snappy series.
+ +Registrant
+The person who registered this snappy series.
+ +Usable distro series
+The distro series that can be used for this snappy series.
+ +Can infer distro series?
+True if inferring a distro series from snapcraft.yaml is supported for this snappy series.
+ +Usable distro series
+The distro series that can be used for this snappy series.
+ +Identity
+A dictionary with the identity attributes and values for the social account. The format is specific for each platform. Matrix account attributes: username, homeserver
+ +Identity
+A dictionary with the identity attributes and values for the social account. The format is specific for each platform. Matrix account attributes: username, homeserver
+ +Return entries in the translation import queue for this entity.
+arg import_status: | |
---|---|
RosettaImportStatus DB Schema entry. | +|
arg file_extension: | |
String with the file type extension, usually 'po' +or 'pot'. | +
If one of both of 'import_status' or 'file_extension' are given, the +returned entries are filtered based on those values.
+ +Status
+Show only entries with this status
+ +Filename extension
+Show only entries with this filename suffix
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Return an iterator over all its translation templates.
+The returned templates are either obsolete or current.
+return: | A sequence of IPOTemplate. | +
---|
Returns all merge proposals of a given status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param eager_load: | |
If True, load related objects for the whole +collection. | +|
returns: | A list of IBranchMergeProposal. | +
Returns all branches with the given lifecycle status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param modified_since: | |
If set, filters the branches being returned +to those that have been modified since the specified date/time. | +|
param eager_load: | |
If True load related objects for the whole +collection. | +|
returns: | A list of IBranch. | +
Get the official branch for this package in the given pocket.
+param pocket: | A PackagePublishingPocket. | +
---|---|
return: | An IBranch. | +
Get the official branches for this package.
+This operation returns a {Pocket-name : IBranch} dict.
+return: | A {Pocket-name : IBranch} dict. | +
---|
Set the official branch for the given pocket of this package.
+param pocket: | A PackagePublishingPocket. | +
---|---|
param branch: | The branch to set as the official branch. | +
param registrant: | |
The individual who created this link. | +|
return: | None | +
Create a new code import.
+param registrant: | |
---|---|
The IPerson to record as the registrant of the +import. | +|
param branch_name: | |
The name of the branch or repository to create. | +|
param rcs_type: | The type of the foreign VCS. | +
param target_rcs_type: | |
The type of the branch or repository to +create (Bazaar or Git). | +|
param url: | The URL to import from if the VCS type uses a single URL +(i.e. isn't CVS). | +
param cvs_root: | The CVSROOT for a CVS import. | +
param cvs_module: | |
The module to import for a CVS import. | +|
param owner: | Who should own the created branch or repository, or +None for it to be the same as the registrant, or the caller over +the API. | +
returns: | An instance of ICodeImport. | +
After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Display name
+A displayname, constructed, for this package
+ +Distribution
+The distribution for this source package.
+ +Distribution Series
+The DistroSeries for this SourcePackage
+ +Name
+The text name of this source package.
+ +Official Bug Tags
+The list of bug tags defined as official.
+ +Project series
+The registered project series that this source package is based on. This series may be the same as the one that earlier versions of this source packages were based on.
+ +After reporting a bug, I can expect the following.
+This message of acknowledgement will be displayed to anyone after reporting a bug.
+ +Helpful guidelines for reporting a bug
+These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.
+ +Return all resulted IBinaryPackagePublishingHistory.
+Follow the build record and return every binary publishing record +for any DistroArchSeries in this DistroSeries and in the same +IArchive and Pocket, ordered by architecture tag. If +active_binaries_only is True (the default), then only return +PUBLISHED or PENDING binary publishing records.
+param active_binaries_only: | |
---|---|
If True, only return PUBLISHED or +PENDING publishing records. | +|
return: | a list with all corresponding publishing records. | +
Return a list of IBuild objects in this publishing context.
+The builds are ordered by DistroArchSeries.architecturetag.
+return: | a list of IBuilds. | +
---|
The .changes file URL for this source publication.
+return: | the .changes file URL for this source (a string). | +
---|
URLs for this source publication's uploaded source files.
+param include_meta: | |
---|---|
Return a list of dicts with keys url, size, and +sha256 for each URL instead of a simple list. | +|
return: | A collection of URLs for this source. | +
URLs for this source publication's binary files.
+return: | A collection of URLs for this source. | +
---|
URL of the debdiff file between this and the supplied version.
+param to_version: | |
---|---|
The version of the source package for which you +want to get the diff to. | +|
return: | A URL to the librarian file containing the diff. | +
The URL for this source package release's changelog.
+return: | the changelog file URL for this source (a string). | +
---|
Delete this source and its binaries.
+param removed_by: | |
---|---|
IPerson responsible for the removal. | +|
param removal_comment: | |
optional text describing the removal reason. | +
Change the component and/or section of this publication.
+It is changed only if the argument is not None.
+Return the overridden publishing record, a +ISourcePackagePublishingHistory.
+ +Publication Creator
+The IPerson who created this publication.
+ +Display Name
+Text representation of the current record.
+ +Package Creator
+The IPerson who created the source package.
+ +Package Maintainer
+The IPerson who maintains the source package.
+ +Package Signer
+The IPerson who signed the source package.
+ +Package upload
+The Package Upload that caused the creation of this publication.
+ +The pocket into which this entry is published
+ +Publication sponsor
+The IPerson who sponsored the creation of this publication.
+ +Package Publishing Status
+The status of this publishing record
+ +Display Name
+Text representation of the current record.
+ +Package Publishing Status
+The status of this publishing record
+ +Restore the build record to its initial state.
+Build record loses its history, is moved to NEEDSBUILD and a new +non-scored BuildQueue entry is created for it.
+ +Cancel the build if it is either pending or in progress.
+Check the can_be_cancelled property prior to calling this method to +find out if cancelling the build is possible.
+If the build is in progress, it is marked as CANCELLING until the +buildd manager terminates the build and marks it CANCELLED. If the +build is not in progress, it is marked CANCELLED immediately and is +removed from the build queue.
+If the build is not in a cancellable state, this method is a no-op.
+ +Archive
+The Archive context for this build.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Builder
+The builder assigned to this job.
+ +Status
+The current status of the job.
+ +Can be cancelled
+Whether this build record can be cancelled.
+ +Can be rescored
+Whether this build record can be rescored manually.
+ +Can be retried
+Whether this build record can be retried.
+ +Date finished
+The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.
+ +Date started
+The timestamp when the build farm job was started.
+ +Date finished
+The timestamp when the build farm job was finished.
+ +Date created
+The timestamp when the build farm job was created.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +Duration
+Duration interval, calculated when the result gets collected.
+ +The build targeted pocket.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +Build Log URL
+A URL for the build log. None if there is no log available.
+ +Status
+The current status of the job.
+ +Dependencies
+Debian-like dependency line that must be satisfied before attempting to build this request.
+ +Distribution
+Shortcut for its distribution.
+ +Distribution series
+Shortcut for its distribution series.
+ +The build targeted pocket.
+ +Upload Log URL
+A URL for failed upload logs.Will be None if there was no failure.
+ +An ISourcePackageRecipe describes how to build a source package.
+More precisely, it describes how to combine a number of branches into a +debianized source tree.
+ +Find distroseries and archive data for pending builds.
+Return a list of dict( +distroseries:distroseries.displayname +archive:archive.token) +The archive reference is as defined by the archive vocab. +This information is used to construct the request builds popup form.
+ +Request that the recipe be built in to the specified archive.
+param archive: | The IArchive which you want the build to end up in. | +
---|---|
param requester: | |
the person requesting the build. | +|
param pocket: | the pocket that should be targeted. | +
raises: | various specific upload errors if the requestor is not +able to upload to the archive. | +
Built daily
+Automatically build each day, if the source has changed.
+ +All builds of this recipe.
+All builds of this recipe, sorted in descending order of finishing (or starting if notcompleted successfully).
+ +The completed builds of this recipe.
+Completed builds of this recipe, sorted in descending order of finishing (or starting if notcompleted successfully).
+ +deb-version template
+The template that will be used to generate a deb version.
+ +Description
+A short description of the recipe.
+ +Default distribution series
+If built daily, these are the distribution versions that the recipe will be built for.
+ +Name
+The name of the recipe is part of the URL and needs to be unique for the given owner.
+ +Owner
+The person or team who can edit this recipe.
+ +The pending builds of this recipe.
+Pending builds of this recipe, sorted in descending order of creation.
+ +Built daily
+Automatically build each day, if the source has changed.
+ +Description
+A short description of the recipe.
+ +Default distribution series
+If built daily, these are the distribution versions that the recipe will be built for.
+ +Name
+The name of the recipe is part of the URL and needs to be unique for the given owner.
+ +Owner
+The person or team who can edit this recipe.
+ +Associate a branch with this bug.
+param branch: | The branch being linked to. | +
---|---|
param registrant: | |
The user linking the branch. | +
Unlink a branch from this bug.
+param branch: | The branch being unlinked from. | +
---|---|
param user: | The user unlinking the branch. | +
Link a bug to this specification.
+param bug: | IBug to link. | +
---|
Unlink a bug to this specification.
+param bug: | IBug to unlink. | +
---|
Participation essential
+Check this if participation in the design of the feature is essential.
+ +Approver
+The person responsible for approving the specification, and for reviewing the code when it's ready to be landed.
+ +Assignee
+The person responsible for implementing the feature.
+ +Starter
+The person who finally set the state of the spec to the values that we consider mark it as complete.
+ +Date Completed
+The date when this spec was marked complete. Note that complete also includes "obsolete" and superseded. Essentially, it is the state where no more work will be done on the feature.
+ +Date Started
+The date when this spec was marked started.
+ +Definition Status
+The current status of the process to define the feature and get approval for the implementation plan.
+ +Basic direction approved?
+Check this to indicate that the drafter and assignee have satisfied the approver that they are headed in the right basic direction with this specification.
+ +Drafter
+The person responsible for drafting the specification.
+ +Series goal is accepted
+Is true if this specification has been proposed as a goal for a specific series, and the drivers of that series have accepted the goal.
+ +Implementation Status
+The state of progress being made on the actual implementation or delivery of this feature.
+ +Information Type
+The type of information contained in this specification.
+ +Is started
+Is True if this spec is already completely implemented. Note that it is True for informational specs, since they describe general functionality rather than specific code to be written. It is also true of obsolete and superseded specs, since there is no longer any need to schedule work for them.
+ +Is started
+Is True if the spec is in a state which we consider to be "started". This looks at the delivery attribute, and also considers informational specs to be started when they are approved.
+ +Milestone
+The milestone in which we would like this feature to be delivered.
+ +Name
+May contain lower-case letters, numbers, and dashes. It will be used in the specification url. Examples: mozilla-type-ahead-find, postgres-smart-serial.
+ +Specification URL
+The URL of the specification. This is usually a wiki page.
+ +Starter
+The person who first set the state of the spec to the values that we consider mark it as started.
+ +Summary
+A single-paragraph description of the feature. This will also be displayed in most feature listings.
+ +For
+The project for which this proposal is being made.
+ +Title
+Describe the feature as clearly as possible in up to 70 characters. This title is displayed in every feature list or report.
+ +Status Whiteboard
+Any notes on the status of this spec you would like to make. Your changes will override the current text.
+ +Work Items
+Work items for this specification input in a text format. Your changes will override the current work items.
+ +Approver
+The person responsible for approving the specification, and for reviewing the code when it's ready to be landed.
+ +Assignee
+The person responsible for implementing the feature.
+ +Definition Status
+The current status of the process to define the feature and get approval for the implementation plan.
+ +Basic direction approved?
+Check this to indicate that the drafter and assignee have satisfied the approver that they are headed in the right basic direction with this specification.
+ +Drafter
+The person responsible for drafting the specification.
+ +Implementation Status
+The state of progress being made on the actual implementation or delivery of this feature.
+ +Information Type
+The type of information contained in this specification.
+ +Milestone
+The milestone in which we would like this feature to be delivered.
+ +Name
+May contain lower-case letters, numbers, and dashes. It will be used in the specification url. Examples: mozilla-type-ahead-find, postgres-smart-serial.
+ +Specification URL
+The URL of the specification. This is usually a wiki page.
+ +Summary
+A single-paragraph description of the feature. This will also be displayed in most feature listings.
+ +For
+The project for which this proposal is being made.
+ +Title
+Describe the feature as clearly as possible in up to 70 characters. This title is displayed in every feature list or report.
+ +Status Whiteboard
+Any notes on the status of this spec you would like to make. Your changes will override the current text.
+ +Work Items
+Work items for this specification input in a text format. Your changes will override the current work items.
+ +All specifications
+A list of all specifications, regardless of status or approval or completion, for this object.
+ +Valid specifications
+All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal
+ +Subscribed by
+The person creating the subscription.
+ +Subscriber
+The person subscribed.
+ +Return all the subscriptions with the specified levels.
+return: | A sequence of IStructuralSubscription. | +
---|
Add a bug subscription for this structure.
+This method is used to create a new IStructuralSubscription for the +target. This initially has a single filter which will allow all +notifications will be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription. | +
Add a bug subscription filter for this structure.
+This method is used to create a new IBugSubscriptionFilter for the +target. It will initially allow all notifications to be sent.
+subscriber: | The IPerson who will be subscribed. If omitted, +subscribed_by will be used. | +
---|---|
subscribed_by: | The IPerson creating the subscription. | +
return: | The new bug subscription filter. | +
Remove a subscription to bugs from this structure.
+This will delete all associated filters.
+subscriber: | The IPerson who will be unsubscribed. If omitted, +unsubscribed_by will be used. | +
---|---|
unsubscribed_by: | |
The IPerson removing the subscription. | +
A group of people and other teams.
+Launchpadlib example of getting the date a user joined a team:
++def get_join_date(team, user): + team = launchpad.people[team] + members = team.members_details + for member in members: + if member.member.name == user: + return member.date_joined + return None ++
Implementation notes:
+Return entries in the translation import queue for this entity.
+arg import_status: | |
---|---|
RosettaImportStatus DB Schema entry. | +|
arg file_extension: | |
String with the file type extension, usually 'po' +or 'pot'. | +
If one of both of 'import_status' or 'file_extension' are given, the +returned entries are filtered based on those values.
+ +Status
+Show only entries with this status
+ +Filename extension
+Show only entries with this filename suffix
+ +Search the IBugTasks reported on this entity.
+search_params: | a BugTaskSearchParams object | +
---|
Return an iterable of matching results.
+Note: milestone is currently ignored for all IBugTargets +except IProduct.
+ +Status
+Show only bugs with the given status value or list of values.
+ +Importance
+Show only bugs with the given importance or list of importances.
+ +Information Type
+Show only bugs with the given information type or list of information types.
+ +Tags
+String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
+ +Tags combination
+Search for any or all of the tags specified.
+ +Status upstream
+Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.
+ +Milestone
+Show only bug tasks targeted to this milestone.
+ +Component
+Distribution package archive grouping. E.g. main, universe, multiverse
+ +Returns merge proposals where a person was asked to review.
+This does not include merge proposals that were requested from +teams that the person is part of. If status is not passed then +it will return proposals that are in the "Needs Review" state.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
returns: | A list of IBranchMergeProposal. | +
Returns all merge proposals of a given status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param eager_load: | |
If True, load related objects for the whole +collection. | +|
returns: | A list of IBranchMergeProposal. | +
Returns all branches with the given lifecycle status.
+param status: | A list of statuses to filter with. | +
---|---|
param visible_by_user: | |
Normally the user who is asking. | +|
param modified_since: | |
If set, filters the branches being returned +to those that have been modified since the specified date/time. | +|
param eager_load: | |
If True load related objects for the whole +collection. | +|
returns: | A list of IBranch. | +
Return private archive URLs that this person can see.
+For each of the private archives (PPAs) that this person can see, +return a URL that includes the HTTP basic auth data. The URL +returned is suitable for including in a sources.list file.
+ +Return the packages for which this person is a bug subscriber.
+Returns a list of IDistributionSourcePackage's, ordered alphabetically +(A to Z) by name.
+ +Return the people whose membership on this team match :status:.
+If no orderby is provided, Person.sortingColumns is used.
+ +Return a PPA with the given name if it exists.
+param name: | A string with the exact name of the ppa being looked up. | +
---|---|
raises: | NoSuchPPA if a suitable PPA could not be found. | +
return: | a PPA IArchive record corresponding to the name. | +
Search the person's questions.
+param search_text: | |
---|---|
A string that is matched against the question +title and description. If None, the search_text is not included as +a filter criteria. | +|
param status: | A sequence of QuestionStatus Items. If None or an empty +sequence, the status is not included as a filter criteria. The +default is to match all status except Expired and Invalid. | +
param language: | An ILanguage or a sequence of ILanguage objects to +match against the question's language. If None or an empty +sequence, the language is not included as a filter criteria. | +
param participation: | |
A list of QuestionParticipation that defines the +set of relationship to questions that will be searched. If None or +an empty sequence, all relationships are considered. | +|
param needs_attention: | |
If this flag is true, only questions that +need attention the person will be included. These are the +questions in the NEEDSINFO or ANSWERED state owned by the person. +The questions not owned by the person but on which the person +requested more information or gave an answer and that are back in +the OPEN state are also included. | +|
param sort: | An attribute of QuestionSort. If None, a default value is +used. When there is a search_text value, the default is to sort by +RELEVANCY, otherwise results are sorted NEWEST_FIRST. | +
Return a list of IQuestionTargets that a person is subscribed to.
+This will return IQuestionTargets that the person is registered as an +answer contact because they subscribed themselves.
+ +Return a list of IQuestionTargets that are indirect subscriptions.
+This will return IQuestionTargets that the person or team is +registered as an answer contact because of their membership in a team.
+ +Projects owned by this person or teams to which they belong.
+param match_name: | |
---|---|
string optional project name to screen the results. | +
Return the teams that this person owns.
+The iterator includes the teams that the user owns, but it not +a member of.
+ +Join the given team if its membership_policy is not RESTRICTED.
+Join the given team according to the policies and defaults of that +team:
+If may_subscribe_to_list is True, then also attempt to +subscribe to the team's mailing list, depending on the list +status and the person's auto-subscribe settings.
+param requester: | |
---|---|
The person who requested the membership on +behalf of a team or None when a person requests the +membership for themselves. | +|
param may_subscribe_to_list: | |
If True, also try subscribing to +the team mailing list. | +
Leave the given team.
+This is a convenience method for retractTeamMembership() that allows +a user to leave the given team, or to cancel a PENDING membership +request.
+param team: | The team to leave. | +
---|
Add the given person as a member of this team.
+param person: | If the given person is already a member of this +team we'll simply change its membership status. Otherwise a new +TeamMembership is created with the given status. | +
---|---|
param reviewer: | The user who made the given person a member of this +team. | +
param comment: | String that will be assigned to the +proponent_comment, reviewer_comment, or acknowledger comment. | +
param status: | TeamMembershipStatus value must be either +Approved, Proposed or Admin. +If the new member is a team, the status will be changed to +Invited unless the user is also an admin of that team. | +
param force_team_add: | |
If the person is actually a team and +force_team_add is False, the team will actually be invited to +join this one. Otherwise the team is added as if it were a +person. | +|
param may_subscribe_to_list: | |
If the person is not a team, and +may_subscribe_to_list is True, then the person may be subscribed +to the team's mailing list, depending on the list status and the +person's auto-subscribe settings. | +|
return: | A tuple containing a boolean indicating when the +membership status changed and the current TeamMembershipStatus. +This depends on the desired status passed as an argument, the +membership policy and the user's privileges. | +
Accept an invitation to become a member of the given team.
+There must be a TeamMembership for this person and the given team with +the INVITED status. The status of this TeamMembership will be changed +to APPROVED.
+ +Decline an invitation to become a member of the given team.
+There must be a TeamMembership for this person and the given team with +the INVITED status. The status of this TeamMembership will be changed +to INVITATION_DECLINED.
+ +Retract this team's membership in the given team.
+If there's a membership entry for this team on the given team and +its status is either APPROVED, ADMIN, PENDING, or INVITED, the status +is changed and the relevant entries in TeamParticipation.
+APPROVED and ADMIN status are changed to DEACTIVATED. +PENDING status is changed to DECLINED. +INVITED status is changes to INVITATION_DECLINED.
+param team: | The team to leave. | +
---|---|
param user: | The user making the retraction. | +
param comment: | An optional explanation about why the change was made. | +
Create a PPA.
+param distribution: | |
---|---|
The distribution that this archive is for. | +|
param name: | The name of the new PPA to create. | +
param displayname: | |
The displayname for the new PPA. | +|
param description: | |
The description for the new PPA. | +|
param private: | Whether or not to create a private PPA. Defaults to +False, which means the PPA will be public. | +
param suppress_subscription_notifications: | |
Whether or not to suppress +emails to new subscribers about their subscriptions. Only +meaningful for private PPAs. | +|
raises: | PPACreationError if an error is encountered | +
return: | a PPA IArchive record. | +
Create a SourcePackageRecipe owned by this person.
+param name: | the name to use for referring to the recipe. | +
---|---|
param description: | |
A description of the recipe. | +|
param recipe_text: | |
The text of the recipe. | +|
param distroseries: | |
The distroseries to use. | +|
param registrant: | |
The person who created this recipe. | +|
param daily_build_archive: | |
The archive to use for daily builds. | +|
param build_daily: | |
If True, build this recipe daily (if changed). | +|
return: | a SourcePackageRecipe. | +
Get a text line that is suitable to be used for a sources.list +entry.
+It will create a new IArchiveAuthToken if one doesn't already exist.
+It raises Unauthorized if the context user does not have a +valid subscription for the target archive or the caller is not +context user itself.
+ +Add a language to this person's preferences.
+param language: | An object providing ILanguage. | +
---|
If the given language is one of the user's preferred languages +already, nothing will happen.
+ +Remove a language from this person's preferences.
+param language: | An object providing ILanguage. | +
---|
If the given language is not present, nothing will happen.
+ +All specifications
+A list of all specifications, regardless of status or approval or completion, for this object.
+ +Default PPA
+The PPA named 'ppa' owned by this person.
+ +Confirmed emails of this person.
+Confirmed emails are the ones in the VALIDATED state
+ +Subscription period
+Number of days a new subscription lasts before expiring. You can customize the length of an individual subscription when approving it. Leave this empty or set to 0 for subscriptions to never expire.
+ +Self renewal period
+Number of days members can renew their own membership. The number can be from 1 to 3650 (10 years).
+ +Description
+Details about interests and goals. Use plain text, paragraphs are preserved and URLs are linked.
+ +Display Name
+Your name as you would like it displayed throughout Launchpad. Most people use their full name here.
+ +Homepage Content
+Obsolete. Use description.
+ +ID
+Internal immutable identifier for this person. Only visible by privileged users.
+ +Karma
+The cached total karma for this person.
+ +Logo
+An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to you. Traditionally this is a logo, a small picture or a personal mascot. It should be no bigger than 50kb in size.
+ +Mailing List Auto-subscription Policy
+This attribute determines whether a person is automatically subscribed to a team's mailing list when the person joins said team.
+ +Active TeamMemberships for this object's members.
+Active TeamMemberships are the ones with the ADMIN or APPROVED status. The results are ordered using Person.sortingColumns.
+ +Membership policy
+The policies that describe who can be a member. The choice of policy +reflects the need to build a community (inclusive) versus the need to +control Launchpad projects, branches, and PPAs (exclusive).
+ +Mugshot
+A large image of exactly 192x192 pixels, that will be displayed on your home page in Launchpad. Traditionally this is a great big picture of your grinning face. Make the most of it! It should be no bigger than 100kb in size.
+ +Name
+A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.
+ +Open membership invitations.
+All TeamMemberships which represent an invitation (to join a team) sent to this person.
+ +All participants of this team.
+List of all direct and indirect people and teams who, one way or another, are a part of this team. If you want a method to check if a given person is a member of a team, you should probably look at IPerson.inTeam().
+ +PPAs for this person.
+PPAs owned by the context person ordered by name.
+ +Preferred email address
+The preferred email address for this person. The one we'll use to communicate with them.
+ +This team is private
+Private teams are visible only to their members.
+ +All subteams of this team.
+A subteam is any team that is a member (either directly or +indirectly) of this team. As an example, let's say we have +this hierarchy of teams:
+In this case, both 'Rosetta pt Translators' and 'Rosetta pt_BR +Translators' are subteams of the 'Rosetta Translators' team, +and all members of both subteams are considered members of +"Rosetta Translators".
+ +Membership policy
+Obsolete: use membership_policy
+ +All superteams of this team.
+A superteam is any team that this team is a member of. For +example, let's say we have this hierarchy of teams, and we are +the "Rosetta pt_BR Translators":
+In this case, we will return both 'Rosetta pt Translators' and +'Rosetta Translators', because we are member of both of them.
+ +Team Description
+Obsolete. Use description.
+ +Valid specifications
+All specifications that are not obsolete. When called from an ISpecificationGoal it will also exclude the ones that have not been accepted for that goal
+ +Visibility
+Anyone can see a public team's data. Only team members can see private team data.
+ +Subscription period
+Number of days a new subscription lasts before expiring. You can customize the length of an individual subscription when approving it. Leave this empty or set to 0 for subscriptions to never expire.
+ +Self renewal period
+Number of days members can renew their own membership. The number can be from 1 to 3650 (10 years).
+ +Description
+Details about interests and goals. Use plain text, paragraphs are preserved and URLs are linked.
+ +Display Name
+Your name as you would like it displayed throughout Launchpad. Most people use their full name here.
+ +Homepage Content
+Obsolete. Use description.
+ +Logo
+An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to you. Traditionally this is a logo, a small picture or a personal mascot. It should be no bigger than 50kb in size.
+ +Mailing List Auto-subscription Policy
+This attribute determines whether a person is automatically subscribed to a team's mailing list when the person joins said team.
+ +Membership policy
+The policies that describe who can be a member. The choice of policy +reflects the need to build a community (inclusive) versus the need to +control Launchpad projects, branches, and PPAs (exclusive).
+ +Mugshot
+A large image of exactly 192x192 pixels, that will be displayed on your home page in Launchpad. Traditionally this is a great big picture of your grinning face. Make the most of it! It should be no bigger than 100kb in size.
+ +Name
+A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.
+ +Membership policy
+Obsolete: use membership_policy
+ +Team Description
+Obsolete. Use description.
+ +Visibility
+Anyone can see a public team's data. Only team members can see private team data.
+ +TeamMembership for Users.
+This table includes direct team members only. Indirect memberships are +handled by the TeamParticipation table.
+ +Set this membership's expiration date.
+The given date must be None or in the future and the given user must +be allowed to change this membership's expiration date as per the +rules defined in canChangeExpirationDate().
+ +Set the status of this membership.
+The user and comment are stored in last_changed_by and +last_change_comment and may also be stored in proposed_by +(and proponent_comment), reviewed_by (and reviewer_comment) or +acknowledged_by (and acknowledger_comment), depending on the state +transition.
+The given status must be different than the current status.
+Return True if the status got changed, otherwise False.
+ +Date joined
+The date in which this membership was made active for the first time.
+ +Name
+The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.
+ +Series URI
+foo
+ +Name
+The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.
+ +Series URI
+foo
+ +Name
+Keep this name very short, unique, and +descriptive, because it will be used in URLs. Examples: +gnome-translation-project, ubuntu-translators.
+ +Title
+Title of this Translation Group. +This title is displayed at the top of the Translation Group +page and in lists or reports of translation groups. Do not +add "translation group" to this title, or it will be shown +double.
+ +Name
+Keep this name very short, unique, and +descriptive, because it will be used in URLs. Examples: +gnome-translation-project, ubuntu-translators.
+ +Title
+Title of this Translation Group. +This title is displayed at the top of the Translation Group +page and in lists or reports of translation groups. Do not +add "translation group" to this title, or it will be shown +double.
+ +Transition to a new status if possible.
+param new_status: | |
---|---|
Status to transition to. | +|
param user: | The user that is doing the transition. | +
Error output
+Output from most recent import attempt.
+ +Path
+The path to this file inside the source tree. Includes the filename.
+ +Uploader
+The person that uploaded this file to Launchpad.
+ +Path
+The path to this file inside the source tree. Includes the filename.
+ +Information type
+Indicates the privacy of the vulnerability.
+ +Private
+Private vulnerabilities are visible only to their subscribers.
+ +Information type
+Indicates the privacy of the vulnerability.
+ +Attempt to deliver the event again.
+Launchpad will automatically retry regularly for 24 hours, but +this can be used after it gives up or to avoid waiting for the +next automatic attempt.
+ +Reset automatic retries
+Restart the 24 hour automatic retry window as well as trying again now.
+ +Date first sent
+Timestamp of the first delivery attempt.
+ +Date scheduled
+Timestamp of the next delivery attempt.
+ +Date sent
+Timestamp of the last delivery attempt.
+ +Error message
+Details of the error encountered by the most recent delivery attempt.
+ +Pending
+Whether a delivery attempt is in progress.
+ +Successful
+Whether the most recent delivery attempt succeeded, or null if no attempts have been made yet.
+ +Webhook
+The webhook that this delivery is for.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +Active
+Deliver details of subscribed events.
+ +Git ref pattern
+Pattern to match against git-ref/branch name of an event, to filter webhook triggers
+ +Registrant
+The person who created this webhook.
+ +Target
+The object for which this webhook receives events.
+ +Active
+Deliver details of subscribed events.
+ +Git ref pattern
+Pattern to match against git-ref/branch name of an event, to filter webhook triggers
+ +Active
+Deliver details of subscribed events.
+ +Secret
+An optional string used to sign delivery bodies with HMAC-SHA1 in the X-Hub-Signature header. This must be less than 200 bytes long.
+ +([\s\S]*?)<\/p>\s*$/); //strip
and
that marked (maybe) adds and we don't want + html = t !== null ? t[1] : html; + var q = html.match(/^'([\s\S]*?)'$/); // strip quotes from strings + if (q !== null) html = q[1] + } else if (out_data.msg_type === "execute_result" | out_data.msg_type === "display_data" ) { + var ul = out_data.content.data; + if (ul != undefined) { + if (ul['text/latex'] != undefined) { + html = ul['text/latex']; + } else if (ul['image/svg+xml'] != undefined) { + var svg = ul['image/svg+xml']; + /* embed SVG in an([\s\S]*?)<\/p>\s*$/); //strip
and
that marked adds and we don't want + html = t !== null ? t[1] : html; + var q = html.match(/^'([\s\S]*?)'$/); // strip quotes from strings + if (q !== null) html = q[1] + } + } + } else { + return; + } + thiscell.metadata.variables[thismatch] = html; + var el = document.getElementById(id); + el.innerHTML = el.innerHTML + html; // output result + }; + var callbacks = { iopub : { output: execute_callback } }; + if (cell.notebook.kernel != null) { + cell.notebook.kernel.execute(code, callbacks, {silent: false, store_history : false, stop_on_error: false }); + return ""; // add HTML tag with ID where output will be placed + } + return undefined; + } else { + /* Notebook not dirty: replace tags with metadata */ + val = cell.metadata.variables[tag]; + return ""+val+"" + } + }); + if (found == true) return newtext; + return undefined + }; + + /* + * Render markdown cell and replace {{...}} with python code + * + */ + var render_cell = function(cell) { + var element = cell.element.find('div.text_cell_render'); + var text = execute_python(cell, element[0].innerHTML); + if (text !== undefined) { + element[0].innerHTML = text; + MathJax.Hub.Queue(["Typeset",MathJax.Hub,element[0]]); + } + }; + + /* force rendering of markdown cell if notebook is dirty */ + var original_render = textcell.MarkdownCell.prototype.render; + textcell.MarkdownCell.prototype.render = function() { + if (IPython.notebook.dirty === true) { + this.rendered = false + } + return original_render.apply(this) + }; + + var set_trusted_indicator = function() { + var ind = $('.notebook-trusted'); + if (IPython.notebook.trusted === true) { + ind.attr('title','Notebook is trusted'); + ind.removeClass('fa-question'); + ind.addClass('fa-check'); + } else { + ind.attr('title','Notebook is not trusted'); + ind.removeClass('fa-check'); + ind.addClass('fa-question'); + } + }; + + + /** + * Add CSS file + * + * @param name filename + */ + var load_css = function (name) { + var link = document.createElement("link"); + link.type = "text/css"; + link.rel = "stylesheet"; + link.href = requirejs.toUrl(name); + document.getElementsByTagName("head")[0].appendChild(link); + }; + + + /** + * Update all references variables in markdown cells + * + */ + var update_md_cells = function () { + var ncells = IPython.notebook.ncells(); + var cells = IPython.notebook.get_cells(); + for (var i = 0; i < ncells; i++) { + var cell = cells[i]; + if (cell.metadata.hasOwnProperty('variables')) { + render_cell(cell) + } + } + }; + + var load_ipython_extension = function() { + load_css('./main.css'); + events.on("rendered.MarkdownCell", function (event, data) { + render_cell(data.cell); + }); + events.on("trust_changed.Notebook", set_trusted_indicator); + + $('#save_widget').append(''); + set_trusted_indicator(); + + /* Show values stored in metadata on reload */ + events.on("kernel_ready.Kernel", function () { + if (Jupyter.notebook !== undefined && Jupyter.notebook._fully_loaded) { + update_md_cells() + } else { + events.on("notebook_loaded.Notebook", function () { + update_md_cells() + }) + } + }); + }; + + return { + load_ipython_extension : load_ipython_extension + }; +}); diff --git a/.local/share/jupyter/nbextensions/qtconsole/qtconsole.yaml b/.local/share/jupyter/nbextensions/qtconsole/qtconsole.yaml new file mode 100644 index 0000000000000000000000000000000000000000..102310d818d87493d7955bd2211d4cdbbad4e2e9 --- /dev/null +++ b/.local/share/jupyter/nbextensions/qtconsole/qtconsole.yaml @@ -0,0 +1,6 @@ +Type: IPython Notebook Extension +Name: Launch QTConsole +Link: README.md +Description: Launch a QTConsole attached to the running kernel +Main: qtconsole.js +Compatibility: 4.x diff --git a/.local/share/jupyter/nbextensions/rubberband/main.css b/.local/share/jupyter/nbextensions/rubberband/main.css new file mode 100644 index 0000000000000000000000000000000000000000..39ad1dfdd0025d70faa79be10f9cc7a5842eae6a --- /dev/null +++ b/.local/share/jupyter/nbextensions/rubberband/main.css @@ -0,0 +1,12 @@ +.highlight-drag +{ + background-color: transparent; + border: dashed #ff3333 3px; + position: absolute; + display: none; +} + +.cell.selected +{ + background-color: #fcfcfc; +} diff --git a/.local/share/jupyter/nbextensions/rubberband/rubberband.yaml b/.local/share/jupyter/nbextensions/rubberband/rubberband.yaml new file mode 100644 index 0000000000000000000000000000000000000000..fa643c51afdfb54820a9602c62402f08b3ebf585 --- /dev/null +++ b/.local/share/jupyter/nbextensions/rubberband/rubberband.yaml @@ -0,0 +1,7 @@ +Type: IPython Notebook Extension +Name: Rubberband +Description: The rubberband extension allows selecting multiple cells +Link: readme.md +Icon: icon.png +Main: main.js +Compatibility: 4.x, 5.x diff --git a/.local/share/jupyter/nbextensions/ruler/ruler.yaml b/.local/share/jupyter/nbextensions/ruler/ruler.yaml new file mode 100644 index 0000000000000000000000000000000000000000..dee55c832df7e6dc981992e92da6f5e8e2ff300d --- /dev/null +++ b/.local/share/jupyter/nbextensions/ruler/ruler.yaml @@ -0,0 +1,32 @@ +Type: IPython Notebook Extension +Name: Ruler +Description: This extension enables the Ruler CodeMirror feature +Link: readme.md +Icon: icon.png +Main: main.js +Compatibility: 4.x, 5.x +Parameters: + +- name: ruler_column + input_type: list + list_element: + input_type: number + description: Column where ruler is displayed + default: [78] + +- name: ruler_color + input_type: list + list_element: + input_type: color + description: Ruler color + default: ["#ff0000"] + +- name: ruler_linestyle + description: 'Ruler style, e.g. solid, dashed' + input_type: list + default: ['dashed'] + +- name: ruler_do_css_patch + description: apply css patch for ruler padding bug in notebook >= 4.3 + input_type: checkbox + default: true diff --git a/.local/share/jupyter/nbextensions/runtools/main.js b/.local/share/jupyter/nbextensions/runtools/main.js new file mode 100644 index 0000000000000000000000000000000000000000..c07de86a71165f61b8f307549a9b333f502ac3da --- /dev/null +++ b/.local/share/jupyter/nbextensions/runtools/main.js @@ -0,0 +1,745 @@ +// Extended code execution commands and more + +define([ + 'base/js/namespace', + 'jquery', + 'require', + 'base/js/events', + 'services/config', + 'base/js/utils', + 'notebook/js/codecell' +], function(Jupyter, $, requirejs, events, configmod, utils, codecell) { + "use strict"; + + var run_list = []; /* list of cells to be run */ + + // define default config parameter values + var params = { + run_cells_above: 'Alt-a', + run_cells_below: 'Alt-b', + toggle_marker: 'Alt-t', + mark_all_codecells: 'Alt-m', + unmark_all_codecells: 'Alt-u', + run_marked_cells: 'Alt-r', + run_all_cells: 'Alt-x', + run_all_cells_ignore_errors: 'Alt-f', + stop_execution: 'Ctrl-c', + marked_color: '#20f224', + scheduled_color: '#00def0', + run_color: '#f30a2d' + }; + + /** + * Add event if user clicks on codemirror gutter + * + */ + function add_gutter_events() { + var ncells = Jupyter.notebook.ncells(); + var cells = Jupyter.notebook.get_cells(); + for (var i = 0; i < ncells; i++) { + var cell = cells[i]; + if ((cell.cell_type === "code")) { + cell.code_mirror.on("gutterClick", changeEvent); + if (is_marked(cell)) { + var g = cell.code_mirror.getGutterElement(); + $(g).css({ + "background-color": params.marked_color + }); + } + } + } + } + + /* + * Initialize toolbar and gutter after config was loaded + */ + function initialize() { + $.extend(true, params, Jupyter.notebook.config.data.runtools); + + add_gutter_events(); + + /* Add run control buttons to toolbar */ + $(Jupyter.toolbar.add_buttons_group([ + Jupyter.keyboard_manager.actions.register ({ + help: 'Toggle Runtools Toolbar', + icon: 'fa-cogs', + handler: toggle_toolbar + }, 'toggle-runtools-toolbar', 'runtools') + ])).find('.btn').attr('id', 'toggle_runtools').css({ + 'outline': 'none' + }); + + /* Add keyboard shortcuts */ + var add_command_shortcuts = {}; + add_command_shortcuts[params["run_cells_above"]] = { + help: 'Run cells above', + help_index: 'xa', + handler: function() { + execute_cells_above(); + return false; + } + }; + add_command_shortcuts[params["run_cells_below"]] = { + help: 'Run cells below', + help_index: 'aa', + handler: function() { + execute_cells_below(); + return false; + } + }; + add_command_shortcuts[params["toggle_marker"]] = { + help: 'Toggle marker', + help_index: 'mt', + handler: function() { + toggle_marker(); + return false; + } + }; + add_command_shortcuts[params["mark_all_codecells"]] = { + help: 'Mark all codecells', + help_index: 'ma', + handler: function() { + mark_all(); + return false; + } + }; + add_command_shortcuts[params["unmark_all_codecells"]] = { + help: 'Unmark all codecells', + help_index: 'mu', + handler: function() { + mark_none(); + return false; + } + }; + add_command_shortcuts[params["run_marked_cells"]] = { + help: 'Run marked cells', + help_index: 'rm', + handler: function() { + run_marked_cells(); + return false; + } + }; + add_command_shortcuts[params["run_all_cells"]] = { + help: 'Run all cells', + help_index: 'ra', + handler: function() { + var pos = Jupyter.notebook.element.scrollTop(); + execute_all_cells(); + Jupyter.notebook.element.animate({ + scrollTop: pos + }, 100); + return false; + } + }; + add_command_shortcuts[params["run_all_cells_ignore_errors"]] = { + help: 'Run all cells - ignore errors', + help_index: 'rf', + handler: function() { + run_all_cells_ignore_errors(); + return false; + } + }; + Jupyter.keyboard_manager.command_shortcuts.add_shortcuts(add_command_shortcuts); + Jupyter.keyboard_manager.edit_shortcuts.add_shortcuts(add_command_shortcuts); + + events.on('finished_execute.CodeCell', finished_execute_event); + } + + /** + * Hide or show a cell + * + * @param cell + * @param io 'i' for cell input, 'o' for cell output + * @param showme {Boolean} show (true) or hide (false) cell + */ + function showCell(cell, io, showme) { + if (io === 'i') { + if (showme === true) { + cell.element.find("div.input").show(); + cell.metadata.hide_input = false; + } else { + cell.element.find("div.input").hide(); + cell.metadata.hide_input = true; + } + } else { + if (showme === true) { + cell.element.find('div.output').show(); + cell.metadata.hide_output = false; + } else { + cell.element.find('div.output').hide(); + cell.metadata.hide_output = true; + } + } + } + + function _show_input_output_of_marked(show, char) { + var cells = Jupyter.notebook.get_cells(); + var ncells = cells.length; + for (var i = 0; i < ncells; i++) { + var _cell = cells[i]; + if (is_marked(_cell)) + showCell(_cell, char, show); + } + } + + /** + * Hide or show input of all marked code cells + * + * @param show {Boolean} show (true) or hide (false) code cells + */ + function show_input(show) { + _show_input_output_of_marked(show, 'i'); + } + + /** + * Hide or show output area of all marked code cells + * + * @param {Boolean} show show (true) or hide (false) + */ + function show_output(show) { + _show_input_output_of_marked(show, 'o'); + } + + + /** + * Execute next cell in run list, if it is still marked + * + */ + function execute_next_marked_cell() { + var cells = Jupyter.notebook.get_cells(); + var end = cells.length; + while (run_list.length > 0) { + var runcell = run_list.shift(); + for (var i = 0; i < end; i++) { + if (runcell === cells[i]) { + if (runcell.metadata.run_control !== undefined && runcell.metadata.run_control.marked === true) { + var g = runcell.code_mirror.getGutterElement(); + $(g).css({ + "background-color": params.run_color + }); + runcell.execute(); + return; + } + } + } + } + } + + function _execute_without_selecting(idx_start, idx_end, stop_on_error) { + // notebook.execute_cells alters selection, this doesn't + var cells = Jupyter.notebook.get_cells(); + idx_start = idx_start !== undefined ? idx_start : 0; + idx_end = idx_end !== undefined ? idx_end : cells.length; + for (var ii = idx_start; ii < idx_end; ii++) { + cells[ii].execute(stop_on_error); + } + } + + function execute_cells_above() { + _execute_without_selecting(0, Jupyter.notebook.get_selected_index()); + } + + function execute_cells_below() { + _execute_without_selecting(Jupyter.notebook.get_selected_index(), undefined); + } + + function execute_all_cells(stop_on_error) { + _execute_without_selecting(0, undefined, stop_on_error); + } + + /** + * Run code cells marked in metadata + * + */ + function run_marked_cells() { + var cells = Jupyter.notebook.get_cells(); + var end = cells.length; + run_list = []; + /* Show all marked cells as scheduled to be run with new gutter background color */ + for (var i = 0; i < end; i++) { + var cell = cells[i]; + if (cell instanceof codecell.CodeCell) { + var last_line = cell.code_mirror.lastLine(); + var cell_empty = ( last_line === 0 && cell.code_mirror.getLine(last_line) === ""); + if (cell.metadata.run_control !== undefined && cell_empty === false) { + if (cell.metadata.run_control.marked === true) { + var g = cell.code_mirror.getGutterElement(); + $(g).css({ + "background-color": params.scheduled_color + }); + run_list.push(cell); + } + } + } + } + execute_next_marked_cell(); + } + + /* + * Execute next cell in run_list when notified execution of last cell has been finished + * @param evt Event + * @param data Cell that has finished executing + */ + var finished_execute_event = function(evt, data) { + var cell = data.cell; + /* Reset gutter color no non-queued state */ + if (is_marked(cell)) { + var g = cell.code_mirror.getGutterElement(); + $(g).css({ + "background-color": params.marked_color + }); + } + execute_next_marked_cell(); + }; + + /** + * + * @param cell + * @param value + */ + function setCell(cell, value) { + if (!(cell instanceof codecell.CodeCell)) return; + if (cell.metadata.run_control === undefined) cell.metadata.run_control = {}; + if (cell.metadata.run_control.marked === undefined) cell.metadata.run_control.marked = false; + if (value === undefined) value = !cell.metadata.run_control.marked; + var g = cell.code_mirror.getGutterElement(); + if (value === false) { + cell.metadata.run_control.marked = false; + $(g).css({ + "background-color": "" + }); + } else { + cell.metadata.run_control.marked = true; + $(g).css({ + "background-color": params.marked_color + }); + } + } + + function setCellsMarked(cells, value) { + var ncells = cells.length; + for (var i = 0; i < ncells; i++) { + setCell(cells[i], value); + } + } + + /** + * Toggle code cell marker + */ + function toggle_marker() { + setCellsMarked(Jupyter.notebook.get_selected_cells(), undefined); + } + + /** + * + */ + function mark_all() { + setCellsMarked(Jupyter.notebook.get_cells(), true); + } + + /** + * + */ + function mark_none() { + setCellsMarked(Jupyter.notebook.get_cells(), false); + } + + /** + * + * @param cell notebook cell instance + * @param state {string} state to be display [ '', 'locked', 'executed', 'modified' ] + */ + function set_cell_state(cell, state) { + var icon = ""; + if (state === 'locked') { + icon = '