l.a.d.DdtpTarballUpload(CustomUpload) : class documentation

Part of lp.archivepublisher.ddtp_tarball View In Hierarchy

DDTP (Debian Description Translation Project) tarball upload

The tarball filename must be of the form:

<NAME>_<COMPONENT>_<VERSION>.tar.gz

where:

It is consisted of a tarball containing all the supported indexes files for the DDTP system (under 'i18n' directory) contents driven by component.

Results will be published (installed in archive) under:

<ARCHIVE>dists/<SUITE>/<COMPONENT>/i18n

Old contents will be preserved.

Static Method parsePath Parse tarfile_path, returning its useful components.
Method setComponents Set instance variables based on decomposing the filename.
Method setTargetDirectory Set self.targetdir based on parameters.
Class Method getSeriesKey Get a unique key for instances of this custom upload type.
Method checkForConflicts Check for conflicts with existing publications in the archive.
Method shouldInstall Returns True if the given filename should be installed.
Method fixCurrentSymlink Update the 'current' symlink and prune old entries.

Inherited from CustomUpload:

Class Method publish See ICustomUploadHandler.
Method __init__ Undocumented
Method process Process the upload and install it into the archive.
Method verifyBeforeExtracting Verify the tarball before extracting it.
Method extract Extract the custom upload to a temporary directory.
Method ensurePath Ensure the parent directory exists.
Method shouldSign Returns True if the given filename should be signed.
Method sign Sign a file.
Method installFiles Install the files from the custom upload to the archive.
Method cleanup Clean up the temporary directory
Method _buildInstallPaths Build and return paths used to install files.
@staticmethod
def parsePath(tarfile_path):
Parse tarfile_path, returning its useful components.
RaisesValueErrorIf tarfile_path is incorrectly formed.
def setComponents(self, tarfile_path):
Set instance variables based on decomposing the filename.
def setTargetDirectory(self, archive, tarfile_path, suite):
Set self.targetdir based on parameters.

This should also set self.version and self.arch (if applicable) as a side-effect.

@classmethod
def getSeriesKey(cls, tarfile_path):
Get a unique key for instances of this custom upload type.

The key should differ for any uploads that may be published simultaneously, but should be identical for (e.g.) different versions of the same type of upload on the same architecture in the same series. Returns None on failure to parse tarfile_path.

def checkForConflicts(self):
Check for conflicts with existing publications in the archive.
def shouldInstall(self, filename):
Returns True if the given filename should be installed.
def fixCurrentSymlink(self):
Update the 'current' symlink and prune old entries.

The 'current' symbolic link will point to the latest version present in 'targetdir' and only the latest 3 valid entries will be kept.

Entries named as invalid versions, for instance 'alpha-X', will be ignored and left alone. That's because they were probably copied manually into this location, they should remain in place.

See DebVersion for more information about version validation.

API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.