l.r.b.d.DistroSeriesDifferenceBaseView(LaunchpadFormView, PackageCopyingMixin, DerivedDistroSeriesMixin) : class documentation

Part of lp.registry.browser.distroseries View In Hierarchy

Known subclasses: lp.registry.browser.distroseries.DistroSeriesLocalDifferencesView, lp.registry.browser.distroseries.DistroSeriesMissingPackagesView, lp.registry.browser.distroseries.DistroSeriesUniquePackagesView

Base class for all pages presenting differences between a derived series and its parent.
Method initialize_sync_label Undocumented
Method label Undocumented
Method setupPackageFilterRadio Undocumented
Method setUpFields Add the selected differences field.
Method action_url The request URL including query string.
Method validate_sync Validate selected differences.
Method canPerformSync Return whether a sync can be performed.
Method pending_syncs Pending synchronization jobs for this distroseries.
Method pending_dsd_updates Pending DistroSeriesDifference update jobs.
Method hasPendingDSDUpdate Have there been changes that dsd is still being updated for?
Method pendingSync Is there a package-copying job pending to resolve dsd?
Method isNewerThanParent Is the child's version of this package newer than the parent's?
Method canRequestSync Does it make sense to request a sync for this difference?
Method describeJobs Describe any jobs that may be pending for dsd.
Method specified_name_filter If specified, return the name filter from the GET form data.
Method specified_packagesets_filter If specified, return Packagesets given in the GET form data.
Method specified_changed_by_filter If specified, return Persons given in the GET form data.
Method specified_package_type If specified, return the package type filter from the GET form
Method cached_differences Return a batch navigator of filtered results.
Method parent_changelog_url The URL to the /parent/series/+source/package/+changelog
Method _sync_sources Synchronise packages from the parent series to this one.

Inherited from LaunchpadFormView:

Method __init__ Undocumented
Method initialize Undocumented
Method render Return the body of the response.
Method extendFields Allow subclasses to extend the form fields.
Method setUpWidgets Set up the widgets using the view's form fields and the context.
Method help_links Dictionary mapping field names to help links.
Method adapters Provide custom adapters for use when setting up the widgets.
Method has_available_actions Does the view have any available actions that will render?
Method initial_values Override this in your subclass if you want any widgets to have
Method addError Add a form wide error.
Method getFieldError Get the error associated with a particular field.
Method setFieldError Set the error associated with a particular field.
Static Method validate_none Do not do any validation.
Method validate_widgets Validate the named form widgets.
Method error_count Undocumented
Method ajax_failure_handler Called by the form if validate() finds any errors.
Method validate Validate the form.
Method validate_cancel Noop validation in case we cancel.
Method focusedElementScript Helper function to construct the script element content.
Method isSingleLineLayout Undocumented
Method isMultiLineLayout Undocumented
Method isCheckBoxLayout Undocumented
Method showOptionalMarker Should the (Optional) marker be shown?
Method _processNotifications Add any notification messages to the response headers.
Method _abort Abort the form edit.
Method _validate Check all widgets and perform any custom validation.

Inherited from PackageCopyingMixin:

Method do_copy Copy packages and add appropriate feedback to the browser page.

Inherited from DerivedDistroSeriesMixin:

Method has_unique_parent Undocumented
Method unique_parent Undocumented
Method number_of_parents Undocumented
Method getParentName Undocumented
def initialize_sync_label(self, label):
Undocumented
@property
def label(self):
overridden in lp.registry.browser.distroseries.DistroSeriesLocalDifferencesView, lp.registry.browser.distroseries.DistroSeriesMissingPackagesView, lp.registry.browser.distroseries.DistroSeriesUniquePackagesView
Undocumented
def setupPackageFilterRadio(self):
Undocumented
def setUpFields(self):
overrides lp.app.browser.launchpadform.LaunchpadFormView.setUpFields
Add the selected differences field.

As this field depends on other search/filtering field values for its own vocabulary, we set it up after all the others.

def _sync_sources(self, action, data):
Synchronise packages from the parent series to this one.
@property
def action_url(self):
overrides lp.app.browser.launchpadform.LaunchpadFormView.action_url
The request URL including query string.

Forms should post to the view with a query string containing the active batch and filtering parameters. Actions should then redirect using that information so that the user is left on the same batch page, with the same filtering parameters, as the page from which they submitted the form.

def validate_sync(self, action, data):
Validate selected differences.
def canPerformSync(self, *args):
overridden in lp.registry.browser.distroseries.DistroSeriesUniquePackagesView
Return whether a sync can be performed.

This method is used as a condition for the above sync action, as well as directly in the template.

@cachedproperty
def pending_syncs(self):
Pending synchronization jobs for this distroseries.
ReturnsA dict mapping package names to pending sync jobs.
@cachedproperty
def pending_dsd_updates(self): 
Pending `DistroSeriesDifference` update jobs.

:return: A `set` of `DistroSeriesDifference`s that have pending
    `DistroSeriesDifferenceJob`s.
def hasPendingDSDUpdate(self, dsd):
Have there been changes that dsd is still being updated for?
def pendingSync(self, dsd):
Is there a package-copying job pending to resolve dsd?
def isNewerThanParent(self, dsd):
Is the child's version of this package newer than the parent's?

If it is, there's no point in offering to sync it.

Any version is considered "newer" than a missing version.

def canRequestSync(self, dsd):
Does it make sense to request a sync for this difference?
def describeJobs(self, dsd):
Describe any jobs that may be pending for dsd.

Shows "synchronizing..." if the entry is being synchronized, "updating..." if the DSD is being updated with package changes and "waiting in <queue>..." if the package is in the distroseries queues (<queue> will be NEW or UNAPPROVED and links to the relevant queue page).

ParametersdsdA DistroSeriesDifference on the page.
ReturnsAn HTML text describing work that is pending or in progress for dsd; or None.
@property
def specified_name_filter(self):
If specified, return the name filter from the GET form data.
@property
def specified_packagesets_filter(self):
If specified, return Packagesets given in the GET form data.
@property
def specified_changed_by_filter(self):
If specified, return Persons given in the GET form data.
@property
def specified_package_type(self):
If specified, return the package type filter from the GET form data.
@cachedproperty
def cached_differences(self):
Return a batch navigator of filtered results.
def parent_changelog_url(self, distroseriesdifference):
The URL to the /parent/series/+source/package/+changelog
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.