Warning
This documentation is for an old version of IPython. You can find docs for newer versions here.
Module: parallel.apps.baseapp
¶
The Base Application class for IPython.parallel apps
3 Classes¶
-
class
IPython.parallel.apps.baseapp.
PIDFileError
¶ Bases:
Exception
-
class
IPython.parallel.apps.baseapp.
ParallelCrashHandler
(app)¶ Bases:
IPython.core.crashhandler.CrashHandler
sys.excepthook for IPython itself, leaves a detailed report on disk.
-
__init__
(app)¶
-
-
class
IPython.parallel.apps.baseapp.
BaseParallelApplication
(**kwargs)¶ Bases:
IPython.core.application.BaseIPythonApplication
The base Application for IPython.parallel apps
Principle extensions to BaseIPyythonApplication:
- work_dir
- remote logging via pyzmq
- IOLoop instance
-
crash_handler_class
¶ alias of
ParallelCrashHandler
-
get_pid_from_file
()¶ Get the pid from the pid file.
If the pid file doesn’t exist a
PIDFileError
is raised.
-
initialize
(argv=None)¶ initialize the app
-
remove_pid_file
()¶ Remove the pid file.
This should be called at shutdown by registering a callback with
reactor.addSystemEventTrigger()
. This needs to returnNone
.
-
write_pid_file
(overwrite=False)¶ Create a .pid file in the pid_dir with my pid.
This must be called after pre_construct, which sets
self.pid_dir
. This raisesPIDFileError
if the pid file exists already.