Allow customization of the process title.
The library allows a process to change its title (as displayed by system tools such as ps and top).
Changing a process title is mostly useful in multi-process systems, for example when using a pool of slave workers whose job is not decided when the process is spawned, but later on, after some form of communication from the controlling process.
You can use easy_install to install the module: to perform a system-wide installation use:
sudo easy_install setproctitle
If you are an unprivileged user or you want to limit installation to a local environment, you can use the command:
easy_install -d /target/path setproctitle
Notice that easy_install requires /target/path to be in your PYTHONPATH.
The module exports the following functions:
- Set title as the title for the current process.
- Return the current process title.
Albeit the core part of the code has been tested on a wild variety of platforms, compiling the Python module has currently been tested on:
- Mac OS X
Other known implementations and discussions
Currently in tip
Notice that on Windows there is no way to change the process string. What the module does is to create a Named Object whose value can be read in tools such as Process Explorer.
- Module works on Mac OS X 10.2. Reported working on OS X 10.6 too.
- Added prctl() call on Linux > 2.6.9 to update /proc/self/status.
- Initial public release.