Skip to content
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

Jump to bottom

Cryptic deprecation notice in the re module #99308

Open
Kentzo opened this issue Nov 10, 2022 · 3 comments
Open

Cryptic deprecation notice in the re module #99308

Kentzo opened this issue Nov 10, 2022 · 3 comments
Labels
docs Documentation in the Doc dir expert-regex

Comments

@Kentzo
Copy link
Contributor

Kentzo commented Nov 10, 2022 •
edited by bedevere-bot

Documentation

I'm confused by the following notice:

Deprecated since version 3.11: Group id containing anything except ASCII digits.

After some digging I found the related PR.

With the notice as is I would assume that non-ASCII digits would be interpreted as a name, but after reading the PR it's obvious that it cannot be the case since names must contain ASCII letters and digits.

Perhaps it's better to rewrite it to match the notice for re.sub:

Deprecated since version 3.11: Group id containing anything except ASCII digits. Group names containing non-ASCII characters in bytes replacement strings.

See https://discuss.python.org/t/cryptic-3-11-deprecation-notice-in-the-re-module-doc/20903
@Kentzo Kentzo added the docs Documentation in the Doc dir label Nov 10, 2022
Kentzo added a commit to GreatFruitOmsk/cpython that referenced this issue Nov 10, 2022
@Kentzo
pythongh-99308: Fix wording of the deprecation notice in re for 3.12
002af29
@bedevere-bot bedevere-bot mentioned this issue Nov 10, 2022
Closed
@bedevere-bot
Copy link

bedevere-bot commented Nov 10, 2022

GH-99310 is a backport of this pull request to the 3.11 branch.

Kentzo added a commit to GreatFruitOmsk/cpython that referenced this issue Nov 10, 2022
@Kentzo
pythongh-99308: Fix wording of the deprecation notice in re for 3.11
e2c4950
@bedevere-bot bedevere-bot mentioned this issue Nov 10, 2022
Merged
@gvanrossum
Copy link
Member

gvanrossum commented Nov 10, 2022

Maybe @CAM-Gerlach can review this? It does look like the original PR left some unclear deprecation notices.

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Nov 10, 2022

I'd reviewed the linked #99311 previously, but while I didn't explicitly state it in my initial review, yeah the textual clarifications I suggest there should also be made in the other two places from the same original PR where a change in the allowed values for name in patterns and replacements is mentioned.

Also, since this was an unusual case where a deprecation made in one released turned into a change in the next, the changes will likely need to be manually backported with the cherry-picker script. While doing so, it would be really helpful to change the .. deprecated directive to deprecated-removed, to clarify both human-readibly and programmatically that the planned removal of support for the non-ASCII/numeric values will be in the very next version, which is not currently stated anywhere (and also isn't the standard deprecation policy).

Kentzo added a commit to GreatFruitOmsk/cpython that referenced this issue Nov 30, 2022
@Kentzo
pythongh-99308: Fix typos and make wording consistent
0aa2260
Kentzo added a commit to GreatFruitOmsk/cpython that referenced this issue Nov 30, 2022
@Kentzo
pythongh-99308: Fix missing dot.
65b9453
kumaraditya303 pushed a commit that referenced this issue Dec 25, 2022
@Kentzo
gh-99308: Clarify re docs for byte pattern group names (#99311)
dbc1e69
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir expert-regex
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@Kentzo @gvanrossum @CAM-Gerlach @bedevere-bot @AlexWaygood