lsst.pex.config  15.0-1-gae1598d
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pex.config.configurableField.ConfigurableField Class Reference
Inheritance diagram for lsst.pex.config.configurableField.ConfigurableField:
lsst.pex.config.config.Field

Public Member Functions

def validateTarget (self, target, ConfigClass)
 
def __init__ (self, doc, target, ConfigClass=None, default=None, check=None)
 
def __get__ (self, instance, owner=None, at=None, label="default")
 
def __set__ (self, instance, value, at=None, label="assignment")
 
def rename (self, instance)
 
def save (self, outfile, instance)
 
def freeze (self, instance)
 
def toDict (self, instance)
 
def validate (self, instance)
 
def __deepcopy__ (self, memo)
 
def __delete__ (self, instance, at=None, label='deletion')
 

Public Attributes

 target
 
 ConfigClass
 
 dtype
 
 doc
 
 default
 
 check
 
 optional
 
 source
 

Static Public Attributes

 supportedTypes = set((str, unicode, basestring, oldStringType, bool, float, int, complex))
 

Detailed Description

A variant of a ConfigField which has a known configurable target

Behaves just like a ConfigField except that it can be 'retargeted' to point
at a different configurable. Further you can 'apply' to construct a fully
configured configurable.

Definition at line 144 of file configurableField.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pex.config.configurableField.ConfigurableField.__init__ (   self,
  doc,
  target,
  ConfigClass = None,
  default = None,
  check = None 
)
@param target is the configurable target. Must be callable, and the first
parameter will be the value of this field
@param ConfigClass is the class of Config object expected by the target.
If not provided by target.ConfigClass it must be provided explicitly in this argument

Definition at line 171 of file configurableField.py.

Member Function Documentation

◆ __deepcopy__()

def lsst.pex.config.configurableField.ConfigurableField.__deepcopy__ (   self,
  memo 
)
Customize deep-copying, because we always want a reference to the original typemap.

WARNING: this must be overridden by subclasses if they change the constructor signature!

Definition at line 265 of file configurableField.py.

◆ __delete__()

def lsst.pex.config.config.Field.__delete__ (   self,
  instance,
  at = None,
  label = 'deletion' 
)
inherited
Describe how attribute deletion should occur on the Config instance.
This is invoked by the owning config object and should not be called
directly

Definition at line 344 of file config.py.

◆ __get__()

def lsst.pex.config.configurableField.ConfigurableField.__get__ (   self,
  instance,
  owner = None,
  at = None,
  label = "default" 
)

Definition at line 201 of file configurableField.py.

◆ __set__()

def lsst.pex.config.configurableField.ConfigurableField.__set__ (   self,
  instance,
  value,
  at = None,
  label = "assignment" 
)

Definition at line 207 of file configurableField.py.

◆ freeze()

def lsst.pex.config.configurableField.ConfigurableField.freeze (   self,
  instance 
)

Definition at line 249 of file configurableField.py.

◆ rename()

def lsst.pex.config.configurableField.ConfigurableField.rename (   self,
  instance 
)

Definition at line 227 of file configurableField.py.

◆ save()

def lsst.pex.config.configurableField.ConfigurableField.save (   self,
  outfile,
  instance 
)

Definition at line 232 of file configurableField.py.

◆ toDict()

def lsst.pex.config.configurableField.ConfigurableField.toDict (   self,
  instance 
)

Definition at line 253 of file configurableField.py.

◆ validate()

def lsst.pex.config.configurableField.ConfigurableField.validate (   self,
  instance 
)

Definition at line 257 of file configurableField.py.

◆ validateTarget()

def lsst.pex.config.configurableField.ConfigurableField.validateTarget (   self,
  target,
  ConfigClass 
)

Definition at line 155 of file configurableField.py.

Member Data Documentation

◆ check

lsst.pex.config.config.Field.check
inherited

Definition at line 197 of file config.py.

◆ ConfigClass

lsst.pex.config.configurableField.ConfigurableField.ConfigClass

Definition at line 190 of file configurableField.py.

◆ default

lsst.pex.config.config.Field.default
inherited

Definition at line 196 of file config.py.

◆ doc

lsst.pex.config.config.Field.doc
inherited

Definition at line 194 of file config.py.

◆ dtype

lsst.pex.config.config.Field.dtype
inherited

Definition at line 193 of file config.py.

◆ optional

lsst.pex.config.config.Field.optional
inherited

Definition at line 198 of file config.py.

◆ source

lsst.pex.config.config.Field.source
inherited

Definition at line 199 of file config.py.

◆ supportedTypes

lsst.pex.config.config.Field.supportedTypes = set((str, unicode, basestring, oldStringType, bool, float, int, complex))
staticinherited

Definition at line 164 of file config.py.

◆ target

lsst.pex.config.configurableField.ConfigurableField.target

Definition at line 189 of file configurableField.py.


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