Skip to content

Test nested PandasArray #24993

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jan 30, 2019
2 changes: 1 addition & 1 deletion pandas/core/arrays/numpy_.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ def __getitem__(self, item):
item = item._ndarray

result = self._ndarray[item]
if not lib.is_scalar(result):
if not lib.is_scalar(item):
result = type(self)(result)
return result

Expand Down
Empty file.
38 changes: 38 additions & 0 deletions pandas/tests/extension/numpy_/conftest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import numpy as np
import pytest

from pandas.core.arrays.numpy_ import PandasArray


@pytest.fixture
def allow_in_pandas(monkeypatch):
"""
A monkeypatch to tells pandas to let us in.

By default, passing a PandasArray to an index / series / frame
constructor will unbox that PandasArray to an ndarray, and treat
it as a non-EA column. We don't want people using EAs without
reason.

The mechanism for this is a check against ABCPandasArray
in each constructor.

But, for testing, we need to allow them in pandas. So we patch
the _typ of PandasArray, so that we evade the ABCPandasArray
check.
"""
with monkeypatch.context() as m:
m.setattr(PandasArray, '_typ', 'extension')
yield


@pytest.fixture
def na_value():
return np.nan


@pytest.fixture
def na_cmp():
def cmp(a, b):
return np.isnan(a) and np.isnan(b)
return cmp
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,14 @@
from pandas.core.arrays.numpy_ import PandasArray, PandasDtype
import pandas.util.testing as tm

from . import base
from .. import base


@pytest.fixture
def dtype():
return PandasDtype(np.dtype('float'))


@pytest.fixture
def allow_in_pandas(monkeypatch):
"""
A monkeypatch to tells pandas to let us in.

By default, passing a PandasArray to an index / series / frame
constructor will unbox that PandasArray to an ndarray, and treat
it as a non-EA column. We don't want people using EAs without
reason.

The mechanism for this is a check against ABCPandasArray
in each constructor.

But, for testing, we need to allow them in pandas. So we patch
the _typ of PandasArray, so that we evade the ABCPandasArray
check.
"""
with monkeypatch.context() as m:
m.setattr(PandasArray, '_typ', 'extension')
yield


@pytest.fixture
def data(allow_in_pandas, dtype):
return PandasArray(np.arange(1, 101, dtype=dtype._dtype))
Expand All @@ -46,18 +24,6 @@ def data_missing(allow_in_pandas):
return PandasArray(np.array([np.nan, 1.0]))


@pytest.fixture
def na_value():
return np.nan


@pytest.fixture
def na_cmp():
def cmp(a, b):
return np.isnan(a) and np.isnan(b)
return cmp


@pytest.fixture
def data_for_sorting(allow_in_pandas):
"""Length-3 array with a known sort order.
Expand Down
281 changes: 281 additions & 0 deletions pandas/tests/extension/numpy_/test_numpy_nested.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,281 @@
"""
Tests for PandasArray with nested data. Users typically won't create
these objects via `pd.array`, but they can show up through `.array`
on a Series with nested data.
"""
import pytest

import pandas as pd
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add a comment here on what this particular file is testing. (as a casual glance makes it look very similar to test_numpy.py)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TomAugspurger but still this does not answer the question of why you duplicated things

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it makes sense, I suppose enough. Problem is a future reader may not understand exactly what you are getting at here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TomAugspurger why don't you just add a marker to specific tests? (and skip on that)

I'm not aware of a way for a test marker to get access to the value of another fixture.

@TomAugspurger I fear that I may have led you in the wrong direction with the first example on just including the fixture that you want the value of in the function signature. that was just to show that fixtures can be added to the function signature and that additional unwanted permutations would not occur.

from the pytest docs on request.getfixturevalue.. "Declaring fixtures via function argument is recommended where possible. But if you can only decide whether to use another fixture at test setup time, you may use this function to retrieve it inside a fixture or test function body."

hence why i mentioned the function argument approach first.

@jreback is right about adding markers, and the pytest.mark.usefixtures is probably the appropriate marker to use.

if this marker was used only on tests that depended on the dtype fixture, then the autouse fixture I suggested could be used without the request.getfixturevalue('dtype') and dtype included in the fixture signature along with the request fixture which gives access to the class, instance and function to determine if the test should be skipped.

Good to merge?

My comments should not be taken as a reason not to merge. A follow-on PR could look into this approach.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm relatively happy with current approach. It's lower-tech which is fine for me in tests.

from pandas.core.arrays.numpy_ import PandasArray, PandasDtype

from .. import base

# For NumPy <1.16, np.array([np.nan, (1,)]) raises
# ValueError: setting an array element with a sequence.
np = pytest.importorskip('numpy', minversion='1.16.0')


@pytest.fixture
def dtype():
return PandasDtype(np.dtype('object'))


@pytest.fixture
def data(allow_in_pandas, dtype):
return pd.Series([(i,) for i in range(100)]).array


@pytest.fixture
def data_missing(allow_in_pandas):
return PandasArray(np.array([np.nan, (1,)]))


@pytest.fixture
def data_for_sorting(allow_in_pandas):
"""Length-3 array with a known sort order.

This should be three items [B, C, A] with
A < B < C
"""
# Use an empty tuple for first element, then remove,
# to disable np.array's shape inference.
return PandasArray(
np.array([(), (2,), (3,), (1,)])[1:]
)


@pytest.fixture
def data_missing_for_sorting(allow_in_pandas):
"""Length-3 array with a known sort order.

This should be three items [B, NA, A] with
A < B and NA missing.
"""
return PandasArray(
np.array([(1,), np.nan, (0,)])
)


@pytest.fixture
def data_for_grouping(allow_in_pandas):
"""Data for factorization, grouping, and unique tests.

Expected to be like [B, B, NA, NA, A, A, B, C]

Where A < B < C and NA is missing
"""
a, b, c = (1,), (2,), (3,)
return PandasArray(np.array(
[b, b, np.nan, np.nan, a, a, b, c]
))


skip_nested = pytest.mark.skip(reason="Skipping for nested PandasArray")


class BaseNumPyTests(object):
pass


class TestCasting(BaseNumPyTests, base.BaseCastingTests):

@skip_nested
def test_astype_str(self, data):
pass


class TestConstructors(BaseNumPyTests, base.BaseConstructorsTests):
@pytest.mark.skip(reason="We don't register our dtype")
# We don't want to register. This test should probably be split in two.
def test_from_dtype(self, data):
pass

@skip_nested
def test_array_from_scalars(self, data):
pass


class TestDtype(BaseNumPyTests, base.BaseDtypeTests):

@pytest.mark.skip(reason="Incorrect expected.")
# we unsurprisingly clash with a NumPy name.
def test_check_dtype(self, data):
pass


class TestGetitem(BaseNumPyTests, base.BaseGetitemTests):

@skip_nested
def test_getitem_scalar(self, data):
pass

@skip_nested
def test_take_series(self, data):
pass


class TestGroupby(BaseNumPyTests, base.BaseGroupbyTests):
@skip_nested
def test_groupby_extension_apply(self, data_for_grouping, op):
pass


class TestInterface(BaseNumPyTests, base.BaseInterfaceTests):
@skip_nested
def test_array_interface(self, data):
# NumPy array shape inference
pass


class TestMethods(BaseNumPyTests, base.BaseMethodsTests):

@pytest.mark.skip(reason="TODO: remove?")
def test_value_counts(self, all_data, dropna):
pass

@pytest.mark.skip(reason="Incorrect expected")
# We have a bool dtype, so the result is an ExtensionArray
# but expected is not
def test_combine_le(self, data_repeated):
super(TestMethods, self).test_combine_le(data_repeated)

@skip_nested
def test_combine_add(self, data_repeated):
# Not numeric
pass

@skip_nested
def test_shift_fill_value(self, data):
# np.array shape inference. Shift implementation fails.
super().test_shift_fill_value(data)

@skip_nested
def test_unique(self, data, box, method):
# Fails creating expected
pass

@skip_nested
def test_fillna_copy_frame(self, data_missing):
# The "scalar" for this array isn't a scalar.
pass

@skip_nested
def test_fillna_copy_series(self, data_missing):
# The "scalar" for this array isn't a scalar.
pass

@skip_nested
def test_hash_pandas_object_works(self, data, as_frame):
# ndarray of tuples not hashable
pass

@skip_nested
def test_searchsorted(self, data_for_sorting, as_series):
# Test setup fails.
pass

@skip_nested
def test_where_series(self, data, na_value, as_frame):
# Test setup fails.
pass

@skip_nested
def test_repeat(self, data, repeats, as_series, use_numpy):
# Fails creating expected
pass


class TestPrinting(BaseNumPyTests, base.BasePrintingTests):
pass


class TestMissing(BaseNumPyTests, base.BaseMissingTests):

@skip_nested
def test_fillna_scalar(self, data_missing):
# Non-scalar "scalar" values.
pass

@skip_nested
def test_fillna_series_method(self, data_missing, method):
# Non-scalar "scalar" values.
pass

@skip_nested
def test_fillna_series(self, data_missing):
# Non-scalar "scalar" values.
pass

@skip_nested
def test_fillna_frame(self, data_missing):
# Non-scalar "scalar" values.
pass


class TestReshaping(BaseNumPyTests, base.BaseReshapingTests):

@pytest.mark.skip("Incorrect parent test")
# not actually a mixed concat, since we concat int and int.
def test_concat_mixed_dtypes(self, data):
super(TestReshaping, self).test_concat_mixed_dtypes(data)

@skip_nested
def test_merge(self, data, na_value):
# Fails creating expected
pass

@skip_nested
def test_merge_on_extension_array(self, data):
# Fails creating expected
pass

@skip_nested
def test_merge_on_extension_array_duplicates(self, data):
# Fails creating expected
pass


class TestSetitem(BaseNumPyTests, base.BaseSetitemTests):

@skip_nested
def test_setitem_scalar_series(self, data, box_in_series):
pass

@skip_nested
def test_setitem_sequence(self, data, box_in_series):
pass

@skip_nested
def test_setitem_sequence_mismatched_length_raises(self, data, as_array):
pass

@skip_nested
def test_setitem_sequence_broadcasts(self, data, box_in_series):
pass

@skip_nested
def test_setitem_loc_scalar_mixed(self, data):
pass

@skip_nested
def test_setitem_loc_scalar_multiple_homogoneous(self, data):
pass

@skip_nested
def test_setitem_iloc_scalar_mixed(self, data):
pass

@skip_nested
def test_setitem_iloc_scalar_multiple_homogoneous(self, data):
pass

@skip_nested
def test_setitem_mask_broadcast(self, data, setter):
pass

@skip_nested
def test_setitem_scalar_key_sequence_raise(self, data):
pass


# Skip Arithmetics, NumericReduce, BooleanReduce, Parsing