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)

Bases: optparse.TitledHelpFormatter

For description and epilog preserve double newlines as one newline

format_description(description)

format_epilog(epilog)

class PyFoam.Basics.FoamOptionParser.FoamOptionParser(args=None, usage=None, version=None, description=None, epilog=None, examples=None, interspersed=False)

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

casePath()

Returns the path to the case (if applicable)

getApplication()

Return the OpenFOAM-Application to be run

getArgs()

Return the arguments left after parsing

getOptions()

Return the options

parse(nr=None, exactNr=True)

parse the options :param nr: minimum number of arguments that are to be passed to the application 3 is default for pre-1.5 versions of OpenFOAM

processKeywordArguments(kw)

restoreEnvironment()

Restore the environment to its old glory… if it was changed

class PyFoam.Basics.FoamOptionParser.Subcommand(name, parser=None, help='', aliases=(), nr=None, exactNr=None)

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=[])

Bases: PyFoam.Basics.FoamOptionParser.FoamOptionParser

Subclass of the regular option parser that allows setting subcommands Inspired by https://gist.github.com/sampsyo/462717

addSubcommand(cmd, usage=None)

format_help(formatter=None)

Taken from https://gist.github.com/sampsyo/462717

getArgs()

Return the arguments left after parsing

parse(nr=None, exactNr=None)

Do the parsing of a subcommand