DP Write Fix & Refactor for Easier Usage as a Library (#265)

* Remove annotation field from record & container structs

* Break data_product_writer self.process() into 2 functions for use as library

* Add `fdp` to expect.txt

* Remove printing of record.id for every record

Author: Willmac16

.github/actions/spelling/expect.txt

@@ -140,6 +140,7 @@ exts
 fastentrypoints
 fbuild
 fd
+fdp
 FEEDNAME
 feq
 FFCC

src/fprime_gds/executables/data_product_writer.py

@@ -264,13 +264,11 @@ class RecordStruct(BaseModel):
     type: Union[AliasType, StructType, ArrayType, IntegerType, FloatType, BoolType, QualifiedType, StringType]
     array: bool
     id: int
-    annotation: str
 
 class ContainerStruct(BaseModel):
     name: str
     id: int
     defaultPriority: int
-    annotation: str
 
 # -------------------------------------------------------------------------------------
 # These Pydantic classes define the FPRIME_DICTIONARY_FILE
@@ -771,7 +769,6 @@ def get_record_data(self, headerJSON: DPHeader, dictJSON: FprimeDict) -> Dict[st
         rootDict['dataId'] = self.read_field(headerJSON.dataId.underlyingType)
         for record in dictJSON.records:
             if record.id == rootDict['dataId']:    
-                print(f'Processing Record ID {record.id}')
                 if record.array:
                     dataSize = self.read_field(headerJSON.dataSize.type)
                     rootDict['size'] = dataSize
@@ -844,17 +841,17 @@ def check_record_data(self, dictJSON: FprimeDict):
                 idSet.add(record.id)
 
 
-
-    # -------------------------------------------------------------------------------------------------------------------------
-    # Function process
+    # ----------------------------------------------------------------------------------------------
+    # Function: get_records
     #
-    # Description: 
-    #   Main processing
-    # -------------------------------------------------------------------------------------------------------------------------
-    def process(self):
-
+    # Description:
+    #   Reads all the records from the fdp file
+    #
+    # Returns:
+    #   List[Dict[str, obj]]: A list of dictionaries populated with the header followed by all records.
+    # ----------------------------------------------------------------------------------------------
+    def get_records(self):
         try:
-
             # Read the F prime JSON dictionary
             print(f"Parsing {self.jsonDict}...")
             try:
@@ -908,7 +905,20 @@ def process(self):
             msg = f'ValueError in JSON file {error["loc"]}: {error["msg"]}'
             self.handleException(msg)
 
+        return recordList
 
+    # ----------------------------------------------------------------------------------------------
+    # Function: write_records
+    #
+    # Description:
+    #   Writes all records to a json file
+    #
+    # Parameters:
+    #   recordList (List[Dict[str, obj]]): A list of dictionaries populated with the header followed by all records.
+    #
+    # Returns:
+    # ----------------------------------------------------------------------------------------------
+    def write_records(self, recordList):
         # Output the generated json to a file
         baseName = os.path.basename(self.binaryFileName)
         outputJsonFile = os.path.splitext(baseName)[0] + '.json'
@@ -919,6 +929,17 @@ def process(self):
 
         print(f'Output data generated in {outputJsonFile}')
 
+    # -------------------------------------------------------------------------------------------------------------------------
+    # Function process
+    #
+    # Description:
+    #   Main processing: parses records from the fdp file, then writes all records to a json file
+    # -------------------------------------------------------------------------------------------------------------------------
+    def process(self):
+        recordList = self.get_records()
+
+        self.write_records(recordList)
+
 
 # ------------------------------------------------------------------------------------------
 # main program