U d{j0@sddlZddlmZddlmZmZdgZGdddZe dddZ e dd d Z e d d d Z e dddZ dS)N)deprecated_attributedeprecated_renamed_argument Parameterc@seZdZdZiZeddddddgdddd d d Zd d ZeddZ eddZ eddZ e dddZ eddZd+ddZddZeddZddZdd Zed,d!d"Zd-d#d$Zd%d&Zd'd(Zd)d*ZdS).raCosmological parameter (descriptor). Should only be used with a :class:`~astropy.cosmology.Cosmology` subclass. Parameters ---------- 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}`). 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. fvalidate : callable[[object, object, Any], Any] or str (optional, keyword-only) 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`. 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 .. deprecated:: 5.1 doc : str or None (optional, keyword-only) Parameter description. Examples -------- For worked examples see :class:`~astropy.cosmology.FLRW`. fmtNz5.1)ZsinceFdefault)derivedunit equivalencies fvalidaterdoccCsd|_|_||_t||_||_|dk r4t|nd|_||_ ||_ t |rPnJ||j krf|j |}n4t |trtd|j ntd|j ||_dS)Nz `fvalidate`, if str, must be in z"`fvalidate` must be a function or ) _attr_name_attr_name_private_derivedstr _format_spec__doc__uZUnit_unit_equivalencies _fvalidate_incallable_registry_validators isinstance ValueErrorkeys TypeError _fvalidate)selfrr r r rr rZ/var/www/html/bwave/python/venv/lib/python3.8/site-packages/astropy/cosmology/parameter.py__init__6s&     zParameter.__init__cCs||_d||_dS)N_)r r)r cosmo_clsnamerrr __set_name__^szParameter.__set_name__cCs|jS)zParameter name.)r rrrr r$cszParameter.namecCs|jS)zParameter unit.)rr&rrr r hszParameter.unitcCs|jS)z/Equivalencies used when initializing Parameter.)rr&rrr r mszParameter.equivalencies format_speccCs|jS)z:Whether the Parameter is derived; true parameters are not.)rr&rrr rtszParameter.derivedcCs|dkr |St||jS)N)getattrr)r cosmologyr#rrr __get__|szParameter.__get__cCsXt||jrtd|jd||t|}t|drF|jddt||j|dS)zBAllows attribute setting once. Raises AttributeError subsequently.zcan't set attribute z againsetflagsF)writeN) hasattrrAttributeErrorr validatecopydeepcopyr+setattrrr)valuerrr __set__s    zParameter.__set__cCs|jS)z9Function to validate a potential value of this Parameter.)rr&rrr r szParameter.fvalidatecCs |j|dS)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``. r )clone)rr rrr validatorszParameter.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). r6r3rrr r/szParameter.validatecsBjkrtdd|dk r0|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`` )rr6clskeyrr registers z.Parameter.register_validator..register)rKeyError)r:r;r r<rr9r register_validators  zParameter.register_validatorcCs8|j|j|j|r|jn|j|jd}|jr4|j|d<|S)aInitialization arguments. Parameters ---------- processed : bool Whether to more closely reproduce the input arguments (`False`, default) or the processed arguments (`True`). The former is better for string representations and round-tripping with ``eval(repr())``. Returns ------- dict[str, Any] )rr r r r r)rr r r rrr)r processedkwrrr _get_init_argumentss  zParameter._get_init_argumentscKs.||}t|f|}|j|_|j|_|S)adClone this `Parameter`, changing any constructor argument. Parameters ---------- **kw Passed to constructor. The current values, eg. ``fvalidate`` are used as the default values, so an empty ``**kw`` is an exact copy. Examples -------- >>> p = Parameter() >>> p Parameter(derived=False, unit=None, equivalencies=[], fvalidate='default', doc=None) >>> p.clone(unit="km") Parameter(derived=False, unit=Unit("km"), equivalencies=[], fvalidate='default', doc=None) )rAtyper r)rr@kwargsZclonedrrr r7s  zParameter.clonecCs.t|tstS|d|dko,|j|jkS)aCheck Parameter equality. Only equal to other Parameter objects. Returns ------- NotImplemented or True `True` if equal, `NotImplemented` otherwise. This allows `other` to be check for equality with ``other.__eq__``. Examples -------- >>> p1, p2 = Parameter(unit="km"), Parameter(unit="km") >>> p1 == p2 True >>> p3 = Parameter(unit="km / s") >>> p3 == p1 False >>> p1 != 2 True T)rrNotImplementedrAr$)rotherrrr __eq__&s   zParameter.__eq__cCs"dddd|DS)zString representation. ``eval(repr())`` should work, depending if contents like ``fvalidate`` can be similarly round-tripped. z Parameter({})z, css |]\}}|d|VqdS)=Nr).0kvrrr Lsz%Parameter.__repr__..)formatjoinrAitemsr&rrr __repr__EszParameter.__repr__)N)N)F)__name__ __module__ __qualname__rrrr!r%propertyr$r r rr'rr*r5r r8r/ classmethodr>rAr7rFrOrrrr r s@( '        , rc Cs4|jdk r0t|jt||j}W5QRX|S)z] Default Parameter value validator. Adds/converts units if Parameter has a unit. N)r rZadd_enabled_equivalenciesr ZQuantityr)paramr4rrr _validate_with_unitTs rWfloatcCst|||}t|S)z=Parameter value validator with units, and converted to float.)rWrXrUrrr _validate_to_float`s rYZscalarcCs&t|||}|js"t|jd|S)rz is a non-scalar quantity)rWZisscalarrr$rUrrr _validate_to_scalargs rZz non-negativecCs(t|||}|dkr$t|jd|S)z:Parameter value validator where value is a positive float.gz cannot be negative.)rYrr$rUrrr _validate_non_negativeps r[)r0Z astropy.unitsZunitsrZastropy.utils.decoratorsrr__all__rr>rWrYrZr[rrrr s K