Skip to main content

A Python module to customize the process title

Project description

Author:

Daniele Varrazzo

The setproctitle module 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

setproctitle is a C extension: in order to build it you will need a C compiler and the Python development support (the python-dev or python3-dev package in most Linux distributions). No further external dependencies are required.

You can use pip to install the module:

pip install setproctitle

You can use pip -t or virtualenv for local installations, sudo pip for a system-wide one… the usual stuff. Read pip or virtualenv docs for all the details.

Usage

The setproctitle module exports the following functions:

setproctitle(title)

Set title as the title for the current process.

getproctitle()

Return the current process title.

The process title is usually visible in files such as /proc/PID/cmdline, /proc/PID/status, /proc/PID/comm, depending on the operating system and kernel version. These information are used by user-space tools such as ps and top.

setthreadtitle(title)

Set title as the title for the current thread.

getthreadtitle()

Get the current thread title.

The thread title is exposed by some operating systems as the file /proc/PID/task/TID/comm, which is used by certain tools such as htop.

Environment variables

A few environment variables can be used to customize the module behavior:

SPT_NOENV

Avoid clobbering /proc/PID/environ.

On many platforms, setting the process title will clobber the environ memory area. os.environ will work as expected from within the Python process, but the content of the file /proc/PID/environ will be overwritten. If you require this file not to be broken you can set the SPT_NOENV environment variable to any non-empty value: in this case the maximum length for the title will be limited to the length of the command line.

SPT_DEBUG

Print debug information on stderr.

If the module doesn’t work as expected you can set this variable to a non-empty value to generate information useful for debugging. Note that the most useful information is printed when the module is imported, not when the functions are called.

Module status

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

  • GNU/Linux

  • BSD

  • MacOS X

  • Windows

Note 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.

Releases history

Version 1.2.1

  • Fixed segfault after os.environ.clear() (issue #88).

Version 1.2

  • added getthreadtitle() and setthreadtitle().

  • Initialisation of the module moved to the first usage: importing the module doesn’t cause side effects.

  • Manage much longer command lines (#52)

  • Improved build on BSD, dropped ancient versions (issue #67).

  • Fixed build for Python 3.8 (#66, #72)

  • Added support for Python 3.9

  • Dropped support for Python < 3.6

Version 1.1.10

  • Fixed building with certain prctl.h implementations (issue #44).

  • Use setuptools if available (issue #48).

Version 1.1.9

  • Fixed build on VC (issues #20, #33).

  • Added MANIFEST.in to the source distribution to help with RPM building (issue #30).

Version 1.1.8

  • Added support for Python “diehard” 2.4 (pull request #3).

  • Fixed build on Mac OS X 10.9 Maverick (issue #27).

Version 1.1.7

Version 1.1.6

  • The module can be compiled again on Windows (issue #21).

Version 1.1.5

  • No module bug, but a packaging issue: files README and HISTORY added back into the distribution.

Version 1.1.4

  • The module works correctly in embedded Python.

  • setproctitle() accepts a keyword argument.

  • Debug output support always compiled in: the variable SPT_DEBUG can be used to emit debug log.

Version 1.1.3

  • Don’t clobber environ if the variable SPT_NOENV is set (issue #16).

Version 1.1.2

  • Find the setproctitle include file on OpenBSD (issue #11).

  • Skip test with unicode if the file system encoding wouldn’t make it pass (issue #13).

Version 1.1.1

  • Fixed segfault when the module is imported under mod_wsgi (issue #9).

Version 1.1

  • The module works correctly with Python 3.

Version 1.0.1

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

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 Distribution

setproctitle-1.2.1.tar.gz (23.6 kB view details)

Uploaded Source

Built Distributions

setproctitle-1.2.1-cp39-cp39-manylinux1_x86_64.whl (35.3 kB view details)

Uploaded CPython 3.9

setproctitle-1.2.1-cp39-cp39-manylinux1_i686.whl (34.4 kB view details)

Uploaded CPython 3.9

setproctitle-1.2.1-cp38-cp38-manylinux1_x86_64.whl (36.0 kB view details)

Uploaded CPython 3.8

setproctitle-1.2.1-cp38-cp38-manylinux1_i686.whl (35.1 kB view details)

Uploaded CPython 3.8

setproctitle-1.2.1-cp37-cp37m-manylinux1_x86_64.whl (36.6 kB view details)

Uploaded CPython 3.7m

setproctitle-1.2.1-cp37-cp37m-manylinux1_i686.whl (35.3 kB view details)

Uploaded CPython 3.7m

setproctitle-1.2.1-cp36-cp36m-manylinux1_x86_64.whl (35.5 kB view details)

Uploaded CPython 3.6m

setproctitle-1.2.1-cp36-cp36m-manylinux1_i686.whl (34.3 kB view details)

Uploaded CPython 3.6m

File details

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

File metadata

  • Download URL: setproctitle-1.2.1.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for setproctitle-1.2.1.tar.gz
Algorithm Hash digest
SHA256 5f0eecb27815e31799a69eb6a06b4d375d38887d079d410565b0be82da65c950
MD5 bd471271c4d3cf50ed7dd3a1bdeb1e7d
BLAKE2b-256 a7e1e76b903af017cc4a99f823b5e4235c1136dcca6902e6b7ee4d545958ba8c

See more details on using hashes here.

Provenance

File details

Details for the file setproctitle-1.2.1-cp39-cp39-manylinux1_x86_64.whl.

File metadata

  • Download URL: setproctitle-1.2.1-cp39-cp39-manylinux1_x86_64.whl
  • Upload date:
  • Size: 35.3 kB
  • Tags: CPython 3.9
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for setproctitle-1.2.1-cp39-cp39-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 ab42aa209d21a056f886ab053788ca5599fe97c3aa0e5db93d3779771bfc6500
MD5 085d8e8f2c1fd53b9195fefee7474cb0
BLAKE2b-256 a4ad0c3a42b4c4afd6a9b0ce1b809f29a9a125bf6db3e925dc725b3f4a1ffb6d

See more details on using hashes here.

Provenance

File details

Details for the file setproctitle-1.2.1-cp39-cp39-manylinux1_i686.whl.

File metadata

  • Download URL: setproctitle-1.2.1-cp39-cp39-manylinux1_i686.whl
  • Upload date:
  • Size: 34.4 kB
  • Tags: CPython 3.9
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for setproctitle-1.2.1-cp39-cp39-manylinux1_i686.whl
Algorithm Hash digest
SHA256 8e91d0d6741b3d55c2b890b0706b4a57ab22aac067d9b5ffd620dc8be3a78628
MD5 6ba0f4cb544812890e59b091d539b6e9
BLAKE2b-256 8e0675fce18b475755728341b9122571cdea5f6e36a9b54359aae88e1ebfa3f5

See more details on using hashes here.

Provenance

File details

Details for the file setproctitle-1.2.1-cp38-cp38-manylinux1_x86_64.whl.

File metadata

  • Download URL: setproctitle-1.2.1-cp38-cp38-manylinux1_x86_64.whl
  • Upload date:
  • Size: 36.0 kB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for setproctitle-1.2.1-cp38-cp38-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 21d434a918eb44af5e3cef40fd67d55162344e4cf1048dbcb0bb10ae1e4f0437
MD5 dd8bfab4783425be8bad8bdcfb1a25bd
BLAKE2b-256 d52387f5e1c90c5d7ff2f44c6144b83b8feb242dd1cc1e099d43955d081c6861

See more details on using hashes here.

Provenance

File details

Details for the file setproctitle-1.2.1-cp38-cp38-manylinux1_i686.whl.

File metadata

  • Download URL: setproctitle-1.2.1-cp38-cp38-manylinux1_i686.whl
  • Upload date:
  • Size: 35.1 kB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for setproctitle-1.2.1-cp38-cp38-manylinux1_i686.whl
Algorithm Hash digest
SHA256 9f16239e7d927b39b62a29a07eb11a991ddc7d9aebe3d758b8288106ff48d493
MD5 392789a6616e1ebf99cb0fe18fdb86ef
BLAKE2b-256 bc2651634c3a634dc69400743334af9bfec7e69d2e601996ad8923b440b8d5ad

See more details on using hashes here.

Provenance

File details

Details for the file setproctitle-1.2.1-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: setproctitle-1.2.1-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 36.6 kB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for setproctitle-1.2.1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 5ec8edbf3170d95fd21424b2c6f537dfd1311bb027ab2a94f48b7c0ce2052a6a
MD5 91549fc69ced4dcef4f01845e0ba0893
BLAKE2b-256 3ea9e388165abea905f016ce1bab66b5fd7184b69dd4b70b23872a32c0b6cc87

See more details on using hashes here.

Provenance

File details

Details for the file setproctitle-1.2.1-cp37-cp37m-manylinux1_i686.whl.

File metadata

  • Download URL: setproctitle-1.2.1-cp37-cp37m-manylinux1_i686.whl
  • Upload date:
  • Size: 35.3 kB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for setproctitle-1.2.1-cp37-cp37m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 9b79419d6e964643431e37da033c1f53c5399f2521dbd68d417ee023630a8ec8
MD5 9b3dfb3004b5deeaa639d345c9b0decd
BLAKE2b-256 8cffbd06e2649ae8ae36c52240aab506f9697649458cd4c464fb47672a7b305e

See more details on using hashes here.

Provenance

File details

Details for the file setproctitle-1.2.1-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: setproctitle-1.2.1-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 35.5 kB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for setproctitle-1.2.1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 34b24fefc6612099cb41102e9d2b92859bc997a0553b7605fe51fb21a5b5c4d6
MD5 3e0f2bc67d40d2f9c7a70e121874d948
BLAKE2b-256 ab7cf2c7bdf58459dc3672028f725cecc80c081a6de17d5e1d501b9cdc846c00

See more details on using hashes here.

Provenance

File details

Details for the file setproctitle-1.2.1-cp36-cp36m-manylinux1_i686.whl.

File metadata

  • Download URL: setproctitle-1.2.1-cp36-cp36m-manylinux1_i686.whl
  • Upload date:
  • Size: 34.3 kB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for setproctitle-1.2.1-cp36-cp36m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 9c7bf0dc84739d321921f122ba50f3a88e1de3886de85b331cd555e8aa5b3bd9
MD5 1a3e88cd11e20cb38cda240cabfb908f
BLAKE2b-256 985acb52a202f3306486506e2b4a291572c18e3c68c7010c482f85793e1e7eac

See more details on using hashes here.

Provenance

Supported by

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