Title: threading.Semaphore documentation is not internally consistent · Issue #141196 · python/cpython · GitHub
Open Graph Title: threading.Semaphore documentation is not internally consistent · Issue #141196 · python/cpython
X Title: threading.Semaphore documentation is not internally consistent · Issue #141196 · python/cpython
Description: Documentation threading.Semaphore has two methods, acquire() and release(). The documentation for acquire() states: Exactly one thread will be awoken by each call to release(). The documentation for release() states: Release a semaphore,...
Open Graph Description: Documentation threading.Semaphore has two methods, acquire() and release(). The documentation for acquire() states: Exactly one thread will be awoken by each call to release(). The documentation fo...
X Description: Documentation threading.Semaphore has two methods, acquire() and release(). The documentation for acquire() states: Exactly one thread will be awoken by each call to release(). The documentation fo...
Opengraph URL: https://github.com/python/cpython/issues/141196
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"threading.Semaphore documentation is not internally consistent","articleBody":"# Documentation\n\n[threading.Semaphore](https://docs.python.org/3/library/threading.html#threading.Semaphore) has two methods, `acquire()` and `release()`. The documentation for `acquire()` states:\n\n\u003e Exactly one thread will be awoken by each call to [release()](https://docs.python.org/3/library/threading.html#threading.Semaphore.release).\n\nThe documentation for `release()` states:\n\n\u003e Release a semaphore, incrementing the internal counter by _n_. When it was zero on entry and other threads are waiting for it to become larger than zero again, wake up _n_ of those threads.\n\nThese statements cannot both be true. Which is correct? Technically, I suspect... neither. Though my guess is the latter is far closer to the truth.\n\nThe _n_ parameter to `release()` was added in Python 3.9; before that development, the statement in `acquire()` would have been true. So I suspect the statement in the documentation for `acquire()` is simply old information, rendered obsolete by this new parameter.\n\nHowever, the documentation for `release()` says it will wake up _n_ threads. But what if fewer than _n_ threads are waiting? It can't wake up threads that don't exist.\n\nSomeone should read the implementation of `threading.Semaphore`, figure out what its behavior actually is, and rewrite the documentation to accurately reflect that behavior. My suspicion is that this statement correctly describes its behavior:\n\n\u003e If there are _j_ threads blocked on `acquire()`, and you call `release(n)`, release will wake up `min(j, n)` of those threads.\n\nIt might be nice to backport this change to all currently-supported versions, too.\n\n\u003c!-- gh-linked-prs --\u003e\n### Linked PRs\n* gh-141243\n* gh-141244\n\u003c!-- /gh-linked-prs --\u003e\n","author":{"url":"https://github.com/larryhastings","@type":"Person","name":"larryhastings"},"datePublished":"2025-11-07T13:57:18.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/141196/cpython/issues/141196"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:afbcd479-2b68-110a-2782-59488069a719 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | BCC0:DC370:2723D0C:36B7663:6A50C9EF |
| html-safe-nonce | 55967d3f2c3b0111d93d10034e82487fb5db7e1fab2daf88267f2fd7f2abe827 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCQ0MwOkRDMzcwOjI3MjNEMEM6MzZCNzY2Mzo2QTUwQzlFRiIsInZpc2l0b3JfaWQiOiIyNjU3MjEzOTAzMjMxMDQ0MDc5IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 13b5edb88f474e35a94438dc4e6c2fcd4623189cbe4f2450c89d4f12dcd3fc66 |
| hovercard-subject-tag | issue:3600467241 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/cpython/141196/issue_layout |
| twitter:image | https://opengraph.githubassets.com/d9eab1c2b8d40245cc06805958693d9985441327fb29067615509dedd6c3e0be/python/cpython/issues/141196 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/d9eab1c2b8d40245cc06805958693d9985441327fb29067615509dedd6c3e0be/python/cpython/issues/141196 |
| og:image:alt | Documentation threading.Semaphore has two methods, acquire() and release(). The documentation for acquire() states: Exactly one thread will be awoken by each call to release(). The documentation fo... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | larryhastings |
| hostname | github.com |
| expected-hostname | github.com |
| None | 72b13e0e8d0319acdd27a145cfe73f4f06c791713d0ac4690e41fb68ad28cac0 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 08e79d53fc070870d5b168356afebb1e286a2ffe |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width