Skip to content

Fix annotations of str methods that accept regular expressions#1278

Merged
Dr-Irv merged 1 commit intopandas-dev:mainfrom
hamdanal:str-patterns
Jul 24, 2025
Merged

Fix annotations of str methods that accept regular expressions#1278
Dr-Irv merged 1 commit intopandas-dev:mainfrom
hamdanal:str-patterns

Conversation

@hamdanal
Copy link
Copy Markdown
Contributor

@hamdanal hamdanal commented Jul 16, 2025

  • Closes #xxxx (Replace xxxx with the Github issue number)
  • Tests added: Please use assert_type() to assert the type of any return value

These methods accept compiled regular expressions as documented in pandas and tested at runtime.

hamdanal
hamdanal commented Jul 16, 2025
View reviewed changes
Comment thread pandas-stubs/core/strings.pyi
Comment thread pandas-stubs/core/strings.pyi
Comment thread pandas-stubs/core/strings.pyi
Comment thread pandas-stubs/core/strings.pyi
Comment thread pandas-stubs/core/strings.pyi
Comment thread pandas-stubs/core/strings.pyi
Comment thread pandas-stubs/core/strings.pyi
@twoertwein
Copy link
Copy Markdown
Member

twoertwein commented Jul 16, 2025

Thank you for your well-tested PR!

These methods accept compiled regular expressions as documented in pandas

It is not clear to me if the documentation suggests that re.Pattern objects are officially accepted (for example here https://pandas.pydata.org/docs/reference/api/pandas.Series.str.extractall.html). The type is often explicitly annotated as str in pandas and the fact that not all functions accept it might hint that it is not officially accepted. I will defer to @Dr-Irv.

Feel free to open an issue/PR at pandas about it.

@Dr-Irv
Copy link
Copy Markdown
Collaborator

Dr-Irv commented Jul 24, 2025

It is not clear to me if the documentation suggests that re.Pattern objects are officially accepted (for example here https://pandas.pydata.org/docs/reference/api/pandas.Series.str.extractall.html). The type is often explicitly annotated as str in pandas and the fact that not all functions accept it might hint that it is not officially accepted. I will defer to @Dr-Irv.

I think the PR discussion in pandas-dev/pandas#61879 will lead to the docs getting corrected. So I'll accept this PR as is.

Dr-Irv
Dr-Irv approved these changes Jul 24, 2025
View reviewed changes
Copy link
Copy Markdown
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 @hamdanal

@Dr-Irv Dr-Irv merged commit f141c69 into pandas-dev:main Jul 24, 2025
13 checks passed
@hamdanal hamdanal deleted the str-patterns branch July 26, 2025 07:31
@hamdanal hamdanal mentioned this pull request Aug 3, 2025
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@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.

3 participants

@hamdanal @twoertwein @Dr-Irv