# coding: utf-8
# AUTO-GENERATED FILE -- DO NOT EDIT

""" This module provides primitive operations to write multi-threaded programs.
The 'threading' module provides a more convenient interface. """

class LockType(object):
  """ A lock object is a synchronization primitive.  To create a lock,
  call the PyThread_allocate_lock() function.  Methods are:
  
  acquire() -- lock the lock, possibly blocking until it can be obtained
  release() -- unlock of the lock
  locked() -- test whether the lock is currently locked
  
  A lock is not owned by the thread that locked it; another thread may
  unlock it.  A thread attempting to lock a lock that it has already locked
  will block until another thread unlocks it.  Deadlocks may ensue. """

  pass

__doc__ = """This module provides primitive operations to write multi-threaded programs.
The 'threading' module provides a more convenient interface."""
__name__ = 'thread'
__package__ = None

class _local(object):
  """ Thread-local data """

  pass

def allocate():
  """ allocate_lock() -> lock object
  (allocate() is an obsolete synonym)
  
  Create a new lock object.  See LockType.__doc__ for information about locks. """
  return None

def allocate_lock():
  """ allocate_lock() -> lock object
  (allocate() is an obsolete synonym)
  
  Create a new lock object.  See LockType.__doc__ for information about locks. """
  return None

class error(Exception):

  pass

def exit():
  """ exit()
  (PyThread_exit_thread() is an obsolete synonym)
  
  This is synonymous to ``raise SystemExit''.  It will cause the current
  thread to exit silently unless the exception is caught. """
  pass

def exit_thread():
  """ exit()
  (PyThread_exit_thread() is an obsolete synonym)
  
  This is synonymous to ``raise SystemExit''.  It will cause the current
  thread to exit silently unless the exception is caught. """
  pass

def get_ident():
  """ get_ident() -> integer
  
  Return a non-zero integer that uniquely identifies the current thread
  amongst other threads that exist simultaneously.
  This may be used to identify per-thread resources.
  Even though on some platforms threads identities may appear to be
  allocated consecutive numbers starting at 1, this behavior should not
  be relied upon, and the number should be seen purely as a magic cookie.
  A thread's identity may be reused for another thread after it exits. """
  return 1

def interrupt_main():
  """ interrupt_main()
  
  Raise a KeyboardInterrupt in the main thread.
  A subthread can use this function to interrupt the main thread. """
  pass

def stack_size(size=None):
  """ stack_size([size]) -> size
  
  Return the thread stack size used when creating new threads.  The
  optional size argument specifies the stack size (in bytes) to be used
  for subsequently created threads, and must be 0 (use platform or
  configured default) or a positive integer value of at least 32,768 (32k).
  If changing the thread stack size is unsupported, a ThreadError
  exception is raised.  If the specified size is invalid, a ValueError
  exception is raised, and the stack size is unmodified.  32k bytes
   currently the minimum supported stack size value to guarantee
  sufficient stack space for the interpreter itself.
  
  Note that some platforms may have particular restrictions on values for
  the stack size, such as requiring a minimum stack size larger than 32kB or
  requiring allocation in multiples of the system memory page size
  - platform documentation should be referred to for more information
  (4kB pages are common; using multiples of 4096 for the stack size is
  the suggested approach in the absence of more specific information). """
  return None

def start_new(function, args, kwargs=None):
  """ start_new_thread(function, args[, kwargs])
  (start_new() is an obsolete synonym)
  
  Start a new thread and return its identifier.  The thread will call the
  function with positional arguments from the tuple args and keyword arguments
  taken from the optional dictionary kwargs.  The thread exits when the
  function returns; the return value is ignored.  The thread will also exit
  when the function raises an unhandled exception; a stack trace will be
  printed unless the exception is SystemExit.
   """
  pass

def start_new_thread(function, args, kwargs=None):
  """ start_new_thread(function, args[, kwargs])
  (start_new() is an obsolete synonym)
  
  Start a new thread and return its identifier.  The thread will call the
  function with positional arguments from the tuple args and keyword arguments
  taken from the optional dictionary kwargs.  The thread exits when the
  function returns; the return value is ignored.  The thread will also exit
  when the function raises an unhandled exception; a stack trace will be
  printed unless the exception is SystemExit.
   """
  pass