Setter de propriedade para subclasse de DataFrame do Pandas

9

Eu estou tentando configurar uma subclasse de pd.DataFrameque tem dois argumentos necessários ao inicializar ( groupe timestamp_col). Quero executar a validação nesses argumentos groupe timestamp_col, portanto, tenho um método setter para cada uma das propriedades. Isso tudo funciona até eu tentar set_index()e conseguir TypeError: 'NoneType' object is not iterable. Parece que nenhum argumento está sendo passado para a minha função setter em test_set_indexe test_assignment_with_indexed_obj. Se eu adicionar if g == None: returnà minha função setter, posso passar nos casos de teste, mas não acho que essa seja a solução adequada.

Como devo implementar a validação de propriedade para esses argumentos obrigatórios?

Abaixo está a minha turma:

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

Aqui estão meus casos de teste:

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']
página
fonte
11
Se Noneé um valor inválido para a grouppropriedade, você não deve aumentar um ValueError?
chepner 11/01
11
Você está certo de que Noneé um valor inválido, e é por isso que não gosto da instrução if. Mas acrescentando que None faz passar nos testes. Estou procurando como corrigir isso corretamente, sem a instrução None if.
cpage 11/01
2
O levantador deve levantar a ValueError. O problema é descobrir o que está tentando definir o groupatributo Noneem primeiro lugar.
chepner 11/01
@chepner sim, exatamente.
cpage 11/01
Talvez o pacote Pandas Flavor possa ajudar.
Mykola Zotko

Respostas:

3

O set_index()método chamará self.copy()internamente para criar uma cópia do seu objeto DataFrame (consulte o código-fonte aqui ), dentro do qual ele usa seu método construtor personalizado _internal_ctor(), para criar o novo objeto ( fonte ). Observe que self._constructor()é idêntico a self._internal_ctor(), que é um método interno comum para quase todas as classes de pandas para criar novas instâncias durante operações como cópia profunda ou fatiamento. Seu problema realmente se origina desta função:

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)

Eu acho que você copiou esse código da questão do github . As linhas kwargs["**"] = Noneexplicitamente dizem ao construtor para definir Noneambos groupe timestamp_col. Finalmente, o setter / validador obtém Noneo novo valor e gera um erro.

Portanto, você deve definir um valor aceitável para groupe 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)

Em seguida, você pode excluir as if g == None: returnlinhas no validador.

gdlmx
fonte