Pandas DataFrameのサブクラスのプロパティセッター


9

pd.DataFrame初期化するときに必要な引数が2つあるサブクラスをセットアップしようとしています(groupおよびtimestamp_col)。これらの引数grouptimestamp_colに対して検証を実行したいので、各プロパティのセッターメソッドがあります。これは、私がset_index()取得しようとするまですべて機能しますTypeError: 'NoneType' object is not iterabletest_set_indexandで私のセッター関数に引数が渡されていないようtest_assignment_with_indexed_objです。if g == None: returnセッター関数に追加すると、テストケースに合格できますが、それが適切な解決策であるとは思われません。

これらの必須引数のプロパティ検証を実装するにはどうすればよいですか?

以下は私のクラスです:

import pandas as pd
import numpy as np


class HistDollarGains(pd.DataFrame):
    @property
    def _constructor(self):
        return HistDollarGains._internal_ctor

    _metadata = ["group", "timestamp_col", "_group", "_timestamp_col"]

    @classmethod
    def _internal_ctor(cls, *args, **kwargs):
        kwargs["group"] = None
        kwargs["timestamp_col"] = None
        return cls(*args, **kwargs)

    def __init__(
        self,
        data,
        group,
        timestamp_col,
        index=None,
        columns=None,
        dtype=None,
        copy=True,
    ):
        super(HistDollarGains, self).__init__(
            data=data, index=index, columns=columns, dtype=dtype, copy=copy
        )

        self.group = group
        self.timestamp_col = timestamp_col

    @property
    def group(self):
        return self._group

    @group.setter
    def group(self, g):
        if g == None:
            return

        if isinstance(g, str):
            group_list = [g]
        else:
            group_list = g

        if not set(group_list).issubset(self.columns):
            raise ValueError("Data does not contain " + '[' + ', '.join(group_list) + ']')
        self._group = group_list

    @property
    def timestamp_col(self):
        return self._timestamp_col

    @timestamp_col.setter
    def timestamp_col(self, t):
        if t == None:
            return
        if not t in self.columns:
            raise ValueError("Data does not contain " + '[' + t + ']')
        self._timestamp_col = t

これが私のテストケースです:

import pytest

import pandas as pd
import numpy as np

from myclass import *


@pytest.fixture(scope="module")
def sample():
    samp = pd.DataFrame(
        [
            {"timestamp": "2020-01-01", "group": "a", "dollar_gains": 100},
            {"timestamp": "2020-01-01", "group": "b", "dollar_gains": 100},
            {"timestamp": "2020-01-01", "group": "c", "dollar_gains": 110},
            {"timestamp": "2020-01-01", "group": "a", "dollar_gains": 110},
            {"timestamp": "2020-01-01", "group": "b", "dollar_gains": 90},
            {"timestamp": "2020-01-01", "group": "d", "dollar_gains": 100},
        ]
    )

    return samp

@pytest.fixture(scope="module")
def sample_obj(sample):
    return HistDollarGains(sample, "group", "timestamp")

def test_constructor_without_args(sample):
    with pytest.raises(TypeError):
        HistDollarGains(sample)


def test_constructor_with_string_group(sample):
    hist_dg = HistDollarGains(sample, "group", "timestamp")
    assert hist_dg.group == ["group"]
    assert hist_dg.timestamp_col == "timestamp"


def test_constructor_with_list_group(sample):
    hist_dg = HistDollarGains(sample, ["group", "timestamp"], "timestamp")

def test_constructor_with_invalid_group(sample):
    with pytest.raises(ValueError):
        HistDollarGains(sample, "invalid_group", np.random.choice(sample.columns))

def test_constructor_with_invalid_timestamp(sample):
    with pytest.raises(ValueError):
        HistDollarGains(sample, np.random.choice(sample.columns), "invalid_timestamp")

def test_assignment_with_indexed_obj(sample_obj):
    b = sample_obj.set_index(sample_obj.group + [sample_obj.timestamp_col])

def test_set_index(sample_obj):
    # print(isinstance(a, pd.DataFrame))
    assert sample_obj.set_index(sample_obj.group + [sample_obj.timestamp_col]).index.names == ['group', 'timestamp']

1
プロパティのNone無効な値である場合は、?groupValueError
chepner

1
あなたは正しいですNone、私はif文のようにしない理由で無効な値、です。しかし、Noneを追加すると、テストに合格します。None ifステートメントなしでこれを適切に修正する方法を探しています。
cページ

2
セッターはを発生させる必要がありValueErrorます。問題は、最初にgroup属性を何に設定しようとしているのかを理解することですNone
chepner

@chepnerはい、そうです。
cページ

たぶんパンダスフレーバーパッケージが役立つかもしれません。
Mykola Zotko

回答:


3

set_index()メソッドは呼び出しますself.copy()、あなたのデータフレームのオブジェクトのコピーを作成します(ソースコードを参照するために内部でここにそれは、あなたのカスタマイズされたコンストラクタメソッドを使用してその内側に、)_internal_ctor()新しいオブジェクト(作成するには、ソースを)。self._constructor()と同じであることに注意してくださいself._internal_ctor()。これは、ディープコピーやスライスなどの操作中に新しいインスタンスを作成するためのほぼすべてのパンダクラスの一般的な内部メソッドです。あなたの問題は実際にはこの関数に起因しています:

class HistDollarGains(pd.DataFrame):
    ...
    @classmethod
    def _internal_ctor(cls, *args, **kwargs):
        kwargs["group"]         = None
        kwargs["timestamp_col"] = None
        return cls(*args, **kwargs) # this is equivalent to calling
                                    # HistDollarGains(data, group=None, timestamp_col=None)

github issueからこのコードをコピーしたと思います。行は、kwargs["**"] = None明示的にセットにコンストラクタを伝えるNoneの両方にgrouptimestamp_col。最後に、setter / validatorがNone新しい値として取得され、エラーが発生します。

したがって、許容値をgroupおよびに設定する必要がありtimestamp_colます。

    @classmethod
    def _internal_ctor(cls, *args, **kwargs):
        kwargs["group"]         = []
        kwargs["timestamp_col"] = 'timestamp' # or whatever name that makes your validator happy
        return cls(*args, **kwargs)

次にif g == None: return、バリデーターの行を削除できます。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.