python.AthArgumentParser.AthArgumentParser Class Reference

Inheritance diagram for python.AthArgumentParser.AthArgumentParser:

Collaboration diagram for python.AthArgumentParser.AthArgumentParser:

Public Member Functions
	__init__ (self, jo_name=None, prog=None, print_caller_help=True, **kwargs)
	add_argument (self, *args, **kwargs)
	parse_args (self, args=None, namespace=None)
	parse_known_args (self, args=None, namespace=None)
	format_help (self)

Public Attributes
str	caller_help
	prefix_chars

Detailed Description

Parse user commandline arguments in a job option. 

Definition at line 31 of file AthArgumentParser.py.

Constructor & Destructor Documentation

__init__()

python.AthArgumentParser.AthArgumentParser.__init__	(		self,
			jo_name = None,
			prog = None,
			print_caller_help = True,
		**	kwargs )

 Create the parser
    ---------
    Arguments
    ---------
    jo_name: 
        The name of the calling job option, used to format the help
        text. Will attempt to deduce it if possible
    prog:
        The start of the usage message, usually can be deduced
    print_caller_help:
        Whether or not to print the help text from the calling program
        (usually athena)

    All other keyword arguments are forwarded to the base class
    constructor

Definition at line 34 of file AthArgumentParser.py.

    def __init__(self, jo_name=None, prog=None, print_caller_help=True, **kwargs):
        """ Create the parser
            ---------
            Arguments
            ---------
            jo_name: 
                The name of the calling job option, used to format the help
                text. Will attempt to deduce it if possible
            prog:
                The start of the usage message, usually can be deduced
            print_caller_help:
                Whether or not to print the help text from the calling program
                (usually athena)
 
            All other keyword arguments are forwarded to the base class
            constructor
        """
 
        caller = sys.argv[0]
        if prog is None:
            if jo_name is None:
                # Use inspect to find which job option we're in. This isn't
                # completely foolproof but it's just a cosmetic detail so
                # doesn't need to be
                for frame in inspect.stack():
                    # For each frame in the stack, check the file name and keep
                    # it if it matches one of the scripts supplied
                    fname = inspect.getfile(frame[0])
                    try:
                        jo_name = next(
                            script for script in opts.scripts if fname.endswith(script)
                        )
                        break
                    except StopIteration:
                        pass
                else:
                    # fallback name
                    jo_name = "User job option"
            prog = "{0} {1} [{0} options] -".format(os.path.basename(caller), jo_name)
        if print_caller_help:
            # Get the help options for the caller
            caller_help, _ = Popen(
                [caller, "--help"], stdout=PIPE, stderr=PIPE
            ).communicate()
            # decode from bytes
            caller_help = caller_help.decode("utf-8")
            if caller.endswith("athena.py"):
                # If this is being called from athena, we know that there are
                # some lines to strip off
                caller_help = caller_help.split("\n", 3)[3]
            self.caller_help = "{} options:\n{}".format(
                os.path.basename(caller), caller_help
            )
        else:
            self.caller_help = ""
        super().__init__(prog=prog, **kwargs)
        super().add_argument(
            "remaining scripts",
            nargs="*",
            help="Any remaining scripts to be run by athena after this job option. Mainly used to run the 'post' script on the grid.",
        )
 

Member Function Documentation

add_argument()

python.AthArgumentParser.AthArgumentParser.add_argument	(		self,
		*	args,
		**	kwargs )

 Add a new argument

The difference between this and the base class is that it disallows
adding positional arguments which are reserved by athena for job
options. In particular, even if user code uses only one job option
(which is common) pathena will add more when running on the grid

Definition at line 96 of file AthArgumentParser.py.

    def add_argument(self, *args, **kwargs):
        """ Add a new argument
 
        The difference between this and the base class is that it disallows
        adding positional arguments which are reserved by athena for job
        options. In particular, even if user code uses only one job option
        (which is common) pathena will add more when running on the grid
        """
        if not args or len(args) and args[0][0] not in self.prefix_chars:
            raise ValueError(
                "Positional arguments are not allowed! Defining them could mess up grid running!"
            )
        return super().add_argument(*args, **kwargs)
 

format_help()

python.AthArgumentParser.AthArgumentParser.format_help

(

self

)

Definition at line 126 of file AthArgumentParser.py.

    def format_help(self):
        text = super().format_help()
        return "\n".join([text, self.caller_help])

parse_args()

python.AthArgumentParser.AthArgumentParser.parse_args	(		self,
			args = None,
			namespace = None )

 Override the base class to use the leftover athena argumnets by
default

Definition at line 110 of file AthArgumentParser.py.

    def parse_args(self, args=None, namespace=None):
        """ Override the base class to use the leftover athena argumnets by
        default
        """
        if args is None:
            args = opts.user_opts
        return super().parse_args(args, namespace)
 

parse_known_args()

python.AthArgumentParser.AthArgumentParser.parse_known_args	(		self,
			args = None,
			namespace = None )

 Override the base class to use the leftover athena argumnets by
default

Definition at line 118 of file AthArgumentParser.py.

    def parse_known_args(self, args=None, namespace=None):
        """ Override the base class to use the leftover athena argumnets by
        default
        """
        if args is None:
            args = opts.user_opts
        return super().parse_known_args(args, namespace)
 

Member Data Documentation

caller_help

str python.AthArgumentParser.AthArgumentParser.caller_help

Initial value:

=  "{} options:\n{}".format(
                os.path.basename(caller), caller_help
            )

Definition at line 84 of file AthArgumentParser.py.

prefix_chars

python.AthArgumentParser.AthArgumentParser.prefix_chars

Definition at line 104 of file AthArgumentParser.py.

---

The documentation for this class was generated from the following file:

• AthArgumentParser.py