bpo-43352: Add a Barrier object in asyncio lib#24903

YvesDup

bpo-43352: Add a Barrier object in asyncio lib

Copy design of object Barrier from threading, same features

Modified files are:

file lib/asyncio/locks.py

Add Barrier and BrokenBarrierError objects
Added these 2 previous objects to 'all' variable

file lib/test/test_asyncio/test_locks.py

Add a BarrierTests object
Modify STR_RGX_REPR to integrate 'repr' of Barrier
Add a new test with Barrier in 'LockTest.test_lock_doesnt_accept_loop_parameter'

I am not familiar with git, so all files with .rst.bak extension are not in the scope of this PR

Just see https://bugs.python.org/issue37945, so the following paragraph can be deleted
"""
All tests (Win10 Python x64) are done and succesfull except one: python -m test -v test_locale
I am surprised about this error because, asyncio and locale are not linked, or are they ?
Please, how to proceed about this failure ? Open a new issue on bpo ?
a log file is available.
Thank for help
"""

https://bugs.python.org/issue43352

Add a Barrier object to asyncio synchronized primitives

Change after run make patchcheck

run make patchcheck

Add comment when testing self._state Change if to while instruction in _block method

Refactoring all test names of BarrierTests to be more readable Add a method cancel_coros Refactoring and simplifyiing some tests Correction of RGX_REPR

after run python.bat Tools\scripts\patchcheck.py

the-knights-who-say-ni

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@YvesDup

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

rhettinger

Please post a clean PR. The current version touches 23 files, most of which are new bak files.

YvesDup

PR was cleaned, stayed only 2 files now

rhettinger

Please update the documentation.

YvesDup

@rhettinger I am a rookie on cpython.
Which documentation are talking about ? Are they files about asyncio files as https://github.com/python/cpython/blob/master/Doc/library/asyncio-api-index.rst and https://github.com/python/cpython/blob/master/Doc/library/asyncio-sync.rst ?
Thank you to help me to this first time
Yves

Add Barrier object as a clone of threading.Barrier

asvetlov

Please fix documentation example: https://github.com/python/cpython/runs/5646810414?check_suite_focus=true

…thonGH-24903) Fix example

…thonGH-24903) Add a test to check multiple reuses of a barrier object.

…ythonGH-24903) Remove `action` paramater

…ythonGH-24903) Remove `import coroutines` Suppress trailing whitespaces

…ythonGH-24903) minor correction

YvesDup

I have made the requested changes; please review again
Please @asvetlov @1st1 could you approve running workflows. Thank

bedevere-bot

Thanks for making the requested changes!

@asvetlov, @1st1: please review the changes made to this pull request.

asvetlov

Let me re-read the implementation and tests, please.

… only

asvetlov

The barrier state is enum now
repr() is simplified and follows threading.Barrier exposed properties
Tests don't access private attrs. They test the whole behavior, it is stable and future updates friendly.

…ythonGH-24903) Update sample with new `__repr__`

…ythonGH-24903) Missing a newline

YvesDup

Thanks @asvetlov for giving me some time to understand what you did and your last comments.
I have updated the result of the doc example with the new string __repr__.

asvetlov

Sorry, bad merge with master

…ythonGH-24903) Minor correction in example

bedevere-bot

🤖 New build scheduled with the buildbot fleet by @asvetlov for commit 3c30290 🤖

If you want to schedule another build, you need to add the ":hammer: test-with-buildbots" label again.

asvetlov

Merged. Thanks for your patience, @YvesDup

YvesDup

A very big thank you to @asvetlov and @1st1 for your support and all the work done together on this PR, my first one !!

Thanks to @eamanu for your review, and a special thanks to @JulienPalard for his help especially on the good practices on cpython world.

PS: @asvetlov should I do something else, or just close this PR ?

asvetlov

Everything is done. PR is merged, https://bugs.python.org/issue43352 is closed.
The last thing you can do is drop related branch on GitHub, it is up to you.

YvesDup

@asvetlov Please can tell me how to add a paragraph in whatnew 3.11#asyncio about this new feature ?
Thank you

gvanrossum

@YvesDup Just submit a PR for Doc/whatsnew/3.11.rst that adds the desired text, and tell the reviewer to mark it for backport to 3.11.

gvanrossum

You can reference the same issue (now migrated to #87518).

YvesDup

@gvanrossum Job in progress. Thank you

YvesDup added 7 commits March 16, 2021 10:51

Initial commit …

2cd5ce0

Add a Barrier object to asyncio synchronized primitives

make patchcheck …

7dfa8ef

Change after run make patchcheck

make patchcheck …

f19ea24

run make patchcheck

Update test_locks.py

f4bb33a

Update locks.py …

5f14a7d

Add comment when testing self._state Change if to while instruction in _block method

Update test_locks.py …

214fd35

Refactoring all test names of BarrierTests to be more readable Add a method cancel_coros Refactoring and simplifyiing some tests Correction of RGX_REPR

Update from patch …

619f60a

after run python.bat Tools\scripts\patchcheck.py

YvesDup requested review from 1st1, asvetlov, berkerpeksag, ericvsmith, rhettinger and vsajip as code owners March 17, 2021 13:55

the-knights-who-say-ni added the CLA not signed label Mar 17, 2021

bedevere-bot added the awaiting review label Mar 17, 2021

YvesDup changed the title ~~Fix issue 43352~~ Mar 17, 2021

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Mar 17, 2021

remove cpython/doc/*.rst.bak

04d4f69

YvesDup force-pushed the fix-issue-43352 branch from 29b38e3 to 04d4f69 Compare March 31, 2021 14:30

📜🤖 Added by blurb_it.

c2e438a

berkerpeksag removed their request for review March 31, 2021 22:43

Update 2021-03-31-15-22-45.bpo-43352.nSjMuE.rst

97598f3

rhettinger removed their request for review April 3, 2021 22:20

Update documentation about add of Barrier object …

dfea4c2

Add Barrier object as a clone of threading.Barrier

YvesDup added 5 commits March 22, 2022 19:30

po-43352: Add a Barrier object to asyncio synchronized primitives (py… …

1c16176

…thonGH-24903) Fix example

po-43352: Add a Barrier object to asyncio synchronized primitives (py… …

151ca5d

…thonGH-24903) Add a test to check multiple reuses of a barrier object.

bpo-43352: Add a Barrier object to asyncio synchronized primitives (p… …

37efb91

…ythonGH-24903) Remove `action` paramater

bpo-43352: Add a Barrier object to asyncio synchronized primitives (p… …

337189e

…ythonGH-24903) Remove `import coroutines` Suppress trailing whitespaces

bpo-43352: Add a Barrier object to asyncio synchronized primitives (p… …

ee59e3a

…ythonGH-24903) minor correction

asvetlov added 3 commits March 24, 2022 19:53

Rewrite repr(), use enum for state, drop _count_blocked used by tests… …

df5bd42

… only

Inline method

f1acd93

Move BrokenBarrierError to exceptions.py

1bb3297

YvesDup added 2 commits March 25, 2022 13:03

bpo-43352: Add a Barrier object to asyncio synchronized primitives (p… …

d82f1a5

…ythonGH-24903) Update sample with new `__repr__`

bpo-43352: Add a Barrier object to asyncio synchronized primitives (p… …

f89dc5f

…ythonGH-24903) Missing a newline

This comment was marked as outdated.

Sign in to view

asvetlov and others added 3 commits March 25, 2022 16:13

Tune docs

896e274

bpo-43352: Add a Barrier object to asyncio synchronized primitives (p… …

b7bdf40

…ythonGH-24903) Minor correction in example

Bump

3c30290

asvetlov approved these changes Mar 25, 2022

View reviewed changes

Conversation

YvesDup commented Mar 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

the-knights-who-say-ni commented Mar 17, 2021

Recognized GitHub username

Uh oh!

rhettinger commented Mar 31, 2021

Uh oh!

YvesDup commented Mar 31, 2021

Uh oh!

rhettinger commented Apr 3, 2021

Uh oh!

YvesDup commented Apr 5, 2021

Uh oh!

asvetlov commented Mar 22, 2022

Uh oh!

YvesDup commented Mar 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bedevere-bot commented Mar 23, 2022

Uh oh!

asvetlov commented Mar 24, 2022

Uh oh!

asvetlov commented Mar 25, 2022

Uh oh!

YvesDup commented Mar 25, 2022

Uh oh!

This comment was marked as outdated.

asvetlov commented Mar 25, 2022

Uh oh!

bedevere-bot commented Mar 25, 2022

Uh oh!

asvetlov commented Mar 25, 2022

Uh oh!

YvesDup commented Mar 28, 2022

Uh oh!

asvetlov commented Mar 28, 2022

Uh oh!

YvesDup commented May 17, 2022

Uh oh!

gvanrossum commented May 17, 2022

Uh oh!

gvanrossum commented May 17, 2022

Uh oh!

YvesDup commented May 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

YvesDup commented Mar 17, 2021 •

edited

Loading

YvesDup commented Mar 23, 2022 •

edited

Loading

YvesDup commented May 18, 2022 •

edited

Loading