feat: add as_series flag to maybe_get_index to return the index as a narwhals Series#3706
Open
mvanhorn wants to merge 1 commit into
Open
feat: add as_series flag to maybe_get_index to return the index as a narwhals Series#3706mvanhorn wants to merge 1 commit into
mvanhorn wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a keyword-only
as_series: bool = Falseargument tomaybe_get_index. Whenas_series=Trueand the input is pandas-like, the index is returned wrapped as a narwhalsSeries(matching the input's implementation and stable-api version) instead of the raw native index. The default behavior is unchanged:as_series=Falsereturns the raw native index, and non-pandas-like inputs returnNone.This closes the request in #3693.
maybe_get_indexpreviously returned the raw pandas-likeIndex, which cannot be fed directly intomaybe_set_index(..., index=...)because that parameter expects a narwhalsSeries(or list of them). Callers had to drop down to native objects and reassign.indexby hand. Withas_series=True, the result round-trips straight intomaybe_set_index:Backend parity is preserved: the returned
Seriescarries the same implementation as the input (pandas / modin / cuDF), and the stablev1/v2namespaces return their ownSeriestype. Non-pandas-like inputs (e.g. Polars) still returnNonerather than an emptySeries.What type of PR is this? (check all applicable)
Related issues
maybe_get_indexto return the index as narwhals Series #3693Checklist