gh-133146: Add the old public get_value method to documentation and refactor code. (GH-133301)

also uses it within the internals in a few places.
This commit is contained in:
Duprat 2025-11-29 23:12:48 +01:00 committed by GitHub
parent f2ca1581ca
commit db098a475a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 20 additions and 5 deletions

View file

@ -1577,12 +1577,22 @@ object -- see :ref:`multiprocessing-managers`.
A solitary difference from its close analog exists: its ``acquire`` method's
first argument is named *block*, as is consistent with :meth:`Lock.acquire`.
.. method:: get_value()
Return the current value of semaphore.
Note that this may raise :exc:`NotImplementedError` on platforms like
macOS where ``sem_getvalue()`` is not implemented.
.. method:: locked()
Return a boolean indicating whether this object is locked right now.
.. versionadded:: 3.14
.. note::
On macOS, ``sem_timedwait`` is unsupported, so calling ``acquire()`` with

View file

@ -121,7 +121,7 @@ def get(self, block=True, timeout=None):
def qsize(self):
# Raises NotImplementedError on Mac OSX because of broken sem_getvalue()
return self._maxsize - self._sem._semlock._get_value()
return self._maxsize - self._sem.get_value()
def empty(self):
return not self._poll()

View file

@ -135,11 +135,16 @@ def __init__(self, value=1, *, ctx):
SemLock.__init__(self, SEMAPHORE, value, SEM_VALUE_MAX, ctx=ctx)
def get_value(self):
'''Returns current value of Semaphore.
Raises NotImplementedError on Mac OSX
because of broken sem_getvalue().
'''
return self._semlock._get_value()
def __repr__(self):
try:
value = self._semlock._get_value()
value = self.get_value()
except Exception:
value = 'unknown'
return '<%s(value=%s)>' % (self.__class__.__name__, value)
@ -155,7 +160,7 @@ def __init__(self, value=1, *, ctx):
def __repr__(self):
try:
value = self._semlock._get_value()
value = self.get_value()
except Exception:
value = 'unknown'
return '<%s(value=%s, maxvalue=%s)>' % \
@ -247,8 +252,8 @@ def _make_methods(self):
def __repr__(self):
try:
num_waiters = (self._sleeping_count._semlock._get_value() -
self._woken_count._semlock._get_value())
num_waiters = (self._sleeping_count.get_value() -
self._woken_count.get_value())
except Exception:
num_waiters = 'unknown'
return '<%s(%s, %s)>' % (self.__class__.__name__, self._lock, num_waiters)