python.AthConfigFlags.AthConfigFlags Class Reference

Inheritance diagram for python.AthConfigFlags.AthConfigFlags:

Collaboration diagram for python.AthConfigFlags.AthConfigFlags:

Public Member Functions
def	__init__ (self)
def	athHash (self)
def	__hash__ (self)
def	__getattr__ (self, name)
def	__setattr__ (self, name, value)
def	__delattr__ (self, name)
def	__getitem__ (self, name)
def	__setitem__ (self, name, value)
def	__delitem__ (self, name)
def	__contains__ (self, name)
def	__iter__ (self)
def	asdict (self)
def	addFlag (self, name, setDef, type=None, help=None)
def	addFlagsCategory (self, path, generator, prefix=False)
def	needFlagsCategory (self, name)
def	loadAllDynamicFlags (self)
def	hasCategory (self, name)
def	hasFlag (self, name)
def	__call__ (self, name)
def	lock (self)
def	locked (self)
def	clone (self)
def	cloneAndReplace (self, subsetToReplace, replacementSubset, keepOriginal=False)
def	join (self, other, prefix='')
def	dump (self, pattern=".*", evaluate=False, formatStr="{:40} : {}", maxLength=None)
def	initAll (self)
def	getArgumentParser (self, **kwargs)
def	parser (self)
def	args (self)
def	fillFromString (self, flag_string)
def	fillFromArgs (self, listOfArgs=None, parser=None, return_unknown=False)

Static Public Attributes
	print_context

Private Member Functions
def	_calculateHash (self)
def	_renamed_map (self)
def	_subflag_itr (self)
def	_loadDynaFlags (self, name)
def	_set (self, name, value)
def	_get (self, name)
def	_tryModify (self)

Private Attributes
	_flagdict
	_locked
	_dynaflags
	_loaded
	_categoryCache
	_hash
	_parser
	_args
	_renames

Static Private Attributes
list	_hashedFlags = []

Detailed Description

Definition at line 230 of file AthConfigFlags.py.

Constructor & Destructor Documentation

__init__()

def python.AthConfigFlags.AthConfigFlags.__init__

(

self

)

Definition at line 237 of file AthConfigFlags.py.

    def __init__(self):
        self._flagdict=dict()
        self._locked=False
        self._dynaflags = dict()
        self._loaded    = set()      # dynamic flags that were loaded
        self._categoryCache = set()  # cache for already found categories
        self._hash = None
        self._parser = None
        self._args = None # user args from parser
        self._renames = {}
 

Member Function Documentation

__call__()

def python.AthConfigFlags.AthConfigFlags.__call__	(		self,
			name
	)

Definition at line 491 of file AthConfigFlags.py.

    def __call__(self,name):
        return self._get(name)
 

__contains__()

def python.AthConfigFlags.AthConfigFlags.__contains__	(		self,
			name
	)

Definition at line 307 of file AthConfigFlags.py.

    def __contains__(self, name):
        return hasattr(self, name)
 

__delattr__()

def python.AthConfigFlags.AthConfigFlags.__delattr__	(		self,
			name
	)

Definition at line 290 of file AthConfigFlags.py.

    def __delattr__(self, name):
        del self[name]
 

__delitem__()

def python.AthConfigFlags.AthConfigFlags.__delitem__	(		self,
			name
	)

Definition at line 299 of file AthConfigFlags.py.

    def __delitem__(self, name):
        self._tryModify()
        self.loadAllDynamicFlags()
        for key in list(self._flagdict):
            if key.startswith(name):
                del self._flagdict[key]
        self._categoryCache.clear()
 

__getattr__()

def python.AthConfigFlags.AthConfigFlags.__getattr__	(		self,
			name
	)

Definition at line 268 of file AthConfigFlags.py.

    def __getattr__(self, name):
        # Avoid infinite recursion looking up our own attributes
        _flagdict = object.__getattribute__(self, "_flagdict")
 
        # First try to get an already loaded flag or category
        if name in _flagdict:
            return self._get(name)
 
        # Check (and load if needed) dynamic flags
        if self.hasCategory(name):
            return FlagAddress(self, name)
 
        raise AttributeError(f"No such flag: {name}")
 

__getitem__()

def python.AthConfigFlags.AthConfigFlags.__getitem__	(		self,
			name
	)

Definition at line 293 of file AthConfigFlags.py.

    def __getitem__(self, name):
        return getattr(self, name)
 

__hash__()

def python.AthConfigFlags.AthConfigFlags.__hash__

(

self

)

Definition at line 255 of file AthConfigFlags.py.

    def __hash__(self):
        raise DeprecationWarning("__hash__ method in AthConfigFlags is deprecated. Probably called from function decorator, use AccumulatorCache decorator instead.")
 

__iter__()

def python.AthConfigFlags.AthConfigFlags.__iter__

(

self

)

Definition at line 310 of file AthConfigFlags.py.

    def __iter__(self):
        self.loadAllDynamicFlags()
        rmap = self._renamed_map()
        used = set()
        for flag in self._flagdict:
            for r in rmap[flag]:
                first = r.split('.',1)[0]
                if first not in used:
                    yield first
                    used.add(first)
 

__setattr__()

def python.AthConfigFlags.AthConfigFlags.__setattr__	(		self,
			name,
			value
	)

Definition at line 282 of file AthConfigFlags.py.

    def __setattr__(self, name, value):
        if name.startswith("_"):
            return object.__setattr__(self, name, value)
 
        if name in self._flagdict:
            return self._set(name, value)
        raise RuntimeError( "No such flag: "+ name+". The name is likely incomplete." )
 

__setitem__()

def python.AthConfigFlags.AthConfigFlags.__setitem__	(		self,
			name,
			value
	)

Definition at line 296 of file AthConfigFlags.py.

    def __setitem__(self, name, value):
        setattr(self, name, value)
 

_calculateHash()

def python.AthConfigFlags.AthConfigFlags._calculateHash (   self )

private

Definition at line 258 of file AthConfigFlags.py.

    def _calculateHash(self):
        # Once we've hashed a flags instance, we need to be sure that
        # it never goes away.  Otherwise, since we base the hash
        # on just the id of the dictionary, if a flags object is deleted
        # and a new one created, the hash of the new one could match the
        # hash of the old, even if contents are different.
        # See ATLASRECTS-8070.
        AthConfigFlags._hashedFlags.append (self)
        return hash( (frozenset({k: v for k, v in self._renames.items() if k != v}), id(self._flagdict)) )
 

_get()

def python.AthConfigFlags.AthConfigFlags._get (   self,   name  )

private

Definition at line 482 of file AthConfigFlags.py.

    def _get(self,name):
        try:
            return self._flagdict[name].get(self)
        except KeyError:
            closestMatch = get_close_matches(name,self._flagdict.keys(),1)
            raise KeyError(f"No flag with name '{name}' found" +
                           (f". Did you mean '{closestMatch[0]}'?" if closestMatch else ""))
 

_loadDynaFlags()

def python.AthConfigFlags.AthConfigFlags._loadDynaFlags (   self,   name  )

private

loads the flags of the form "A.B.C" first attempting the path "A" then "A.B" and then "A.B.C"

Definition at line 403 of file AthConfigFlags.py.

    def _loadDynaFlags(self, name):
        """
        loads the flags of the form "A.B.C" first attempting the path "A" then "A.B" and then "A.B.C"
        """
 
        def __load_impl( flagBaseName ):
            if flagBaseName in self._loaded:
                _msg.debug("Flags %s already loaded",flagBaseName  )
                return
            if flagBaseName in self._dynaflags:
                _msg.debug("Dynamically loading the flags under %s", flagBaseName )
                # Retain locked status and hash
                isLocked = self._locked
                myHash = self._hash
                self._locked = False
                generator, prefix = self._dynaflags[flagBaseName]
                self.join( generator(), flagBaseName if prefix else "" )
                self._locked = isLocked
                self._hash = myHash
                del self._dynaflags[flagBaseName]
                self._loaded.add(flagBaseName)
 
        pathfrags = name.split('.')
        for maxf in range(1, len(pathfrags)+1):
            __load_impl( '.'.join(pathfrags[:maxf]) )
 

_renamed_map()

def python.AthConfigFlags.AthConfigFlags._renamed_map (   self )

private

mapping from the old names to the new names

This is the inverse of _renamed, which maps new names to old
names

Returns a list of the new names corresponding to the old names
(since cloneAndReplace may or may not disable access to the old name,
it is possible that an old name renames to multiple new names)

Definition at line 331 of file AthConfigFlags.py.

    def _renamed_map(self):
        """mapping from the old names to the new names
 
        This is the inverse of _renamed, which maps new names to old
        names
        
        Returns a list of the new names corresponding to the old names
        (since cloneAndReplace may or may not disable access to the old name,
        it is possible that an old name renames to multiple new names)
        """        
        revmap = defaultdict(list)
        
        for new, old in self._renames.items():
            if old is not None:
                revmap[old].append(new)
        
        def rename(key):
            for old, newlist in revmap.items():
                if key.startswith(old + '.'):
                    stem = key.removeprefix(old)
                    return [ f'{new}{stem}' if new else '' for new in newlist ]
            return [ key ]
        
        return {x:rename(x) for x in self._flagdict.keys()}
 

_set()

def python.AthConfigFlags.AthConfigFlags._set (   self,   name,   value  )

private

Definition at line 473 of file AthConfigFlags.py.

    def _set(self,name,value):
        self._tryModify()
        try:
            self._flagdict[name].set(value)
        except KeyError:
            closestMatch = get_close_matches(name,self._flagdict.keys(),1)
            raise KeyError(f"No flag with name '{name}' found" +
                           (f". Did you mean '{closestMatch[0]}'?" if closestMatch else ""))
 

_subflag_itr()

def python.AthConfigFlags.AthConfigFlags._subflag_itr (   self )

private

Subflag iterator for all flags

This is used by the asdict() function.

Definition at line 356 of file AthConfigFlags.py.

    def _subflag_itr(self):
        """Subflag iterator for all flags
 
        This is used by the asdict() function.
        """
        self.loadAllDynamicFlags()
 
        for old, newlist in self._renamed_map().items():
            for new in newlist:
                # Lots of modules are missing in analysis releases. I
                # tried to prevent imports using the _addFlagsCategory
                # function which checks if some module exists, but this
                # turned in to quite a rabbit hole. Catching and ignoring
                # the missing module exception seems to work, even if it's
                # not pretty.
                try:
                    yield new, getattr(self, old)
                except ModuleNotFoundError as err:
                    _msg.debug(f'missing module: {err}')
                    pass
 

_tryModify()

def python.AthConfigFlags.AthConfigFlags._tryModify (   self )

private

Definition at line 504 of file AthConfigFlags.py.

    def _tryModify(self):
        if self._locked:
            raise RuntimeError("Attempt to modify locked flag container")
        else:
            # if unlocked then invalidate hash
            self._hash = None
 

addFlag()

def python.AthConfigFlags.AthConfigFlags.addFlag	(		self,
			name,
			setDef,
			type = None,
			help = None
	)

Definition at line 377 of file AthConfigFlags.py.

    def addFlag(self, name, setDef, type=None, help=None):
        self._tryModify()
        if name in self._flagdict:
            raise KeyError("Duplicated flag name: {}".format( name ))
        self._flagdict[name]=CfgFlag(setDef, type, help)
        return
 

addFlagsCategory()

def python.AthConfigFlags.AthConfigFlags.addFlagsCategory	(		self,
			path,
			generator,
			prefix = False
	)

The path is the beginning of the flag name (e.g. "X" for flags generated with name "X.*").
The generator is a function that returns a flags container, the flags have to start with the same path.
When the prefix is True the flags created by the generator are prefixed by "path".

Supported calls are then:
 addFlagsCategory("A", g) - where g is function creating flags  is f.addFlag("A.x", someValue)
 addFlagsCategory("A", g, True) - when flags are defined in g like this: f.addFalg("x", somevalue),
The latter option allows to share one generator among flags that are later loaded in different paths.

Definition at line 384 of file AthConfigFlags.py.

    def addFlagsCategory(self, path, generator, prefix=False):
        """
        The path is the beginning of the flag name (e.g. "X" for flags generated with name "X.*").
        The generator is a function that returns a flags container, the flags have to start with the same path.
        When the prefix is True the flags created by the generator are prefixed by "path".
 
        Supported calls are then:
         addFlagsCategory("A", g) - where g is function creating flags  is f.addFlag("A.x", someValue)
         addFlagsCategory("A", g, True) - when flags are defined in g like this: f.addFalg("x", somevalue),
        The latter option allows to share one generator among flags that are later loaded in different paths.
        """
        self._tryModify()
        _msg.debug("Adding flag category %s", path)
        self._dynaflags[path] = (generator, prefix)
 

args()

def python.AthConfigFlags.AthConfigFlags.args

(

self

)

Definition at line 654 of file AthConfigFlags.py.

    def args(self):
        return self._args
 
 

asdict()

def python.AthConfigFlags.AthConfigFlags.asdict

(

self

)

Convert to a python dictionary

This is identical to the `asdict` in FlagAddress, but for all
the flags.

Definition at line 321 of file AthConfigFlags.py.

    def asdict(self):
        """Convert to a python dictionary
 
        This is identical to the `asdict` in FlagAddress, but for all
        the flags.
 
        """
        return _asdict(self._subflag_itr())
 
 

athHash()

def python.AthConfigFlags.AthConfigFlags.athHash

(

self

)

Definition at line 248 of file AthConfigFlags.py.

    def athHash(self):
        if self._locked is False:
            raise RuntimeError("Cannot calculate hash of unlocked flag container")
        elif self._hash is None:
            self._hash = self._calculateHash()
        return self._hash
 

clone()

def python.AthConfigFlags.AthConfigFlags.clone

(

self

)

Return an unlocked copy of self (dynamic flags are not loaded)

Definition at line 511 of file AthConfigFlags.py.

    def clone(self):
        """Return an unlocked copy of self (dynamic flags are not loaded)"""
        cln = AthConfigFlags()
        cln._flagdict = deepcopy(self._flagdict)
        cln._dynaflags = copy(self._dynaflags)
        cln._renames = deepcopy(self._renames)
        return cln
 
 

cloneAndReplace()

def python.AthConfigFlags.AthConfigFlags.cloneAndReplace	(		self,
			subsetToReplace,
			replacementSubset,
			keepOriginal = False
	)

This is to replace subsets of configuration flags like

Example:
newflags = flags.cloneAndReplace('Muon', 'Trigger.Offline.Muon')

Definition at line 520 of file AthConfigFlags.py.

    def cloneAndReplace(self,subsetToReplace,replacementSubset, keepOriginal=False):
        """
        This is to replace subsets of configuration flags like
 
        Example:
        newflags = flags.cloneAndReplace('Muon', 'Trigger.Offline.Muon')
        """
 
        _msg.debug("cloning flags and replacing %s by %s", subsetToReplace, replacementSubset)
 
        self._loadDynaFlags( subsetToReplace )
        self._loadDynaFlags( replacementSubset )
 
        subsetToReplace = subsetToReplace.strip(".")
        replacementSubset = replacementSubset.strip(".")
 
        #Sanity check: Don't replace a by a
        if (subsetToReplace == replacementSubset):
            raise RuntimeError(f'Can not replace flags {subsetToReplace} with themselves')
 
        # protect against subsequent remaps within remaps: clone = flags.cloneAndReplace('Y', 'X').cloneAndReplace('X.b', 'X.a')
        for alias,src in self._renames.items():
            if src is None: continue
            if src+"." in subsetToReplace:
                raise RuntimeError(f'Can not replace flags {subsetToReplace} by {replacementSubset} because of already present replacement of {alias} by {src}')
 
 
        newFlags = copy(self) # shallow copy
        newFlags._renames = deepcopy(self._renames) #maintains renames
 
        if replacementSubset in newFlags._renames: #and newFlags._renames[replacementSubset]:
            newFlags._renames[subsetToReplace] = newFlags._renames[replacementSubset]
        else:
            newFlags._renames[subsetToReplace] = replacementSubset
        
        if not keepOriginal:
            if replacementSubset not in newFlags._renames or newFlags._renames[replacementSubset] == replacementSubset:
                newFlags._renames[replacementSubset] = None # block access to original flags
            else:
                del newFlags._renames[replacementSubset]
                #If replacementSubset was a "pure renaming" of another set of flags,
                #the original set of flags gets propagated down to its potential further renamings:
                #no need to worry about maintaining the intermediate steps in the renaming.
        else:
            if replacementSubset not in newFlags._renames:
                newFlags._renames[replacementSubset] = replacementSubset
                #For _renamed_map to know that these flags still work.
        newFlags._hash = None
        return newFlags
 
 

dump()

def python.AthConfigFlags.AthConfigFlags.dump	(		self,
			pattern = ".*",
			evaluate = False,
			formatStr = "{:40} : {}",
			maxLength = None
	)

Definition at line 592 of file AthConfigFlags.py.

    def dump(self, pattern=".*", evaluate=False, formatStr="{:40} : {}", maxLength=None):        import re
        compiled = re.compile(pattern)
        def truncate(s): return s[:maxLength] + ("..." if maxLength and len(s)>maxLength else "")
        reverse_renames = {value: key for key, value in self._renames.items() if value is not None} # new name to old
        for name in sorted(self._flagdict):
            renamed = name
            if any([name.startswith(r) for r in reverse_renames.keys() if r is not None]):
                for oldprefix, newprefix in reverse_renames.items():
                    if name.startswith(oldprefix):
                        renamed = name.replace(oldprefix, newprefix)
                        break
            if compiled.match(renamed):
                if evaluate:
                    try:
                        rep = repr(self._flagdict[name] )
                        val = repr(self._flagdict[name].get(self))
                        if val != rep:
                            print(formatStr.format(renamed,truncate("{} {}".format( val, rep )) ))
                        else:
                            print(formatStr.format(renamed, truncate("{}".format(val)) ) )
                    except Exception as e:
                        print(formatStr.format(renamed, truncate("Exception: {}".format( e )) ))
                else:
                    print(formatStr.format( renamed, truncate("{}".format(repr(self._flagdict[name] ) )) ))
 
        if len(self._dynaflags) != 0 and any([compiled.match(x) for x in self._dynaflags.keys()]):
            print("Flag categories that can be loaded dynamically")
            print("{:25} : {:>30} : {}".format( "Category","Generator name", "Defined in" ) )
            for name,gen_and_prefix in sorted(self._dynaflags.items()):
                if compiled.match(name):
                    print("{:25} : {:>30} : {}".format( name, gen_and_prefix[0].__name__, '/'.join(gen_and_prefix[0].__code__.co_filename.split('/')[-2:]) ) )
        if len(self._renames):
            print("Flag categories that are redirected by the cloneAndReplace")
            for alias,src in self._renames.items():
                print("{:30} points to {:>30} ".format( alias, src  if src else "nothing") )
            
 
 

fillFromArgs()

def python.AthConfigFlags.AthConfigFlags.fillFromArgs	(		self,
			listOfArgs = None,
			parser = None,
			return_unknown = False
	)

Used to set flags from command-line parameters, like flags.fillFromArgs(sys.argv[1:])

if return_unknown=False, returns: args 
       otherwise returns: args, uknown_args
     where unknown_args is the list of arguments that did not correspond to one of the flags 

Definition at line 699 of file AthConfigFlags.py.

    def fillFromArgs(self, listOfArgs=None, parser=None, return_unknown=False):
        """
        Used to set flags from command-line parameters, like flags.fillFromArgs(sys.argv[1:])
 
        if return_unknown=False, returns: args 
                       otherwise returns: args, uknown_args
             where unknown_args is the list of arguments that did not correspond to one of the flags 
        """
        import sys
 
        self._tryModify()
 
        if parser is None:
            parser = self.parser()
        self._parser = parser # set our parser to given one
        argList = listOfArgs if listOfArgs is not None else sys.argv[1:]
        do_help = False
        # We will now do a pre-parse of the command line arguments to propagate these to the flags
        # the reason for this is so that we can use the help messaging to display the values of all
        # flags as they would be *after* any parsing takes place. This is nice to see e.g. the value
        # that any derived flag (functional flag) will take after, say, the filesInput are set
        import argparse
        unrequiredActions = []
        if "-h" in argList or "--help" in argList:
            do_help = True
            if "-h" in argList: argList.remove("-h")
            if "--help" in argList: argList.remove("--help")
            # need to unrequire any required arguments in order to do a "pre parse"
            for a in parser._actions:
                if a.required:
                    unrequiredActions.append(a)
                    a.required = False
        (args,leftover)=parser.parse_known_args(argList)
        for a in unrequiredActions: a.required=True
 
        # remove the leftovers from the argList ... for later use in the do_help
        argList = [a for a in argList if a not in leftover]
 
        # First, handle athena.py-like arguments (if available in parser):
        def arg_set(dest):
            """Check if dest is available in parser and has been set"""
            return vars(args).get(dest, None) is not None
 
        if arg_set('debug'):
            self.Exec.DebugStage=args.debug
 
        if arg_set('evtMax'):
            self.Exec.MaxEvents=args.evtMax
 
        if arg_set('interactive'):
            self.Exec.Interactive=args.interactive
 
        if arg_set('skipEvents'):
            self.Exec.SkipEvents=args.skipEvents
 
        if arg_set('filesInput'):
            self.Input.Files = [] # remove generic
            for f in args.filesInput.split(","):
                found = glob.glob(f)
                # if not found, add string directly
                self.Input.Files += found if found else [f]
 
        if "-l" in argList or "--loglevel" in argList: # different check b.c. has a default value so will always be in args
            from AthenaCommon import Constants
            self.Exec.OutputLevel = getattr(Constants, args.loglevel)
 
        if arg_set('config_only') and args.config_only is not False:
            from os import environ
            environ["PICKLECAFILE"] = "" if args.config_only is True else args.config_only
 
        if arg_set('threads'):
            self.Concurrency.NumThreads = args.threads
            #Work-around a possible inconsistency of NumThreads and NumConcurrentEvents that may
            #occur when these values are set by the transforms and overwritten by --athenaopts ..
            #See also ATEAM-907
            if args.concurrent_events is None and self.Concurrency.NumConcurrentEvents==0:
                self.Concurrency.NumConcurrentEvents = args.threads
 
        if arg_set('concurrent_events'):
            self.Concurrency.NumConcurrentEvents = args.concurrent_events
 
        if arg_set('nprocs'):
            self.Concurrency.NumProcs = args.nprocs
 
        if arg_set('perfmon'):
            from PerfMonComps.PerfMonConfigHelpers import setPerfmonFlagsFromRunArgs
            setPerfmonFlagsFromRunArgs(self, args)
 
        if arg_set('mtes'):
            self.Exec.MTEventService = args.mtes
 
        if arg_set('mtes_channel'):
            self.Exec.MTEventServiceChannel = args.mtes_channel
 
        if arg_set('profile_python'):
            from AthenaCommon.Debugging import dumpPythonProfile
            import atexit, cProfile, functools
            cProfile._athena_python_profiler = cProfile.Profile()
            cProfile._athena_python_profiler.enable()
 
            # Save stats to file at exit
            atexit.register(functools.partial(dumpPythonProfile, args.profile_python))
 
        if arg_set('mpi'):
            self.Exec.MPI = args.mpi
 
        # All remaining arguments are assumed to be key=value pairs to set arbitrary flags:
        unknown_args = []
        for arg in leftover:
            if arg=='--':
                argList += ["---"]
                continue # allows for multi-value arguments to be terminated by a " -- "
            if do_help and '=' not in arg:
                argList += arg.split(".") # put arg back back for help (but split by sub-categories)
                continue
            try:
                self.fillFromString(arg)
            except KeyError as e:
                if return_unknown:
                    unknown_args += [arg]
                else:
                    raise e
 
        if do_help:
            if parser.epilog is None: parser.epilog=""
            parser.epilog += "  Note: Specify additional flags in form <flagName>=<value>."
            subparsers = {"":[parser,parser.add_subparsers(help=argparse.SUPPRESS)]} # first is category's parser, second is subparsers (effectively the category's subcategories)
            # silence logging while evaluating flags
            logging.root.setLevel(logging.ERROR)
            def getParser(category): # get parser for a given category
                if category not in subparsers.keys():
                    cat1,cat2 = category.rsplit(".",1) if "." in category else ("",category)
                    p,subp = getParser(cat1)
                    if subp.help==argparse.SUPPRESS:
                        subp.help = "Flag subcategories:"
                    newp = subp.add_parser(cat2,help="{} flags".format(category),
                                           formatter_class = argparse.ArgumentDefaultsHelpFormatter,usage=argparse.SUPPRESS)
                    newp._positionals.title = "flags"
                    subparsers[category] = [newp,newp.add_subparsers(help=argparse.SUPPRESS)]
                return subparsers[category]
            self.loadAllDynamicFlags()
            for name in sorted(self._flagdict):
                category,flagName = name.rsplit(".",1) if "." in name else ("",name)
                flag = self._flagdict[name]
                try:
                    val = repr(flag.get(self))
                except Exception:
                    val = None
                if flag._help != argparse.SUPPRESS:
                    helptext = ""
                    if flag._help is not None:
                        helptext = f": {flag._help}"
                    if flag._type is not None:
                        helptext += f' [type: {flag._type.__name__}]'
                    if val is not None and helptext == "":
                        helptext = ": " # ensures default values are displayed even if there's no help text
                    getParser(category)[0].add_argument(name, nargs='?', default=val, help=helptext)
 
            parser._positionals.title = 'flags and positional arguments'
            parser.parse_known_args(argList + ["--help"])
 
        self._args = args
 
        if return_unknown:
            return args,unknown_args
        else:
            return args
 
 
 

fillFromString()

def python.AthConfigFlags.AthConfigFlags.fillFromString	(		self,
			flag_string
	)

Fill the flags from a string of type key=value

Definition at line 658 of file AthConfigFlags.py.

    def fillFromString(self, flag_string):
        """Fill the flags from a string of type key=value"""
        import ast
 
        try:
            key, value = flag_string.split("=")
        except ValueError:
            raise ValueError(f"Cannot interpret argument {flag_string}, expected a key=value format")
 
        key = key.strip()
        value = value.strip()
 
        # also allow key+=value to append
        oper = "="
        if (key[-1]=="+"):
            oper = "+="
            key = key[:-1]
 
        if key not in self._flagdict:
            self._loadDynaFlags( '.'.join(key.split('.')[:-1]) ) # for a flag A.B.C dynamic flags from category A.B
        if key not in self._flagdict:
            raise KeyError(f"{key} is not a known configuration flag")
 
        flag_type = self._flagdict[key]._type
        if flag_type is None:
            # Regular flag
            try:
                ast.literal_eval(value)
            except Exception:  # Can't determine type, assume we got an un-quoted string
                value=f"\"{value}\""
 
        elif isinstance(flag_type, EnumMeta):
            # Flag is an enum, so we need to import the module containing the enum
            ENUM = importlib.import_module(flag_type.__module__)  # noqa: F841 (used in exec)
            value=f"ENUM.{value}"
 
        # Set the value (this also does the type checking if needed)
        exec(f"self.{key}{oper}{value}")
 
 

getArgumentParser()

def python.AthConfigFlags.AthConfigFlags.getArgumentParser	(		self,
		**	kwargs
	)

Scripts calling AthConfigFlags.fillFromArgs can extend this parser, and pass their version to fillFromArgs

Definition at line 639 of file AthConfigFlags.py.

    def getArgumentParser(self, **kwargs):
        """
        Scripts calling AthConfigFlags.fillFromArgs can extend this parser, and pass their version to fillFromArgs
        """
        import argparse
        from AthenaCommon.AthOptionsParser import getArgumentParser
        parser = getArgumentParser(**kwargs)
        parser.add_argument("---",dest="terminator",action='store_true', help=argparse.SUPPRESS) # special hidden option required to convert option terminator -- for --help calls
 
        return parser
 

hasCategory()

def python.AthConfigFlags.AthConfigFlags.hasCategory	(		self,
			name
	)

Check if category exists (loads dynamic flags if needed)

Definition at line 436 of file AthConfigFlags.py.

    def hasCategory(self, name):
        """Check if category exists (loads dynamic flags if needed)"""
        # We cache successfully found categories
        if name in self._categoryCache:
            return True
 
        if (re_name := self._renames.get(name)) is not None and re_name != name:
            return self.hasCategory(re_name)
 
        # Load dynamic flags if needed
        self._loadDynaFlags(name)
 
        # If not found do search through all keys.
        # TODO: could be improved by using a trie for _flagdict
        for f in self._flagdict.keys():
            if f.startswith(name+'.'):
                self._categoryCache.add(name)
                return True
        for c in self._dynaflags.keys():
            if c.startswith(name):
                self._categoryCache.add(name)
                return True
 
        return False
 

hasFlag()

def python.AthConfigFlags.AthConfigFlags.hasFlag	(		self,
			name
	)

Check if flag exists (loads dynamic flags if needed)

Definition at line 461 of file AthConfigFlags.py.

    def hasFlag(self, name):
        """Check if flag exists (loads dynamic flags if needed)"""
        # Use attrgetter to check if attribute exists. As opposed to getattr,
        # this also supports nested attributes, which is required to trigger loading
        # of dynamics flags.
        try:
            attrgetter(name)(self)
            # Now check if flag was found (taking into account renames)
            return any(name in x for x in self._renamed_map().values())
        except AttributeError:
            return False
 

initAll()

def python.AthConfigFlags.AthConfigFlags.initAll

(

self

)

Mostly a self-test method

Definition at line 630 of file AthConfigFlags.py.

    def initAll(self):
        """
        Mostly a self-test method
        """
        for n,f in list(self._flagdict.items()):
            f.get(self)
        return
 
 

join()

def python.AthConfigFlags.AthConfigFlags.join	(		self,
			other,
			prefix = ''
	)

Merges two flag containers
When the prefix is passed each flag from the "other" is prefixed by "prefix."

Definition at line 571 of file AthConfigFlags.py.

    def join(self, other, prefix=''):
        """
        Merges two flag containers
        When the prefix is passed each flag from the "other" is prefixed by "prefix."
        """
        self._tryModify()
 
        for (name,flag) in other._flagdict.items():
            fullName = prefix+"."+name if prefix != "" else name
            if fullName in self._flagdict:
                raise KeyError("Duplicated flag name: {}".format( fullName ) )
            self._flagdict[fullName]=flag
 
        for (name,loader) in other._dynaflags.items():
            fullName = prefix+"."+name if prefix != "" else name
            if fullName in self._dynaflags:
                raise KeyError("Duplicated dynamic flags name: {}".format( fullName ) )
            _msg.debug("Joining dynamic flags with %s", fullName)
            self._dynaflags[fullName] = loader
        return
 

loadAllDynamicFlags()

def python.AthConfigFlags.AthConfigFlags.loadAllDynamicFlags

(

self

)

Force load all the dynamic flags 

Definition at line 429 of file AthConfigFlags.py.

    def loadAllDynamicFlags(self):
        """Force load all the dynamic flags """
        while len(self._dynaflags) != 0:
            # Need to convert to a list since _loadDynaFlags may change the dict.
            for prefix in list(self._dynaflags.keys()):
                self._loadDynaFlags( prefix )
 

lock()

def python.AthConfigFlags.AthConfigFlags.lock

(

self

)

Definition at line 494 of file AthConfigFlags.py.

    def lock(self):
        if not self._locked:
            # before locking, parse args if a parser was defined
            if self._args is None and self._parser is not None: self.fillFromArgs()
            self._locked = True
        return
 

locked()

def python.AthConfigFlags.AthConfigFlags.locked

(

self

)

Definition at line 501 of file AthConfigFlags.py.

    def locked(self):
        return self._locked
 

needFlagsCategory()

def python.AthConfigFlags.AthConfigFlags.needFlagsCategory	(		self,
			name
	)

public interface for _loadDynaFlags 

Definition at line 399 of file AthConfigFlags.py.

    def needFlagsCategory(self, name):
        """ public interface for _loadDynaFlags """
        self._loadDynaFlags( name )
 

parser()

def python.AthConfigFlags.AthConfigFlags.parser

(

self

)

Definition at line 650 of file AthConfigFlags.py.

    def parser(self):
        if self._parser is None: self._parser = self.getArgumentParser()
        return self._parser
 

Member Data Documentation

_args

python.AthConfigFlags.AthConfigFlags._args

private

Definition at line 245 of file AthConfigFlags.py.

_categoryCache

python.AthConfigFlags.AthConfigFlags._categoryCache

private

Definition at line 242 of file AthConfigFlags.py.

_dynaflags

python.AthConfigFlags.AthConfigFlags._dynaflags

private

Definition at line 240 of file AthConfigFlags.py.

_flagdict

python.AthConfigFlags.AthConfigFlags._flagdict

private

Definition at line 238 of file AthConfigFlags.py.

_hash

python.AthConfigFlags.AthConfigFlags._hash

private

Definition at line 243 of file AthConfigFlags.py.

_hashedFlags

list python.AthConfigFlags.AthConfigFlags._hashedFlags = []

staticprivate

Definition at line 235 of file AthConfigFlags.py.

_loaded

python.AthConfigFlags.AthConfigFlags._loaded

private

Definition at line 241 of file AthConfigFlags.py.

_locked

python.AthConfigFlags.AthConfigFlags._locked

private

Definition at line 239 of file AthConfigFlags.py.

_parser

python.AthConfigFlags.AthConfigFlags._parser

private

Definition at line 244 of file AthConfigFlags.py.

_renames

python.AthConfigFlags.AthConfigFlags._renames

private

Definition at line 246 of file AthConfigFlags.py.

print_context

python.AthConfigFlags.AthConfigFlags.print_context

static

Definition at line 490 of file AthConfigFlags.py.

---

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

• AthConfigFlags.py