lsst.pex.config.config.Field Class Reference

Inheritance diagram for lsst.pex.config.config.Field:

Public Member Functions
def	__init__
def	rename
def	validate
def	freeze
def	save
def	toDict
def	__get__
def	__set__
def	__delete__

Public Attributes
	dtype
	doc
	default
	check
	optional
	source

Static Public Attributes
tuple	supportedTypes = (str, bool, float, int, complex)

Private Member Functions
def	_setup
def	_validateValue
def	_compare

Private Attributes
	__doc__

Detailed Description

A field in a a Config.

Instances of Field should be class attributes of Config subclasses:
Field only supports basic data types (int, float, complex, bool, str)

class Example(Config):
    myInt = Field(int, "an integer field!", default=0)

Definition at line 136 of file config.py.

Constructor & Destructor Documentation

def lsst.pex.config.config.Field.__init__	(		self,
			doc,
			dtype,
			default = None,
			check = None,
			optional = False
	)

Initialize a Field.

dtype ------ Data type for the field.  
doc -------- Documentation for the field.
default ---- A default value for the field.
check ------ A callable to be called with the field value that returns 
     False if the value is invalid.  More complex inter-field 
     validation can be written as part of Config validate() 
     method; this will be ignored if set to None.
optional --- When False, Config validate() will fail if value is None

Definition at line 147 of file config.py.

    def __init__(self, doc, dtype, default=None, check=None, optional=False):
        """Initialize a Field.
        
        dtype ------ Data type for the field.  
        doc -------- Documentation for the field.
        default ---- A default value for the field.
        check ------ A callable to be called with the field value that returns 
                     False if the value is invalid.  More complex inter-field 
                     validation can be written as part of Config validate() 
                     method; this will be ignored if set to None.
        optional --- When False, Config validate() will fail if value is None
        """
        if dtype not in self.supportedTypes:
            raise ValueError("Unsupported Field dtype %s"%_typeStr(dtype))
        source = traceback.extract_stack(limit=2)[0]
        self._setup(doc=doc, dtype=dtype, default=default, check=check, optional=optional, source=source)