l.c.m.b.RosettaUploadJob(BranchJobDerived) : class documentation

Part of lp.code.model.branchjob View In Hierarchy

A Job that uploads translation files to Rosetta.
Method __init__ Undocumented
Static Method getMetadata Undocumented
Method from_revision_id Undocumented
Method force_translations_upload Undocumented
Class Method providesTranslationFiles See IRosettaUploadJobSource.
Class Method create See IRosettaUploadJobSource.
Method file_names A contatenation of all lists of filenames.
Method run See IRosettaUploadJob.
Static Method iterReady See IRosettaUploadJobSource.
Static Method findUnfinishedJobs See IRosettaUploadJobSource.
Method _iter_all_lists Iterate through all the file lists.
Method _iter_lists_and_uploaders Iterate through all files for a productseries.
Method _init_translation_file_lists Initialize the member variables that hold the information about
Method _uploader_person_pot Determine which person is the uploader for a pot file.
Method _uploader_person_po Determine which person is the uploader for a po file.

Inherited from BranchJobDerived:

Method __repr__ Undocumented
Method __eq__ Undocumented
Method __ne__ Undocumented
Class Method get Return the instance of this class whose key is supplied.
Method getOopsVars See IRunnableJob.
Method getErrorRecipients Return a list of email-ids to notify about user errors.

Inherited from BaseRunnableJob (via BranchJobDerived):

Method __lt__ Undocumented
Method getOopsRecipients Return a list of email-ids to notify about oopses.
Method getOperationDescription Undocumented
Method getOopsMailController Return a MailController for notifying people about oopses.
Method getUserErrorMailController Return a MailController for notifying about user errors.
Method notifyOops Report this oops.
Method notifyUserError See IRunnableJob.
Method makeOopsReport Generate an OOPS report using the given OOPS configuration.
Method acquireLease Undocumented
Method taskId Return a task ID that gives a clue what this job is about.
Method runViaCelery Request that this job be run via celery.
Method getDBClass Undocumented
Method celeryCommitHook Hook function to call when a commit completes.
Method celeryRunOnCommit Configure transaction so that commit runs this job via Celery.
Method queue See IJob.

Inherited from BaseRunnableJobSource (via BranchJobDerived, BaseRunnableJob):

Static Method contextManager Undocumented
def __init__(self, branch_job):
overrides lp.code.model.branchjob.BranchJobDerived.__init__
Undocumented
@staticmethod
def getMetadata(from_revision_id, force_translations_upload):
Undocumented
@property
def from_revision_id(self):
Undocumented
@property
def force_translations_upload(self):
Undocumented
@classmethod
def providesTranslationFiles(cls, branch):
See IRosettaUploadJobSource.
@classmethod
def create(cls, branch, from_revision_id, force_translations_upload=False):
See IRosettaUploadJobSource.
def _iter_all_lists(self):
Iterate through all the file lists.

File names and files are stored in different lists according to their type (template or translation). But some operations need to be performed on both lists. This generator yields a pair of lists, one containing all file names for the given type, the other containing all file names and content of the changed files.

def _iter_lists_and_uploaders(self, productseries):
Iterate through all files for a productseries.

File names and files are stored in different lists according to their type (template or translation). Which of these are needed depends on the configuration of the product series these uploads are for. This generator checks the configuration of the series and produces the a lists of lists and a person object. The first list contains all file names or the given type, the second contains all file names and content of the changed files. The person is who is to be credited as the importer of these files and will vary depending on the file type.

@property
def file_names(self):
A contatenation of all lists of filenames.
def _init_translation_file_lists(self): 
Initialize the member variables that hold the information about
the relevant files.

The information is collected from the branch tree and stored in the
following member variables:
* file_names is a dictionary of two lists ('pot', 'po') of file names
  that are POT or PO files respectively. This includes all files,
  changed or unchanged.
* changed_files is a dictionary of two lists ('pot', 'po') of tuples
  of (file_name, file_content) of all changed files that are POT or
  PO files respectively.
def _uploader_person_pot(self, series):
Determine which person is the uploader for a pot file.
def _uploader_person_po(self, series):
Determine which person is the uploader for a po file.
def run(self):
See IRosettaUploadJob.
@staticmethod
def iterReady():
overrides lp.code.model.branchjob.BranchJobDerived.iterReady
See IRosettaUploadJobSource.
@staticmethod
def findUnfinishedJobs(branch, since=None):
See IRosettaUploadJobSource.
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.