Skip to content

GH1169 Improve parameter types for DataFrame.pct_change and Series.pct_change #1194

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Apr 24, 2025
Merged

GH1169 Improve parameter types for DataFrame.pct_change and Series.pct_change #1194

merged 7 commits into from
Apr 24, 2025

Conversation

yangdanny97
Copy link
Contributor

This PR does the following for the two functions in the title:

cc @MarcoGorelli should these have tests? they're not overloaded so I'm not sure if it's necessary

@yangdanny97 yangdanny97 changed the title Improve parameter types for DataFrame.pct_change and Series.pct_change GH1169 Improve parameter types for DataFrame.pct_change and Series.pct_change Apr 22, 2025
Dr-Irv
Dr-Irv requested changes Apr 22, 2025
View reviewed changes
Copy link
Collaborator

@Dr-Irv Dr-Irv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add tests for the various arguments in test_frame.py:test_dataframe_pct_change() ?

Dr-Irv
Dr-Irv requested changes Apr 23, 2025
View reviewed changes
Copy link
Collaborator

@Dr-Irv Dr-Irv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you also add tests for Series.pct_change() in test_series.py ?

Use the check(assert_type(... pattern

@yangdanny97
Copy link
Contributor Author

I had to change the return type of Series.pct_change to get the tests to pass, I don't think the result always has the same dtype as the input.

Based on the docs, the output seems to be a series of floats, but shift is typed with UnknownSeries as the return so maybe this one should also be UnknownSeries...

@Dr-Irv thoughts?

Dr-Irv
Dr-Irv approved these changes Apr 24, 2025
View reviewed changes
Copy link
Collaborator

@Dr-Irv Dr-Irv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @yangdanny97

@Dr-Irv
Copy link
Collaborator

Dr-Irv commented Apr 24, 2025

I had to change the return type of Series.pct_change to get the tests to pass, I don't think the result always has the same dtype as the input.

Based on the docs, the output seems to be a series of floats, but shift is typed with UnknownSeries as the return so maybe this one should also be UnknownSeries...

@Dr-Irv thoughts?

You did the right thing. Series.pct_change() will return a Series[float], so I'm good with that. The previous declaration was just wrong, and existed from when we first created the repo.

@Dr-Irv Dr-Irv merged commit 18df89e into pandas-dev:main Apr 24, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@loicdiridollou loicdiridollou loicdiridollou left review comments

@Dr-Irv Dr-Irv Dr-Irv approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

type kwargs in pct_change according to params in shift

3 participants

@yangdanny97 @Dr-Irv @loicdiridollou