c.b.p.g.GenerateTranslationTemplates : class documentation

Part of canonical.buildd.pottery.generate_translation_templates View In Hierarchy

Script to generate translation templates from a branch.
Method __init__ Prepare to generate templates for a branch.
Method generate Do It. Generate templates.
Method _setupLogger Sets up and returns a logger.
Method _getBranch Set self.branch_dir, and check out branch if needed.
Method _checkout Check out a source branch to generate from.
Method _makeTarball Put the given files into a tarball in the working directory.
def __init__(self, branch_spec, result_name, work_dir):
Prepare to generate templates for a branch.
Parametersbranch_specEither a branch URL or the path of a local branch. URLs are recognized by the occurrence of ':'. In the case of a URL, this will make up a path for the branch and check out the branch to there.
result_nameThe name of the result tarball. Should end in .tar.gz.
work_dirThe directory to work in. Must exist.
def _setupLogger(self):
Sets up and returns a logger.
def _getBranch(self):
Set self.branch_dir, and check out branch if needed.
def _checkout(self, branch_url):
Check out a source branch to generate from.

The branch is checked out to the location specified by self.branch_dir.

def _makeTarball(self, files):
Put the given files into a tarball in the working directory.
def generate(self):
Do It. Generate templates.
API Documentation for Launchpad, generated by pydoctor at 2010-09-27 00:00:11.