Package gavo :: Package svcs :: Module inputdef :: Class CoreArgs
[frames] | no frames]

Class CoreArgs

source code

         object --+    
                  |    
base.meta.MetaMixin --+
                      |
                     CoreArgs

A container for core arguments.

There's inputTD, which reference the renderer-adapted input table, and args, the ContextGrammar processed input. For kicks, we also have rawArgs, which is the contextGrammar's input (if you find you're using it, tell us; that's pointing to a problem on our side).

getParam(name) -> value and getParamDict() -> dict methods are present for backward compatibility.

Instance Methods
 
__init__(self, inputTD, args, rawArgs)
is a constructor for standalone use.
source code
 
getParam(self, name) source code
 
getParamDict(self) source code

Inherited from base.meta.MetaMixin: addMeta, buildRepr, copyMetaFrom, delMeta, getAllMetaPairs, getMeta, getMetaKeys, getMetaParent, isEmpty, iterMeta, keys, makeOriginal, setMeta, setMetaParent, traverse

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods
 
fromRawArgs(cls, inputTD, rawArgs, contextGrammar=None)
returns a CoreArgs instance built from an inputDD and ContextGrammar-parseable rawArgs.
source code
Properties

Inherited from object: __class__

Method Details

__init__(self, inputTD, args, rawArgs)
(Constructor)

source code 

is a constructor for standalone use. You do *not* want to call this when mixing into a Structure.

Overrides: object.__init__
(inherited documentation)

fromRawArgs(cls, inputTD, rawArgs, contextGrammar=None)
Class Method

source code 

returns a CoreArgs instance built from an inputDD and ContextGrammar-parseable rawArgs.

contextGrammar can be overridden, e.g., to cache or to add extra, non-core keys.