Inheritance diagram for lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField:

Public Member Functions
	__init__ (self, str doc, Mapping[str, ConfigurableAction]\|None default=None, bool optional=False, deprecated=None)

	__class_getitem__ (cls, params)

	__set__ (self, Config instance,(None\|Mapping[str, ConfigurableAction]\|SimpleNamespace\|ConfigurableActionStruct\|ConfigurableActionStructField\|type[ConfigurableActionStructField]) value, Iterable[StackFrame] at=None, str label="assigment")

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

ConfigurableActionStruct[ActionTypeVar]	__get__ (self, Config instance, Any owner=None, Any at=None, str label="default")

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

	rename (self, Config instance)

	validate (self, Config instance)

	toDict (self, instance)

	save (self, outfile, instance)

	freeze (self, instance)

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

Public Attributes
	dtype = dtype

	doc = doc

	deprecated = deprecated

	default = default

	check = check

	optional = optional

	source = source

Static Public Attributes
	StructClass = ConfigurableActionStruct

dict	supportedTypes = {str, bool, float, int, complex}

Protected Member Functions
	_collectImports (self, instance, imports)

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

	_setup (self, doc, dtype, default, check, optional, source, deprecated)

	_validateValue (self, value)

Static Protected Member Functions
Mapping[str, Any]	_parseTypingArgs (tuple[type,...]\|tuple[str,...] params, Mapping[str, Any] kwds)

Detailed Description

`ConfigurableActionStructField` is a `~lsst.pex.config.Field` subclass
that allows a `ConfigurableAction` to be organized in a
`~lsst.pex.config.Config` class in a manner similar to how a
`~lsst.pipe.base.Struct` works.

This class uses a `ConfigurableActionStruct` as an intermediary object to
organize the `ConfigurableAction`. See its documentation for further
information.

Parameters
----------
doc : `str`
    Documentation string.
default : `~collections.abc.Mapping` [ `str`, `ConfigurableAction` ] \
        or `None`, optional
    Default value.
optional : `bool`, optional
    If `True`, the field doesn't need to have a set value.
deprecated : `bool` or `None`, 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.

Definition at line 249 of file _configurableActionStructField.py.

Constructor & Destructor Documentation

◆ init()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__init__	(		self,
		str	doc,
		Mapping[str, ConfigurableAction] \| None	default = None,
		bool	optional = False,
			deprecated = None )

Definition at line 282 of file _configurableActionStructField.py.

    ):
        source = getStackFrame()
        self._setup(
            doc=doc,
            dtype=self.__class__,
            default=default,
            check=None,
            optional=optional,
            source=source,
            deprecated=deprecated,
        )
 

Member Function Documentation

◆ __class_getitem__()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__class_getitem__	(		cls,
			params )

Definition at line 300 of file _configurableActionStructField.py.

    def __class_getitem__(cls, params):
        return GenericAlias(cls, params)
 

◆ delete()

lsst.pex.config.config.Field.__delete__	(	self,
		instance,
		at = None,
		label = "deletion" )

inherited

Delete an attribute from a `lsst.pex.config.Config` instance.

Parameters
----------
instance : `lsst.pex.config.Config`
    The config instance that contains this field.
at : `list` of `lsst.pex.config.callStack.StackFrame`
    The call stack (created by
    `lsst.pex.config.callStack.getCallStack`).
label : `str`, optional
    Event label for the history.

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

Definition at line 800 of file config.py.

    def __delete__(self, instance, at=None, label="deletion"):
        """Delete an attribute from a `lsst.pex.config.Config` instance.
 
        Parameters
        ----------
        instance : `lsst.pex.config.Config`
            The config instance that contains this field.
        at : `list` of `lsst.pex.config.callStack.StackFrame`
            The call stack (created by
            `lsst.pex.config.callStack.getCallStack`).
        label : `str`, optional
            Event label for the history.
 
        Notes
        -----
        This is invoked by the owning `~lsst.pex.config.Config` object and
        should not be called directly.
        """
        if at is None:
            at = getCallStack()
        self.__set__(instance, None, at=at, label=label)
 

◆ get() [1/3]

ConfigurableActionStruct[ActionTypeVar] lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__	(		self,
		Config	instance,
		Any	owner = None,
		Any	at = None,
		str	label = "default" )

Definition at line 360 of file _configurableActionStructField.py.

362 ) -> ConfigurableActionStruct[ActionTypeVar]: ...

363

◆ get() [2/3]

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__	(	self,
		instance,
		owner = None,
		at = None,
		label = "default" )

Definition at line 364 of file _configurableActionStructField.py.

    def __get__(self, instance, owner=None, at=None, label="default"):
        if instance is None or not isinstance(instance, Config):
            return self
        else:
            field: ConfigurableActionStruct | None = instance._storage[self.name]
            return field
 

◆ get() [3/3]

ConfigurableActionStruct[ActionTypeVar] lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__	(		self,
		None	instance,
		Any	owner = None,
		Any	at = None,
		str	label = "default" )

Definition at line 355 of file _configurableActionStructField.py.

357 ) -> ConfigurableActionStruct[ActionTypeVar]: ...

358

◆ set()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.__set__	(		self,
		Config	instance,
		( None \| Mapping[str, ConfigurableAction] \| SimpleNamespace \| ConfigurableActionStruct \| ConfigurableActionStructField \| type[ConfigurableActionStructField] )	value,
		Iterable[StackFrame]	at = None,
		str	label = "assigment" )

Definition at line 303 of file _configurableActionStructField.py.

    ):
        if instance._frozen:
            msg = f"Cannot modify a frozen Config. Attempting to set field to value {value}"
            raise FieldValidationError(self, instance, msg)
 
        if at is None:
            at = getCallStack()
 
        if value is None or (self.default is not None and self.default == value):
            value = self.StructClass(instance, self, value, at=at, label=label)
        else:
            # An actual value is being assigned check for what it is
            if isinstance(value, self.StructClass):
                # If this is a ConfigurableActionStruct, we need to make our
                # own copy that references this current field
                value = self.StructClass(instance, self, value._attrs, at=at, label=label)
            elif isinstance(value, SimpleNamespace):
                # If this is a a python analogous container, we need to make
                # a ConfigurableActionStruct initialized with this data
                value = self.StructClass(instance, self, vars(value), at=at, label=label)
 
            elif type(value) is ConfigurableActionStructField:
                raise ValueError(
                    "ConfigurableActionStructFields can only be used in a class body declaration"
                    f"Use a {self.StructClass}, SimpleNamespace or Struct"
                )
            else:
                raise ValueError(f"Unrecognized value {value}, cannot be assigned to this field")
 
            history = instance._history.setdefault(self.name, [])
            history.append((value, at, label))
 
        if not isinstance(value, ConfigurableActionStruct):
            raise FieldValidationError(
                self, instance, "Can only assign things that are subclasses of Configurable Action"
            )
        instance._storage[self.name] = value
 

◆ _collectImports()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField._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.

Definition at line 414 of file _configurableActionStructField.py.

    def _collectImports(self, instance, imports):
        # docstring inherited from Field
        actionStruct = self.__get__(instance)
        for v in actionStruct:
            v._collectImports()
            imports |= v._imports
 

◆ _compare()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField._compare	(	self,
		instance1,
		instance2,
		shortcut,
		rtol,
		atol,
		output )

protected

Compare two fields for equality.

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 : 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.

Definition at line 421 of file _configurableActionStructField.py.

    def _compare(self, instance1, instance2, shortcut, rtol, atol, output):
        """Compare two fields for equality.
 
        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 : 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`.
        """
        d1: ConfigurableActionStruct = getattr(instance1, self.name)
        d2: ConfigurableActionStruct = getattr(instance2, self.name)
        name = getComparisonName(
            _joinNamePath(instance1._name, self.name), _joinNamePath(instance2._name, self.name)
        )
        if not compareScalars(f"{name} (fields)", set(d1.fieldNames), set(d2.fieldNames), output=output):
            return False
        equal = True
        for k, v1 in d1.items():
            v2 = getattr(d2, k)
            result = compareConfigs(
                f"{name}.{k}", v1, v2, shortcut=shortcut, rtol=rtol, atol=atol, output=output
            )
            if not result and shortcut:
                return False
            equal = equal and result
        return equal

◆ _parseTypingArgs()

Mapping[str, Any] lsst.pex.config.config.Field._parseTypingArgs	(	tuple[type, ...] \| tuple[str, ...]	params,
		Mapping[str, Any]	kwds )

staticprotectedinherited

Parse type annotations into keyword constructor arguments.

This is a special private method that interprets type arguments (i.e.
Field[str]) into keyword arguments to be passed on to the constructor.

Subclasses of Field can implement this method to customize how they
handle turning type parameters into keyword arguments (see DictField
for an example)

Parameters
----------
params : `tuple` of `type` or `tuple` of str
    Parameters passed to the type annotation. These will either be
    types or strings. Strings are to interpreted as forward references
    and will be treated as such.
kwds : `MutableMapping` with keys of `str` and values of `Any`
    These are the user supplied keywords that are to be passed to the
    Field constructor.

Returns
-------
kwds : `MutableMapping` with keys of `str` and values of `Any`
    The mapping of keywords that will be passed onto the constructor
    of the Field. Should be filled in with any information gleaned
    from the input parameters.

Raises
------
ValueError
    Raised if params is of incorrect length.
    Raised if a forward reference could not be resolved
    Raised if there is a conflict between params and values in kwds

Reimplemented in lsst.pex.config.configurableField.ConfigurableField, and lsst.pex.config.dictField.DictField.

Definition at line 410 of file config.py.

    ) -> Mapping[str, Any]:
        """Parse type annotations into keyword constructor arguments.
 
        This is a special private method that interprets type arguments (i.e.
        Field[str]) into keyword arguments to be passed on to the constructor.
 
        Subclasses of Field can implement this method to customize how they
        handle turning type parameters into keyword arguments (see DictField
        for an example)
 
        Parameters
        ----------
        params : `tuple` of `type` or `tuple` of str
            Parameters passed to the type annotation. These will either be
            types or strings. Strings are to interpreted as forward references
            and will be treated as such.
        kwds : `MutableMapping` with keys of `str` and values of `Any`
            These are the user supplied keywords that are to be passed to the
            Field constructor.
 
        Returns
        -------
        kwds : `MutableMapping` with keys of `str` and values of `Any`
            The mapping of keywords that will be passed onto the constructor
            of the Field. Should be filled in with any information gleaned
            from the input parameters.
 
        Raises
        ------
        ValueError
            Raised if params is of incorrect length.
            Raised if a forward reference could not be resolved
            Raised if there is a conflict between params and values in kwds
        """
        if len(params) > 1:
            raise ValueError("Only single type parameters are supported")
        unpackedParams = params[0]
        if isinstance(unpackedParams, str):
            _typ = ForwardRef(unpackedParams)
            # type ignore below because typeshed seems to be wrong. It
            # indicates there are only 2 args, as it was in python 3.8, but
            # 3.9+ takes 3 args.
            result = _typ._evaluate(globals(), locals(), recursive_guard=set())  # type: ignore
            if result is None:
                raise ValueError("Could not deduce type from input")
            unpackedParams = cast(type, result)
        if "dtype" in kwds and kwds["dtype"] != unpackedParams:
            raise ValueError("Conflicting definition for dtype")
        elif "dtype" not in kwds:
            kwds = {**kwds, **{"dtype": unpackedParams}}
        return kwds
 

◆ _setup()

lsst.pex.config.config.Field._setup	(	self,
		doc,
		dtype,
		default,
		check,
		optional,
		source,
		deprecated )

protectedinherited

Set attributes, usually during initialization.

Definition at line 486 of file config.py.

    def _setup(self, doc, dtype, default, check, optional, source, deprecated):
        """Set attributes, usually during initialization."""
        self.dtype = dtype
        """Data type for the field.
        """
 
        if not doc:
            raise ValueError("Docstring is empty.")
 
        # append the deprecation message to the docstring.
        if deprecated is not None:
            doc = f"{doc} Deprecated: {deprecated}"
        self.doc = doc
        """A description of the field (`str`).
        """
 
        self.deprecated = deprecated
        """If not None, a description of why this field is deprecated (`str`).
        """
 
        self.__doc__ = f"{doc} (`{dtype.__name__}`"
        if optional or default is not None:
            self.__doc__ += f", default ``{default!r}``"
        self.__doc__ += ")"
 
        self.default = default
        """Default value for this field.
        """
 
        self.check = check
        """A user-defined function that validates the value of the field.
        """
 
        self.optional = optional
        """Flag that determines if the field is required to be set (`bool`).
 
        When `False`, `lsst.pex.config.Config.validate` will fail if the
        field's value is `None`.
        """
 
        self.source = source
        """The stack frame where this field is defined (`list` of
        `~lsst.pex.config.callStack.StackFrame`).
        """
 

◆ _validateValue()

lsst.pex.config.config.Field._validateValue	(		self,
			value )

protectedinherited

Validate a value.

Parameters
----------
value : object
    The value being validated.

Raises
------
TypeError
    Raised if the value's type is incompatible with the field's
    ``dtype``.
ValueError
    Raised if the value is rejected by the ``check`` method.

Reimplemented in lsst.pex.config.choiceField.ChoiceField, and lsst.pex.config.rangeField.RangeField.

Definition at line 598 of file config.py.

    def _validateValue(self, value):
        """Validate a value.
 
        Parameters
        ----------
        value : object
            The value being validated.
 
        Raises
        ------
        TypeError
            Raised if the value's type is incompatible with the field's
            ``dtype``.
        ValueError
            Raised if the value is rejected by the ``check`` method.
        """
        if value is None:
            return
 
        if not isinstance(value, self.dtype):
            msg = (
                f"Value {value} is of incorrect type {_typeStr(value)}. Expected type {_typeStr(self.dtype)}"
            )
            raise TypeError(msg)
        if self.check is not None and not self.check(value):
            msg = f"Value {value} is not a valid value"
            raise ValueError(msg)
 

◆ freeze()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.freeze	(		self,
			instance )

Make this field read-only (for internal use 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.

Definition at line 408 of file _configurableActionStructField.py.

    def freeze(self, instance):
        actionStruct = self.__get__(instance)
        if actionStruct is not None:
            for v in actionStruct:
                v.freeze()
 

◆ rename()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.rename	(		self,
		Config	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.

Definition at line 371 of file _configurableActionStructField.py.

    def rename(self, instance: Config):
        actionStruct: ConfigurableActionStruct = self.__get__(instance)
        if actionStruct is not None:
            for k, v in actionStruct.items():
                base_name = _joinNamePath(instance._name, self.name)
                fullname = _joinNamePath(base_name, k)
                v._rename(fullname)
 

◆ save()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.save	(	self,
		outfile,
		instance )

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

Parameters
----------
outfile : file-like object
    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.

Definition at line 394 of file _configurableActionStructField.py.

    def save(self, outfile, instance):
        actionStruct = self.__get__(instance)
        fullname = _joinNamePath(instance._name, self.name)
 
        # Ensure that a struct is always empty before assigning to it.
        outfile.write(f"{fullname}=None\n")
 
        if actionStruct is None:
            return
 
        for _, v in sorted(actionStruct.items()):
            outfile.write(f"{v._name}={_typeStr(v)}()\n")
            v._save(outfile)
 

◆ toDict()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.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.

Definition at line 385 of file _configurableActionStructField.py.

    def toDict(self, instance):
        actionStruct = self.__get__(instance)
        if actionStruct is None:
            return None
 
        dict_ = {k: v.toDict() for k, v in actionStruct.items()}
 
        return dict_
 

◆ validate()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.validate	(		self,
		Config	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.

Definition at line 379 of file _configurableActionStructField.py.

    def validate(self, instance: Config):
        value = self.__get__(instance)
        if value is not None:
            for item in value:
                item.validate()
 

Member Data Documentation

◆ check

lsst.pex.config.config.Field.check = check

inherited

Definition at line 515 of file config.py.

◆ default

lsst.pex.config.config.Field.default = default

inherited

Definition at line 511 of file config.py.

◆ deprecated

lsst.pex.config.config.Field.deprecated = deprecated

inherited

Definition at line 502 of file config.py.

◆ doc

lsst.pex.config.config.Field.doc = doc

inherited

Definition at line 498 of file config.py.

◆ dtype

lsst.pex.config.config.Field.dtype = dtype

inherited

Definition at line 488 of file config.py.

◆ optional

lsst.pex.config.config.Field.optional = optional

inherited

Definition at line 519 of file config.py.

◆ source

lsst.pex.config.config.Field.source = source

inherited

Definition at line 526 of file config.py.

◆ StructClass

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructField.StructClass = ConfigurableActionStruct

static

Definition at line 275 of file _configurableActionStructField.py.

◆ supportedTypes

dict lsst.pex.config.config.Field.supportedTypes = {str, bool, float, int, complex}

staticinherited

Definition at line 405 of file config.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/pex_config/gabf8522325+cc757f8247/python/lsst/pex/config/configurableActions/_configurableActionStructField.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __class_getitem__()

◆ __delete__()

◆ __get__() [1/3]

◆ __get__() [2/3]

◆ __get__() [3/3]

◆ __set__()

◆ _collectImports()

◆ _compare()

◆ _parseTypingArgs()

◆ _setup()

◆ _validateValue()

◆ freeze()

◆ rename()

◆ save()

◆ toDict()

◆ validate()

Member Data Documentation

◆ check

◆ default

◆ deprecated

◆ doc

◆ dtype

◆ optional

◆ source

◆ StructClass

◆ supportedTypes

◆ init()

◆ delete()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ set()