mirror of
https://github.com/python/cpython.git
synced 2025-11-03 19:34:08 +00:00
54f22ed30b
who writes: Here is batch 2, as a big collection of CVS context diffs. Along with moving comments into docstrings, i've added a couple of missing docstrings and attempted to make sure more module docstrings begin with a one-line summary. I did not add docstrings to the methods in profile.py for fear of upsetting any careful optimizations there, though i did move class documentation into class docstrings. The convention i'm using is to leave credits/version/copyright type of stuff in # comments, and move the rest of the descriptive stuff about module usage into module docstrings. Hope this is okay.
51 lines
1.5 KiB
Python
51 lines
1.5 KiB
Python
"""Mutual exclusion -- for use with module sched
|
|
|
|
A mutex has two pieces of state -- a 'locked' bit and a queue.
|
|
When the mutex is not locked, the queue is empty.
|
|
Otherwise, the queue contains 0 or more (function, argument) pairs
|
|
representing functions (or methods) waiting to acquire the lock.
|
|
When the mutex is unlocked while the queue is not empty,
|
|
the first queue entry is removed and its function(argument) pair called,
|
|
implying it now has the lock.
|
|
|
|
Of course, no multi-threading is implied -- hence the funny interface
|
|
for lock, where a function is called once the lock is aquired.
|
|
"""
|
|
|
|
class mutex:
|
|
def __init__(self):
|
|
"""Create a new mutex -- initially unlocked."""
|
|
self.locked = 0
|
|
self.queue = []
|
|
|
|
def test(self):
|
|
"""Test the locked bit of the mutex."""
|
|
return self.locked
|
|
|
|
def testandset(self):
|
|
"""Atomic test-and-set -- grab the lock if it is not set,
|
|
return true if it succeeded."""
|
|
if not self.locked:
|
|
self.locked = 1
|
|
return 1
|
|
else:
|
|
return 0
|
|
|
|
def lock(self, function, argument):
|
|
"""Lock a mutex, call the function with supplied argument
|
|
when it is acquired. If the mutex is already locked, place
|
|
function and argument in the queue."""
|
|
if self.testandset():
|
|
function(argument)
|
|
else:
|
|
self.queue.append((function, argument))
|
|
|
|
def unlock(self):
|
|
"""Unlock a mutex. If the queue is not empty, call the next
|
|
function with its argument."""
|
|
if self.queue:
|
|
function, argument = self.queue[0]
|
|
del self.queue[0]
|
|
function(argument)
|
|
else:
|
|
self.locked = 0
|