pvua 1.0.1__tar.gz

pvua-1.0.1/LICENSE

@@ -0,0 +1,42 @@
+Copyright (c) 2026, The Board of Trustees of the Leland Stanford
+Junior University, through SLAC National Accelerator Laboratory
+(subject to receipt of any required approvals from the U.S. Dept. of
+Energy). All rights reserved. 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 Leland Stanford Junior University, SLAC
+National Accelerator Laboratory, U.S. Dept. of Energy 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
+OWNER, THE UNITED STATES GOVERNMENT, 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.
+
+You are under no obligation whatsoever to provide any bug fixes,
+patches, or upgrades to the features, functionality or performance of
+the source code ("Enhancements") to anyone; however, if you choose to
+make your Enhancements available either publicly, or directly to SLAC
+National Accelerator Laboratory, without imposing a separate written
+license agreement for such Enhancements, then you hereby grant the
+following license: a non-exclusive, royalty-free perpetual license to
+install, use, modify, prepare derivative works, incorporate into other
+computer software, distribute, and sublicense such Enhancements or
+derivative works thereof, in binary and source code form.

pvua-1.0.1/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: pvua
+Version: 1.0.1
+Summary: A light wrapper around p4p and pyepics.
+Author-email: Laura Lewis <lxlewis@slac.stanford.edu>, Jeremy Lorelli <lorelli@slac.stanford.edu>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/slac-epics/pvua
+Project-URL: Issues, https://github.com/slac-epics/pvua/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: p4p
+Requires-Dist: pyepics
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Provides-Extra: test
+Requires-Dist: caproto[standard]; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# PV Unified Access
+
+[DOE Code](https://www.osti.gov/doecode/biblio/192186)
+
+A light wrapper around p4p and pyepics.
+
+## Installation
+
+A package on PyPI will be provided shortly. In the meantime, install with pip using the following command:
+
+```
+python -m pip install git+https://github.com/slac-epics/pvua.git
+```
+
+## CLI
+
+When the package is installed, new commands will be added that call into it.
+
+- `pvuaget <PV name> [ca/pva]`
+- `pvuainfo <PV name> [ca/pva]`
+  - Currently only Channel Access is supported for the info command.
+- `pvuaput <PV name> <PV value> [ca/pva]`
+
+If no provider is specified, both CA and PVA will be tried, with PVA tried first.
+
+The following command will run the "universal" interface that the installed commands hook into:
+
+```
+python -m pvua.cli <get/info/put> <ca/pva/unknown> <PV name> <value (if put specified)>
+```
+
+## Development
+
+### Guidelines
+
+Contributors should note the primary focus of the library is supporting PyEPICS functionality relying on both PyEPICS and p4p,
+although features outside this scope will be considered.
+
+### Installation
+
+Clone this repository locally, then install an editable copy of the library with test dependencies.
+
+```
+python -m pip install -e .[test]
+```
+
+### Testing
+
+The following command will start a test IOC that serves three commands, which the CLI and library
+can interact with. This requires the test dependencies to be installed.
+
+```
+python -m pvua.test.server
+```
+
+## Copyright Notice
+            
+COPYRIGHT © SLAC National Accelerator Laboratory. All rights reserved. 
+This work is supported [in part] by the U.S. Department of Energy, Office of Basic Energy Sciences under contract DE-AC02-76SF00515.
+
+## Usage Restrictions
+
+Neither the name of the Leland Stanford Junior University, SLAC National Accelerator Laboratory, U.S. Department of Energy 
+nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

pvua-1.0.1/README.md

@@ -0,0 +1,64 @@
+# PV Unified Access
+
+[DOE Code](https://www.osti.gov/doecode/biblio/192186)
+
+A light wrapper around p4p and pyepics.
+
+## Installation
+
+A package on PyPI will be provided shortly. In the meantime, install with pip using the following command:
+
+```
+python -m pip install git+https://github.com/slac-epics/pvua.git
+```
+
+## CLI
+
+When the package is installed, new commands will be added that call into it.
+
+- `pvuaget <PV name> [ca/pva]`
+- `pvuainfo <PV name> [ca/pva]`
+  - Currently only Channel Access is supported for the info command.
+- `pvuaput <PV name> <PV value> [ca/pva]`
+
+If no provider is specified, both CA and PVA will be tried, with PVA tried first.
+
+The following command will run the "universal" interface that the installed commands hook into:
+
+```
+python -m pvua.cli <get/info/put> <ca/pva/unknown> <PV name> <value (if put specified)>
+```
+
+## Development
+
+### Guidelines
+
+Contributors should note the primary focus of the library is supporting PyEPICS functionality relying on both PyEPICS and p4p,
+although features outside this scope will be considered.
+
+### Installation
+
+Clone this repository locally, then install an editable copy of the library with test dependencies.
+
+```
+python -m pip install -e .[test]
+```
+
+### Testing
+
+The following command will start a test IOC that serves three commands, which the CLI and library
+can interact with. This requires the test dependencies to be installed.
+
+```
+python -m pvua.test.server
+```
+
+## Copyright Notice
+            
+COPYRIGHT © SLAC National Accelerator Laboratory. All rights reserved. 
+This work is supported [in part] by the U.S. Department of Energy, Office of Basic Energy Sciences under contract DE-AC02-76SF00515.
+
+## Usage Restrictions
+
+Neither the name of the Leland Stanford Junior University, SLAC National Accelerator Laboratory, U.S. Department of Energy 
+nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

pvua-1.0.1/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pvua"
+version = "1.0.1"
+authors = [
+    { name="Laura Lewis",    email="lxlewis@slac.stanford.edu" },
+    { name="Jeremy Lorelli", email="lorelli@slac.stanford.edu" },
+]
+description = "A light wrapper around p4p and pyepics."
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+dependencies = [
+    "p4p",
+    "pyepics",
+]
+
+[project.optional-dependencies]
+docs = [
+    "sphinx",
+]
+test = [
+    "caproto[standard]",
+    "pytest",
+]
+
+[project.scripts]
+pvuaget = "pvua.cli:cli_get_entrypoint"
+pvuainfo = "pvua.cli:cli_info_entrypoint"
+pvuaput = "pvua.cli:cli_put_entrypoint"
+pvuamonitor = "pvua.cli:cli_monitor_entrypoint"
+
+[project.urls]
+Homepage = "https://github.com/slac-epics/pvua"
+Issues = "https://github.com/slac-epics/pvua/issues"

pvua-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pvua-1.0.1/src/pvua/__init__.py

@@ -0,0 +1,5 @@
+from pvua.context import Provider, Context
+from pvua.pv import PV
+
+
+__all__ = ["Provider", "Context", "PV"]

pvua-1.0.1/src/pvua/cli.py

@@ -0,0 +1,80 @@
+from datetime import datetime
+import sys
+import time
+
+from .context import Context, Provider
+
+
+def str_to_provider(provider: str) -> Provider:
+    match provider.lower():
+        case "pva":
+            return Provider.PVA
+        case "ca":
+            return Provider.CA
+        case _:
+            return Provider.UNKNOWN
+
+
+def cli_universal(command: str, provider: Provider, pvname: str, pv_value: str | None = None) -> int:
+    ctx = Context()
+
+    match command:
+        case "get":
+            timevars = ctx.get_timevars(pvname, provider_override=provider)
+            ms, ns = divmod((int(timevars['posixseconds'] * 1_000_000_000) + timevars['nanoseconds']) // 1_000_000, 1_000)
+            print(f"{pvname}\t{ctx.get(pvname, provider_override=provider)}\t{datetime.fromtimestamp(ms).strftime(f"%Y:%m:%d %H:%M:%S.{ns:03d}")}")
+        case "info":
+            if provider == Provider.PVA:
+                print("Info command unimplemented for PVA.")
+                return 1
+            else:
+                print(f"{ctx.info_ca(pvname)}")
+        case "put":
+            ctx.put(pvname, pv_value, provider_override=provider)
+        case "monitor":
+            ctx.monitor(pvname, callback=lambda **kwargs: print(kwargs["pvname"] + " " + str(kwargs["value"])), provider_override=provider)
+            try:
+                while True:
+                    time.sleep(0.25)
+            except KeyboardInterrupt:
+                pass
+        case _:
+            print(f"Unknown command: {command}")
+            return 1
+    return 0
+
+
+def cli_get_entrypoint() -> int:
+    if len(sys.argv) < 2:
+        print("Usage: <PV name> [ca/pva]")
+        return 1
+    return cli_universal("get", str_to_provider(sys.argv[2].strip()) if len(sys.argv) > 2 else Provider.UNKNOWN, sys.argv[1].strip())
+
+
+def cli_info_entrypoint() -> int:
+    if len(sys.argv) < 2:
+        print("Usage: <PV name> [ca/pva]")
+        return 1
+    return cli_universal("info", str_to_provider(sys.argv[2].strip()) if len(sys.argv) > 2 else Provider.UNKNOWN, sys.argv[1].strip())
+
+
+def cli_put_entrypoint() -> int:
+    if len(sys.argv) < 3:
+        print("Usage: <PV name> <PV value> [ca/pva]")
+        return 1
+    return cli_universal("put", str_to_provider(sys.argv[3].strip()) if len(sys.argv) > 3 else Provider.UNKNOWN, sys.argv[1].strip(), sys.argv[2].strip())
+
+
+def cli_monitor_entrypoint() -> int:
+    if len(sys.argv) < 2:
+        print("Usage: <PV name> [ca/pva]")
+        return 1
+    return cli_universal("monitor", str_to_provider(sys.argv[2].strip()) if len(sys.argv) > 2 else Provider.UNKNOWN, sys.argv[1].strip())
+
+
+if __name__ == "__main__":
+    if len(sys.argv) < 4:
+        print("Usage: <get/info/put/monitor> <ca/pva/unknown> <PV name> <value (if put specified)>")
+        sys.exit(1)
+
+    sys.exit(cli_universal(sys.argv[1].strip(), str_to_provider(sys.argv[2].strip()), sys.argv[3].strip(), sys.argv[4].strip() if len(sys.argv) > 4 else None))