Test to go along with example/recipe

Rename strings classes in tests

Update imports in tests

Author: jbrockmendel

pandas/tests/test_accessors.py

@@ -0,0 +1,100 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+
+An example/recipe/test for implementing custom accessors.
+
+"""
+
+import pandas as pd
+
+from pandas.core.accessors import (wrap_delegate_names,
+								   PandasDelegate, AccessorProperty)
+
+class State(object):
+    def __repr__(self):
+        return repr(self.name)
+
+    def __init__(self, name):
+        self.name = name
+        self._abbrev_dict = {'California': 'CA', 'Alabama': 'AL'}
+
+    @property
+    def abbrev(self):
+        return self._abbrev_dict[self.name]
+
+    @abbrev.setter
+    def abbrev(self, value):
+        self._abbrev_dict[self.name] = value
+
+    def fips(self):
+        return {'California': 6, 'Alabama': 1}[self.name]
+
+
+
+@wrap_delegate_names(delegate=State,
+                     accessors=["fips"],
+                     typ="method")
+@wrap_delegate_names(delegate=State,
+                     accessors=["abbrev"],
+                     typ="property")
+class StateDelegate(PandasDelegate):
+   
+    def __init__(self, values):
+        self.values = values
+        #self._freeze()
+
+    @classmethod
+    def _make_accessor(cls, data):
+    	"""
+    	When implementing custom accessors, `_make_accessor` is the place
+    	to do validation that the attributes be accessed will actually be
+    	present in the underlying data.
+    	"""
+        if not isinstance(data, pd.Series):
+            raise ValueError('Input must be a Series of States')
+        elif not data.apply(lambda x: isinstance(x, State)).all():
+            raise ValueError('All entries must be State objects')
+        return StateDelegate(data)
+
+    def _delegate_method(self, name, *args, **kwargs):
+        state_method = lambda x: getattr(x, name)(*args, **kwargs)
+        return self.values.apply(state_method)
+
+    def _delegate_property_get(self, name):
+        state_property = lambda x: getattr(x, name)
+        return self.values.apply(state_property)
+
+    def _delegate_property_set(self, name, new_values):
+    	"""
+    	Setting properties via accessors is permitted but discouraged.
+    	"""
+    	for (obj, val) in zip(self.values, new_values):
+    		setattr(obj, name, val)
+
+
+
+
+
+def test_geo_state_accessor():
+	import pandas.util.testing as tm
+
+	pd.Series.state = AccessorProperty(StateDelegate)
+
+	ser = pd.Series([State('Alabama'), State('California')])
+
+	abbrev = pd.Series(['AL', 'CA'])
+	tm.assert_series_equal(ser.state.abbrev, abbrev)
+
+	fips = pd.Series([1, 6])
+	tm.assert_series_equal(ser.state.fips(), fips)
+
+
+
+	ser.state.abbrev = ['Foo', 'Bar']
+
+	new_abbrev = pd.Series(['Foo', 'Bar'])
+	tm.assert_series_equal(ser.state.abbrev, new_abbrev)
+
+
+

pandas/tests/test_base.py

@@ -17,7 +17,8 @@
                     Timedelta, IntervalIndex, Interval)
 from pandas.compat import StringIO
 from pandas.compat.numpy import np_array_datetime64_compat
-from pandas.core.accessors import PandasDelegate
+from pandas.core import accessors
+
 from pandas.core.base import NoNewAttributesMixin
 from pandas.core.indexes.datetimelike import DatetimeIndexOpsMixin
 from pandas._libs.tslib import iNaT
@@ -105,28 +106,26 @@ def bar(self, *args, **kwargs):
             """ a test bar method """
             pass
 
-    class Delegate(PandasDelegate):
+    class Delegate(accessors.PandasDelegate):
 
         def __init__(self, obj):
             self.obj = obj
 
     def setup_method(self, method):
         pass
 
-    def test_invalida_delgation(self):
+    def test_invalid_delegation(self):
         # these show that in order for the delegation to work
         # the _delegate_* methods need to be overriden to not raise a TypeError
 
-        self.Delegate._add_delegate_accessors(
-            delegate=self.Delegator,
-            accessors=self.Delegator._properties,
-            typ='property'
-        )
-        self.Delegate._add_delegate_accessors(
-            delegate=self.Delegator,
-            accessors=self.Delegator._methods,
-            typ='method'
-        )
+        for name in self.Delegator._properties:
+            func = accessors.Delegator.create_delegator_property(name, self.Delegator)
+            setattr(self.Delegate, name, func)
+
+        for name in self.Delegator._methods:
+            func = accessors.Delegator.create_delegator_method(name, self.Delegator)
+            setattr(self.Delegate, name, func)
+
 
         delegate = self.Delegate(self.Delegator())
 

pandas/tests/test_categorical.py

@@ -4276,11 +4276,11 @@ def test_cat_accessor_no_new_attributes(self):
 
     def test_str_accessor_api_for_categorical(self):
         # https://github.com/pandas-dev/pandas/issues/10661
-        from pandas.core.strings import StringMethods
+        from pandas.core.strings import StringDelegate
         s = Series(list('aabb'))
         s = s + " " + s
         c = s.astype('category')
-        assert isinstance(c.str, StringMethods)
+        assert isinstance(c.str, StringDelegate)
 
         # str functions, which need special arguments
         special_func_defs = [
@@ -4352,7 +4352,7 @@ def test_str_accessor_api_for_categorical(self):
 
     def test_dt_accessor_api_for_categorical(self):
         # https://github.com/pandas-dev/pandas/issues/10661
-        from pandas.core.indexes.accessors import Properties
+        from pandas.core.indexes.accessors import BaseDatetimeAccessor
 
         s_dr = Series(date_range('1/1/2015', periods=5, tz="MET"))
         c_dr = s_dr.astype("category")
@@ -4372,7 +4372,7 @@ def test_dt_accessor_api_for_categorical(self):
             ("Period", get_ops(PeriodIndex), s_pr, c_pr),
             ("Timedelta", get_ops(TimedeltaIndex), s_tdr, c_tdr)]
 
-        assert isinstance(c_dr.dt, Properties)
+        assert isinstance(c_dr.dt, BaseDatetimeAccessor)
 
         special_func_defs = [
             ('strftime', ("%Y-%m-%d",), {}),

pandas/tests/test_strings.py

@@ -24,8 +24,8 @@ class TestStringMethods(object):
     def test_api(self):
 
         # GH 6106, GH 9322
-        assert Series.str is strings.StringMethods
-        assert isinstance(Series(['']).str, strings.StringMethods)
+        assert Series.str is strings.StringAccessor
+        assert isinstance(Series(['']).str, strings.StringAccessor)
 
         # GH 9184
         invalid = Series([1])
@@ -2708,14 +2708,14 @@ def test_index_str_accessor_visibility(self):
                      (['aa', datetime(2011, 1, 1)], 'mixed')]
         for values, tp in cases:
             idx = Index(values)
-            assert isinstance(Series(values).str, StringMethods)
-            assert isinstance(idx.str, StringMethods)
+            assert isinstance(Series(values).str, strings.StringAccessor)
+            assert isinstance(idx.str, strings.StringAccessor)
             assert idx.inferred_type == tp
 
         for values, tp in cases:
             idx = Index(values)
-            assert isinstance(Series(values).str, StringMethods)
-            assert isinstance(idx.str, StringMethods)
+            assert isinstance(Series(values).str, strings.StringAccessor)
+            assert isinstance(idx.str, strings.StringAccessor)
             assert idx.inferred_type == tp
 
         cases = [([1, np.nan], 'floating'),