TYP: internals (#32403)

Author: jbrockmendel

pandas/core/internals/blocks.py

@@ -11,6 +11,7 @@
 import pandas._libs.internals as libinternals
 from pandas._libs.tslibs import Timedelta, conversion
 from pandas._libs.tslibs.timezones import tz_compare
+from pandas._typing import DtypeObj
 from pandas.util._validators import validate_bool_kwarg
 
 from pandas.core.dtypes.cast import (
@@ -170,20 +171,20 @@ def _consolidate_key(self):
         return (self._can_consolidate, self.dtype.name)
 
     @property
-    def _is_single_block(self):
+    def _is_single_block(self) -> bool:
         return self.ndim == 1
 
     @property
-    def is_view(self):
+    def is_view(self) -> bool:
         """ return a boolean if I am possibly a view """
         return self.values.base is not None
 
     @property
-    def is_datelike(self):
+    def is_datelike(self) -> bool:
         """ return True if I am a non-datelike """
         return self.is_datetime or self.is_timedelta
 
-    def is_categorical_astype(self, dtype):
+    def is_categorical_astype(self, dtype) -> bool:
         """
         validate that we have a astypeable to categorical,
         returns a boolean if we are a categorical
@@ -255,7 +256,7 @@ def mgr_locs(self, new_mgr_locs):
         self._mgr_locs = new_mgr_locs
 
     @property
-    def array_dtype(self):
+    def array_dtype(self) -> DtypeObj:
         """
         the dtype to return if I want to construct this block as an
         array
@@ -333,7 +334,7 @@ def dtype(self):
         return self.values.dtype
 
     @property
-    def ftype(self):
+    def ftype(self) -> str:
         if getattr(self.values, "_pandas_ftype", False):
             dtype = self.dtype.subtype
         else:
@@ -367,7 +368,7 @@ def set(self, locs, values):
         """
         self.values[locs] = values
 
-    def delete(self, loc):
+    def delete(self, loc) -> None:
         """
         Delete given loc(-s) from block in-place.
         """
@@ -401,7 +402,7 @@ def _split_op_result(self, result) -> List["Block"]:
 
         return [result]
 
-    def fillna(self, value, limit=None, inplace=False, downcast=None):
+    def fillna(self, value, limit=None, inplace: bool = False, downcast=None):
         """
         fillna on the block with the value. If we fail, then convert to
         ObjectBlock and try again
@@ -687,15 +688,21 @@ def to_native_types(self, slicer=None, na_rep="nan", quoting=None, **kwargs):
         return values
 
     # block actions #
-    def copy(self, deep=True):
+    def copy(self, deep: bool = True):
         """ copy constructor """
         values = self.values
         if deep:
             values = values.copy()
         return self.make_block_same_class(values, ndim=self.ndim)
 
     def replace(
-        self, to_replace, value, inplace=False, filter=None, regex=False, convert=True
+        self,
+        to_replace,
+        value,
+        inplace: bool = False,
+        filter=None,
+        regex: bool = False,
+        convert: bool = True,
     ):
         """
         replace the to_replace value with value, possible to create new
@@ -917,7 +924,15 @@ def setitem(self, indexer, value):
         block = self.make_block(values)
         return block
 
-    def putmask(self, mask, new, align=True, inplace=False, axis=0, transpose=False):
+    def putmask(
+        self,
+        mask,
+        new,
+        align: bool = True,
+        inplace: bool = False,
+        axis: int = 0,
+        transpose: bool = False,
+    ):
         """
         putmask the data to the block; it is possible that we may create a
         new dtype of block
@@ -1261,7 +1276,7 @@ def func(x):
         blocks = [self.make_block_same_class(interp_values)]
         return self._maybe_downcast(blocks, downcast)
 
-    def take_nd(self, indexer, axis, new_mgr_locs=None, fill_tuple=None):
+    def take_nd(self, indexer, axis: int, new_mgr_locs=None, fill_tuple=None):
         """
         Take values according to indexer and return them as a block.bb
 
@@ -1302,7 +1317,7 @@ def diff(self, n: int, axis: int = 1) -> List["Block"]:
         new_values = _block_shape(new_values, ndim=self.ndim)
         return [self.make_block(values=new_values)]
 
-    def shift(self, periods, axis=0, fill_value=None):
+    def shift(self, periods, axis: int = 0, fill_value=None):
         """ shift the block by periods, possibly upcast """
         # convert integer to float if necessary. need to do a lot more than
         # that, handle boolean etc also
@@ -1334,7 +1349,7 @@ def where(
         self,
         other,
         cond,
-        align=True,
+        align: bool = True,
         errors="raise",
         try_cast: bool = False,
         axis: int = 0,
@@ -1346,11 +1361,12 @@ def where(
         ----------
         other : a ndarray/object
         cond  : the condition to respect
-        align : boolean, perform alignment on other/cond
+        align : bool, default True
+            Perform alignment on other/cond.
         errors : str, {'raise', 'ignore'}, default 'raise'
             - ``raise`` : allow exceptions to be raised
             - ``ignore`` : suppress exceptions. On error return original object
-        axis : int
+        axis : int, default 0
 
         Returns
         -------
@@ -1482,7 +1498,7 @@ def _unstack(self, unstacker_func, new_columns, n_rows, fill_value):
         blocks = [make_block(new_values, placement=new_placement)]
         return blocks, mask
 
-    def quantile(self, qs, interpolation="linear", axis=0):
+    def quantile(self, qs, interpolation="linear", axis: int = 0):
         """
         compute the quantiles of the
 
@@ -1539,7 +1555,13 @@ def quantile(self, qs, interpolation="linear", axis=0):
         return make_block(result, placement=np.arange(len(result)), ndim=ndim)
 
     def _replace_coerce(
-        self, to_replace, value, inplace=True, regex=False, convert=False, mask=None
+        self,
+        to_replace,
+        value,
+        inplace: bool = True,
+        regex: bool = False,
+        convert: bool = False,
+        mask=None,
     ):
         """
         Replace value corresponding to the given boolean array with another
@@ -1551,7 +1573,7 @@ def _replace_coerce(
             Scalar to replace or regular expression to match.
         value : object
             Replacement object.
-        inplace : bool, default False
+        inplace : bool, default True
             Perform inplace modification.
         regex : bool, default False
             If true, perform regular expression substitution.
@@ -1638,7 +1660,9 @@ def set(self, locs, values, check=False):
         assert locs.tolist() == [0]
         self.values = values
 
-    def putmask(self, mask, new, align=True, inplace=False, axis=0, transpose=False):
+    def putmask(
+        self, mask, new, align=True, inplace=False, axis=0, transpose=False,
+    ):
         """
         putmask the data to the block; we must be a single block and not
         generate other blocks
@@ -1754,7 +1778,7 @@ def _can_hold_na(self):
         return self._holder._can_hold_na
 
     @property
-    def is_view(self):
+    def is_view(self) -> bool:
         """Extension arrays are never treated as views."""
         return False
 
@@ -1819,7 +1843,7 @@ def to_native_types(self, slicer=None, na_rep="nan", quoting=None, **kwargs):
         # we are expected to return a 2-d ndarray
         return values.reshape(1, len(values))
 
-    def take_nd(self, indexer, axis=0, new_mgr_locs=None, fill_tuple=None):
+    def take_nd(self, indexer, axis: int = 0, new_mgr_locs=None, fill_tuple=None):
         """
         Take values according to indexer and return them as a block.
         """
@@ -2080,7 +2104,7 @@ def to_native_types(
         )
         return formatter.get_result_as_array()
 
-    def should_store(self, value):
+    def should_store(self, value) -> bool:
         # when inserting a column should not coerce integers to floats
         # unnecessarily
         return issubclass(value.dtype.type, np.floating) and value.dtype == self.dtype
@@ -2098,7 +2122,7 @@ def _can_hold_element(self, element: Any) -> bool:
             element, (float, int, complex, np.float_, np.int_)
         ) and not isinstance(element, (bool, np.bool_))
 
-    def should_store(self, value):
+    def should_store(self, value) -> bool:
         return issubclass(value.dtype.type, np.complexfloating)
 
 
@@ -2117,7 +2141,7 @@ def _can_hold_element(self, element: Any) -> bool:
             )
         return is_integer(element)
 
-    def should_store(self, value):
+    def should_store(self, value) -> bool:
         return is_integer_dtype(value) and value.dtype == self.dtype
 
 
@@ -2255,7 +2279,7 @@ def to_native_types(
         ).reshape(i8values.shape)
         return np.atleast_2d(result)
 
-    def should_store(self, value):
+    def should_store(self, value) -> bool:
         return (
             issubclass(value.dtype.type, np.datetime64)
             and not is_datetime64tz_dtype(value)
@@ -2320,7 +2344,7 @@ def _maybe_coerce_values(self, values):
         return values
 
     @property
-    def is_view(self):
+    def is_view(self) -> bool:
         """ return a boolean if I am possibly a view """
         # check the ndarray values of the DatetimeIndex values
         return self.values._data.base is not None
@@ -2507,7 +2531,7 @@ def fillna(self, value, **kwargs):
             )
         return super().fillna(value, **kwargs)
 
-    def should_store(self, value):
+    def should_store(self, value) -> bool:
         return issubclass(
             value.dtype.type, np.timedelta64
         ) and not is_extension_array_dtype(value)
@@ -2553,7 +2577,7 @@ def _can_hold_element(self, element: Any) -> bool:
             return issubclass(tipo.type, np.bool_)
         return isinstance(element, (bool, np.bool_))
 
-    def should_store(self, value):
+    def should_store(self, value) -> bool:
         return issubclass(value.dtype.type, np.bool_) and not is_extension_array_dtype(
             value
         )
@@ -2645,7 +2669,7 @@ def _maybe_downcast(self, blocks: List["Block"], downcast=None) -> List["Block"]
     def _can_hold_element(self, element: Any) -> bool:
         return True
 
-    def should_store(self, value):
+    def should_store(self, value) -> bool:
         return not (
             issubclass(
                 value.dtype.type,