PyFoam.Basics.FoamOptionParser module¶
Parse options for the PyFoam-Scripts
-
class
PyFoam.Basics.FoamOptionParser.
FoamHelpFormatter
(indent_increment=0, max_help_position=24, width=None, short_first=0)[source]¶ Bases:
optparse.TitledHelpFormatter
For description and epilog preserve double newlines as one newline
-
class
PyFoam.Basics.FoamOptionParser.
FoamOptionParser
(args=None, usage=None, version=None, description=None, epilog=None, examples=None, interspersed=False)[source]¶ Bases:
optparse.OptionParser
Wrapper to the usual OptionParser to honor the conventions of OpenFOAM-utilities
Options that are not used by the script are passed to the OpenFOAM-application
-
class
PyFoam.Basics.FoamOptionParser.
Subcommand
(name, parser=None, help='', aliases=(), nr=None, exactNr=None)[source]¶ Bases:
object
A subcommand of a root command-line application that may be invoked by a SubcommandOptionParser. Taken from https://gist.github.com/sampsyo/462717
-
class
PyFoam.Basics.FoamOptionParser.
SubcommandFoamOptionParser
(args=None, usage=None, version=None, epilog=None, examples=None, description=None, subcommands=[])[source]¶ Bases:
PyFoam.Basics.FoamOptionParser.FoamOptionParser
Subclass of the regular option parser that allows setting subcommands Inspired by https://gist.github.com/sampsyo/462717
-
format_help
(formatter=None)[source]¶ Taken from https://gist.github.com/sampsyo/462717
-