fprime-gds 3.5.2a1__tar.gz → 3.6.0__tar.gz

fprime_gds-3.6.0/.github/actions/spelling/expect.txt

@@ -0,0 +1,380 @@
+abeautifulsite
+AClass
+addoption
+ADEBAD
+adrianheine
+allbox
+ALLEXTERNALS
+ALOG
+amsmath
+ANamespace
+Anps
+argcomplete
+argdesc
+ARGN
+argname
+argtype
+autoapi
+AUTOBRIEF
+autocoded
+autogen
+autoraise
+autosectionlabel
+backface
+batchmode
+baudrate
+bcolors
+BGR
+Biberstein
+bibtex
+bitmaps
+breadcrumb
+Btns
+BUGLIST
+calibri
+callergraph
+callgraph
+cata
+CCB
+CCFF
+Cdioux
+cdn
+cdxoefg
+CFDG
+CFDP
+CFPD
+chartjs
+CHNG
+classdocs
+clearfix
+cls
+cmdhist
+CODEFILE
+COLORSTYLE
+colorwheel
+columnify
+combuffer
+commandsi
+configs
+Consolas
+creatingdocsetswithdoxygen
+csum
+curateable
+curated
+curating
+customise
+daringfireball
+dataobjects
+dblclick
+Dct
+ddl
+Ded
+deframe
+deframed
+deframer
+deframing
+DEPRECATEDLIST
+DESER
+Deserial
+deserializes
+dests
+dexc
+DGRAM
+diafile
+dimitri
+dinkel
+docbook
+docset
+dontinclude
+DOTFONTPATH
+downfiles
+downlinker
+dox
+doxyfile
+doxygenversion
+doxyindexer
+doxypypy
+doxyrules
+doxysearch
+Doxywizard
+doy
+dps
+dropleft
+dropright
+dropup
+Drv
+Dsh
+dts
+DVI
+ECLIPSEHELP
+ECONNRESET
+ect
+EEXIST
+Efg
+ENDC
+endcond
+errorhandler
+errorrs
+ev
+Evn
+evr
+evt
+extlinks
+exts
+fastentrypoints
+fbuild
+fd
+FEEDNAME
+FFCC
+FFFF
+fileurl
+Firefox
+focusring
+FONTNAME
+FONTPATH
+FONTSIZE
+fpp
+fprime
+fptable
+fsw
+gdiplus
+getbootstrap
+github
+grayscales
+gse
+gtags
+GUIS
+gz
+Haverbeke
+hh
+hhc
+hhk
+hhp
+hidecallergraph
+hidecallgraph
+hideinitializer
+hlp
+HLTH
+hookspecs
+hpaulson
+htags
+hyperlinks
+idct
+idl
+ieeetr
+ified
+ifun
+IH
+inprogress
+intersphinx
+intlimits
+ip
+ipc
+ipp
+itcl
+ixx
+janamian
+Jdk
+jpl
+JSO
+jsonable
+jsonified
+jsonify
+keepalive
+keyify
+kinda
+lestarch
+levelname
+Lezer
+libcrc
+libiconv
+Linting
+LIw
+logdata
+logdir
+logpath
+logselect
+luxon
+makeindex
+MAKEVAR
+marijnh
+matchobj
+mathjax
+mcternan
+MDFILE
+memb
+millis
+misordered
+MML
+moz
+msc
+mscfile
+mscgen
+mstarch
+mx
+mycompany
+nassert
+nbytes
+Neue
+Nify
+ninjaaron
+nitpicky
+noapp
+NOSONAR
+nosort
+nosubgrouping
+Noto
+NSPACES
+nuntil
+odl
+OKBLUE
+OKGREEN
+OMG
+OPREG
+oring
+osexc
+OSX
+outputfile
+packetized
+Paetz
+PARAMDOC
+passthrough
+pb
+pdflatex
+PERLMOD
+pkts
+plainnat
+plantuml
+PNGs
+preds
+prm
+procs
+PROGRAMLISTING
+projectbrief
+projectlogo
+projectname
+projectnumber
+propget
+propput
+px
+py
+qch
+qhelpgenerator
+QHG
+qhp
+qsf
+qthelpproject
+rackerlabs
+rackspace
+rae
+rb
+RCVHWM
+RCVTIMEO
+RDWR
+Readback
+recommonmark
+recuring
+recvd
+recvs
+reder
+removeit
+reqparse
+riverbankcomputing
+Roboto
+rollup
+rpaetz
+rst
+saba
+sdd
+searchdata
+Segoe
+seqfile
+seqgen
+serializables
+serialutil
+showinitializer
+sideeffect
+SIGALRM
+sizeb
+SMAP
+Smath
+SNDHWM
+sorttable
+squashify
+sss
+Ssymbols
+stackoverflow
+startuml
+subgrouping
+subhist
+subhistory
+superpackage
+superpkg
+tabetc
+tagfile
+tcanham
+tcp
+tcpserver
+td
+telem
+TESTLIST
+Theif
+thtcp
+thudp
+timebase
+timescales
+timespan
+timestep
+timestring
+timetype
+tinyseqgen
+TKC
+tlm
+toctree
+TODOLIST
+tooltiptext
+treeview
+tsn
+tstring
+ttl
+tts
+twbs
+typedef'ed
+typedef
+uart
+ucf
+udp
+UIs
+uk
+ul
+UNINIT
+updown
+upfiles
+uplinker
+uplinkvue
+usec
+useconds
+usepackage
+usr
+vh
+vhd
+vhdl
+viewcode
+vle
+vname
+VRuntime
+vw
+Watney
+webified
+webpage
+website
+wikipedia
+WSL
+wx
+xapian
+xhttp
+xl
+xmit
+xy
+zeromq
+zmq

{fprime_gds-3.5.2a1 → fprime_gds-3.6.0}/.github/workflows/spelling.yml

@@ -21,24 +21,33 @@ jobs:
       actions: read
     outputs:
       followup: ${{ steps.spelling.outputs.followup }}
-    runs-on: ubuntu-20.04
-    if: "contains(github.event_name, 'pull_request') || github.event_name == 'push'"
-    concurrency:
-      group: spelling-${{ github.event.pull_request.number || github.ref }}
-      # note: If you use only_check_changed_files, you do not want cancel-in-progress
-      cancel-in-progress: true
+    runs-on: ubuntu-24.04
+    if: ${{ contains(github.event_name, 'pull_request') || github.event_name == 'push' }}
     steps:
     - name: check-spelling
       id: spelling
-      uses: check-spelling/check-spelling@v0.0.20
+      uses: check-spelling/check-spelling@v0.0.24
       with:
         suppress_push_for_open_pull_request: 1
         checkout: true
         post_comment: 0
-        extra_dictionaries:
+        check_extra_dictionaries: ''
+        dictionary_source_prefixes: >
+          {
+          "cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20241114/dictionaries/"
+          }
+        extra_dictionaries: |
           cspell:filetypes/filetypes.txt
           cspell:python/python.txt
+          cspell:python/python/python-lib.txt
+          cspell:python/python/python.txt
+          cspell:python/common/extra.txt
           cspell:django/django.txt
           cspell:html/html.txt
           cspell:fullstack/fullstack.txt
-        check_extra_dictionaries: ''
+          cspell:software-terms/softwareTerms.txt
+          cspell:cpp/stdlib-c.txt
+          cspell:cpp/stdlib-cpp.txt
+          cspell:mnemonics/mnemonics.txt
+          cspell:cpp/ecosystem.txt
+

{fprime_gds-3.5.2a1 → fprime_gds-3.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: fprime-gds
-Version: 3.5.2a1
+Version: 3.6.0
 Summary: F Prime Flight Software Ground Data System layer
 Author-email: Michael Starch <Michael.D.Starch@jpl.nasa.gov>, Thomas Boyer-Chammard <Thomas.Boyer.Chammard@jpl.nasa.gov>
 License: 

{fprime_gds-3.5.2a1 → fprime_gds-3.6.0}/src/fprime_gds/common/data_types/cmd_data.py

@@ -131,9 +131,8 @@ class CmdData(sys_data.SysData):
         else:
             # The arguments are currently serializable objects which cannot be
             # used to fill in a format string. Convert them to values that can be
-            arg_val_list = [arg_obj.val for arg_obj in self.args]
-
-            arg_str = " ".join(str(arg_val_list))
+            arg_val_list = self.get_arg_vals()
+            arg_str = str(arg_val_list)
 
         if verbose and csv:
             return f"{time_str},{raw_time_str},{name},{self.id},{arg_str}"
@@ -149,13 +148,13 @@ class CmdData(sys_data.SysData):
         args = []
         for val, arg_tuple in zip(input_values, self.template.arguments):
             try:
-                _, _, arg_type = arg_tuple
+                arg_name, _, arg_type = arg_tuple
                 arg_value = arg_type()
                 self.convert_arg_value(val, arg_value)
                 args.append(arg_value)
                 errors.append("")
             except Exception as exc:
-                errors.append(str(exc))
+                errors.append(f"{arg_name}[{arg_type.__name__}]: {exc}")
         return args, errors
 
     @staticmethod

{fprime_gds-3.5.2a1 → fprime_gds-3.6.0}/src/fprime_gds/common/loaders/json_loader.py

@@ -178,7 +178,10 @@ class JsonLoader(dict_loader.DictLoader):
             SerializableType: The constructed serializable type.
 
         """
-        struct_members = []
+        # Note on struct_members: the order of the members list matter when calling construct_type() below.
+        # It should be ordered by incrementing index which corresponds to the order in the FPP declaration
+        # The JSON dictionary ordering is not guaranteed, so we use a dict() to sort by index below.
+        struct_members = {}
         for name, member_dict in qualified_type.get("members").items():
             member_type_dict = member_dict["type"]
             member_type_obj = self.parse_type(member_type_dict)
@@ -197,11 +200,17 @@ class JsonLoader(dict_loader.DictLoader):
                 member_type_obj.FORMAT if hasattr(member_type_obj, "FORMAT") else "{}"
             )
             description = member_type_dict.get("annotation", "")
-            struct_members.append((name, member_type_obj, fmt_str, description))
+            member_index = member_dict["index"]
+            if member_index in struct_members:
+                raise KeyError(
+                    f"Invalid dictionary: Duplicate index {member_index} in serializable type {type_name}"
+                )
+            struct_members[member_index] = (name, member_type_obj, fmt_str, description)
 
+        # Construct the serializable type with list of members sorted by index
         ser_type = SerializableType.construct_type(
             type_name,
-            struct_members,
+            [struct_members[i] for i in sorted(struct_members.keys())],
         )
         self.parsed_types[type_name] = ser_type
         return ser_type

{fprime_gds-3.5.2a1 → fprime_gds-3.6.0}/src/fprime_gds/common/transport.py

@@ -241,7 +241,7 @@ class ThreadedTCPSocketClient(ThreadedTransportClient):
         assert self.dest is not None, "Cannot send data before connect call"
         self.sock.send(b"A5A5 %s %s" % (self.dest, data))
 
-    def recv(self, timeout=100):
+    def recv(self, timeout=0.1):
         """Receives data from the threaded tcp server
 
         Receives raw data from the threaded tcp server. This data is expected to have no headers and will be passed as

{fprime_gds-3.5.2a1 → fprime_gds-3.6.0}/src/fprime_gds/flask/commands.py

@@ -49,7 +49,7 @@ class CommandArgumentsInvalidException(werkzeug.exceptions.BadRequest):
     """Command arguments failed to validate properly"""
 
     def __init__(self, errors):
-        super().__init__("Failed to validate all arguments")
+        super().__init__(f"Failed to validate all arguments: {', '.join(errors)}")
         self.args = errors
 
 

{fprime_gds-3.5.2a1 → fprime_gds-3.6.0}/src/fprime_gds/flask/static/addons/commanding/arguments.js

@@ -74,7 +74,7 @@ export function command_argument_assignment_helper(argument, squashed_argument_v
         command_argument_array_serializable_assignment_helper(argument, squashed_argument_value);
     } else {
         let is_not_string = typeof(argument.type.MAX_LENGTH) === "undefined";
-        argument.value = (is_not_string && (squashed_argument_value === FILL_NEEDED)) ? null : squashed_argument_value;
+        argument.value = (is_not_string && (squashed_argument_value === FILL_NEEDED)) ? null : squashed_argument_value.toString();
     }
 }
 
@@ -119,7 +119,21 @@ export function squashify_argument(argument) {
             let field = argument.type.MEMBER_LIST[i][0];
             value[field] = squashify_argument(argument.value[field]);
         }
-    } else if (["U64Type", "U32Type", "U16Type", "U8Type"].indexOf(argument.type.name) != -1) {
+    } else if (["U64Type"].indexOf(argument.type.name) !== -1) {
+        if (argument.value.startsWith("0x")) {
+            // Hexadecimal
+            value = BigInt(argument.value, 16);
+        } else if (argument.value.startsWith("0b")) {
+            // Binary
+            value = BigInt(argument.value.slice(2), 2);
+        } else if (argument.value.startsWith("0o")) {
+            // Octal
+            value = BigInt(argument.value.slice(2), 8);
+        } else {
+            // Decimal
+            value = BigInt(argument.value, 10);
+        }
+    } else if (["U32Type", "U16Type", "U8Type"].indexOf(argument.type.name) !== -1) {
         if (argument.value.startsWith("0x")) {
             // Hexadecimal
             value = parseInt(argument.value, 16);
@@ -134,10 +148,13 @@ export function squashify_argument(argument) {
             value = parseInt(argument.value, 10);
         }
     }
-    else if (["I64Type", "I32Type", "I16Type", "I8Type"].indexOf(argument.type.name) != -1) {
+    else if (["I64Type"].indexOf(argument.type.name) !== -1) {
+        value = BigInt(argument.value, 10);
+    }
+    else if (["I32Type", "I16Type", "I8Type"].indexOf(argument.type.name) !== -1) {
         value = parseInt(argument.value, 10);
     }
-    else if (["F64Type", "F32Type"].indexOf(argument.type.name) != -1) {
+    else if (["F64Type", "F32Type"].indexOf(argument.type.name) !== -1) {
         value = parseFloat(argument.value);
     }
     else if (argument.type.name == "BoolType") {
@@ -160,22 +177,35 @@ export function squashify_argument(argument) {
  * @returns: string to display
  */
 export function argument_display_string(argument) {
-    // Base assignment of the value
-    let string = `${(argument.value == null || argument.value === "") ? FILL_NEEDED: argument.value}`;
-
-    if (argument.type.LENGTH) {
-        string = `[${argument.value.map((argument) => argument_display_string(argument)).join(", ")}]`;
-    } else if (argument.type.MEMBER_LIST) {
-        let fields = [];
-        for (let i = 0; i < argument.type.MEMBER_LIST.length; i++) {
-            let field = argument.type.MEMBER_LIST[i][0];
-            fields.push(`${field}: ${argument_display_string(argument.value[field])}`);
+    let string = FILL_NEEDED;
+    try {
+        // Check for array
+        if (argument.type.LENGTH) {
+            string = `[${argument.value.map((argument) => argument_display_string(argument)).join(", ")}]`;
+        }
+        // Serializable
+        else if (argument.type.MEMBER_LIST) {
+            let fields = [];
+            for (let i = 0; i < argument.type.MEMBER_LIST.length; i++) {
+                let field = argument.type.MEMBER_LIST[i][0];
+                fields.push(`${field}: ${argument_display_string(argument.value[field])}`);
+            }
+            string = `{${fields.join(", ")}}`
+        }
+        // String type
+        else if (argument.type.MAX_LENGTH) {
+            let value = (argument.value == null) ? "" : argument.value;
+            value = value.replace(/"/g, '\\\"');
+            string = `"${value}"`
+        }
+        // Unassigned values
+        else if (argument.value == null || argument.value === "") {
+            string = FILL_NEEDED;
+        } else {
+            string = squashify_argument(argument);
         }
-        string = `{${fields.join(", ")}}`
-    } else if (argument.type.MAX_LENGTH) {
-        let value = (argument.value == null) ? "" : argument.value;
-        value = value.replace(/"/g, '\\\"');
-        string = `"${value}"`
+    } catch (e) {
+        string = FILL_NEEDED;
     }
     return string;
 }
@@ -291,7 +321,7 @@ Vue.component("command-scalar-argument", {
                 return ["text", "0[bB][01]+|0[oO][0-7]+|0[xX][0-9a-fA-F]+|[1-9]\\d*|0", ""];
             }
             else if (["I64Type", "I32Type", "I16Type", "I8Type"].indexOf(this.argument.type.name) != -1) {
-                return ["number", null, "1"];
+                return ["text", "-?[1-9]\\d*|0", ""];
             }
             else if (["F64Type", "F32Type"].indexOf(this.argument.type.name) != -1) {
                 return ["number", null, "any"];

{fprime_gds-3.5.2a1 → fprime_gds-3.6.0}/src/fprime_gds/flask/static/addons/commanding/command-history.js

@@ -10,7 +10,8 @@ import {command_argument_assignment_helper} from "./arguments.js";
 import {listExistsAndItemNameNotInList, timeToString} from "../../js/vue-support/utils.js";
 import {command_history_template} from "./command-history-template.js";
 import {command_display_string} from "./command-string.js";
-
+import { SaferParser } from "../../js/json.js";
+SaferParser.register();
 
 /**
  * command-history:
@@ -103,27 +104,7 @@ Vue.component("command-history", {
             // Can only set command if it is a child of a command input
             if (this.$parent.selectCmd) {
                 // command-input expects an array of strings as arguments
-                this.$parent.selectCmd(cmd.full_name, this.preprocess_args(cmd.args));
-            }
-        },
-        /**
-         * Process the arguments for a command. If the argument is (or contains) a number, it
-         * is converted to a string. Other types that should be pre-processed can be added here.
-         * 
-         * @param {*} args 
-         * @returns args processed for command input (numbers converted to strings)
-         */
-        preprocess_args(args) {
-            if (Array.isArray(args)) {
-                return args.map(el => this.preprocess_args(el));
-            } else if (typeof args === 'object' && args !== null) {
-                return Object.fromEntries(
-                    Object.entries(args).map(([key, value]) => [key, this.preprocess_args(value)])
-                );
-            } else if (typeof args === 'number') {
-                return args.toString();
-            } else {
-                return args;
+                this.$parent.selectCmd(cmd.full_name, cmd.args);
             }
         }
     }

{fprime_gds-3.5.2a1 → fprime_gds-3.6.0}/src/fprime_gds/flask/static/addons/commanding/command-input.js

@@ -15,6 +15,8 @@ import {
 } from "../../addons/commanding/arguments.js";
 import {_settings} from "../../js/settings.js";
 import {command_input_template} from "./command-input-template.js";
+import { SaferParser } from "../../js/json.js";
+SaferParser.register();
 
 /**
  * This helper will help assign command and values in a safe manner by searching the command store, finding a reference,
@@ -38,6 +40,7 @@ function command_assignment_helper(desired_command_name, desired_command_args, p
         return null;
     }
     let selected = _datastore.commands[command_name];
+
     // Set arguments here
     for (let i = 0; i < selected.args.length; i++) {
         let assign_value = (desired_command_args.length > i)? desired_command_args[i] : null;
@@ -147,6 +150,7 @@ Vue.component("command-input", {
          * command reaches the ground system.
          */
         sendCommand() {
+
             // Validate the command before sending anything
             if (!this.validate()) {
                 return;
@@ -158,8 +162,9 @@ Vue.component("command-input", {
             let _self = this;
             _self.active = true;
             let command = this.selected;
+            let squashed_args = command.args.map(serialize_arg);
             this.loader.load("/commands/" + command.full_name, "PUT",
-                {"key":0xfeedcafe, "arguments": command.args.map(serialize_arg)})
+                {"key":0xfeedcafe, "arguments": squashed_args})
                 .then(function() {
                     _self.active = false;
                     // Clear errors, as there is not a problem further

{fprime_gds-3.5.2a1 → fprime_gds-3.6.0}/src/fprime_gds/flask/static/addons/commanding/command-string-template.js

@@ -3,7 +3,8 @@
  *
  * Contains the templates used to render the command string input box.
  */
-export let COMMAND_FORMAT_SPEC = "FULL_COMMAND_NAME[[[, ARG1], ARG2], ...]";
+export let COMMAND_FORMAT_SPEC = "FULL_COMMAND_NAME[[[, ARG1], ARG2], ...] " +
+    "where ARGN is a decimal number, quoted string, or an enumerated constant";
 
 export let command_string_template = `
 <div class="fp-flex-repeater">