updated object file generator

generators/objects/objects.py

@@ -1,22 +1,18 @@
-#! /usr/bin/env python3
-"""
-@file   objects.py
-@brief  Part of the Mission Information Base Exporter for the SOURCE project by KSat.
-@details
+"""Part of the Mission Information Base Exporter for the SOURCE project by KSat.
 Object exporter.
-To use MySQLdb, run pip install mysqlclient or install in IDE.
-On Windows, Build Tools installation might be necessary
-@data   21.11.2019
 """
 import datetime
 
-from fsfwgen.objects.objects import sql_object_exporter, ObjectDefinitionParser, write_translation_file, \
+from fsfwgen.core import get_console_logger
+from fsfwgen.objects.objects import sql_object_exporter, ObjectDefinitionParser, \
+    write_translation_file, \
     export_object_file, write_translation_header_file
 from fsfwgen.utility.printer import PrettyPrinter
 from fsfwgen.utility.file_management import copy_file, move_file
 
-from definitions import BspType, DATABASE_NAME
+from definitions import BspType, DATABASE_NAME, OBSW_ROOT_DIR, ROOT_DIR
 
+LOGGER = get_console_logger()
 DATE_TODAY = datetime.datetime.now()
 DATE_STRING_FULL = DATE_TODAY.strftime("%Y-%m-%d %H:%M:%S")
 
@@ -31,23 +27,23 @@ GENERATE_HEADER = True
 BSP_SELECT = BspType.BSP_Q7S
 BSP_DIR_NAME = BSP_SELECT.value
 if BSP_SELECT == BspType.BSP_Q7S or BSP_SELECT == BspType.BSP_LINUX_BOARD:
-    FSFW_CONFIG_ROOT = f"../../linux/fsfwconfig"
+    FSFW_CONFIG_ROOT = f"{OBSW_ROOT_DIR}/linux/fsfwconfig"
 else:
-    FSFW_CONFIG_ROOT = f"../../{BSP_DIR_NAME}/fsfwconfig"
+    FSFW_CONFIG_ROOT = f"{OBSW_ROOT_DIR}/{BSP_DIR_NAME}/fsfwconfig"
 
 EXPORT_TO_SQL = True
 
 CPP_COPY_DESTINATION = f"{FSFW_CONFIG_ROOT}/objects/"
-CSV_MOVE_DESTINATION = "../"
-CPP_FILENAME = "translateObjects.cpp"
-CPP_H_FILENAME = "translateObjects.h"
+CSV_MOVE_DESTINATION = f"{ROOT_DIR}"
+CPP_FILENAME = f'{__package__}/translateObjects.cpp'
+CPP_H_FILENAME = f'{__package__}/translateObjects.h'
 CSV_OBJECT_FILENAME = f"{BSP_SELECT.value}_objects.csv"
 FILE_SEPARATOR = ";"
 
 
 OBJECTS_PATH = f"{FSFW_CONFIG_ROOT}/objects/systemObjectList.h"
-FRAMEWORK_OBJECT_PATH = "../../fsfw/objectmanager/frameworkObjects.h"
-COMMON_OBJECTS_PATH = "../../common/config/commonObjects.h"
+FRAMEWORK_OBJECT_PATH = f'{OBSW_ROOT_DIR}/fsfw/src/fsfw/objectmanager/frameworkObjects.h'
+COMMON_OBJECTS_PATH = f'{OBSW_ROOT_DIR}/common/config/commonObjects.h'
 OBJECTS_DEFINITIONS = [OBJECTS_PATH, FRAMEWORK_OBJECT_PATH, COMMON_OBJECTS_PATH]
 
 SQL_DELETE_OBJECTS_CMD = """
@@ -68,33 +64,33 @@ VALUES(?,?)
 """
 
 
-def main():
-    print("Parsing objects: ")
-    list_items = parse_objects()
-    handle_file_export(list_items)
-    if EXPORT_TO_SQL:
-        print("ObjectParser: Exporting to SQL")
-        sql_object_exporter(
-            object_table=list_items, delete_cmd=SQL_DELETE_OBJECTS_CMD, insert_cmd=SQL_INSERT_INTO_OBJECTS_CMD,
-            create_cmd=SQL_CREATE_OBJECTS_CMD, db_filename=f"../{DATABASE_NAME}"
-        )
-
-
-def parse_objects():
+def parse_objects(print_object_list: bool = True):
     # fetch objects
     object_parser = ObjectDefinitionParser(OBJECTS_DEFINITIONS)
     subsystem_definitions = object_parser.parse_files()
     # id_subsystem_definitions.update(framework_subsystem_definitions)
     list_items = sorted(subsystem_definitions.items())
-    PrettyPrinter.pprint(list_items)
-    print("ObjectParser: Number of objects: ", len(list_items))
-    return list_items
+    LOGGER.info(f'ObjectParser: Number of objects: {len(list_items)}')
+
+    if print_object_list:
+        PrettyPrinter.pprint(list_items)
+
+    handle_file_export(list_items)
+    if EXPORT_TO_SQL:
+        LOGGER.info('ObjectParser: Exporting to SQL')
+        sql_object_exporter(
+            object_table=list_items, delete_cmd=SQL_DELETE_OBJECTS_CMD,
+            insert_cmd=SQL_INSERT_INTO_OBJECTS_CMD,
+            create_cmd=SQL_CREATE_OBJECTS_CMD, db_filename=f"{ROOT_DIR}/{DATABASE_NAME}"
+        )
 
 
 def handle_file_export(list_items):
     if GENERATE_CPP:
-        print("ObjectParser: Generating translation C++ file.")
-        write_translation_file(filename=CPP_FILENAME, list_of_entries=list_items, date_string_full=DATE_STRING_FULL)
+        LOGGER.info('ObjectParser: Generating translation C++ file')
+        write_translation_file(
+            filename=CPP_FILENAME, list_of_entries=list_items, date_string_full=DATE_STRING_FULL
+        )
         if COPY_CPP:
             print("ObjectParser: Copying object file to " + CPP_COPY_DESTINATION)
             copy_file(CPP_FILENAME, CPP_COPY_DESTINATION)
@@ -103,10 +99,6 @@ def handle_file_export(list_items):
         copy_file(filename=CPP_H_FILENAME, destination=CPP_COPY_DESTINATION)
     if GENERATE_CSV:
         print("ObjectParser: Generating text export.")
-        export_object_file(filename=CSV_OBJECT_FILENAME, object_list=list_items, file_separator=FILE_SEPARATOR)
-        if MOVE_CSV:
-            move_file(file_name=CSV_OBJECT_FILENAME, destination=CSV_MOVE_DESTINATION)
-
-
-if __name__ == "__main__":
-    main()
+        export_object_file(
+            filename=CSV_OBJECT_FILENAME, object_list=list_items, file_separator=FILE_SEPARATOR
+        )