Inheritance diagram for lsst.pex.config.configField.ConfigField:

Public Member Functions
	__init__ (self, doc, dtype=None, default=None, check=None, deprecated=None)

"ConfigField[FieldTypeVar]"	__get__ (self, None instance, Any owner=None, Any at=None, str label="default")

FieldTypeVar	__get__ (self, Config instance, Any owner=None, Any at=None, str label="default")

	__get__ (self, instance, owner=None, at=None, label="default")

None	__set__ (self, Config instance, FieldTypeVar\|None value, Any at=None, str label="assignment")

	rename (self, instance)

	save (self, outfile, instance)

	freeze (self, instance)

	toDict (self, instance)

	validate (self, instance)

Public Member Functions inherited from lsst.pex.config.config.Field
	__class_getitem__ (cls, tuple[type,...]\|type\|ForwardRef params)

	__init__ (self, doc, dtype=None, default=None, check=None, optional=False, deprecated=None)

Field[FieldTypeVar]	__get__ (self, None instance, Any owner=None, Any at=None, str label="default")

FieldTypeVar	__get__ (self, Config instance, Any owner=None, Any at=None, str label="default")

	__get__ (self, instance, owner=None, at=None, label="default")

None	__set__ (self, Config instance, FieldTypeVar\|None value, Any at=None, str label="assignment")

	__delete__ (self, instance, at=None, label="deletion")

Public Attributes
	name

Public Attributes inherited from lsst.pex.config.config.Field
	dtype = dtype

	doc = doc

	deprecated = deprecated

	default = default

	check = check

	optional = optional

	source = source

Protected Member Functions
	_collectImports (self, instance, imports)

Any	_copy_storage (self, Config old, Config new)

	_compare (self, instance1, instance2, shortcut, rtol, atol, output)

Protected Member Functions inherited from lsst.pex.config.config.Field
	_setup (self, doc, dtype, default, check, optional, source, deprecated)

	_validateValue (self, value)

Additional Inherited Members
Static Public Attributes inherited from lsst.pex.config.config.Field
dict	supportedTypes = {str, bool, float, int, complex}

Static Protected Member Functions inherited from lsst.pex.config.config.Field
Mapping[str, Any]	_parseTypingArgs (tuple[type,...]\|tuple[str,...] params, Mapping[str, Any] kwds)

Detailed Description

A configuration field (`~lsst.pex.config.Field` subclass) that takes a
`~lsst.pex.config.Config`-type as a value.

Parameters
----------
doc : `str`
    A description of the configuration field.
dtype : `lsst.pex.config.Config`-type
    The type of the field, which must be a subclass of
    `lsst.pex.config.Config`.
default : `lsst.pex.config.Config`, optional
    If default is `None`, the field will default to a default-constructed
    instance of ``dtype``. Additionally, to allow for fewer deep-copies,
    assigning an instance of ``ConfigField`` to ``dtype`` itself, is
    considered equivalent to assigning a default-constructed sub-config.
    This means that the argument default can be ``dtype``, as well as an
    instance of ``dtype``.
check : `collections.abc.Callable`, optional
    A callback function that validates the field's value, returning `True`
    if the value is valid, and `False` otherwise.
deprecated : `None` or `str`, optional
    A description of why this Field is deprecated, including removal date.
    If not `None`, the string is appended to the docstring for this Field.

See Also
--------
ChoiceField
ConfigChoiceField
ConfigDictField
ConfigurableField
DictField
Field
ListField
RangeField
RegistryField

Notes
-----
The behavior of this type of field is much like that of the base `Field`
type.

Assigning to ``ConfigField`` will update all of the fields in the
configuration.

Member Function Documentation

◆ _collectImports()

lsst.pex.config.configField.ConfigField._collectImports	(	self,
		instance,
		imports )

protected

Call the _collectImports method on all config
objects the field may own, and union them with the supplied imports
set.

Parameters
----------
instance : instance or subclass of `lsst.pex.config.Config`
    A config object that has this field defined on it
imports : `set`
    Set of python modules that need imported after persistence

Reimplemented from lsst.pex.config.config.Field.

◆ _compare()

lsst.pex.config.configField.ConfigField._compare	(	self,
		instance1,
		instance2,
		shortcut,
		rtol,
		atol,
		output )

protected

Compare two fields for equality.

Used by `ConfigField.compare`.

Parameters
----------
instance1 : `lsst.pex.config.Config`
    Left-hand side config instance to compare.
instance2 : `lsst.pex.config.Config`
    Right-hand side config instance to compare.
shortcut : `bool`
    If `True`, this function returns as soon as an inequality if found.
rtol : `float`
    Relative tolerance for floating point comparisons.
atol : `float`
    Absolute tolerance for floating point comparisons.
output : `collections.abc.Callable`
    A callable that takes a string, used (possibly repeatedly) to
    report inequalities.

Returns
-------
isEqual : bool
    `True` if the fields are equal, `False` otherwise.

Notes
-----
Floating point comparisons are performed by `numpy.allclose`.

Reimplemented from lsst.pex.config.config.Field.

◆ _copy_storage()

Any lsst.pex.config.configField.ConfigField._copy_storage	(		self,
		Config	old,
		Config	new )

protected

Copy the storage for this field in the given field into an object
suitable for storage in a new copy of that config.

Any frozen storage should be unfrozen.

Reimplemented from lsst.pex.config.config.Field.

◆ freeze()

lsst.pex.config.configField.ConfigField.freeze	(		self,
			instance )

Make this field read-only.

Parameters
----------
instance : `lsst.pex.config.Config`
    The config instance that contains this field.

Notes
-----
Freezing is only relevant for fields that hold subconfigs. Fields which
hold subconfigs should freeze each subconfig.

**Subclasses should implement this method.**

Reimplemented from lsst.pex.config.config.Field.

◆ rename()

lsst.pex.config.configField.ConfigField.rename	(		self,
			instance )

Rename the field in a `~lsst.pex.config.Config` (for internal use
only).

Parameters
----------
instance : `lsst.pex.config.Config`
The config instance that contains this field.

Notes
-----
This method is invoked by the `lsst.pex.config.Config` object that
contains this field and should not be called directly.

Renaming is only relevant for `~lsst.pex.config.Field` instances that
hold subconfigs. `~lsst.pex.config.Field`\s that hold subconfigs should
rename each subconfig with the full field name as generated by
`lsst.pex.config.config._joinNamePath`.

Reimplemented from lsst.pex.config.config.Field.

◆ save()

lsst.pex.config.configField.ConfigField.save	(	self,
		outfile,
		instance )

Save this field to a file (for internal use only).

Parameters
----------
outfile : `typing.IO`
    A writeable field handle.
instance : `~lsst.pex.config.Config`
    The `~lsst.pex.config.Config` instance that contains this field.

Notes
-----
This method is invoked by the `~lsst.pex.config.Config` object that
contains this field and should not be called directly.

The output consists of the documentation string
(`lsst.pex.config.Field.doc`) formatted as a Python comment. The second
line is formatted as an assignment: ``{fullname}={value}``.

This output can be executed with Python.

Reimplemented from lsst.pex.config.config.Field.

Reimplemented in lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField.

◆ toDict()

lsst.pex.config.configField.ConfigField.toDict	(		self,
			instance )

Convert the field value so that it can be set as the value of an
item in a `dict` (for internal use only).

Parameters
----------
instance : `~lsst.pex.config.Config`
    The `~lsst.pex.config.Config` that contains this field.

Returns
-------
value : `object`
    The field's value. See *Notes*.

Notes
-----
This method invoked by the owning `~lsst.pex.config.Config` object and
should not be called directly.

Simple values are passed through. Complex data structures must be
manipulated. For example, a `~lsst.pex.config.Field` holding a
subconfig should, instead of the subconfig object, return a `dict`
where the keys are the field names in the subconfig, and the values are
the field values in the subconfig.

Reimplemented from lsst.pex.config.config.Field.

◆ validate()

lsst.pex.config.configField.ConfigField.validate	(		self,
			instance )

Validate the field (for internal use only).

Parameters
----------
instance : `lsst.pex.config.Config`
    The config instance that contains this field.

Raises
------
lsst.pex.config.FieldValidationError
    Raised if verification fails.

Notes
-----
This method provides basic validation:

- Ensures that the value is not `None` if the field is not optional.
- Ensures type correctness.
- Ensures that the user-provided ``check`` function is valid.

Most `~lsst.pex.config.Field` subclasses should call
`lsst.pex.config.Field.validate` if they re-implement
`~lsst.pex.config.Field.validate`.

Reimplemented from lsst.pex.config.config.Field.

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

python/lsst/pex/config/configField.py

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _collectImports()

◆ _compare()

◆ _copy_storage()

◆ freeze()

◆ rename()

◆ save()

◆ toDict()

◆ validate()