multiprocessing (package)

This module has no docstring.

Classes

AuthenticationError

with_traceback(...)

  Exception.with_traceback(tb) --
      set self.__traceback__ to tb and return self.

args = <attribute 'args' of 'BaseException' objects>

BufferTooShort

with_traceback(...)

  Exception.with_traceback(tb) --
      set self.__traceback__ to tb and return self.

args = <attribute 'args' of 'BaseException' objects>

Process

close(self)


          Close the Process object.

          This method releases resources held by the Process object.  It is
          an error to call this method if the child process is still running.

is_alive(self)


          Return whether process is alive

join(self, timeout=None)


          Wait until child process terminates

kill(self)


          Terminate process; sends SIGKILL signal or uses TerminateProcess()

run(self)


          Method to be run in sub-process; can be overridden in sub-class

start(self)


          Start child process

terminate(self)


          Terminate process; sends SIGTERM signal or uses TerminateProcess()

authkey = <property object at 0x7f75e1c84cc0>

daemon = <property object at 0x7f75e1c84c70>

          Return whether process is a daemon

exitcode = <property object at 0x7f75e1c84b80>

          Return exit code of process or `None` if it has yet to stop

ident = <property object at 0x7f75e1c84bd0>

          Return identifier (PID) of process or `None` if it has yet to start

name = <property object at 0x7f75e1c84c20>

pid = <property object at 0x7f75e1c84bd0>

          Return identifier (PID) of process or `None` if it has yet to start

sentinel = <property object at 0x7f75e1c84d10>

          Return a file descriptor (Unix) or handle (Windows) suitable for
          waiting for process termination.

ProcessError

with_traceback(...)

  Exception.with_traceback(tb) --
      set self.__traceback__ to tb and return self.

args = <attribute 'args' of 'BaseException' objects>

TimeoutError

with_traceback(...)

  Exception.with_traceback(tb) --
      set self.__traceback__ to tb and return self.

args = <attribute 'args' of 'BaseException' objects>

Functions

Array

Array(typecode_or_type, size_or_initializer, *, lock=True)

  Returns a synchronized shared array

Barrier

Barrier(parties, action=None, timeout=None)

  Returns a barrier object

BoundedSemaphore

BoundedSemaphore(value=1)

  Returns a bounded semaphore object

Condition

Condition(lock=None)

  Returns a condition object

Event

Event()

  Returns an event object

JoinableQueue

JoinableQueue(maxsize=0)

  Returns a queue object

Lock

Lock()

  Returns a non-recursive lock object

Manager

Manager()

  Returns a manager associated with a running server process

          The managers methods such as `Lock()`, `Condition()` and `Queue()`
          can be used to create shared objects.

Pipe

Pipe(duplex=True)

  Returns two connection object connected by a pipe

Pool

Pool(processes=None, initializer=None, initargs=(), maxtasksperchild=None)

  Returns a process pool object

Queue

Queue(maxsize=0)

  Returns a queue object

RLock

RLock()

  Returns a recursive lock object

RawArray

RawArray(typecode_or_type, size_or_initializer)

  Returns a shared array

RawValue

RawValue(typecode_or_type, *args)

  Returns a shared object

Semaphore

Semaphore(value=1)

  Returns a semaphore object

SimpleQueue

SimpleQueue()

  Returns a queue object

Value

Value(typecode_or_type, *args, lock=True)

  Returns a synchronized shared object

active_children

active_children()


      Return list of process objects corresponding to live child processes

allow_connection_pickling

allow_connection_pickling()

  Install support for sending connections and sockets
          between processes

cpu_count

cpu_count()

  Returns the number of CPUs in the system

current_process

current_process()


      Return process object representing the current process

freeze_support

freeze_support()

  Check whether this is a fake forked process in a frozen executable.
          If so then run code specified by commandline and exit.

get_all_start_methods

get_all_start_methods()

get_context

get_context(method=None)

get_logger

get_logger()

  Return package logger -- if it does not already exist then
          it is created.

get_start_method

get_start_method(allow_none=False)

log_to_stderr

log_to_stderr(level=None)

  Turn on logging and add a handler which prints to stderr

parent_process

parent_process()


      Return process object representing the parent process

set_executable

set_executable(executable)

  Sets the path to a python.exe or pythonw.exe binary used to run
          child processes instead of sys.executable when using the 'spawn'
          start method.  Useful for people embedding Python.

set_forkserver_preload

set_forkserver_preload(module_names)

  Set list of module names to try to load in forkserver process.
          This is really just a hint.

set_start_method

set_start_method(method, force=False)

Other members

SUBDEBUG = 5

SUBWARNING = 25

Modules