ENH: Add use_na_sentinal (#333)

* ENH: Add use_na_sentinal

* ENH: Add return type

Author: bashtage

pandas-stubs/core/arrays/base.pyi

@@ -43,7 +43,10 @@ class ExtensionArray:
     def unique(self): ...
     def searchsorted(self, value, side: str = ..., sorter=...): ...
     def factorize(
-        self, na_sentinel: int = ...
+        self,
+        # Not actually positional-only, used to handle deprecations in 1.5.0
+        *,
+        use_na_sentinel: bool = ...,
     ) -> tuple[np.ndarray, ABCExtensionArray]: ...
     def repeat(self, repeats, axis=...): ...
     def take(

pandas-stubs/core/arrays/sparse/array.pyi

@@ -3,7 +3,7 @@ from pandas.core.arrays import (
     ExtensionArray,
     ExtensionOpsMixin,
 )
-from pandas.core.base import PandasObject as PandasObject
+from pandas.core.base import PandasObject
 
 class SparseArray(PandasObject, ExtensionArray, ExtensionOpsMixin):
     def __init__(
@@ -42,7 +42,13 @@ class SparseArray(PandasObject, ExtensionArray, ExtensionOpsMixin):
     def fillna(self, value=..., method=..., limit=...): ...
     def shift(self, periods: int = ..., fill_value=...): ...
     def unique(self): ...
-    def factorize(self, na_sentinel: int = ...): ...
+    def factorize(  # type: ignore[override]
+        self,
+        na_sentinel: int = ...,
+        # Not actually positional-only, used to handle deprecations in 1.5.0
+        *,
+        use_na_sentinel: bool = ...,
+    ) -> tuple[np.ndarray, SparseArray]: ...
     def value_counts(self, dropna: bool = ...): ...
     def __getitem__(self, key): ...
     def take(self, indices, allow_fill: bool = ..., fill_value=...): ...
@@ -62,5 +68,3 @@ class SparseArray(PandasObject, ExtensionArray, ExtensionOpsMixin):
     def T(self): ...
     def __array_ufunc__(self, ufunc, method, *inputs, **kwargs): ...
     def __abs__(self): ...
-
-def make_sparse(arr, kind: str = ..., fill_value=..., dtype=..., copy: bool = ...): ...

pandas-stubs/core/indexes/range.pyi

@@ -1,6 +1,8 @@
 import numpy as np
 from pandas.core.indexes.numeric import Int64Index
 
+from pandas._typing import npt
+
 class RangeIndex(Int64Index):
     def __new__(
         cls,
@@ -44,6 +46,13 @@ class RangeIndex(Int64Index):
     def min(self, axis=..., skipna: bool = ..., *args, **kwargs): ...
     def max(self, axis=..., skipna: bool = ..., *args, **kwargs): ...
     def argsort(self, *args, **kwargs): ...
+    def factorize(
+        self,
+        sort: bool = ...,
+        # Not actually positional-only, used to handle deprecations in 1.5.0
+        *,
+        use_na_sentinel: bool = ...,
+    ) -> tuple[npt.NDArray[np.intp], RangeIndex]: ...
     def equals(self, other): ...
     def intersection(self, other, sort: bool = ...): ...
     def join(