Initial Commit

Data.py

@@ -0,0 +1,109 @@
+import logging
+from typing import Any
+
+from .DataValidation import DataValidation, ValidationError
+from .Helpers import load_data_file as helpers_load_data_file
+
+from .hooks.Data import \
+    after_load_game_file, \
+    after_load_item_file, after_load_location_file, \
+    after_load_event_file, \
+    after_load_region_file, after_load_category_file, \
+    after_load_option_file, after_load_meta_file
+
+# blatantly copied from the minecraft ap world because why not
+def load_data_file(*args) -> dict:
+    logging.warning("Deprecated usage of importing load_data_file from Data.py uses the one from Helper.py instead")
+    return helpers_load_data_file(*args)
+
+def convert_to_list(data, property_name: str) -> list:
+    if isinstance(data, dict):
+        data = data.get(property_name, [])
+    return data
+
+class ManualFile:
+    filename: str
+    data_type: dict|list
+
+    def __init__(self, filename, data_type):
+        self.filename = filename
+        self.data_type = data_type
+
+    def load(self):
+        contents = helpers_load_data_file(self.filename)
+
+        if not contents and type(contents) != self.data_type:
+            return self.data_type()
+
+        return contents
+
+
+game_table: dict[str, Any] = ManualFile('game.json', dict).load() #dict
+item_table: list[dict[str, Any]] = convert_to_list(ManualFile('items.json', list).load(), 'data') #list
+location_table: list[dict[str, Any]] = convert_to_list(ManualFile('locations.json', list).load(), 'data') #list
+event_table: list[dict[str, Any]] = convert_to_list(ManualFile('events.json', list).load(), 'data') #list
+region_table: dict[str, Any] = ManualFile('regions.json', dict).load() #dict
+category_table: dict[str, Any] = ManualFile('categories.json', dict).load() #dict
+option_table: dict[str, Any] = ManualFile('options.json', dict).load() #dict
+meta_table: dict[str, Any] = ManualFile('meta.json', dict).load() #dict
+
+# Removal of schemas in root of tables
+region_table.pop('$schema', '')
+category_table.pop('$schema', '')
+
+# hooks
+game_table = after_load_game_file(game_table)
+item_table = after_load_item_file(item_table)
+location_table = after_load_location_file(location_table)
+event_table = after_load_event_file(event_table)
+region_table = after_load_region_file(region_table)
+category_table = after_load_category_file(category_table)
+option_table = after_load_option_file(option_table)
+meta_table = after_load_meta_file(meta_table)
+
+# seed all of the tables for validation
+DataValidation.game_table = game_table
+DataValidation.item_table = item_table
+DataValidation.location_table = location_table
+DataValidation.event_table = event_table
+DataValidation.region_table = region_table
+
+# Add UT's glitch item if required
+if game_table.get("glitches_item_name"):
+    DataValidation.event_table = DataValidation.event_table + [{"name": game_table["glitches_item_name"]}]
+
+# might as well save this for other uses in tests
+DataValidation.location_name_to_location = {l.get("name", f"unknown location {key}"): l for key, l in enumerate(DataValidation.location_table)}
+# since "copy_location" just changes data its handled here to simplify things
+for key, event in enumerate(event_table):
+    if "copy_location" in event:
+        if event["copy_location"] not in DataValidation.location_name_to_location.keys():
+            raise KeyError(f"Event {event.get('name', f'unnamed event #{key}')} tried to copy a location named {event['copy_location']} but its misspelled or does not exist.")
+
+        event_table[key] = DataValidation.location_name_to_location[event["copy_location"]] | event
+        DataValidation.event_table[key] = event_table[key]
+
+DataValidation.item_table_with_events = DataValidation.item_table + DataValidation.event_table
+DataValidation.location_table_with_events = DataValidation.location_table + DataValidation.event_table
+
+validation_errors = []
+
+# check that json files are not just invalid json
+try: DataValidation.checkForGameBeingInvalidJSON()
+except ValidationError as e: validation_errors.append(e)
+
+try: DataValidation.checkForItemsBeingInvalidJSON()
+except ValidationError as e: validation_errors.append(e)
+
+try: DataValidation.checkForLocationsBeingInvalidJSON()
+except ValidationError as e: validation_errors.append(e)
+
+
+############
+# If there are any validation errors, display all of them at once
+############
+
+if len(validation_errors) > 0:
+    logging.error("\nValidationError(s): \n\n%s\n\n" % ("\n".join([' - ' + str(validation_error) for validation_error in validation_errors])))
+    print("\n\nYou can close this window.\n")
+    keeping_terminal_open = input("If you are running from a terminal, press Ctrl-C followed by ENTER to break execution.")