Skip to content

TST/DOC: Add procedure for TestPickle #9401

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.

Sign up for GitHub

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 1 commit into from
Feb 11, 2015
Merged

TST/DOC: Add procedure for TestPickle #9401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 37 additions & 26 deletions pandas/io/tests/test_pickle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,20 @@
from pandas.util.misc import is_little_endian
import pandas

class TestPickle(tm.TestCase):
class TestPickle():
Copy link
Contributor

Choose a reason for hiding this comment

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

put a comment why we are not sub-classing TestCase here

Copy link
Member Author

Choose a reason for hiding this comment

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

Added.

"""
How to add pickle tests:

1. Install pandas version intended to output the pickle.

2. Execute "generate_legacy_pkcles.py" to create the pickle.
$ python generate_legacy_pickles.py <version> <output_dir>

3. Move the created pickle to "data/legacy_pickle/<version>" directory.

NOTE: TestPickle can't be a subclass of tm.Testcase to use test generator.
http://stackoverflow.com/questions/6689537/nose-test-generators-inside-class
"""
_multiprocess_can_split_ = True

def setUp(self):
Expand All @@ -28,7 +41,7 @@ def setUp(self):

def compare_element(self, typ, result, expected):
if isinstance(expected,Index):
self.assertTrue(expected.equals(result))
tm.assert_index_equal(expected, result)
return

if typ.startswith('sp_'):
Expand Down Expand Up @@ -65,8 +78,9 @@ def read_pickles(self, version):
raise nose.SkipTest("known failure on non-little endian")

pth = tm.get_data_path('legacy_pickle/{0}'.format(str(version)))
n = 0
for f in os.listdir(pth):
vf = os.path.join(pth,f)
vf = os.path.join(pth, f)
data = self.compare(vf)

if data is None:
Expand All @@ -76,21 +90,18 @@ def read_pickles(self, version):
if 'ts' in data['series']:
self._validate_timeseries(data['series']['ts'], self.data['series']['ts'])
self._validate_frequency(data['series']['ts'])

def test_read_pickles_0_10_1(self):
self.read_pickles('0.10.1')

def test_read_pickles_0_11_0(self):
self.read_pickles('0.11.0')

def test_read_pickles_0_12_0(self):
self.read_pickles('0.12.0')

def test_read_pickles_0_13_0(self):
self.read_pickles('0.13.0')

def test_read_pickles_0_14_0(self):
self.read_pickles('0.14.0')
n += 1
assert n > 0, 'Pickle files are not tested'

Copy link
Contributor

Choose a reason for hiding this comment

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

rather than making these in one test, can you have a routine which create tests from the legacy_pickle dir (like you are doing now), but makes them separate tests (so need to do this at import time). That way you can see them running indepedently (and if they fail they would fail independetly)

def test_pickles(self):
pickle_path = tm.get_data_path('legacy_pickle')
n = 0
for v in os.listdir(pickle_path):
pth = os.path.join(pickle_path, v)
if os.path.isdir(pth):
yield self.read_pickles, v
n += 1
assert n > 0, 'Pickle files are not tested'

def test_round_trip_current(self):

Expand Down Expand Up @@ -145,24 +156,24 @@ def python_unpickler(path):
def _validate_timeseries(self, pickled, current):
# GH 7748
tm.assert_series_equal(pickled, current)
self.assertEqual(pickled.index.freq, current.index.freq)
self.assertEqual(pickled.index.freq.normalize, False)
self.assert_numpy_array_equal(pickled > 0, current > 0)
tm.assert_equal(pickled.index.freq, current.index.freq)
tm.assert_equal(pickled.index.freq.normalize, False)
tm.assert_numpy_array_equal(pickled > 0, current > 0)

def _validate_frequency(self, pickled):
# GH 9291
from pandas.tseries.offsets import Day
freq = pickled.index.freq
result = freq + Day(1)
self.assertTrue(result, Day(2))
tm.assert_equal(result, Day(2))

result = freq + pandas.Timedelta(hours=1)
self.assertTrue(isinstance(result, pandas.Timedelta))
self.assertEqual(result, pandas.Timedelta(days=1, hours=1))
tm.assert_equal(isinstance(result, pandas.Timedelta), True)
tm.assert_equal(result, pandas.Timedelta(days=1, hours=1))

result = freq + pandas.Timedelta(nanoseconds=1)
self.assertTrue(isinstance(result, pandas.Timedelta))
self.assertEqual(result, pandas.Timedelta(days=1, nanoseconds=1))
tm.assert_equal(isinstance(result, pandas.Timedelta), True)
tm.assert_equal(result, pandas.Timedelta(days=1, nanoseconds=1))


if __name__ == '__main__':
Expand Down
9 changes: 1 addition & 8 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,14 +585,7 @@ def pxd(name):
'pandas.stats.tests',
],
package_data={'pandas.io': ['tests/data/legacy_hdf/*.h5',
'tests/data/legacy_pickle/0.10.1/*.pickle',
'tests/data/legacy_pickle/0.11.0/*.pickle',
'tests/data/legacy_pickle/0.12.0/*.pickle',
'tests/data/legacy_pickle/0.13.0/*.pickle',
'tests/data/legacy_pickle/0.14.0/*.pickle',
'tests/data/legacy_pickle/0.14.1/*.pickle',
'tests/data/legacy_pickle/0.15.0/*.pickle',
'tests/data/legacy_pickle/0.15.2/*.pickle',
'tests/data/legacy_pickle/*/*.pickle',
'tests/data/*.csv',
'tests/data/*.dta',
'tests/data/*.txt',
Expand Down