python.D3PDObject.DeferArg Class Reference

Inheritance diagram for python.D3PDObject.DeferArg:

Collaboration diagram for python.D3PDObject.DeferArg:

Public Member Functions
def	__init__ (self, str, gdict=globals(), **kw)
def	__call__ (self, hookargs={}, **kw)

Public Attributes
	str
	gdict
	kw

Detailed Description

Defer evaluating a block argument until the D3PDObject is instantiated.

Sometimes you want to pass an argument to a block function that isn't
known at the time the D3PDObject is defined, for example the
StoreGate key to use.  You could do this with a hook function
or a LOD function, but that's a bit cumbersome.  Instead, you can
use DeferArg.  DeferArg stores a string.  If a block argument
has a value that's an instance of DeferArg, then this string
is evaluated at the time the D3PDObject is instantiated.
The arguments passed to the D3PDObject will be available
in the context in which the string is evaluated.
A global dictionary may be provided as an optional argument;
any additional keyword arguments will be merged into this
dictionary.

Example:

  FooD3PDObject.defineBlock (1, 'SomeBlock', SomeTool,
                             Name = DeferArg ('"name_" + sgkey'))

If FooD3PDObject is then instantiated with a StoreGate key of `Bar',
then the Name argument of this block will be set to `name_Bar'.

Definition at line 59 of file D3PDObject.py.

Constructor & Destructor Documentation

__init__()

def python.D3PDObject.DeferArg.__init__	(		self,
			str,
			gdict = globals(),
		**	kw
	)

Definition at line 83 of file D3PDObject.py.

    def __init__ (self, str, gdict = globals(), **kw):  # noqa: B008 (globals is already a global ref.)
        self.str = str
        self.gdict = gdict
        self.kw = kw
        return
 
 

Member Function Documentation

__call__()

def python.D3PDObject.DeferArg.__call__	(		self,
			hookargs = {},
		**	kw
	)

Definition at line 90 of file D3PDObject.py.

    def __call__ (self, hookargs = {}, **kw):
        gdict = self.gdict.copy()
        gdict.update (self.kw)
        hookargs = hookargs.copy()
        hookargs.update (kw)
        return eval (self.str, gdict, hookargs)
    
 
 

Member Data Documentation

gdict

python.D3PDObject.DeferArg.gdict

Definition at line 85 of file D3PDObject.py.

kw

python.D3PDObject.DeferArg.kw

Definition at line 86 of file D3PDObject.py.

str

python.D3PDObject.DeferArg.str

Definition at line 84 of file D3PDObject.py.

---

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

• D3PDObject.py