Skip to main content

Allow customization of the process title.

Project description

Author:

Daniele Varrazzo

The library allows a process to change its title (as displayed by system tools such as ps and top).

Changing the title is mostly useful in multi-process systems, for example when a master process is forked: changing the children’s title allows to identify the task each process is busy with. The technique is used by PostgreSQL and the OpenSSH Server for example.

The procedure is hardly portable across different systems. PostgreSQL provides a good multi-platform implementation: this module is a Python wrapper around PostgreSQL code.

Installation

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.

Module content

The module exports the following functions:

setproctitle(title)

Set title as the title for the current process.

getproctitle()

Return the current process title.

Module status

The module can be currently compiled and effectively used on the following platforms:

  • GNU/Linux

  • BSD

  • MacOS X

  • Windows

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 using a tool such as Process Explorer (contribution of a more useful tool to be used together with setproctitle would be well accepted).

The module can probably work on HP-UX, but I haven’t found any to test with. It is unlikely that it can work on Solaris instead.

Other known implementations and discussions

  • procname: a module exposing the same functionality, but less portable and not well packaged.

  • Issue 5672: where the introduction of such functionality into the stdlib is being discussed.

Releases history

Version 1.0.1

  • setproctitle() works even when Python messes up with argv, e.g. when run with the -m option.

Version 1.0

No major change since the previous version. The module has been heavily used in production environment without any problem reported, so it’s time to declare it stable.

Version 0.4

Version 0.3

  • Module works on Mac OS X 10.2. Reported working on OS X 10.6 too.

Version 0.2

  • Added prctl() call on Linux >= 2.6.9 to update /proc/self/status.

Version 0.1

  • Initial public release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

setproctitle-1.0.1.zip (17.5 kB view details)

Uploaded Source

setproctitle-1.0.1.tar.gz (12.9 kB view details)

Uploaded Source

File details

Details for the file setproctitle-1.0.1.zip.

File metadata

  • Download URL: setproctitle-1.0.1.zip
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for setproctitle-1.0.1.zip
Algorithm Hash digest
SHA256 37cc2aaa870dd43022967de768d7a302830ede7d5e2ef7cebc0788ed42f000ef
MD5 27a63e1cc2dda078baa14cb44aab95c9
BLAKE2b-256 c95491b2c98fcffec2042d2bd1e6ddd9005793f9796eb45733fb9812326db187

See more details on using hashes here.

File details

Details for the file setproctitle-1.0.1.tar.gz.

File metadata

File hashes

Hashes for setproctitle-1.0.1.tar.gz
Algorithm Hash digest
SHA256 2fc197f8630917eea14fb92215e6550da71486841eba7f638048348ec0c0fe83
MD5 1e7522e32cc1d7045d97fcc12324a67e
BLAKE2b-256 e3811fe7f0af0c50fb3da0f67d6cd941eeae8472ef0dc4c327c5f2a1cd1d4b8b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page