Added section on passing contextual information to logging and documentation for...
[python.git] / Doc / library / autogil.rst
blob7625be65a649139f4db2788bfeca4e595bee8a55
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 .. moduleauthor:: Just van Rossum <just@letterror.com>
11 The :mod:`autoGIL` module provides a function :func:`installAutoGIL` that
12 automatically locks and unlocks Python's :term:`Global Interpreter Lock` when
13 running an event loop.
16 .. exception:: AutoGILError
18    Raised if the observer callback cannot be installed, for example because the
19    current thread does not have a run loop.
22 .. function:: installAutoGIL()
24    Install an observer callback in the event loop (CFRunLoop) for the current
25    thread, that will lock and unlock the Global Interpreter Lock (GIL) at
26    appropriate times, allowing other Python threads to run while the event loop is
27    idle.
29    Availability: OSX 10.1 or later.