Correct documentation for s* z* and w*, the argument that should be passed
[python.git] / Doc / library / autogil.rst
blob1c25cb19b871f2d5268e63c5a6e584b3bbc83f4b
2 :mod:`autoGIL` --- Global Interpreter Lock handling in event loops
3 ==================================================================
5 .. module:: autoGIL
6    :platform: Mac
7    :synopsis: Global Interpreter Lock handling in event loops.
8    :deprecated:
9 .. moduleauthor:: Just van Rossum <just@letterror.com>
12 The :mod:`autoGIL` module provides a function :func:`installAutoGIL` that
13 automatically locks and unlocks Python's :term:`Global Interpreter Lock` when
14 running an event loop.
16 .. note::
18    This module has been removed in Python 3.x.
21 .. exception:: AutoGILError
23    Raised if the observer callback cannot be installed, for example because the
24    current thread does not have a run loop.
27 .. function:: installAutoGIL()
29    Install an observer callback in the event loop (CFRunLoop) for the current
30    thread, that will lock and unlock the Global Interpreter Lock (GIL) at
31    appropriate times, allowing other Python threads to run while the event loop is
32    idle.
34    Availability: OSX 10.1 or later.