File: xarray.py

package info (click to toggle)
python-pandas-flavor 0.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 216 kB
  • sloc: python: 289; makefile: 3
file content (74 lines) | stat: -rw-r--r-- 1,927 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
"""XArray support for pandas_flavor."""
from xarray import register_dataarray_accessor, register_dataset_accessor
from functools import wraps


def make_accessor_wrapper(method):
    """
    Makes an XArray-compatible accessor to wrap a method to be added to an
    xr.DataArray, xr.Dataset, or both.

    Args:
        method: A method which takes an XArray object and needed parameters.

    Returns:
        The result of calling ``method``.
    """

    class XRAccessor:
        """XArray accessor for a method."""

        def __init__(self, xr_obj):
            """Initialize the accessor.

            Args:
                xr_obj: The XArray object to which the accessor is attached.
            """
            self._xr_obj = xr_obj

        @wraps(method)
        def __call__(self, *args, **kwargs):
            """Call the method.

            Args:
                *args: Positional arguments to pass to the method.
                **kwargs: Keyword arguments to pass to the method.

            Returns:
                The result of calling ``method``.
            """

            return method(self._xr_obj, *args, **kwargs)

    return XRAccessor


def register_xarray_dataarray_method(method: callable):
    """Register a method on an XArray DataArray object.

    Args:
        method: A method which takes an XArray object and needed parameters.

    Returns:
        The method.
    """
    accessor_wrapper = make_accessor_wrapper(method)
    register_dataarray_accessor(method.__name__)(accessor_wrapper)

    return method


def register_xarray_dataset_method(method: callable):
    """Register a method on an XArray Dataset object.

    Args:
        method: A method which takes an XArray object and needed parameters.

    Returns:
        The method.
    """

    accessor_wrapper = make_accessor_wrapper(method)
    register_dataset_accessor(method.__name__)(accessor_wrapper)

    return method