Skip to content

Commit 7344613

Browse files
committed
move validation function into util and rename for consistency
1 parent 2cf662a commit 7344613

File tree

14 files changed

+73
-78
lines changed

14 files changed

+73
-78
lines changed

pandas/computation/eval.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
from pandas.computation.scope import _ensure_scope
1212
from pandas.compat import string_types
1313
from pandas.computation.engines import _engines
14-
from pandas.types.validate import _validate_bool_kwarg
14+
from pandas.util.validators import validate_bool_kwarg
1515

1616

1717
def _check_engine(engine):
@@ -232,7 +232,7 @@ def eval(expr, parser='pandas', engine=None, truediv=True,
232232
pandas.DataFrame.query
233233
pandas.DataFrame.eval
234234
"""
235-
inplace = _validate_bool_kwarg(inplace, 'inplace')
235+
inplace = validate_bool_kwarg(inplace, 'inplace')
236236
first_expr = True
237237
if isinstance(expr, string_types):
238238
_check_expression(expr)

pandas/core/base.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
from pandas.types.missing import isnull
99
from pandas.types.generic import ABCDataFrame, ABCSeries, ABCIndexClass
1010
from pandas.types.common import is_object_dtype, is_list_like, is_scalar
11-
from pandas.types.validate import _validate_bool_kwarg
11+
from pandas.util.validators import validate_bool_kwarg
1212

1313
from pandas.core import common as com
1414
import pandas.core.nanops as nanops
@@ -1179,7 +1179,7 @@ def searchsorted(self, value, side='left', sorter=None):
11791179
False: 'first'})
11801180
@Appender(_shared_docs['drop_duplicates'] % _indexops_doc_kwargs)
11811181
def drop_duplicates(self, keep='first', inplace=False):
1182-
inplace = _validate_bool_kwarg(inplace, 'inplace')
1182+
inplace = validate_bool_kwarg(inplace, 'inplace')
11831183
if isinstance(self, ABCIndexClass):
11841184
if self.is_unique:
11851185
return self._shallow_copy()

pandas/core/categorical.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
is_integer_dtype, is_bool,
2424
is_list_like, is_sequence,
2525
is_scalar)
26-
from pandas.types.validate import _validate_bool_kwarg
2726
from pandas.core.common import is_null_slice
2827

2928
from pandas.core.algorithms import factorize, take_1d
@@ -36,6 +35,7 @@
3635
deprecate_kwarg, Substitution)
3736

3837
from pandas.util.terminal import get_terminal_size
38+
from pandas.util.validators import validate_bool_kwarg
3939
from pandas.core.config import get_option
4040

4141

@@ -616,7 +616,7 @@ def set_ordered(self, value, inplace=False):
616616
Whether or not to set the ordered attribute inplace or return a copy
617617
of this categorical with ordered set to the value
618618
"""
619-
inplace = _validate_bool_kwarg(inplace, 'inplace')
619+
inplace = validate_bool_kwarg(inplace, 'inplace')
620620
self._validate_ordered(value)
621621
cat = self if inplace else self.copy()
622622
cat._ordered = value
@@ -633,7 +633,7 @@ def as_ordered(self, inplace=False):
633633
Whether or not to set the ordered attribute inplace or return a copy
634634
of this categorical with ordered set to True
635635
"""
636-
inplace = _validate_bool_kwarg(inplace, 'inplace')
636+
inplace = validate_bool_kwarg(inplace, 'inplace')
637637
return self.set_ordered(True, inplace=inplace)
638638

639639
def as_unordered(self, inplace=False):
@@ -646,7 +646,7 @@ def as_unordered(self, inplace=False):
646646
Whether or not to set the ordered attribute inplace or return a copy
647647
of this categorical with ordered set to False
648648
"""
649-
inplace = _validate_bool_kwarg(inplace, 'inplace')
649+
inplace = validate_bool_kwarg(inplace, 'inplace')
650650
return self.set_ordered(False, inplace=inplace)
651651

652652
def _get_ordered(self):
@@ -706,7 +706,7 @@ def set_categories(self, new_categories, ordered=None, rename=False,
706706
remove_categories
707707
remove_unused_categories
708708
"""
709-
inplace = _validate_bool_kwarg(inplace, 'inplace')
709+
inplace = validate_bool_kwarg(inplace, 'inplace')
710710
new_categories = self._validate_categories(new_categories)
711711
cat = self if inplace else self.copy()
712712
if rename:
@@ -759,7 +759,7 @@ def rename_categories(self, new_categories, inplace=False):
759759
remove_unused_categories
760760
set_categories
761761
"""
762-
inplace = _validate_bool_kwarg(inplace, 'inplace')
762+
inplace = validate_bool_kwarg(inplace, 'inplace')
763763
cat = self if inplace else self.copy()
764764
cat.categories = new_categories
765765
if not inplace:
@@ -800,7 +800,7 @@ def reorder_categories(self, new_categories, ordered=None, inplace=False):
800800
remove_unused_categories
801801
set_categories
802802
"""
803-
inplace = _validate_bool_kwarg(inplace, 'inplace')
803+
inplace = validate_bool_kwarg(inplace, 'inplace')
804804
if set(self._categories) != set(new_categories):
805805
raise ValueError("items in new_categories are not the same as in "
806806
"old categories")
@@ -839,7 +839,7 @@ def add_categories(self, new_categories, inplace=False):
839839
remove_unused_categories
840840
set_categories
841841
"""
842-
inplace = _validate_bool_kwarg(inplace, 'inplace')
842+
inplace = validate_bool_kwarg(inplace, 'inplace')
843843
if not is_list_like(new_categories):
844844
new_categories = [new_categories]
845845
already_included = set(new_categories) & set(self._categories)
@@ -885,7 +885,7 @@ def remove_categories(self, removals, inplace=False):
885885
remove_unused_categories
886886
set_categories
887887
"""
888-
inplace = _validate_bool_kwarg(inplace, 'inplace')
888+
inplace = validate_bool_kwarg(inplace, 'inplace')
889889
if not is_list_like(removals):
890890
removals = [removals]
891891

@@ -926,7 +926,7 @@ def remove_unused_categories(self, inplace=False):
926926
remove_categories
927927
set_categories
928928
"""
929-
inplace = _validate_bool_kwarg(inplace, 'inplace')
929+
inplace = validate_bool_kwarg(inplace, 'inplace')
930930
cat = self if inplace else self.copy()
931931
idx, inv = np.unique(cat._codes, return_inverse=True)
932932

@@ -1327,7 +1327,7 @@ def sort_values(self, inplace=False, ascending=True, na_position='last'):
13271327
[NaN, NaN, 5.0, 2.0, 2.0]
13281328
Categories (2, int64): [2, 5]
13291329
"""
1330-
inplace = _validate_bool_kwarg(inplace, 'inplace')
1330+
inplace = validate_bool_kwarg(inplace, 'inplace')
13311331
if na_position not in ['last', 'first']:
13321332
raise ValueError('invalid na_position: {!r}'.format(na_position))
13331333

pandas/core/frame.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@
5555
is_sequence,
5656
is_named_tuple)
5757
from pandas.types.missing import isnull, notnull
58-
from pandas.types.validate import _validate_bool_kwarg
5958

6059
from pandas.core.common import (PandasError, _try_sort,
6160
_default_index,
@@ -79,6 +78,7 @@
7978
from pandas import compat
8079
from pandas.compat.numpy import function as nv
8180
from pandas.util.decorators import deprecate_kwarg, Appender, Substitution
81+
from pandas.util.validators import validate_bool_kwarg
8282

8383
from pandas.tseries.period import PeriodIndex
8484
from pandas.tseries.index import DatetimeIndex
@@ -2202,7 +2202,7 @@ def query(self, expr, inplace=False, **kwargs):
22022202
>>> df.query('a > b')
22032203
>>> df[df.a > df.b] # same result as the previous expression
22042204
"""
2205-
inplace = _validate_bool_kwarg(inplace, 'inplace')
2205+
inplace = validate_bool_kwarg(inplace, 'inplace')
22062206
if not isinstance(expr, compat.string_types):
22072207
msg = "expr must be a string to be evaluated, {0} given"
22082208
raise ValueError(msg.format(type(expr)))
@@ -2269,7 +2269,7 @@ def eval(self, expr, inplace=None, **kwargs):
22692269
>>> df.eval('a + b')
22702270
>>> df.eval('c = a + b')
22712271
"""
2272-
inplace = _validate_bool_kwarg(inplace, 'inplace')
2272+
inplace = validate_bool_kwarg(inplace, 'inplace')
22732273
resolvers = kwargs.pop('resolvers', None)
22742274
kwargs['level'] = kwargs.pop('level', 0) + 1
22752275
if resolvers is None:
@@ -2878,7 +2878,7 @@ def set_index(self, keys, drop=True, append=False, inplace=False,
28782878
-------
28792879
dataframe : DataFrame
28802880
"""
2881-
inplace = _validate_bool_kwarg(inplace, 'inplace')
2881+
inplace = validate_bool_kwarg(inplace, 'inplace')
28822882
if not isinstance(keys, list):
28832883
keys = [keys]
28842884

@@ -2971,7 +2971,7 @@ def reset_index(self, level=None, drop=False, inplace=False, col_level=0,
29712971
-------
29722972
resetted : DataFrame
29732973
"""
2974-
inplace = _validate_bool_kwarg(inplace, 'inplace')
2974+
inplace = validate_bool_kwarg(inplace, 'inplace')
29752975
if inplace:
29762976
new_obj = self
29772977
else:
@@ -3076,7 +3076,7 @@ def dropna(self, axis=0, how='any', thresh=None, subset=None,
30763076
-------
30773077
dropped : DataFrame
30783078
"""
3079-
inplace = _validate_bool_kwarg(inplace, 'inplace')
3079+
inplace = validate_bool_kwarg(inplace, 'inplace')
30803080
if isinstance(axis, (tuple, list)):
30813081
result = self
30823082
for ax in axis:
@@ -3140,7 +3140,7 @@ def drop_duplicates(self, subset=None, keep='first', inplace=False):
31403140
-------
31413141
deduplicated : DataFrame
31423142
"""
3143-
inplace = _validate_bool_kwarg(inplace, 'inplace')
3143+
inplace = validate_bool_kwarg(inplace, 'inplace')
31443144
duplicated = self.duplicated(subset, keep=keep)
31453145

31463146
if inplace:
@@ -3202,7 +3202,7 @@ def f(vals):
32023202
@Appender(_shared_docs['sort_values'] % _shared_doc_kwargs)
32033203
def sort_values(self, by, axis=0, ascending=True, inplace=False,
32043204
kind='quicksort', na_position='last'):
3205-
inplace = _validate_bool_kwarg(inplace, 'inplace')
3205+
inplace = validate_bool_kwarg(inplace, 'inplace')
32063206
axis = self._get_axis_number(axis)
32073207
other_axis = 0 if axis == 1 else 1
32083208

@@ -3313,7 +3313,7 @@ def sort(self, columns=None, axis=0, ascending=True, inplace=False,
33133313
def sort_index(self, axis=0, level=None, ascending=True, inplace=False,
33143314
kind='quicksort', na_position='last', sort_remaining=True,
33153315
by=None):
3316-
inplace = _validate_bool_kwarg(inplace, 'inplace')
3316+
inplace = validate_bool_kwarg(inplace, 'inplace')
33173317
# 10726
33183318
if by is not None:
33193319
warnings.warn("by argument to sort_index is deprecated, pls use "

pandas/core/generic.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
from pandas.types.cast import _maybe_promote, _maybe_upcast_putmask
2828
from pandas.types.missing import isnull, notnull
2929
from pandas.types.generic import ABCSeries, ABCPanel
30-
from pandas.types.validate import _validate_bool_kwarg
3130

3231
from pandas.core.common import (_values_from_object,
3332
_maybe_box_datetimelike,
@@ -53,6 +52,7 @@
5352
isidentifier, set_function_name)
5453
import pandas.core.nanops as nanops
5554
from pandas.util.decorators import Appender, Substitution, deprecate_kwarg
55+
from pandas.util.validators import validate_bool_kwarg
5656
from pandas.core import config
5757

5858
# goal is to be able to define the docs close to function, while still being
@@ -734,7 +734,7 @@ def rename_axis(self, mapper, axis=0, copy=True, inplace=False):
734734
1 2 5
735735
2 3 6
736736
"""
737-
inplace = _validate_bool_kwarg(inplace, 'inplace')
737+
inplace = validate_bool_kwarg(inplace, 'inplace')
738738
non_mapper = is_scalar(mapper) or (is_list_like(mapper) and not
739739
is_dict_like(mapper))
740740
if non_mapper:
@@ -1896,7 +1896,7 @@ def drop(self, labels, axis=0, level=None, inplace=False, errors='raise'):
18961896
-------
18971897
dropped : type of caller
18981898
"""
1899-
inplace = _validate_bool_kwarg(inplace, 'inplace')
1899+
inplace = validate_bool_kwarg(inplace, 'inplace')
19001900
axis = self._get_axis_number(axis)
19011901
axis_name = self._get_axis_name(axis)
19021902
axis, axis_ = self._get_axis(axis), axis
@@ -2045,7 +2045,7 @@ def sort_values(self, by, axis=0, ascending=True, inplace=False,
20452045
@Appender(_shared_docs['sort_index'] % dict(axes="axes", klass="NDFrame"))
20462046
def sort_index(self, axis=0, level=None, ascending=True, inplace=False,
20472047
kind='quicksort', na_position='last', sort_remaining=True):
2048-
inplace = _validate_bool_kwarg(inplace, 'inplace')
2048+
inplace = validate_bool_kwarg(inplace, 'inplace')
20492049
axis = self._get_axis_number(axis)
20502050
axis_name = self._get_axis_name(axis)
20512051
labels = self._get_axis(axis)
@@ -2819,7 +2819,7 @@ def consolidate(self, inplace=False):
28192819
-------
28202820
consolidated : type of caller
28212821
"""
2822-
inplace = _validate_bool_kwarg(inplace, 'inplace')
2822+
inplace = validate_bool_kwarg(inplace, 'inplace')
28232823
if inplace:
28242824
self._consolidate_inplace()
28252825
else:
@@ -3205,7 +3205,7 @@ def convert_objects(self, convert_dates=True, convert_numeric=False,
32053205
@Appender(_shared_docs['fillna'] % _shared_doc_kwargs)
32063206
def fillna(self, value=None, method=None, axis=None, inplace=False,
32073207
limit=None, downcast=None):
3208-
inplace = _validate_bool_kwarg(inplace, 'inplace')
3208+
inplace = validate_bool_kwarg(inplace, 'inplace')
32093209
if isinstance(value, (list, tuple)):
32103210
raise TypeError('"value" parameter must be a scalar or dict, but '
32113211
'you passed a "{0}"'.format(type(value).__name__))
@@ -3414,7 +3414,7 @@ def replace(self, to_replace=None, value=None, inplace=False, limit=None,
34143414
and play with this method to gain intuition about how it works.
34153415
34163416
"""
3417-
inplace = _validate_bool_kwarg(inplace, 'inplace')
3417+
inplace = validate_bool_kwarg(inplace, 'inplace')
34183418
if not is_bool(regex) and to_replace is not None:
34193419
raise AssertionError("'to_replace' must be 'None' if 'regex' is "
34203420
"not a bool")
@@ -3647,7 +3647,7 @@ def interpolate(self, method='linear', axis=0, limit=None, inplace=False,
36473647
"""
36483648
Interpolate values according to different methods.
36493649
"""
3650-
inplace = _validate_bool_kwarg(inplace, 'inplace')
3650+
inplace = validate_bool_kwarg(inplace, 'inplace')
36513651

36523652
if self.ndim > 2:
36533653
raise NotImplementedError("Interpolate has not been implemented "
@@ -4558,7 +4558,7 @@ def _where(self, cond, other=np.nan, inplace=False, axis=None, level=None,
45584558
Equivalent to public method `where`, except that `other` is not
45594559
applied as a function even if callable. Used in __setitem__.
45604560
"""
4561-
inplace = _validate_bool_kwarg(inplace, 'inplace')
4561+
inplace = validate_bool_kwarg(inplace, 'inplace')
45624562

45634563
cond = com._apply_if_callable(cond, self)
45644564

@@ -4826,7 +4826,7 @@ def where(self, cond, other=np.nan, inplace=False, axis=None, level=None,
48264826
def mask(self, cond, other=np.nan, inplace=False, axis=None, level=None,
48274827
try_cast=False, raise_on_error=True):
48284828

4829-
inplace = _validate_bool_kwarg(inplace, 'inplace')
4829+
inplace = validate_bool_kwarg(inplace, 'inplace')
48304830
cond = com._apply_if_callable(cond, self)
48314831

48324832
return self.where(~cond, other=other, inplace=inplace, axis=axis,

0 commit comments

Comments
 (0)