processtitle 1.0__tar.gz → 1.1__tar.gz

{processtitle-1.0/processtitle.egg-info → processtitle-1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: processtitle
-Version: 1.0
+Version: 1.1
 Summary: Customize process "title" as reported by ps and similar tools
 Author-email: Eugene Gershnik <gershnik@hotmail.com>
 License-Expression: BSD-3-Clause
@@ -74,7 +74,7 @@ to be shown in the process list instead.
 ## Platform support
 
 The module will happily _run_ and do nothing on any [compatible system](#requirements) but the ones where it 
-actually _works_ (i.e. changes the process title) are: Linux, macOS, Windows, {Free|Net|Open}BSD and Illumos. See 
+actually _works_ (i.e. changes the process title) are: Linux, macOS, Windows, {Free|Net|Open|DragonFly}BSD and Illumos. See 
 [platform details](#platform-details) below for more information about each platform.
 
 In all cases only reasonably recent versions of each platform are supported. No attempt is made to work
@@ -131,6 +131,16 @@ to a non-empty value (which is not "0"). For example:
 SPT_DEBUG=1 your_script_that_uses_processtitle
 ```
 
+For troubleshooting and general convenience you can also call the module directly or via a wrapper script:
+```console
+$ processtitle
+$ #or
+$ python3 -m processtitle
+```
+
+This produces a list of process IDs and their titles by delegating to `ps` or Windows Powershell in a way 
+most appropriate to each platform. Run `processtitle -h` to see the available command line options.
+
 ## Thread and other safety
 
 `processtitle` _itself_ is thread-safe - all its operations are protected by a mutex. However, 
@@ -214,7 +224,7 @@ To change the title, `processtitle` uses the following methods:
 ### Windows
 
 On Windows you can see the process by looking at the process command line. You can see the command lines of running 
-processes in two ways:
+processes in three ways:
 
 1. Using powershell's `Get-WmiObject Win32_Process` call:
   ```powershell
@@ -225,18 +235,30 @@ processes in two ways:
   powershell -c "Get-WmiObject Win32_Process | Select-Object ProcessId, CommandLine"
   ```
 
-2. In Task Manager details view. If the "Command Line" column is not present, right-click the columns header,
+2. Using `processtitle` command line utility installed with this package. Run `processtitle -h` for 
+   details of available switches. The utility internally uses WMI but in a more sophisticated way,
+
+3. In Task Manager details view. If the "Command Line" column is not present, right-click the columns header,
   choose "Select columns" and check "Command Line" entry in the list.
+  
+> [!IMPORTANT]
+> Task Manager caches the command line of the process. If you had Task Manager open and showing the command
+> line and *then* changed it, you might need to restart it to show the updated value.
 
 To change the title, `processtitle` uses modifies/replaces partially-documented [RTL_USER_PROCESS_PARAMETERS](https://learn.microsoft.com/en-us/windows/win32/api/winternl/ns-winternl-rtl_user_process_parameters) via undocumented or partially documented calls.
 
 ### BSDs
 
-On {Free|Net|Open}BSD you will be able to see the process title in the output of `ps` or `top` commands, as well, 
+On {Free|Net|Open|DragonFly}BSD you will be able to see the process title in the output of `ps` or `top` commands, as well, 
 as with any other tool that displays process info. All of these platforms will, in general, add the original 
 executable name (e.g. `python3`) to the actual title either as a prefix or a suffix.
 
-To change the title, `processtitle` uses documented `setproctitle()` call ([FreeBSD](https://man.freebsd.org/cgi/man.cgi?query=setproctitle&sektion=3&format=html), [NetBSD](https://man.netbsd.org/NetBSD-10.1/setproctitle.3), [OpenBSD](https://man.openbsd.org/setproctitle.3)). 
+> [!NOTE]
+> At the time of this writing the default compiler on DragonFly BSD is an ancient GCC 8. You will need to install
+> GCC 11 (available as a binary package) in order to build `processtitle`. Once installed:
+> `CC=gcc11 CXX=g++11 pip install processtitle`
+
+To change the title, `processtitle` uses documented `setproctitle()` call ([FreeBSD](https://man.freebsd.org/cgi/man.cgi?query=setproctitle&sektion=3&format=html), [NetBSD](https://man.netbsd.org/NetBSD-10.1/setproctitle.3), [OpenBSD](https://man.openbsd.org/setproctitle.3), [DragonFly](https://man.dragonflybsd.org/?command=setproctitle)). 
 
 
 ### Illumos

{processtitle-1.0 → processtitle-1.1}/README.md

@@ -38,7 +38,7 @@ to be shown in the process list instead.
 ## Platform support
 
 The module will happily _run_ and do nothing on any [compatible system](#requirements) but the ones where it 
-actually _works_ (i.e. changes the process title) are: Linux, macOS, Windows, {Free|Net|Open}BSD and Illumos. See 
+actually _works_ (i.e. changes the process title) are: Linux, macOS, Windows, {Free|Net|Open|DragonFly}BSD and Illumos. See 
 [platform details](#platform-details) below for more information about each platform.
 
 In all cases only reasonably recent versions of each platform are supported. No attempt is made to work
@@ -95,6 +95,16 @@ to a non-empty value (which is not "0"). For example:
 SPT_DEBUG=1 your_script_that_uses_processtitle
 ```
 
+For troubleshooting and general convenience you can also call the module directly or via a wrapper script:
+```console
+$ processtitle
+$ #or
+$ python3 -m processtitle
+```
+
+This produces a list of process IDs and their titles by delegating to `ps` or Windows Powershell in a way 
+most appropriate to each platform. Run `processtitle -h` to see the available command line options.
+
 ## Thread and other safety
 
 `processtitle` _itself_ is thread-safe - all its operations are protected by a mutex. However, 
@@ -178,7 +188,7 @@ To change the title, `processtitle` uses the following methods:
 ### Windows
 
 On Windows you can see the process by looking at the process command line. You can see the command lines of running 
-processes in two ways:
+processes in three ways:
 
 1. Using powershell's `Get-WmiObject Win32_Process` call:
   ```powershell
@@ -189,18 +199,30 @@ processes in two ways:
   powershell -c "Get-WmiObject Win32_Process | Select-Object ProcessId, CommandLine"
   ```
 
-2. In Task Manager details view. If the "Command Line" column is not present, right-click the columns header,
+2. Using `processtitle` command line utility installed with this package. Run `processtitle -h` for 
+   details of available switches. The utility internally uses WMI but in a more sophisticated way,
+
+3. In Task Manager details view. If the "Command Line" column is not present, right-click the columns header,
   choose "Select columns" and check "Command Line" entry in the list.
+  
+> [!IMPORTANT]
+> Task Manager caches the command line of the process. If you had Task Manager open and showing the command
+> line and *then* changed it, you might need to restart it to show the updated value.
 
 To change the title, `processtitle` uses modifies/replaces partially-documented [RTL_USER_PROCESS_PARAMETERS](https://learn.microsoft.com/en-us/windows/win32/api/winternl/ns-winternl-rtl_user_process_parameters) via undocumented or partially documented calls.
 
 ### BSDs
 
-On {Free|Net|Open}BSD you will be able to see the process title in the output of `ps` or `top` commands, as well, 
+On {Free|Net|Open|DragonFly}BSD you will be able to see the process title in the output of `ps` or `top` commands, as well, 
 as with any other tool that displays process info. All of these platforms will, in general, add the original 
 executable name (e.g. `python3`) to the actual title either as a prefix or a suffix.
 
-To change the title, `processtitle` uses documented `setproctitle()` call ([FreeBSD](https://man.freebsd.org/cgi/man.cgi?query=setproctitle&sektion=3&format=html), [NetBSD](https://man.netbsd.org/NetBSD-10.1/setproctitle.3), [OpenBSD](https://man.openbsd.org/setproctitle.3)). 
+> [!NOTE]
+> At the time of this writing the default compiler on DragonFly BSD is an ancient GCC 8. You will need to install
+> GCC 11 (available as a binary package) in order to build `processtitle`. Once installed:
+> `CC=gcc11 CXX=g++11 pip install processtitle`
+
+To change the title, `processtitle` uses documented `setproctitle()` call ([FreeBSD](https://man.freebsd.org/cgi/man.cgi?query=setproctitle&sektion=3&format=html), [NetBSD](https://man.netbsd.org/NetBSD-10.1/setproctitle.3), [OpenBSD](https://man.openbsd.org/setproctitle.3), [DragonFly](https://man.dragonflybsd.org/?command=setproctitle)). 
 
 
 ### Illumos

{processtitle-1.0 → processtitle-1.1/processtitle.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: processtitle
-Version: 1.0
+Version: 1.1
 Summary: Customize process "title" as reported by ps and similar tools
 Author-email: Eugene Gershnik <gershnik@hotmail.com>
 License-Expression: BSD-3-Clause
@@ -74,7 +74,7 @@ to be shown in the process list instead.
 ## Platform support
 
 The module will happily _run_ and do nothing on any [compatible system](#requirements) but the ones where it 
-actually _works_ (i.e. changes the process title) are: Linux, macOS, Windows, {Free|Net|Open}BSD and Illumos. See 
+actually _works_ (i.e. changes the process title) are: Linux, macOS, Windows, {Free|Net|Open|DragonFly}BSD and Illumos. See 
 [platform details](#platform-details) below for more information about each platform.
 
 In all cases only reasonably recent versions of each platform are supported. No attempt is made to work
@@ -131,6 +131,16 @@ to a non-empty value (which is not "0"). For example:
 SPT_DEBUG=1 your_script_that_uses_processtitle
 ```
 
+For troubleshooting and general convenience you can also call the module directly or via a wrapper script:
+```console
+$ processtitle
+$ #or
+$ python3 -m processtitle
+```
+
+This produces a list of process IDs and their titles by delegating to `ps` or Windows Powershell in a way 
+most appropriate to each platform. Run `processtitle -h` to see the available command line options.
+
 ## Thread and other safety
 
 `processtitle` _itself_ is thread-safe - all its operations are protected by a mutex. However, 
@@ -214,7 +224,7 @@ To change the title, `processtitle` uses the following methods:
 ### Windows
 
 On Windows you can see the process by looking at the process command line. You can see the command lines of running 
-processes in two ways:
+processes in three ways:
 
 1. Using powershell's `Get-WmiObject Win32_Process` call:
   ```powershell
@@ -225,18 +235,30 @@ processes in two ways:
   powershell -c "Get-WmiObject Win32_Process | Select-Object ProcessId, CommandLine"
   ```
 
-2. In Task Manager details view. If the "Command Line" column is not present, right-click the columns header,
+2. Using `processtitle` command line utility installed with this package. Run `processtitle -h` for 
+   details of available switches. The utility internally uses WMI but in a more sophisticated way,
+
+3. In Task Manager details view. If the "Command Line" column is not present, right-click the columns header,
   choose "Select columns" and check "Command Line" entry in the list.
+  
+> [!IMPORTANT]
+> Task Manager caches the command line of the process. If you had Task Manager open and showing the command
+> line and *then* changed it, you might need to restart it to show the updated value.
 
 To change the title, `processtitle` uses modifies/replaces partially-documented [RTL_USER_PROCESS_PARAMETERS](https://learn.microsoft.com/en-us/windows/win32/api/winternl/ns-winternl-rtl_user_process_parameters) via undocumented or partially documented calls.
 
 ### BSDs
 
-On {Free|Net|Open}BSD you will be able to see the process title in the output of `ps` or `top` commands, as well, 
+On {Free|Net|Open|DragonFly}BSD you will be able to see the process title in the output of `ps` or `top` commands, as well, 
 as with any other tool that displays process info. All of these platforms will, in general, add the original 
 executable name (e.g. `python3`) to the actual title either as a prefix or a suffix.
 
-To change the title, `processtitle` uses documented `setproctitle()` call ([FreeBSD](https://man.freebsd.org/cgi/man.cgi?query=setproctitle&sektion=3&format=html), [NetBSD](https://man.netbsd.org/NetBSD-10.1/setproctitle.3), [OpenBSD](https://man.openbsd.org/setproctitle.3)). 
+> [!NOTE]
+> At the time of this writing the default compiler on DragonFly BSD is an ancient GCC 8. You will need to install
+> GCC 11 (available as a binary package) in order to build `processtitle`. Once installed:
+> `CC=gcc11 CXX=g++11 pip install processtitle`
+
+To change the title, `processtitle` uses documented `setproctitle()` call ([FreeBSD](https://man.freebsd.org/cgi/man.cgi?query=setproctitle&sektion=3&format=html), [NetBSD](https://man.netbsd.org/NetBSD-10.1/setproctitle.3), [OpenBSD](https://man.openbsd.org/setproctitle.3), [DragonFly](https://man.dragonflybsd.org/?command=setproctitle)). 
 
 
 ### Illumos

{processtitle-1.0 → processtitle-1.1}/processtitle.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ setup.py
 processtitle.egg-info/PKG-INFO
 processtitle.egg-info/SOURCES.txt
 processtitle.egg-info/dependency_links.txt
+processtitle.egg-info/entry_points.txt
 processtitle.egg-info/top_level.txt
 src/extension.cpp
 src/cpp/bsd.h
@@ -35,5 +36,6 @@ src/cpp/external/pylib/marshalling.h
 src/cpp/external/pylib/method.h
 src/cpp/external/pylib/util.h
 src/processtitle/__init__.py
+src/processtitle/__main__.py
 src/processtitle/_processtitle.pyi
 src/processtitle/py.typed

processtitle-1.1/processtitle.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+processtitle = processtitle.__main__:main

{processtitle-1.0 → processtitle-1.1}/pyproject.toml

@@ -64,3 +64,6 @@ Homepage = 'https://github.com/gershnik/processtitle'
 Documentation = 'https://github.com/gershnik/processtitle'
 Issues = 'https://github.com/gershnik/processtitle/issues'
 Changelog = 'https://github.com/gershnik/processtitle/blob/master/CHANGELOG.md'
+
+[project.scripts]
+processtitle = 'processtitle.__main__:main'

{processtitle-1.0 → processtitle-1.1}/src/cpp/bsd.h

@@ -3,7 +3,7 @@
 
 #include "common.h"
 
-#if defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__)
+#if defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) || defined(__DragonFly__)
 
 #define SPTEX_HAS_BSD 1
 
@@ -12,7 +12,7 @@ void bsdPrepare() {
 }
 
 bool bsdSetProcessTitle(const char * title) {
-    #if defined(__FreeBSD__)
+    #if defined(__FreeBSD__) || defined(__DragonFly__)
         setproctitle("-%s", title);
     #else
         setproctitle("%s", title);

{processtitle-1.0 → processtitle-1.1}/src/processtitle/__init__.py

@@ -6,7 +6,7 @@
 import os
 import logging
 
-__version__ = '1.0'
+__version__ = '1.1'
 
 from ._processtitle import (
     prepare,

processtitle-1.1/src/processtitle/__main__.py

@@ -0,0 +1,122 @@
+# Copyright (c) 2026, Eugene Gershnik
+# SPDX-License-Identifier: BSD-3-Clause
+
+"""Command line utility to list process titles"""
+
+import sys
+import os
+import argparse
+import subprocess
+import shutil
+import re
+import textwrap
+import locale
+
+from pathlib import Path
+
+from . import __version__
+
+def _doBusybox(args, ps: Path):
+    cmd = [ps, '-opid,args']
+    if args.pids is None:
+        proc = subprocess.run(cmd)
+        return proc.returncode
+    
+    encoding = locale.getpreferredencoding(do_setlocale=False)
+    proc = subprocess.Popen(cmd, encoding=encoding, stdout=subprocess.PIPE)
+    assert proc.stdout is not None
+    expr = re.compile(r'^\s*([0-9]+) ')
+    for line in proc.stdout:
+        if (m := expr.search(line)):
+            pid = int(m.group(1))
+            if pid in args.pids:
+                print(line, end='')
+        else:
+            print(line, end='')
+    retcode = proc.wait()
+    return retcode
+
+def _doUnix(args):
+    path = os.environ.get('PATH', '/bin:/usr/bin')
+    ps = shutil.which('ps', path=path)
+    if ps is None:
+        print('ps utility not found', file=sys.stderr, flush=True)
+        return 1
+    
+    test = Path(ps)
+    while test.is_symlink():
+        dest = test.readlink()
+        if dest.name == 'busybox':
+            return _doBusybox(args, Path(ps))
+        
+    cmd = [ps]
+    
+    if sys.platform.startswith("sunos"):
+        cmd += ['-F', '-opid,args']
+    else:
+        cmd += ['-opid,command']
+
+    if args.pids is not None:
+        if sys.platform == "linux":
+            cmd += ['-q', ','.join([str(pid) for pid in args.pids])]
+        else:
+            cmd += ['-p', ','.join([str(pid) for pid in args.pids])]
+    elif args.show_all:
+        cmd += ['-A']
+    
+    proc = subprocess.run(cmd)
+    return proc.returncode
+
+
+def _doWin(args):
+    powershell = shutil.which('powershell')
+    if powershell is None:
+        print('powershell not found', file=sys.stderr, flush=True)
+        return 1
+    
+    pids = ''
+    filter = ''
+    if not args.show_all:
+        filter += '| Where-Object { $sessionId -eq $_.SessionId } '
+    if args.pids is not None:
+        pids = ', '.join(str(pid) for pid in args.pids)
+        filter += '| Where-Object { $pids -contains $_.ProcessId } '
+    input = textwrap.dedent('''
+    $ErrorActionPreference = 'Stop'
+    $pids = @( ''' + pids + ''' )
+    $sessionId = [System.Diagnostics.Process]::GetCurrentProcess().SessionId
+    $s = Get-CimInstance Win32_Process ''' + filter + '''| Format-Table -Property @(
+            @{ Name='PID'; Expression = { $_.ProcessId }} 
+            @{ Name='COMMAND'; Expression = { If ($_.CommandLine.Length) {$_.CommandLine} else {$_.Name}  }} 
+        ) | Out-String
+    $s = $s.Trim()
+    if ($s -eq '') { exit 1 }
+    $s
+    ''').replace('\n', '\r\n')
+    
+    cmd = [powershell, '-NonInteractive', '-NoLogo', '-Command', '-']
+    proc = subprocess.run(cmd, input=input, encoding='utf-8')
+    return proc.returncode
+
+def main():
+    """script entry point"""
+
+    parser = argparse.ArgumentParser(
+        prog='processtitle',
+        description='Portably lists process IDs and their titles'
+    )
+    parser.add_argument('-a', '--all', action='store_true', dest='show_all', 
+                        help="show all (as opposed to 'some') processes. "
+                             "The definition of 'some' is platform dependent.")
+    parser.add_argument('-p', '--pid', metavar='PID', type=int, nargs='+', dest='pids', help='limit output to these process IDs')
+    parser.add_argument('-v', '--version', action='version', version=f'%(prog)s {__version__}')
+
+    args = parser.parse_args()
+
+    if not sys.platform.startswith("win32"):
+        return _doUnix(args)
+    else:
+        return _doWin(args)
+
+if __name__ == '__main__':
+    sys.exit(main())