a ߙfb.@svddlmZddlmZddlmZddlZddlmZddl m Z ddl m Z d gZ gd Zde d ddfd d ZdS) )deepcopy) signature)isliceN)wraps)AstropyUserWarning)NDDatasupport_nddata)dataZ uncertaintymaskmetaZunitZwcsflagsFc sdusdurstdn.dur4r4tdndur@gdurLg|tfddDrntdfdd}|dur||S|SdS) a Decorator to wrap functions that could accept an NDData instance with its properties passed as function arguments. Parameters ---------- _func : callable, None, optional The function to decorate or ``None`` if used as factory. The first positional argument should be ``data`` and take a numpy array. It is possible to overwrite the name, see ``attribute_argument_mapping`` argument. Default is ``None``. accepts : class, optional The class or subclass of ``NDData`` that should be unpacked before calling the function. Default is ``NDData`` repack : bool, optional Should be ``True`` if the return should be converted to the input class again after the wrapped function call. Default is ``False``. .. note:: Must be ``True`` if either one of ``returns`` or ``keeps`` is specified. returns : iterable, None, optional An iterable containing strings which returned value should be set on the class. For example if a function returns data and mask, this should be ``['data', 'mask']``. If ``None`` assume the function only returns one argument: ``'data'``. Default is ``None``. .. note:: Must be ``None`` if ``repack=False``. keeps : iterable. None, optional An iterable containing strings that indicate which values should be copied from the original input to the returned class. If ``None`` assume that no attributes are copied. Default is ``None``. .. note:: Must be ``None`` if ``repack=False``. attribute_argument_mapping : Keyword parameters that optionally indicate which function argument should be interpreted as which attribute on the input. By default it assumes the function takes a ``data`` argument as first argument, but if the first argument is called ``input`` one should pass ``support_nddata(..., data='input')`` to the function. Returns ------- decorator_factory or decorated_function : callable If ``_func=None`` this returns a decorator, otherwise it returns the decorated ``_func``. Notes ----- If properties of ``NDData`` are set but have no corresponding function argument a Warning is shown. If a property is set of the ``NDData`` are set and an explicit argument is given, the explicitly given argument is used and a Warning is shown. The supported properties are: - ``mask`` - ``unit`` - ``wcs`` - ``meta`` - ``uncertainty`` - ``flags`` Examples -------- This function takes a Numpy array for the data, and some WCS information with the ``wcs`` keyword argument:: def downsample(data, wcs=None): # downsample data and optionally WCS here pass However, you might have an NDData instance that has the ``wcs`` property set and you would like to be able to call the function with ``downsample(my_nddata)`` and have the WCS information, if present, automatically be passed to the ``wcs`` keyword argument. This decorator can be used to make this possible:: @support_nddata def downsample(data, wcs=None): # downsample data and optionally WCS here pass This function can now either be called as before, specifying the data and WCS separately, or an NDData instance can be passed to the ``data`` argument. Nz3returns or keeps should only be set if repack=True.z%returns should be set if repack=True.c3s|]}|vVqdS)N).0keep)returnsr8lib/python3.9/site-packages/astropy/nddata/decorators.py z!support_nddata..z;cannot specify the same attribute in `returns` and `keeps`.c sggtjD]\}}|j|j|jfvr>tdz&|j|jkrX |n  |Wqty}z&dt |vr |nWYd}~qd}~00qrd ddkrtd  ddt  f dd}|S)Nz$func may not have *args or **kwargs.zDThe truth value of an array with more than one element is ambiguous.rr z?Can only wrap functions whose first positional argument is `{}`c stj|g|Ri|}t|}|}g}|sLt|trLtdj|rJttddD]}zt ||}Wnt yYq^Yn0|dkr|sq^n |durq^ ||} | vr| |q^| |j vr| vs| vr|j |  | jurtd| || krdnd|tq^||| <q^|j}|rJtdd|t|g|Ri|} |rrtdkrt| trtt| krtd ntdkr| g} durD]} | tt || q| d } d d t| D} |j| fi| S| SdS) NzIOnly NDData sub-classes that inherit from {} can be used by this functionrr zdProperty {} has been passed explicitly and as an NDData property{}, using explicitly specified value z[The following attributes were set on the data object, but will be ignored by the function: z, z9Function did not return the expected number of arguments.r cSsi|]\}}|dkr||qS)r r)rZretresrrr szUsupport_nddata..support_nddata_decorator..wrapper..)rZbind isinstancer TypeErrorformat__name__rSUPPORTED_PROPERTIESgetattrAttributeErrorgetappendZ argumentsdefaultwarningswarnrr joinlentuple ValueErrorrindexzip __class__)r argskwargsZ bound_argsZunpackZ input_dataZignoredZpropvalueZ propmatchresultrZ resultdataZ resultkwargs) accepts all_returns attr_arg_mapfunc func_args func_kwargskeepsrepackrsigrrwrappers            zAsupport_nddata..support_nddata_decorator..wrapper)r parametersitemskindZVAR_POSITIONALZ VAR_KEYWORDr(r"emptyr!strr rr)r3Z param_nameZparamexcr9r0r1r2r6r7r)r3r4r5r8rsupport_nddata_decorators,       _z0support_nddata..support_nddata_decorator)r(any)Z_funcr0r7rr6Zattribute_argument_mappingrArr@rr s"h   )copyrinspectr itertoolsrr# functoolsrZastropy.utils.exceptionsrZnddatar__all__rr rrrrs