python.trfArgClasses.argFactory Class Reference

Factory class used to generate argument class instances for argparse. More...

Inheritance diagram for python.trfArgClasses.argFactory:

Collaboration diagram for python.trfArgClasses.argFactory:

Public Member Functions
def	__init__ (self, genclass, *args, **kwargs)
def	__call__ (self, valueString=None)
def	__str__ (self)

Private Attributes
	_genclass
	_args
	_kwargs

Detailed Description

Factory class used to generate argument class instances for argparse.

Definition at line 31 of file trfArgClasses.py.

Constructor & Destructor Documentation

__init__()

def python.trfArgClasses.argFactory.__init__	(		self,
			genclass,
		*	args,
		**	kwargs
	)

Definition at line 32 of file trfArgClasses.py.

    def __init__(self, genclass, *args, **kwargs):
        msg.debug('Initialised class %s with args=%s; kwargs=%s', genclass, args, kwargs)
        self._genclass = genclass
        self._args = args
        self._kwargs = kwargs
    

Member Function Documentation

__call__()

def python.trfArgClasses.argFactory.__call__	(		self,
			valueString = None
	)

Definition at line 38 of file trfArgClasses.py.

    def __call__(self, valueString=None):
        msg.debug('Called class %s with value=%s; args=%s; kwargs=%s', self._genclass, valueString, self._args, self._kwargs)
        
        # Wrap this step in our own try/except because if this goes wrong we want to see the exception
        # instead of having it masked by the argparse module
        try:
            # Passing None suppresses the value passed to the constructor, thus the constructor's own
            # default value is used - generally this will match the default value for the underlying
            # python object
            if valueString is None:
                obj = self._genclass(*self._args, **self._kwargs)
            else:
                obj = self._genclass(valueString, *self._args, **self._kwargs)
        except Exception as e:
            msg.fatal('Got this exception raised when calling object factory: {0}'.format(e))
            raise
        return obj
    

__str__()

def python.trfArgClasses.argFactory.__str__

(

self

)

Definition at line 56 of file trfArgClasses.py.

    def __str__(self):
        return 'argFactory for {0}, args {1}, kwargs {2}'.format(self._genclass, self._args, self._kwargs)
 
 

Member Data Documentation

_args

python.trfArgClasses.argFactory._args

private

Definition at line 35 of file trfArgClasses.py.

_genclass

python.trfArgClasses.argFactory._genclass

private

Definition at line 34 of file trfArgClasses.py.

_kwargs

python.trfArgClasses.argFactory._kwargs

private

Definition at line 36 of file trfArgClasses.py.

---

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

• trfArgClasses.py