cratermaker.utils.general_utils.Parameter

cratermaker.utils.general_utils.Parameter#

class cratermaker.utils.general_utils.Parameter(fget, fset=None, fdel=None, doc=None)[source]#

Bases: property

A property descriptor that tracks user-defined properties.

This class is a subclass of the built-in property class and is used to create properties in a class that can be set and retrieved. It also tracks whether the property has been set by the user, allowing for parameters to be exported to a YAML configuration file.

__init__(fget, fset=None, fdel=None, doc=None)[source]#

Methods

__init__(fget[, fset, fdel, doc])

deleter(object, /)

Descriptor to obtain a copy of the property with a different deleter.

getter(object, /)

Descriptor to obtain a copy of the property with a different getter.

setter(fset)

Descriptor to obtain a copy of the property with a different setter.

Attributes

fdel

fget

fset

setter(fset)[source]#

Descriptor to obtain a copy of the property with a different setter.