cmsHarvester.CMSHarvesterHelpFormatter Class Reference

Helper class: CMSHarvesterHelpFormatter. More...

Inheritance diagram for cmsHarvester.CMSHarvesterHelpFormatter:

Public Member Functions
def	format_usage

Detailed Description

Helper class: CMSHarvesterHelpFormatter.

Helper class to add some customised help output to cmsHarvester.

We want to add some instructions, as well as a pointer to the CMS
Twiki.

Definition at line 150 of file cmsHarvester.py.

Member Function Documentation

def cmsHarvester.CMSHarvesterHelpFormatter.format_usage	(		self,
			usage
	)

Definition at line 158 of file cmsHarvester.py.

References join().

Referenced by argparse.ArgumentParser.print_usage(), and python.rootplot.argparse.ArgumentParser.print_usage().

    def format_usage(self, usage):

        usage_lines = []

        sep_line = "-" * 60
        usage_lines.append(sep_line)
        usage_lines.append("Welcome to the CMS harvester, a (hopefully useful)")
        usage_lines.append("tool to create harvesting configurations.")
        usage_lines.append("For more information please have a look at the CMS Twiki:")
        usage_lines.append("  %s" % twiki_url)
        usage_lines.append(sep_line)
        usage_lines.append("")

        # Since we only add to the output, we now just append the
        # original output from IndentedHelpFormatter.
        usage_lines.append(optparse.IndentedHelpFormatter. \
                           format_usage(self, usage))

        formatted_usage = "\n".join(usage_lines)
        return formatted_usage