l.s.u.j.j.ComboFile : class documentation

Part of lp.scripts.utilities.js.jsbuild View In Hierarchy

Known subclasses: lp.scripts.utilities.js.jsbuild.CSSComboFile, lp.scripts.utilities.js.jsbuild.JSComboFile

A file made up of several combined files.

It offers support for detecting if the file needs updating and updating it from it source files.

Method __init__ Undocumented
Method needs_update Return True when the file needs to be updated.
Method log Undocumented
Method update Update the file from its source files.
Method get_comment Return a string wrapped in a comment to be include in the output.
Method get_file_header Return a string to include before outputting a file.
Method filter_file_content Hook to process the file content before being combined.
def __init__(self, src_files, target_file):
Undocumented
def needs_update(self):
Return True when the file needs to be updated.

This is usually because the target file doesn't exist yet or because one of the source file was modified.

def log(self, msg):
Undocumented
def update(self):
Update the file from its source files.
def get_comment(self, msg):
Return a string wrapped in a comment to be include in the output.

Can be used to help annotate the output file.

def get_file_header(self, path):
Return a string to include before outputting a file.

Can be used by subclasses to output a file reference in the combined file. Default implementation returns nothing.

def filter_file_content(self, file_content, path):
Hook to process the file content before being combined.
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.