a ߙfb @sxddlmZddlmZdgZGdddZedddZedd d Z ed d d Z edddZ dS)N) classproperty Parameterc@seZdZdZiZd#dgdddddZd d Zed d Zed dZ eddZ eddZ eddZ d$ddZ ddZeddZddZddZed%dd Zd!d"ZdS)&raCosmological parameter (descriptor). Should only be used with a :class:`~astropy.cosmology.Cosmology` subclass. Parameters ---------- fvalidate : callable[[object, object, Any], Any] or str, optional Function to validate the Parameter value from instances of the cosmology class. If "default", uses default validator to assign units (with equivalencies), if Parameter has units. For other valid string options, see ``Parameter._registry_validators``. 'fvalidate' can also be set through a decorator with :meth:`~astropy.cosmology.Parameter.validator`. doc : str or None, optional Parameter description. unit : unit-like or None (optional, keyword-only) The `~astropy.units.Unit` for the Parameter. If None (default) no unit as assumed. equivalencies : `~astropy.units.Equivalency` or sequence thereof Unit equivalencies for this Parameter. fmt : str (optional, keyword-only) `format` specification, used when making string representation of the containing Cosmology. See https://docs.python.org/3/library/string.html#formatspec derived : bool (optional, keyword-only) Whether the Parameter is 'derived', default `False`. Derived parameters behave similarly to normal parameters, but are not sorted by the |Cosmology| signature (probably not there) and are not included in all methods. For reference, see ``Ode0`` in ``FlatFLRWMixin``, which removes :math:`\Omega_{de,0}`` as an independent parameter (:math:`\Omega_{de,0} \equiv 1 - \Omega_{tot}`). Examples -------- For worked examples see :class:`~astropy.cosmology.FLRW`. defaultNz.3gF)unit equivalenciesfmtderivedcCst|r nJ||jvr |j|}n4t|tr@td|jntd|j||_||_|durrt |nd|_ ||_ t||_ ||_dS)Nz `fvalidate`, if str, must be in z"`fvalidate` must be a function or )callable_registry_validators isinstancestr ValueErrorkeys TypeError__doc__ _fvalidateuZUnit_unit_equivalencies_fmt_derived)self fvalidatedocrrrrr:lib/python3.9/site-packages/astropy/cosmology/parameter.py__init__1s"     zParameter.__init__cCs||_d||_dS)N_) _attr_name_attr_name_private)r cosmo_clsnamerrr __set_name__JszParameter.__set_name__cCs|jS)zParameter name.)rrrrrr!OszParameter.namecCs|jS)zParameter unit.)rr#rrrrTszParameter.unitcCs|jS)z/Equivalencies used when initializing Parameter.)rr#rrrrYszParameter.equivalenciescCs|jS)zString format specification.)rr#rrr format_spec^szParameter.format_speccCs|jS)z:Whether the Parameter is derived; true parameters are not.)rr#rrrrcszParameter.derivedcCs|dur |St||jS)N)getattrr)r cosmologyr rrr__get__kszParameter.__get__cCs2t||jrtd|||}t||j|dS)zBAllows attribute setting once. Raises AttributeError subsequently.zcan't set attributeN)hasattrrAttributeErrorvalidatesetattrrr&valuerrr__set__qs  zParameter.__set__cCs|jS)z:Function to validate a potential value of this Parameter..)rr#rrrr~szParameter.fvalidatecCs&t|||j|j|j|j|jd}|S)aoMake new Parameter with custom ``fvalidate``. Note: ``Parameter.fvalidator`` must be the top-most descriptor decorator. Parameters ---------- fvalidate : callable[[type, type, Any], Any] Returns ------- `~astropy.cosmology.Parameter` Copy of this Parameter but with custom ``fvalidate``. )rrrrrr)typerr$rrr)rrZdescrrr validators zParameter.validatorcCs||||S)afRun the validator on this Parameter. Parameters ---------- cosmology : `~astropy.cosmology.Cosmology` instance value : Any The object to validate. Returns ------- Any The output of calling ``fvalidate(cosmology, self, value)`` (yes, that parameter order). rr,rrrr*szParameter.validatecsBjvrtdd|dur0|j<|Sfdd}|S)aDecorator to register a new kind of validator function. Parameters ---------- key : str fvalidate : callable[[object, object, Any], Any] or None, optional Value validation function. Returns ------- ``validator`` or callable[``validator``] if validator is None returns a function that takes and registers a validator. This allows ``register_validator`` to be used as a decorator. z validator z# already registered with Parameter.Ncs|j<|S)zRegister validator function. Parameters ---------- fvalidate : callable[[object, object, Any], Any] Validation function. Returns ------- ``validator`` )r r1clskeyrrregisters z.Parameter.register_validator..register)r KeyError)r3r4rr5rr2rregister_validators  zParameter.register_validatorcCsd|jdtt|dS)Nz )rhexidr#rrr__repr__szParameter.__repr__)rN)N)N)__name__ __module__ __qualname__rr rr"propertyr!rrr$rr'r.rr0r* classmethodr7r;rrrrr s2%          ,rcCsH|jdurDt|jt||j}Wdn1s:0Y|S)z] Default Parameter value validator. Adds/converts units if Parameter has a unit. N)rrZadd_enabled_equivalenciesrZQuantityr&Zparamr-rrr_validate_with_units ,rBfloatcCst|||}t|S)z=Parameter value validator with units, and converted to float.)rBrCrArrr_validate_to_floats rDZscalarcCs&t|||}|js"t|jd|S)z is a non-scalar quantity)rBZisscalarr r!rArrr_validate_to_scalars rFz non-negativecCs(t|||}|dkr$t|jd|S)z:Parameter value validator where value is a positive float.gz cannot be negative.)rDr r!rArrr_validate_non_negatives rG) Z astropy.unitsZunitsrZastropy.utils.decoratorsr__all__rr7rBrDrFrGrrrrs  U