pvaccesslist 0.0.5__tar.gz

pvaccesslist-0.0.5/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Electron-Ion Collider
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pvaccesslist-0.0.5/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.5
+Name: pvaccesslist
+Version: 0.0.5
+Summary: List active EPICS PVAccess PVs by querying discovered PVA servers
+Project-URL: Homepage, https://github.com/eicorg/scripts/tree/main/pvaccesslist
+Author-email: Andrey Sukhanov <sukhanov@bnl.gov>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+
+# pvaccesslist
+
+List all active EPICS PVAccess PVs.
+
+The script works as follows:
+1. Runs `pvlist` with no arguments to discover PVAccess servers.
+2. From each discovered line, extracts the first `ip:port` token after `tcp@[`.
+3. Runs `pvlist <ip:port>` for each extracted endpoint.
+4. Writes command output to stdout.
+
+## Requirements
+
+- EPICS `pvlist` must be available in `PATH`.
+- Python 3.7+
+
+## Usage
+
+- Show help:
+	- `python3 -m pvaccesslist.pvaccesslist -h`
+- List PVs to terminal:
+	- `python3 -m pvaccesslist.pvaccesslist`
+- Save PV list to file:
+	- `python3 -m pvaccesslist.pvaccesslist > pvs.txt`
+
+## Notes
+
+- If `pvlist` is missing, the script exits with an error message.
+- Server discovery diagnostics are printed to stderr; PV names are printed to stdout.

pvaccesslist-0.0.5/README.md

@@ -0,0 +1,28 @@
+# pvaccesslist
+
+List all active EPICS PVAccess PVs.
+
+The script works as follows:
+1. Runs `pvlist` with no arguments to discover PVAccess servers.
+2. From each discovered line, extracts the first `ip:port` token after `tcp@[`.
+3. Runs `pvlist <ip:port>` for each extracted endpoint.
+4. Writes command output to stdout.
+
+## Requirements
+
+- EPICS `pvlist` must be available in `PATH`.
+- Python 3.7+
+
+## Usage
+
+- Show help:
+	- `python3 -m pvaccesslist.pvaccesslist -h`
+- List PVs to terminal:
+	- `python3 -m pvaccesslist.pvaccesslist`
+- Save PV list to file:
+	- `python3 -m pvaccesslist.pvaccesslist > pvs.txt`
+
+## Notes
+
+- If `pvlist` is missing, the script exits with an error message.
+- Server discovery diagnostics are printed to stderr; PV names are printed to stdout.

pvaccesslist-0.0.5/prompt.md

@@ -0,0 +1,9 @@
+Create a python script pvaccesslist.py which lists all active EPICS PVAccess PVs.
+To get a list of available PVAccess servers use pvlist program from EPICS without arguments. Output of the pvlist looks like this:
+
+GUID 0x24397204572FF765D5482C55 version 2: tcp@[ 130.199.104.35:39303 192.168.50.202:39303 192.168.122.1:39303 ]
+GUID 0xF8EC8C9CD38DBB6B9F0EA5C6 version 2: tcp@[ 130.199.104.35:5075 192.168.50.202:5075 192.168.122.1:5075 ]
+
+For each line extract first IP_Port token which comes after 'tcp@['
+
+For each IP_port execute 'pvlist IP_port' and write output to stdout.

pvaccesslist-0.0.5/pvaccesslist/__init__.py

@@ -0,0 +1,4 @@
+from .pvaccesslist import main
+
+raise SystemExit(main())
+

pvaccesslist-0.0.5/pvaccesslist/pvaccesslist.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+"""List active EPICS PVAccess PVs by querying discovered PVA servers."""
+__version__ = 'v0.0.1 2026-08-18'# created
+import re
+import subprocess
+import sys
+
+FIRST_TCP_ENDPOINT_RE = re.compile(r"tcp@\[\s*([^\s\]]+)")
+
+def print_usage() -> None:
+    """Print usage information."""
+    print(
+        "Description:\n"
+        "  List active EPICS PVAccess PVs by discovering PVA servers with 'pvlist'\n"
+        "  and running 'pvlist <ip:port>' for each discovered server.\n"
+        "Usage:\n"
+        "  pvaccesslist.py\n"
+        "  pvaccesslist.py > pvs.txt\n"
+        "  python3 -m pvaccesslist.pvaccesslist\n"
+    )
+
+def run_pvlist(args: list[str]) -> subprocess.CompletedProcess[str]:
+    """Run `pvlist` and return completed process with captured text output."""
+    try:
+        return subprocess.run(
+            ["pvlist", *args],
+            text=True,
+            capture_output=True,
+            check=False,
+        )
+    except FileNotFoundError as exc:
+        raise RuntimeError(
+            "Could not find 'pvlist' in PATH. "
+            "Load your EPICS environment or add pvAccess/bin/... to PATH."
+        ) from exc
+
+def discover_endpoints() -> list[str]:
+    """Return unique first tcp@[ ... ] endpoint from each discovered server line."""
+    result = run_pvlist([])
+    if result.returncode != 0:
+        if result.stderr:
+            print(result.stderr, end="", file=sys.stderr)
+        raise RuntimeError(f"pvlist failed with code {result.returncode}")
+
+    endpoints: list[str] = []
+    seen: set[str] = set()
+    for line in result.stdout.splitlines():
+        match = FIRST_TCP_ENDPOINT_RE.search(line)
+        if not match:
+            continue
+        endpoint = match.group(1)
+        if endpoint not in seen:
+            seen.add(endpoint)
+            endpoints.append(endpoint)
+    return endpoints
+
+def main() -> int:
+    if "-h" in sys.argv[1:] or "--help" in sys.argv[1:]:
+        print_usage()
+        return 0
+
+    try:
+        endpoints = discover_endpoints()
+        print(f"Discovered {len(endpoints)} PVA servers.", file=sys.stderr)
+    except RuntimeError as exc:
+        print(f"Error: {exc}", file=sys.stderr)
+        return 1
+
+    for endpoint in endpoints:
+        result = run_pvlist([endpoint])
+        print(f"--- {endpoint} ---", file=sys.stderr)
+        if result.stdout:
+            sys.stdout.write(result.stdout)
+            if not result.stdout.endswith("\n"):
+                sys.stdout.write("\n")
+        if result.stderr:
+            print(result.stderr, end="", file=sys.stderr)
+
+    return 0
+
+if __name__ == "__main__":
+    raise SystemExit(main())

pvaccesslist-0.0.5/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "pvaccesslist"
+version = "0.0.5"
+license = "BSD-3-Clause"
+authors = [
+  { name="Andrey Sukhanov", email="sukhanov@bnl.gov" },
+]
+description = "List active EPICS PVAccess PVs by querying discovered PVA servers"
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: POSIX :: Linux",
+]
+dependencies = []
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project.urls]
+"Homepage" = "https://github.com/eicorg/scripts/tree/main/pvaccesslist"