FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-102029: Deprecate passing arguments to `_PyRLock` in `threading` by sobolevn · Pull Request #102071 · python/cpython · GitHub

/ cpython Public

gh-102029: Deprecate passing arguments to _PyRLock in threading - #102071

Merged
gpshead merged 11 commits into
python:mainfrom
sobolevn:issue-102029
Aug 17, 2023
ConversationCommits (11)ChecksFiles changed
Merged

gh-102029: Deprecate passing arguments to _PyRLock in threading#102071
gpshead merged 11 commits into
python:mainfrom
sobolevn:issue-102029

Conversation

sobolevn commented Feb 20, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

I hope that this is not really a breaking change. Here's my reasoning:

  1. _PyRLock was the first one (since python2). People are familiar with it: and its signature was always correct
  2. Since passing values never made any sense, I hope nobody does rely on it
  3. Subclasses still work correctly, eventhough they are not really recommened (and RLock is exposed as a function)
  4. typeshed always had RLock defined as () -> RLock with no complains: https://github.com/python/typeshed/blob/40d853cbe239bcf1479e25c2c59615158b672610/stdlib/threading.pyi#L115-L122
  5. I was not able to find any references to RLock with arguments

As the next step, I will propose to deprecate the Python version.

sobolevn changed the title Sync __new__ sigs of _CRLock and _PyRLock in threading gh-102029: Sync __new__ sigs of _CRLock and _PyRLock in threading Feb 20, 2023
bedevere-bot mentioned this pull request Feb 20, 2023
Closed
sobolevn requested a review from pablogsal February 20, 2023 12:46

sobolevn commented Mar 11, 2023

Copy link
Copy Markdown
Member Author

@pablogsal friendly ping :)

gpshead self-requested a review May 29, 2023 00:12
gpshead reviewed May 29, 2023
View reviewed changes

gpshead left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This makes sense to me, but I want to run it through a huge pile of tests at work just to see what - if any - oddball code was relying on passing ignored values. I hope nothing. I'll do that this week.

gpshead self-assigned this May 29, 2023

sobolevn commented May 29, 2023

Copy link
Copy Markdown
Member Author

Thank you! In the meantime, I will change the What's new entry.

gpshead commented May 30, 2023

Copy link
Copy Markdown
Member

note to self: I included this PR in an internal test run today, I'll have results by tonight/tomorrow.

sobolevn commented May 31, 2023

Copy link
Copy Markdown
Member Author

hypothesis failures are not related.

gpshead commented May 31, 2023

Copy link
Copy Markdown
Member

I found only a single instance of a parameter being passed to RLock via testing this change in our huge codebase at work:

threading.RLock(verbose=True)

That code was originally written for Python 2.7 which did support an undocumented verbose argument on threading.RLock. https://github.com/python/cpython/blob/v2.7.18/Lib/threading.py#L132

Easy to fix. But it does suggest that we should just do this API change via our usual DeprecationWarning cycle rather than just assuming we can make it without notice.

gpshead requested changes May 31, 2023
View reviewed changes
Comment thread Doc/whatsnew/3.13.rst Outdated

* Passing any arguments to :func:`threading.RLock` is now restricted.
Previously C version allowed any numbers of args and kwargs,
but they were just ignored. Python version never allowed any arguments.

gpshead May 31, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This statement isn't accurate; Python <= 2.7 and 3.1 accepted a single undocumented verbose argument.

Comment thread Lib/threading.py Outdated
Lock = _allocate_lock

def RLock(*args, **kwargs):
def RLock():

gpshead May 31, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Lets do a regular DeprecationWarning API change cycle on this.

if args or kwargs:
    warnings.warn(DeprecationWarning, ...)

we can put that in 3.12 remove the ignored args/kwargs in 3.14.

sobolevn Jun 1, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I thought that 3.12 is now only accepting bugfixes, isn't it? I would prefer to have this change as safe as possible and to put it in 3.13+. Unless you insist :)

bedevere-bot commented May 31, 2023

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

And if you don't make the requested changes, you will be poked with soft cushions!

sobolevn commented Jun 1, 2023

Copy link
Copy Markdown
Member Author

I have made the requested changes; please review again

bedevere-bot commented Jun 1, 2023

Copy link
Copy Markdown

Thanks for making the requested changes!

@gpshead: please review the changes made to this pull request.

bedevere-bot requested a review from gpshead June 1, 2023 07:34
sobolevn commented Jun 1, 2023
View reviewed changes
Comment thread Doc/whatsnew/3.13.rst
sobolevn changed the title gh-102029: Sync __new__ sigs of _CRLock and _PyRLock in threading gh-102029: Deprecate passing arguments to _PyRLock in threading Aug 11, 2023

sobolevn commented Aug 11, 2023

Copy link
Copy Markdown
Member Author

@gpshead now this is deprecated in 3.13 and stated to be changed in 3.15 :)

ambv commented Aug 11, 2023

Copy link
Copy Markdown
Contributor

Closing and re-opening to retrigger CLA checks. Sorry for the noise.

ambv closed this Aug 11, 2023
ambv reopened this Aug 11, 2023

sobolevn commented Aug 11, 2023

Copy link
Copy Markdown
Member Author

Thanks everyone! CI is now green :)

sobolevn commented Aug 17, 2023

Copy link
Copy Markdown
Member Author

Can someone please click "merge"? :)

gpshead merged commit 80f30cf into python:main Aug 17, 2023
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

gpshead gpshead approved these changes
pablogsal Awaiting requested review from pablogsal

Assignees

gpshead

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL