maxframe 2.4.0rc1__cp312-cp312-win32.whl

maxframe/dataframe/accessors/list_/getitem.py

@@ -0,0 +1,128 @@
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import pandas as pd
+
+from .... import opcodes
+from ....serialization.serializables.field import AnyField, BoolField
+from .core import LegacySeriesListOperator, SeriesListMethod
+
+
+class SeriesListGetItemOperator(LegacySeriesListOperator):
+    # operator class deprecated since v2.3.0
+    _op_type_ = opcodes.SERIES_LIST_GETITEM
+    _method_name = "getitem"
+    query_index = AnyField("query_index", default=None)
+    ignore_index_error = BoolField("ignore_index_error", default=False)
+
+
+def series_list_getitem(series, query_index):
+    """
+    Get the value by the index of each list in the Series.
+
+    Parameters
+    ----------
+    query_index : Any
+        The key to check, must be index.
+
+    Returns
+    -------
+    Series :
+        A Series with the list value's data type. The value will be
+        ``None`` if the list is None.
+
+    Examples
+    --------
+    Create a series with list type data.
+
+    >>> import maxframe.dataframe as md
+    >>> import pyarrow as pa
+    >>> from maxframe.lib.dtypes_extension import list_
+    >>> s = md.Series(
+    ...     data=[[1, 2, 3], [4, 5, 6], None],
+    ...     index=[1, 2, 3],
+    ...     dtype=list_(pa.int64()),
+    ... )
+    >>> s.execute()
+    1    [1, 2, 3]
+    2    [4, 5, 6]
+    3         <NA>
+    dtype: list<int64>[pyarrow]
+
+    >>> s.list.get(0).execute()
+    1       1
+    2       4
+    3    <NA>
+    dtype: int64[pyarrow]
+    """
+    kw = dict(query_index=query_index, ignore_index_error=True)
+    arrow_list_type = series.dtype.pyarrow_dtype
+    return SeriesListMethod(method="getitem", method_kwargs=kw)(
+        series, dtype=pd.ArrowDtype(arrow_list_type.value_type)
+    )
+
+
+def series_list_getitem_with_index_error(series, query_index):
+    """
+    Get the value by the index of each list in the Series. If the index
+    is not in the list, raise IndexError.
+
+    Parameters
+    ----------
+    query_index : Any
+        The index to check, must be integer.
+
+    Returns
+    -------
+    Series :
+        A Series with the list value's data type. Return ``None`` if the list is None.
+
+    Raises
+    ------
+    KeyError
+        If the index is not in one list.
+
+    See Also
+    --------
+    Series.list.get: Get the value by the index of each list in the Series.
+
+    Examples
+    --------
+    Create a series with list type data.
+
+    >>> import maxframe.dataframe as md
+    >>> import pyarrow as pa
+    >>> from maxframe.lib.dtypes_extension import list_
+    >>> s = md.Series(
+    ...     data=[[1, 2, 3], [4, 5, 6], None],
+    ...     index=[1, 2, 3],
+    ...     dtype=list_(pa.int64()),
+    ... )
+    >>> s.execute()
+    1    [1, 2, 3]
+    2    [4, 5, 6]
+    3         <NA>
+    dtype: list<int64>[pyarrow]
+
+    >>> s.list.get(0).execute()
+    1       1
+    2       4
+    3    <NA>
+    dtype: int64[pyarrow]
+    """
+    kw = dict(query_index=query_index, ignore_index_error=False)
+    arrow_list_type = series.dtype.pyarrow_dtype
+    return SeriesListMethod(method="getitem", method_kwargs=kw)(
+        series, dtype=pd.ArrowDtype(arrow_list_type.value_type)
+    )

maxframe/dataframe/accessors/list_/length.py

@@ -0,0 +1,64 @@
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import pandas as pd
+import pyarrow as pa
+
+from .... import opcodes
+from .core import LegacySeriesListOperator, SeriesListMethod
+
+
+class SeriesListLengthOperator(LegacySeriesListOperator):
+    # operator class deprecated since v2.3.0
+    _op_type_ = opcodes.SERIES_LIST_LENGTH
+    _method_name = "len"
+
+
+def series_list_length(series):
+    """
+    Get the length of each list of the Series.
+
+    Returns
+    -------
+    Series :
+        A Series with data type ``pandas.ArrowDtype(pyarrow.int64)``. Each element
+        represents the length of the list, or ``None`` if the list is ``None``.
+
+    Examples
+    --------
+    Create a series with list type data.
+
+    >>> import maxframe.dataframe as md
+    >>> import pyarrow as pa
+    >>> from maxframe.lib.dtypes_extension import list_
+    >>> s = md.Series(
+    ...     data=[[1, 2, 3], [4, 5, 6], None],
+    ...     index=[1, 2, 3],
+    ...     dtype=list_(pa.int64()),
+    ... )
+    >>> s.execute()
+    1    [1, 2, 3]
+    2    [4, 5, 6]
+    3         <NA>
+    dtype: list<int64>[pyarrow]
+
+    >>> s.list.len().execute()
+    1       2
+    2       1
+    3    <NA>
+    dtype: int64[pyarrow]
+    """
+    return SeriesListMethod(method="len")(
+        series, name=None, dtype=pd.ArrowDtype(pa.int64())
+    )

maxframe/dataframe/accessors/list_/tests/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

maxframe/dataframe/accessors/list_/tests/test_list_accessor.py

@@ -0,0 +1,81 @@
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import numpy as np
+import pandas as pd
+import pyarrow as pa
+import pytest
+
+from ..... import dataframe as md
+from .....lib.dtypes_extension import list_
+from .....utils import ARROW_DTYPE_NOT_SUPPORTED
+from ..core import SeriesListMethod
+
+pytestmark = pytest.mark.skipif(
+    ARROW_DTYPE_NOT_SUPPORTED, reason="Arrow Dtype is not supported"
+)
+
+
+@pytest.fixture
+def df():
+    return md.DataFrame(
+        {
+            "A": pd.Series([[5, 3, 2]], dtype=list_(pa.int32())),
+            "B": pd.Series([["ab", "cd"]], dtype=list_(pa.string())),
+            "C": pd.Series([1], dtype=np.dtype("int64")),
+        },
+        index=[1],
+    )
+
+
+def test_invalid_dtype(df):
+    with pytest.raises(AttributeError):
+        df["C"].list.len()
+
+
+def test_getitem(df):
+    s1 = df["A"].list[1]
+    assert isinstance(s1, md.Series)
+    assert s1.dtype == pd.ArrowDtype(pa.int32())
+    assert s1.shape == (1,)
+    assert s1.index_value == df.index_value
+    op = s1.op
+    assert isinstance(op, SeriesListMethod)
+    assert op.method == "getitem"
+    assert op.method_kwargs["query_index"] == 1
+    assert op.method_kwargs["ignore_index_error"] is False
+
+
+def test_getitem_ignore_index_err(df):
+    s1 = df["B"].list.get(1)
+    assert isinstance(s1, md.Series)
+    assert s1.dtype == pd.ArrowDtype(pa.string())
+    assert s1.shape == (1,)
+    assert s1.index_value == df.index_value
+    op = s1.op
+    assert isinstance(op, SeriesListMethod)
+    assert op.method == "getitem"
+    assert op.method_kwargs["query_index"] == 1
+    assert op.method_kwargs["ignore_index_error"] is True
+
+
+def test_length(df):
+    s1 = df["A"].list.len()
+    assert isinstance(s1, md.Series)
+    assert s1.dtype == pd.ArrowDtype(pa.int64())
+    assert s1.shape == (1,)
+    assert s1.index_value == df.index_value
+    op = s1.op
+    assert isinstance(op, SeriesListMethod)
+    assert op.method == "len"

maxframe/dataframe/accessors/plotting/__init__.py

@@ -0,0 +1,40 @@
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+def _install():
+    import pandas as pd
+
+    from ....core import CachedAccessor
+    from ....utils import adapt_docstring
+    from ...core import DATAFRAME_TYPE, SERIES_TYPE
+    from .core import DataFramePlotAccessor, PlotAccessor, SeriesPlotAccessor
+
+    for t in DATAFRAME_TYPE:
+        t.plot = CachedAccessor("plot", DataFramePlotAccessor)
+    for method in dir(pd.DataFrame.plot):
+        if not method.startswith("_"):
+            DataFramePlotAccessor._register(method)
+
+    for t in SERIES_TYPE:
+        t.plot = CachedAccessor("plot", SeriesPlotAccessor)
+    for method in dir(pd.Series.plot):
+        if not method.startswith("_"):
+            SeriesPlotAccessor._register(method)
+
+    PlotAccessor.__doc__ = adapt_docstring(pd.DataFrame.plot.__doc__)
+
+
+_install()
+del _install

maxframe/dataframe/accessors/plotting/core.py

@@ -0,0 +1,78 @@
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from collections import OrderedDict
+
+import pandas as pd
+
+from ....core import ENTITY_TYPE, ExecutableTuple
+from ....utils import adapt_docstring, get_item_if_scalar
+
+
+class PlotAccessor:
+    def __init__(self, obj):
+        self._obj = obj
+
+    def __call__(self, kind="line", session=None, **kwargs):
+        to_executes = self._get_executables(**kwargs)
+
+        result = dict()
+        executed = (
+            ExecutableTuple(to_executes.values())
+            .execute(session=session)
+            .fetch(session=session)
+        )
+        for p, v in zip(to_executes, executed):
+            result[p] = get_item_if_scalar(v)
+
+        data = result.pop("__object__")
+        pd_kwargs = kwargs.copy()
+        pd_kwargs["kind"] = kind
+        pd_kwargs.update(result)
+
+        return data.plot(**pd_kwargs)
+
+    def _get_executables(self, **kwargs) -> OrderedDict:
+        to_executes = OrderedDict()
+        to_executes["__object__"] = self._obj
+
+        for k, v in kwargs.items():
+            if isinstance(v, ENTITY_TYPE):
+                to_executes[k] = v
+
+        return to_executes
+
+    @classmethod
+    def _gen_func(cls, name, doc):
+        def _inner(self, *args, **kwargs):
+            return self(kind=name, *args, **kwargs)
+
+        _inner.__name__ = name
+        _inner.__doc__ = doc
+
+        return _inner
+
+    @classmethod
+    def _register(cls, method):
+        doc = getattr(pd.DataFrame.plot, method).__doc__
+        new_doc = adapt_docstring(doc)
+        setattr(cls, method, cls._gen_func(method, new_doc))
+
+
+class DataFramePlotAccessor(PlotAccessor):
+    pass
+
+
+class SeriesPlotAccessor(PlotAccessor):
+    pass

maxframe/dataframe/accessors/plotting/tests/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

maxframe/dataframe/accessors/plotting/tests/test_plotting_accessor.py

@@ -0,0 +1,136 @@
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import tempfile
+import warnings
+
+import mock
+import numpy as np
+import pandas as pd
+import pytest
+
+try:
+    import matplotlib
+except ImportError:  # pragma: no cover
+    matplotlib = None
+
+from ..... import dataframe as md
+from ..... import tensor as mt
+from .....core import ExecutableTuple
+from .....tensor.datasource import Scalar
+from ....datasource import PandasDataSourceOperator
+
+
+@pytest.fixture
+def wrap_execute():
+    exec_container = dict()
+
+    def new_execute(executable_tuple: ExecutableTuple, *_args, **_kw):
+        for entity in executable_tuple:
+            if isinstance(entity.op, PandasDataSourceOperator):
+                exec_container[entity] = entity.op.get_data()
+            elif isinstance(entity.op, Scalar):
+                exec_container[entity] = entity.op.data
+            else:
+                raise NotImplementedError(entity.op)
+        return executable_tuple
+
+    def new_fetch(executable_tuple: ExecutableTuple, *_args, **_kw):
+        return tuple(exec_container[et] for et in executable_tuple)
+
+    with mock.patch(
+        "maxframe.core.entity.executable.ExecutableTuple.execute", new=new_execute
+    ), mock.patch(
+        "maxframe.core.entity.executable.ExecutableTuple.fetch", new=new_fetch
+    ):
+        yield
+
+
+def close(fignum=None):  # pragma: no cover
+    from matplotlib.pyplot import close as _close
+    from matplotlib.pyplot import get_fignums
+
+    if fignum is None:
+        for fignum in get_fignums():
+            _close(fignum)
+    else:
+        _close(fignum)
+
+
+def assert_is_valid_plot_return_object(objs):  # pragma: no cover
+    import matplotlib.pyplot as plt
+
+    if isinstance(objs, (pd.Series, np.ndarray)):
+        for el in objs.ravel():
+            msg = (
+                "one of 'objs' is not a matplotlib Axes instance, "
+                f"type encountered {type(el).__name__}"
+            )
+            assert isinstance(el, (plt.Axes, dict)), msg
+    else:
+        msg = (
+            "objs is neither an ndarray of Artist instances nor a single "
+            f"ArtistArtist instance, tuple, or dict, 'objs' is a {type(objs).__name__}"
+        )
+        assert isinstance(objs, (plt.Artist, tuple, dict)), msg
+
+
+def _check_plot_works(f, filterwarnings="always", **kwargs):  # pragma: no cover
+    import matplotlib.pyplot as plt
+
+    ret = None
+    with warnings.catch_warnings():
+        warnings.simplefilter(filterwarnings)
+        try:
+            try:
+                fig = kwargs["figure"]
+            except KeyError:
+                fig = plt.gcf()
+
+            plt.clf()
+
+            kwargs.get("ax", fig.add_subplot(211))
+            ret = f(**kwargs)
+
+            assert_is_valid_plot_return_object(ret)
+
+            if f is pd.plotting.bootstrap_plot:
+                assert "ax" not in kwargs
+            else:
+                kwargs["ax"] = fig.add_subplot(212)
+
+            ret = f(**kwargs)
+            assert_is_valid_plot_return_object(ret)
+
+            with tempfile.TemporaryFile() as path:
+                plt.savefig(path)
+        finally:
+            close(fig)
+
+        return ret
+
+
+@pytest.mark.skipif(matplotlib is None, reason="matplotlib is not installed")
+def test_plotting(wrap_execute):
+    raw = pd.DataFrame(
+        {
+            "a": ["s" + str(i) for i in range(10)],
+            "b": np.random.RandomState(0).randint(10, size=10),
+        }
+    )
+    df = md.DataFrame(raw)
+
+    _check_plot_works(df.plot, x="a", y="b")
+    _check_plot_works(df.plot, x="a", y=mt.tensor("b"))
+    _check_plot_works(df.plot.line)

maxframe/dataframe/accessors/string_/__init__.py

@@ -0,0 +1,36 @@
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .core import SeriesStringMethod, string_method_to_handlers
+
+methods = set(string_method_to_handlers.keys())
+del string_method_to_handlers
+
+
+def _install():
+    from ....core import CachedAccessor
+    from ...core import SERIES_TYPE
+    from .accessor import StringAccessor
+    from .core import string_method_to_handlers
+
+    for method in string_method_to_handlers:
+        if not hasattr(StringAccessor, method):
+            StringAccessor._register(method)
+
+    for series in SERIES_TYPE:
+        series.str = CachedAccessor("str", StringAccessor)
+
+
+_install()
+del _install