Merge remote-tracking branch 'repo_org/master' into check_np_pd_fromExamples

* repo_org/master:
  DOC: Validate that See Also section items do not contain the pandas. prefix (pandas-dev#23145)
  API/TST: make hasnans always return python booleans (pandas-dev#23349)

Author: thoo

doc/source/whatsnew/v0.24.0.txt

@@ -910,6 +910,7 @@ Other API Changes
   has an improved ``KeyError`` message, and will not fail on duplicate column names with ``drop=True``. (:issue:`22484`)
 - Slicing a single row of a DataFrame with multiple ExtensionArrays of the same type now preserves the dtype, rather than coercing to object (:issue:`22784`)
 - :class:`DateOffset` attribute `_cacheable` and method `_should_cache` have been removed (:issue:`23118`)
+- :meth:`Index.hasnans` and :meth:`Series.hasnans` now always return a python boolean. Previously, a python or a numpy boolean could be returned, depending on circumstances (:issue:`23294`).
 
 .. _whatsnew_0240.deprecations:
 

pandas/core/arrays/datetimelike.py

@@ -219,7 +219,7 @@ def _isnan(self):
     @property  # NB: override with cache_readonly in immutable subclasses
     def hasnans(self):
         """ return if I have any nans; enables various perf speedups """
-        return self._isnan.any()
+        return bool(self._isnan.any())
 
     def _maybe_mask_results(self, result, fill_value=None, convert=None):
         """

pandas/core/base.py

@@ -889,7 +889,7 @@ def __iter__(self):
     @cache_readonly
     def hasnans(self):
         """ return if I have any nans; enables various perf speedups """
-        return isna(self).any()
+        return bool(isna(self).any())
 
     def _reduce(self, op, name, axis=0, skipna=True, numeric_only=None,
                 filter_type=None, **kwds):

pandas/core/indexes/base.py

@@ -2221,7 +2221,7 @@ def _nan_idxs(self):
     def hasnans(self):
         """ return if I have any nans; enables various perf speedups """
         if self._can_hold_na:
-            return self._isnan.any()
+            return bool(self._isnan.any())
         else:
             return False
 

pandas/tests/indexes/common.py

@@ -417,7 +417,7 @@ def test_get_unique_index(self, indices):
         # and doesn't contain nans.
         assert idx_unique.is_unique is True
         try:
-            assert not idx_unique.hasnans
+            assert idx_unique.hasnans is False
         except NotImplementedError:
             pass
 
@@ -916,7 +916,7 @@ def test_hasnans_isnans(self):
                 # cases in indices doesn't include NaN
                 expected = np.array([False] * len(idx), dtype=bool)
                 tm.assert_numpy_array_equal(idx._isnan, expected)
-                assert not idx.hasnans
+                assert idx.hasnans is False
 
                 idx = index.copy()
                 values = np.asarray(idx.values)
@@ -938,7 +938,7 @@ def test_hasnans_isnans(self):
                 expected = np.array([False] * len(idx), dtype=bool)
                 expected[1] = True
                 tm.assert_numpy_array_equal(idx._isnan, expected)
-                assert idx.hasnans
+                assert idx.hasnans is True
 
     def test_fillna(self):
         # GH 11343
@@ -978,7 +978,7 @@ def test_fillna(self):
                 expected = np.array([False] * len(idx), dtype=bool)
                 expected[1] = True
                 tm.assert_numpy_array_equal(idx._isnan, expected)
-                assert idx.hasnans
+                assert idx.hasnans is True
 
     def test_nulls(self):
         # this is really a smoke test for the methods

pandas/tests/indexes/datetimes/test_ops.py

@@ -356,15 +356,15 @@ def test_nat(self, tz_naive_fixture):
         assert idx._can_hold_na
 
         tm.assert_numpy_array_equal(idx._isnan, np.array([False, False]))
-        assert not idx.hasnans
+        assert idx.hasnans is False
         tm.assert_numpy_array_equal(idx._nan_idxs,
                                     np.array([], dtype=np.intp))
 
         idx = pd.DatetimeIndex(['2011-01-01', 'NaT'], tz=tz)
         assert idx._can_hold_na
 
         tm.assert_numpy_array_equal(idx._isnan, np.array([False, True]))
-        assert idx.hasnans
+        assert idx.hasnans is True
         tm.assert_numpy_array_equal(idx._nan_idxs,
                                     np.array([1], dtype=np.intp))
 

pandas/tests/indexes/interval/test_interval.py

@@ -93,7 +93,7 @@ def test_length(self, closed, breaks):
 
     def test_with_nans(self, closed):
         index = self.create_index(closed=closed)
-        assert not index.hasnans
+        assert index.hasnans is False
 
         result = index.isna()
         expected = np.repeat(False, len(index))
@@ -104,7 +104,7 @@ def test_with_nans(self, closed):
         tm.assert_numpy_array_equal(result, expected)
 
         index = self.create_index_with_nan(closed=closed)
-        assert index.hasnans
+        assert index.hasnans is True
 
         result = index.isna()
         expected = np.array([False, True] + [False] * (len(index) - 2))

pandas/tests/indexes/multi/test_missing.py

@@ -49,7 +49,7 @@ def test_fillna(idx):
             expected = np.array([False] * len(idx), dtype=bool)
             expected[1] = True
             tm.assert_numpy_array_equal(idx._isnan, expected)
-            assert idx.hasnans
+            assert idx.hasnans is True
 
 
 def test_dropna():
@@ -91,7 +91,7 @@ def test_hasnans_isnans(idx):
     # cases in indices doesn't include NaN
     expected = np.array([False] * len(index), dtype=bool)
     tm.assert_numpy_array_equal(index._isnan, expected)
-    assert not index.hasnans
+    assert index.hasnans is False
 
     index = idx.copy()
     values = index.values
@@ -102,7 +102,7 @@ def test_hasnans_isnans(idx):
     expected = np.array([False] * len(index), dtype=bool)
     expected[1] = True
     tm.assert_numpy_array_equal(index._isnan, expected)
-    assert index.hasnans
+    assert index.hasnans is True
 
 
 def test_nan_stays_float():

pandas/tests/indexes/period/test_ops.py

@@ -356,15 +356,15 @@ def test_nat(self):
         assert idx._can_hold_na
 
         tm.assert_numpy_array_equal(idx._isnan, np.array([False, False]))
-        assert not idx.hasnans
+        assert idx.hasnans is False
         tm.assert_numpy_array_equal(idx._nan_idxs,
                                     np.array([], dtype=np.intp))
 
         idx = pd.PeriodIndex(['2011-01-01', 'NaT'], freq='D')
         assert idx._can_hold_na
 
         tm.assert_numpy_array_equal(idx._isnan, np.array([False, True]))
-        assert idx.hasnans
+        assert idx.hasnans is True
         tm.assert_numpy_array_equal(idx._nan_idxs,
                                     np.array([1], dtype=np.intp))
 

pandas/tests/indexes/timedeltas/test_ops.py

@@ -273,15 +273,15 @@ def test_nat(self):
         assert idx._can_hold_na
 
         tm.assert_numpy_array_equal(idx._isnan, np.array([False, False]))
-        assert not idx.hasnans
+        assert idx.hasnans is False
         tm.assert_numpy_array_equal(idx._nan_idxs,
                                     np.array([], dtype=np.intp))
 
         idx = pd.TimedeltaIndex(['1 days', 'NaT'])
         assert idx._can_hold_na
 
         tm.assert_numpy_array_equal(idx._isnan, np.array([False, True]))
-        assert idx.hasnans
+        assert idx.hasnans is True
         tm.assert_numpy_array_equal(idx._nan_idxs,
                                     np.array([1], dtype=np.intp))
 

pandas/tests/series/test_internals.py

@@ -315,11 +315,11 @@ def test_convert_preserve_all_bool(self):
 def test_hasnans_unchached_for_series():
     # GH#19700
     idx = pd.Index([0, 1])
-    assert not idx.hasnans
+    assert idx.hasnans is False
     assert 'hasnans' in idx._cache
     ser = idx.to_series()
-    assert not ser.hasnans
+    assert ser.hasnans is False
     assert not hasattr(ser, '_cache')
     ser.iloc[-1] = np.nan
-    assert ser.hasnans
+    assert ser.hasnans is True
     assert pd.Series.hasnans.__doc__ == pd.Index.hasnans.__doc__

scripts/tests/test_validate_docstrings.py

@@ -346,33 +346,6 @@ def method(self, foo=None, bar=None):
         pass
 
 
-class BadSeeAlso(object):
-
-    def desc_no_period(self):
-        """
-        Return the first 5 elements of the Series.
-
-        See Also
-        --------
-        Series.tail : Return the last 5 elements of the Series.
-        Series.iloc : Return a slice of the elements in the Series,
-            which can also be used to return the first or last n
-        """
-        pass
-
-    def desc_first_letter_lowercase(self):
-        """
-        Return the first 5 elements of the Series.
-
-        See Also
-        --------
-        Series.tail : return the last 5 elements of the Series.
-        Series.iloc : Return a slice of the elements in the Series,
-            which can also be used to return the first or last n.
-        """
-        pass
-
-
 class BadSummaries(object):
 
     def wrong_line(self):
@@ -585,6 +558,44 @@ def no_punctuation(self):
         return "Hello world!"
 
 
+class BadSeeAlso(object):
+
+    def desc_no_period(self):
+        """
+        Return the first 5 elements of the Series.
+
+        See Also
+        --------
+        Series.tail : Return the last 5 elements of the Series.
+        Series.iloc : Return a slice of the elements in the Series,
+            which can also be used to return the first or last n
+        """
+        pass
+
+    def desc_first_letter_lowercase(self):
+        """
+        Return the first 5 elements of the Series.
+
+        See Also
+        --------
+        Series.tail : return the last 5 elements of the Series.
+        Series.iloc : Return a slice of the elements in the Series,
+            which can also be used to return the first or last n.
+        """
+        pass
+
+    def prefix_pandas(self):
+        """
+        Have `pandas` prefix in See Also section.
+
+        See Also
+        --------
+        pandas.Series.rename : Alter Series index labels or name.
+        DataFrame.head : The first `n` rows of the caller object.
+        """
+        pass
+
+
 class TestValidator(object):
 
     def _import_path(self, klass=None, func=None):
@@ -705,7 +716,11 @@ def test_bad_generic_functions(self, func):
         ('BadGenericDocStrings', 'method',
          ('Examples should not have `import numpy` ',)),
         ('BadGenericDocStrings', 'method',
-         ('Examples should not have `import pandas` ',))
+         ('Examples should not have `import pandas` ',)),
+        # See Also tests
+        ('BadSeeAlso', 'prefix_pandas',
+         ('pandas.Series.rename in `See Also` section '
+          'does not need `pandas` prefix',))
     ])
     def test_bad_examples(self, capsys, klass, func, msgs):
         result = validate_one(self._import_path(klass=klass, func=func))  # noqa:F821

scripts/validate_docstrings.py

@@ -521,7 +521,10 @@ def validate_one(func_name):
             else:
                 errs.append('Missing description for '
                             'See Also "{}" reference'.format(rel_name))
-
+            if rel_name.startswith('pandas.'):
+                errs.append('{} in `See Also` section does not '
+                            'need `pandas` prefix, use {} instead.'
+                            .format(rel_name, rel_name[len('pandas.'):]))
     for line in doc.raw_doc.splitlines():
         if re.match("^ *\t", line):
             errs.append('Tabs found at the start of line "{}", '