l.a.s.g.GenerateContentsFiles(LaunchpadCronScript) : class documentation

Part of lp.archivepublisher.scripts.generate_contents_files View In Hierarchy

No class docstring
Method add_my_options See LaunchpadScript.
Method name See LaunchpadScript.
Method processOptions Handle command-line options.
Method setUpContentArchive Make sure the content_archive directories exist.
Method getSuites Return suites that need Contents files.
Method getArchs Query architectures supported by the suite.
Method getDirs Subdirectories needed for each component.
Method writeAptContentsConf Write apt-contents.conf file.
Method createComponentDirs Create the content archive's tree for all of its components.
Method copyOverrides Copy overrides into the content archive.
Method runAptFTPArchive Run apt-ftparchive to produce the Contents files.
Method generateContentsFiles Generate Contents files.
Method updateContentsFile Update Contents file, if it has changed.
Method updateContentsFiles Update all Contents files that have changed.
Method setUp Prepare configuration and filesystem state for the script's work.
Method process Do the bulk of the work.
Method main See LaunchpadScript.

Inherited from LaunchpadCronScript:

Method __init__ Construct new LaunchpadScript.
Method get_last_activity Return the last activity, if any.
Method record_activity Record the successful completion of the script.

Inherited from LaunchpadScript (via LaunchpadCronScript):

Method handle_options Undocumented
Method dbuser Enable subclasses to override with command-line arguments.
Method login Super-convenience method that avoids the import.
Method lockfilename Return lockfilename.
Method lockfilepath Undocumented
Method setup_lock Create lockfile.
Method lock_or_die Attempt to lock, and sys.exit(1) if the lock's already taken.
Method unlock Release the lock. Do this before going home.
Method run Actually run the script, executing zcml and initZopeless.
Method lock_and_run Call lock_or_die(), and then run() the script.
Method _init_zca Initialize the ZCA, this can be overridden for testing purposes.
Method _init_db Initialize the database transaction.
def add_my_options(self):
See LaunchpadScript.
@property
def name(self):
See LaunchpadScript.
def processOptions(self):
Handle command-line options.
def setUpContentArchive(self):
Make sure the content_archive directories exist.
def getSuites(self):
Return suites that need Contents files.
def getArchs(self, suite):
Query architectures supported by the suite.
def getDirs(self, archs):
Subdirectories needed for each component.
def writeAptContentsConf(self, suites):
Write apt-contents.conf file.
def createComponentDirs(self, suites):
Create the content archive's tree for all of its components.
def copyOverrides(self, override_root):
Copy overrides into the content archive.

This method won't access the database.

def runAptFTPArchive(self, distro_name):
Run apt-ftparchive to produce the Contents files.

This method may take a long time to run. This method won't access the database.

def generateContentsFiles(self, override_root, distro_name):
Generate Contents files.

This method may take a long time to run. This method won't access the database.

Parametersoverride_rootCopy of self.config.overrideroot that can be evaluated without accessing the database.
distro_nameCopy of self.distribution.name that can be evaluated without accessing the database.
def updateContentsFile(self, suite, arch):
Update Contents file, if it has changed.
def updateContentsFiles(self, suites):
Update all Contents files that have changed.
def setUp(self):
Prepare configuration and filesystem state for the script's work.

This is idempotent: run it as often as you like. (For example, a test may call setUp prior to calling main which again invokes setUp).

def process(self):
Do the bulk of the work.
def main(self):
See LaunchpadScript.
API Documentation for Launchpad, generated by pydoctor at 2018-08-14 00:00:04.