Skip to content

TYP: first_valid_index & last_valid_index #40535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -11143,7 +11143,7 @@ def __ixor__(self, other):
# Misc methods

@final
def _find_valid_index(self, how: str):
def _find_valid_index(self, *, how: str) -> Optional[Hashable]:
"""
Retrieves the index of the first valid value.

Expand All @@ -11156,16 +11156,16 @@ def _find_valid_index(self, how: str):
-------
idx_first_valid : type of index
"""
idxpos = find_valid_index(self._values, how)
idxpos = find_valid_index(self._values, how=how)
if idxpos is None:
return None
return self.index[idxpos]

@final
@doc(position="first", klass=_shared_doc_kwargs["klass"])
def first_valid_index(self):
def first_valid_index(self) -> Optional[Hashable]:
"""
Return index for {position} non-NA/null value.
Return index for {position} non-NA value or None, if no NA value is found.

Returns
-------
Expand All @@ -11176,12 +11176,12 @@ def first_valid_index(self):
If all elements are non-NA/null, returns None.
Also returns None for empty {klass}.
"""
return self._find_valid_index("first")
return self._find_valid_index(how="first")

@final
@doc(first_valid_index, position="last", klass=_shared_doc_kwargs["klass"])
def last_valid_index(self):
return self._find_valid_index("last")
def last_valid_index(self) -> Optional[Hashable]:
return self._find_valid_index(how="last")


def _doc_params(cls):
Expand Down
23 changes: 18 additions & 5 deletions pandas/core/missing.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ def clean_interp_method(method: str, **kwargs) -> str:
return method


def find_valid_index(values, how: str):
def find_valid_index(values, *, how: str) -> Optional[int]:
"""
Retrieves the index of the first valid value.

Expand Down Expand Up @@ -256,8 +256,17 @@ def interpolate_1d(

# These are sets of index pointers to invalid values... i.e. {0, 1, etc...
all_nans = set(np.flatnonzero(invalid))
start_nans = set(range(find_valid_index(yvalues, "first")))
end_nans = set(range(1 + find_valid_index(yvalues, "last"), len(valid)))

first_valid_index = find_valid_index(yvalues, how="first")
if first_valid_index is None: # no nan found in start
first_valid_index = 0
start_nans = set(range(first_valid_index))

last_valid_index = find_valid_index(yvalues, how="last")
if last_valid_index is None: # no nan found in end
last_valid_index = len(yvalues)
end_nans = set(range(1 + last_valid_index, len(valid)))

mid_nans = all_nans - start_nans - end_nans

# Like the sets above, preserve_nans contains indices of invalid values,
Expand Down Expand Up @@ -595,8 +604,12 @@ def _interpolate_with_limit_area(
invalid = isna(values)

if not invalid.all():
first = find_valid_index(values, "first")
last = find_valid_index(values, "last")
first = find_valid_index(values, how="first")
if first is None:
first = 0
last = find_valid_index(values, how="last")
if last is None:
last = len(values)

values = interpolate_2d(
values,
Expand Down