yamcs-cli 1.4.15__py3-none-any.whl → 1.4.16__py3-none-any.whl

yamcs/cli/alarms.py

@@ -1,12 +1,39 @@
+import binascii
 from itertools import islice
 from typing import Any, List
 
-from yamcs.client import YamcsClient
+from yamcs.client import EventAlarm, ParameterAlarm, YamcsClient
 
 from yamcs.cli import utils
 from yamcs.cli.completers import ProcessorCompleter
 
 
+def format_parameter_trip_value(alarm: ParameterAlarm):
+    # Complicated condition to workaround a seen use case
+    # where the alarm table contains no trigger value
+    # (which should really not occur)
+    if alarm._proto.parameterDetail.HasField("triggerValue"):
+        val = alarm.trigger_value.eng_value
+        if isinstance(val, bool):
+            return str(val).lower()
+        elif isinstance(val, (bytes, bytearray)):
+            return str(binascii.hexlify(val), "ascii")
+        else:
+            return str(alarm.trigger_value.eng_value)
+    else:
+        return None
+
+
+def format_event_trip_value(alarm: EventAlarm):
+    # Complicated condition to workaround a seen use case
+    # where the alarm table contains no trigger value
+    # (which should really not occur)
+    if alarm._proto.eventDetail.HasField("triggerEvent"):
+        return alarm.trigger_event.message
+    else:
+        return None
+
+
 class AlarmsCommand(utils.Command):
     def __init__(self, parent):
         super(AlarmsCommand, self).__init__(parent, "alarms", "Manage alarms")
@@ -114,15 +141,43 @@ class AlarmsCommand(utils.Command):
         instance = opts.require_instance()
         processor = client.get_processor(instance, args.processor)
 
-        rows: List[List[Any]] = [["TIME", "NAME", "SEQNO", "SEVERITY"]]
-        for alarm in processor.list_alarms():
-            row = [
-                alarm.trigger_time,
-                alarm.name,
-                alarm.sequence_number,
-                alarm.severity,
+        rows: List[List[Any]] = [
+            [
+                "TIME",
+                "TYPE",
+                "SUBJECT",
+                "SEQNO",
+                "SEVERITY",
+                "TRIP VALUE",
+                "SAMPLE COUNT",
+                "VIOLATION COUNT",
             ]
-            rows.append(row)
+        ]
+        for alarm in processor.list_alarms():
+            if isinstance(alarm, ParameterAlarm):
+                row = [
+                    alarm.trigger_time,
+                    "PARAMETER",
+                    alarm.name,
+                    alarm.sequence_number,
+                    alarm.severity,
+                    format_parameter_trip_value(alarm),
+                    alarm.count,
+                    alarm.violation_count,
+                ]
+                rows.append(row)
+            elif isinstance(alarm, EventAlarm):
+                row = [
+                    alarm.trigger_time,
+                    "EVENT",
+                    alarm.name,
+                    alarm.sequence_number,
+                    alarm.severity,
+                    format_event_trip_value(alarm),
+                    alarm.count,
+                    alarm.violation_count,
+                ]
+                rows.append(row)
         utils.print_table(rows)
 
     def log(self, args):
@@ -151,15 +206,51 @@ class AlarmsCommand(utils.Command):
         if most_recent_only:
             iterator = reversed(list(islice(iterator, 0, int(args.lines))))
 
-        rows: List[List[Any]] = [["TIME", "NAME", "SEQNO", "SEVERITY"]]
-        for alarm in iterator:
-            row = [
-                alarm.trigger_time,
-                alarm.name,
-                alarm.sequence_number,
-                alarm.severity,
+        rows: List[List[Any]] = [
+            [
+                "TIME",
+                "TYPE",
+                "SUBJECT",
+                "SEQNO",
+                "SEVERITY",
+                "TRIP VALUE",
+                "SAMPLE COUNT",
+                "VIOLATION COUNT",
             ]
-            rows.append(row)
+        ]
+        for alarm in iterator:
+
+            # Avoid defaulting to WATCH severity if severity is not set.
+            # It 'should' always be set, however it has been seen missing
+            # for unknown reason.
+            severity = alarm.severity if alarm._proto.HasField("severity") else None
+
+            if isinstance(alarm, ParameterAlarm):
+                trip_value = format_parameter_trip_value(alarm)
+                row = [
+                    alarm.trigger_time,
+                    "PARAMETER",
+                    alarm.name,
+                    alarm.sequence_number,
+                    "-" if severity is None else severity,
+                    "-" if trip_value is None else trip_value,
+                    alarm.count,
+                    alarm.violation_count,
+                ]
+                rows.append(row)
+            elif isinstance(alarm, EventAlarm):
+                trip_value = format_event_trip_value(alarm)
+                row = [
+                    alarm.trigger_time,
+                    "EVENT",
+                    alarm.name,
+                    alarm.sequence_number,
+                    "-" if severity is None else severity,
+                    "-" if trip_value is None else trip_value,
+                    alarm.count,
+                    alarm.violation_count,
+                ]
+                rows.append(row)
         utils.print_table(rows)
 
     def acknowledge(self, args):

yamcs/cli/dbshell.py

@@ -44,9 +44,11 @@ class DbShellOptions:
         self.column_names = not args.skip_column_names
         self.binary_as_hex = not args.batch or args.binary_as_hex
         self.histfile = os.path.join(utils.CONFIG_DIR, "history")
+        self.exit_on_error = False
 
         if args.batch or args.command:
             self.histfile = None
+            self.exit_on_error = True
 
 
 class DbShellCommand(utils.Command):
@@ -250,7 +252,7 @@ class DbShell(cmd.Cmd):
             print()
 
     def emptyline(self):
-        pass  # Override default behaviour of repeating the last command
+        return False  # Override default behaviour of repeating the last command
 
     def do_delimiter(self, args):
         """(\\d) Set statement delimiter."""
@@ -301,8 +303,9 @@ class DbShell(cmd.Cmd):
                     results = archive.execute_sql(statement)
                     self.paginate(results)
         except YamcsError as e:
-            eprint(e)
-            sys.exit(1)
+            eprint("\n".join("*** " + line for line in str(e).splitlines()))
+            if self.opts.exit_on_error:
+                sys.exit(1)
 
     def run_command(self, command):
         if command == "\\":

yamcs/cli/events.py

@@ -20,7 +20,7 @@ class EventsCommand(utils.Command):
             "-m", "--message", metavar="MESSAGE", type=str, help="event message"
         )
         subparser.add_argument(
-            "--date", metavar="DATE", type=str, help="Override the event time"
+            "--date", metavar="DATE", type=str, help="Set an explicit event time"
         )
         subparser.add_argument(
             "--sequence-number",

yamcs/cli/parameters.py

@@ -50,7 +50,7 @@ class ParametersCommand(utils.Command):
             "--processor", type=str, help="name of the processor", default="realtime"
         ).completer = ProcessorCompleter
         subparser.add_argument(
-            "--date", metavar="DATE", type=str, help="Override the event time"
+            "--date", metavar="DATE", type=str, help="Set an explicit generation time"
         )
         subparser.add_argument(
             "parameter", metavar="PARAMETER", type=str, help="name of the parameter"

{yamcs_cli-1.4.15.dist-info → yamcs_cli-1.4.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yamcs-cli
-Version: 1.4.15
+Version: 1.4.16
 Summary: Yamcs Command-Line Tools
 Home-page: https://github.com/yamcs/yamcs-cli
 Author: Space Applications Services
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown

{yamcs_cli-1.4.15.dist-info → yamcs_cli-1.4.16.dist-info}/RECORD

@@ -1,13 +1,13 @@
 yamcs/cli/__main__.py,sha256=GiDQy_LTHUdc6sNoWNDw90jS8qCjPCWr2Aq5hPDS3_E,4356
-yamcs/cli/alarms.py,sha256=cHLwveHqvpnLHddktGA5LCyOt9FRljcwid9Q7TYd5FI,7126
+yamcs/cli/alarms.py,sha256=Y9rw5nJqRcS-_DqRr8SIBwCuo9xb2QkjUOhS99K0Im0,10342
 yamcs/cli/algorithms.py,sha256=Oqw0tiIv_mmK7smPYIdI00uUfM2KxHMbrySGi8Ywlcc,1622
 yamcs/cli/bash_completion.sh,sha256=sQOPhbykD68uMYkcWudqJNJKuSQh2Blzozt2kkawRo4,1032
 yamcs/cli/commands.py,sha256=ANOyAIeMDhJkk7hNyYAkwqjWDfFIpKpfR-fLkSxmEj0,6465
 yamcs/cli/completers.py,sha256=tteufAU2XeS2rATY8jQ5L4fxlUtbPq1Lj2NSxZvQgU4,4445
 yamcs/cli/config.py,sha256=WeuE6rfRSGt7f5nuD2tJmH_gXl5RSPlLRvufnWj4IGM,2996
 yamcs/cli/containers.py,sha256=vjFoqeAd8Qzw-jp0XxO_HVi2852OEUz3mmtdrBAVqHE,1621
-yamcs/cli/dbshell.py,sha256=p86OUmwe1IGAqbxFdc1iXYeUDwkgZi4Bhlxfe7OhRUo,16719
-yamcs/cli/events.py,sha256=waOT7Is909EOWE1uqXla8G2QGXJXf7MstUgYjVufzs4,5617
+yamcs/cli/dbshell.py,sha256=v8-CNT3dht48cttDJRcm4PZxrxW123cRznUOQFBH_vw,16899
+yamcs/cli/events.py,sha256=jKLSUlO6W34kytyXDeiZMjQA8q98MTrFZ0p9XzaxgvY,5620
 yamcs/cli/exceptions.py,sha256=0RcpLLR_jubALmuSlZ1DQ0KUcfKadOl-1VRPi0LxHSw,238
 yamcs/cli/instances.py,sha256=RBfHQUGZB4hU_MGdhPmZgzO_WkA2Sj54KpxT7BSyLeQ,2119
 yamcs/cli/links.py,sha256=RmdeYLqC1agtORso2T8MUcgp3f-zJKIfeb0UsupsXzc,3330
@@ -15,7 +15,7 @@ yamcs/cli/login.py,sha256=VAIE--YGiCTwf8D79L3dHKKtTlmdSFcgkUcR37CwVzY,4969
 yamcs/cli/logout.py,sha256=XgIdxuAUHQ5VbPP6sZwN88cAvWQEm7GBPfvYj6vn9Rg,562
 yamcs/cli/packets.py,sha256=am8CZxJWpqsWtA3wqSBuD3xck8uv0dYkAYfdwnfimOM,4860
 yamcs/cli/parameter_archive.py,sha256=KWdrtHXygGJNPhbAyHK5itxBAl1YqAwgQnkoDsd_5c4,3999
-yamcs/cli/parameters.py,sha256=ZDOfLly5gzKoUvfvg9vbDLMh_NYnh3mBi95n_sZCjSY,6012
+yamcs/cli/parameters.py,sha256=nalEjz0hSM1lfa8cGYg_fx-NgV2r17vaOP2WG806BVo,6020
 yamcs/cli/processors.py,sha256=9BJlQywmq6x_ea3tWT66dB2wBry9divqWhG3VWKM6Nw,1988
 yamcs/cli/rocksdb.py,sha256=28VjE9ldHUrGCxMeNNOn8FhnvdRJbiMlKjnjErgrl1k,1947
 yamcs/cli/services.py,sha256=4sE7vOB977EmNfA4X9YJSyi3bSmhfqOj3cScGYGR4Lc,2171
@@ -31,9 +31,9 @@ yamcs/cli/protobuf/replication_pb2.py,sha256=0YzH8bVPi2DNmHcgxyv9m_XuhYnH83U0O6k
 yamcs/cli/protobuf/security_pb2.py,sha256=SbVHS7ghG_JDbZ_35p8GwVnV-3HuwNOGAWRVhFoWbPE,21569
 yamcs/cli/protobuf/tablespace_pb2.py,sha256=DLYPDKOgLm1xeZAT5F7WMLaGQJM_npeYfpZAFMSM6OU,37008
 yamcs/cli/protobuf/timeline_pb2.py,sha256=JUl7sGOYMS8IP6h0hCOCrQz8BaBtvxjf6lY7cpDYcfg,5004
-yamcs_cli-1.4.15.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-yamcs_cli-1.4.15.dist-info/METADATA,sha256=qW6I5UpXfZvRpNJvwxtdcuvu5-XG9Jhoypuhw9AkpaM,1695
-yamcs_cli-1.4.15.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-yamcs_cli-1.4.15.dist-info/entry_points.txt,sha256=M6Juk3MbdDMR1v3htR2aHEebitGHW-E3ujHmYQLwEas,50
-yamcs_cli-1.4.15.dist-info/top_level.txt,sha256=EsFTpWxnHBl6f_5Wf-CrENGPSoY7xP4T-JpgBMwsk8Q,6
-yamcs_cli-1.4.15.dist-info/RECORD,,
+yamcs_cli-1.4.16.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+yamcs_cli-1.4.16.dist-info/METADATA,sha256=GeIgyg7eFjG9MjQYBLwvJOaEfOYP44oCkTXeqHKjV8Q,1746
+yamcs_cli-1.4.16.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+yamcs_cli-1.4.16.dist-info/entry_points.txt,sha256=M6Juk3MbdDMR1v3htR2aHEebitGHW-E3ujHmYQLwEas,50
+yamcs_cli-1.4.16.dist-info/top_level.txt,sha256=EsFTpWxnHBl6f_5Wf-CrENGPSoY7xP4T-JpgBMwsk8Q,6
+yamcs_cli-1.4.16.dist-info/RECORD,,