Added logging to export stage, fixed issue with exporter not being registered if not present in blender addons list

Author: sdfgeoff

blender_bevy_toolkit/__init__.py

@@ -2,6 +2,10 @@
 import sys
 sys.path.append(os.path.dirname(os.path.abspath(__file__)))
 
+import logging
+from utils import jdict
+logger = logging.getLogger(__name__)
+
 
 import bpy
 from bpy.app.handlers import persistent
@@ -22,6 +26,7 @@
 
 
 
+
 class BevyComponentsPanel(bpy.types.Panel):
     """ The panel in which buttons that add/remove components are shown """
     bl_idname = "OBJECT_PT_bevy_components_panel"
@@ -38,6 +43,7 @@ def draw(self, context):
 
 
 def register():
+    logger.info({"event":"registering_bevy_addon", "state":"start"})
     bpy.utils.register_class(BevyComponentsPanel)
     bpy.utils.register_class(operators.RemoveBevyComponent)
     bpy.utils.register_class(operators.AddBevyComponent)
@@ -46,9 +52,11 @@ def register():
     bpy.app.handlers.load_post.append(load_handler)
 
     bpy.types.TOPBAR_MT_file_export.append(menu_func)
+    logger.info(jdict(event="registering_bevy_addon", state="end"))
 
 
 def unregister():
+    logger.info(jdict(event="unregistering_bevy_addon", state="start"))
     bpy.utils.unregister_class(BevyComponentsPanel)
     bpy.utils.unregister_class(operators.RemoveBevyComponent)
     bpy.utils.unregister_class(operators.AddBevyComponent)
@@ -58,7 +66,9 @@ def unregister():
     bpy.app.handlers.load_post.remove(load_handler)
 
     for component in component_base.COMPONENTS:
+        logger.info(jdict(event="unregistering_component", component=str(component)))
         component.unregister()
+    logger.info(jdict(event="unregistering_bevy_addon", state="end"))
 
 
 @persistent
@@ -71,6 +81,7 @@ def load_handler(dummy):
     operators.update_all_component_list()
 
     for component in component_base.COMPONENTS:
+        logger.info(jdict(event="registering_component", component=str(component)))
         component.register()
 
 

blender_bevy_toolkit/components.py

@@ -6,11 +6,17 @@
 from . import json_components
 from . import component_base
 
+import logging
+from utils import jdict
+logger = logging.getLogger(__name__)
+
 
 def generate_component_list():
     """ Scans directories for components """
     component_base.COMPONENTS = []
     # Predefined json types
+
+    logger.info(jdict(event="generate_component_list", state="start"))
 
     here = os.path.dirname(os.path.abspath(__file__))
 
@@ -28,6 +34,8 @@ def generate_component_list():
         custom_component_folder = os.path.join(blend_path, "component_definitions")
         if os.path.isdir(custom_component_folder):
             load_folder(custom_component_folder)
+
+    logger.info(jdict(event="generate_component_list", state="complete"))
 
 
 def load_folder(folder):
@@ -36,12 +44,18 @@ def load_folder(folder):
 
 
 def load_python_components(folder):
+    logger.info(jdict(event="scan_folder_for_python_components", folder=folder))
     import importlib.util
     for filename in os.listdir(folder):
         if filename.endswith(".py"):
             module_name = os.path.splitext(filename)[0]
             full_path = os.path.join(folder, filename)
+
+            logger.info(jdict(event="load_python_component", path=full_path, state="start"))
+
             spec = importlib.util.spec_from_file_location(module_name, full_path)
             module = importlib.util.module_from_spec(spec)
             spec.loader.exec_module(module)
             sys.modules[module_name] = module
+
+            logger.info(jdict(event="load_python_component", path=full_path, state="end"))

blender_bevy_toolkit/core_definitions/mesh.py

@@ -4,6 +4,9 @@
 import os
 from blender_bevy_toolkit.component_base import ComponentRepresentation, register_component
 
+import logging
+from blender_bevy_toolkit import jdict
+logger = logging.getLogger(__name__)
 
 @register_component
 class Mesh:
@@ -22,7 +25,7 @@ def encode(config, obj):
             hash_text,
         ))
         if not os.path.exists(mesh_output_file):
-            print("Writing Mesh {}".format(mesh_output_file))
+            logger.info(jdict(event="writing_mesh", path=mesh_output_file))
             open(mesh_output_file, 'wb').write(mesh_data)
 
         path = os.path.relpath(mesh_output_file, config["output_folder"])

blender_bevy_toolkit/json_components.py

@@ -19,6 +19,11 @@
 from .component_base import ComponentRepresentation, register_component
 import utils
 
+import logging
+from utils import jdict
+logger = logging.getLogger(__name__)
+
+
 FieldDefinition = collections.namedtuple("FieldDefinition", ["field", "type", "default", "description"])
 ComponentDefininition = collections.namedtuple("ComponentDefinition", ["name", "description", "id", "struct", "fields"])
 
@@ -59,10 +64,12 @@ def get_component_files(folder):
 
 def construct_component_classes(component_filepath):
     # Parse the file from JSON into some python namedtuples
+    logging.info(jdict(event="construct_json_classes", path=component_filepath, state="start"))
+
     try:
         component = json.load(open(component_filepath))
     except json.decoder.JSONDecodeError as err:
-        print("Failed to construct class for {}: {}".format(component_filepath, err))
+        logging.exception(jdict(event="construct_json_component_parse_error", path=component_filepath, error=err, exc_info=err))
         return None
 
     def parse_field(field):
@@ -80,6 +87,7 @@ def parse_field(field):
         struct=component["struct"],
         fields=[parse_field(f) for f in component["fields"]]
     )
+    logging.debug(jdict(event="construct_json_classes", path=component_filepath, state="parse_complete"))
 
 
     # component becomes bpy.types.Object.<<<obj_key>>>
@@ -116,6 +124,7 @@ def parse_field(field):
     fields["present"] = bpy.props.BoolProperty(name="Present", default=False)
     properties.__annotations__ = fields
 
+    logging.debug(jdict(event="construct_json_classes", path=component_filepath, state="fields_completed"))
 
 
     # Create a class to store the data about this component inside the
@@ -157,6 +166,8 @@ def draw(self, context):
                 row.prop(getattr(context.object, obj_key), field)
     panel.draw = draw
 
+    logging.debug(jdict(event="construct_json_classes", path=component_filepath, state="panel_created"))
+
 
 
     # These functions all get put inside the component_class
@@ -194,13 +205,16 @@ def fix_types(field_name, value):
     component_class.remove = staticmethod(remove)
     component_class.encode = staticmethod(encode)
 
-
+    logging.debug(jdict(event="construct_json_classes", path=component_filepath, state="end"))
     return component_class
 
 
 
 def load_folder(folder):
+    logger.info(jdict(event="scan_folder_for_json_components", folder=folder))
+
     json_files = get_component_files(folder)
+    logger.info(jdict(event="scan_folder_for_json_components", folder=folder, json_files=json_files))
     classes = [construct_component_classes(c) for c in json_files]
     for cls in classes:
         register_component(cls)

blender_bevy_toolkit/rapier_definitions/collider_description.py

@@ -8,7 +8,8 @@
 # has a name (displayed in teh enum), a function
 # that turns an object into bytes
 # and draw_type defines how bounds are drawn in the viewport.
-BoundsType = collections.namedtuple("BoundsType", ["name", "encoder", "draw_type"])
+BoundsType = collections.namedtuple(
+    "BoundsType", ["name", "encoder", "draw_type"])
 
 
 def encode_sphere_collider_data(obj):
@@ -23,7 +24,6 @@ def encode_sphere_collider_data(obj):
     else:
         print("Unable to figure out radius for {}", obj.name)
         radius = 1.0
-    
 
     return struct.pack("<f", radius)
 
@@ -41,20 +41,20 @@ def encode_capsule_collider_data(obj):
 
 def encode_box_collider_data(obj):
     if obj.type == "MESH":
-        dims = [obj.dimensions.x/2.0, obj.dimensions.y/2.0, obj.dimensions.z/2.0]
+        dims = [obj.dimensions.x/2.0,
+                obj.dimensions.y/2.0, obj.dimensions.z/2.0]
     else:
         print("Unable to figure out box dimensions for {}", obj.name)
         dims = [1.0, 1.0, 1.0]
     return struct.pack("<fff", *dims)
 
 
-
 # Physics shapes and a function to encode that shape provided an object
-# Be cautious about inserting to the beginning/middle of this list or 
+# Be cautious about inserting to the beginning/middle of this list or
 # removing an item as it will break existing blend files.
 COLLIDER_SHAPES = [
     BoundsType(
-        name="Sphere", 
+        name="Sphere",
         encoder=encode_sphere_collider_data,
         draw_type="SPHERE"
     ),
@@ -69,7 +69,7 @@ def encode_box_collider_data(obj):
         draw_type="BOX"
     ),
 ]
-    
+
 
 @register_component
 class ColliderDescription:
@@ -86,17 +86,17 @@ def encode(config, obj):
 
         field_dict = {}
         for field_name, converter in field_converters:
-            field_dict[field_name] = converter(getattr(obj.rapier_collider_description, field_name))
+            field_dict[field_name] = converter(
+                getattr(obj.rapier_collider_description, field_name))
 
         # The collider_data field is dependant on the collider_shape, so we have to do some
         # derivation here
         collider_shape = int(obj.rapier_collider_description.collider_shape)
 
         encode_function = COLLIDER_SHAPES[collider_shape].encoder
         raw_data = encode_function(obj)
-        
-        data = list(raw_data)
 
+        data = list(raw_data)
 
         field_dict["collider_shape"] = collider_shape
         field_dict["collider_shape_data"] = {
@@ -108,11 +108,11 @@ def encode(config, obj):
             "blender_bevy_toolkit::rapier_physics::ColliderDescription",
             field_dict
         )
-        
+
     def is_present(obj):
         """ Returns true if the supplied object has this component """
         return obj.rapier_collider_description.present
-    
+
     def can_add(obj):
         return True
 
@@ -125,13 +125,13 @@ def add(obj):
     def remove(obj):
         obj.rapier_collider_description.present = False
         update_draw_bounds(obj)
-    
+
     @staticmethod
     def register():
         bpy.utils.register_class(ColliderDescriptionPanel)
         bpy.utils.register_class(ColliderDescriptionProperties)
-        bpy.types.Object.rapier_collider_description = bpy.props.PointerProperty(type=ColliderDescriptionProperties)
-
+        bpy.types.Object.rapier_collider_description = bpy.props.PointerProperty(
+            type=ColliderDescriptionProperties)
 
     @staticmethod
     def unregister():
@@ -150,50 +150,53 @@ class ColliderDescriptionPanel(bpy.types.Panel):
     @classmethod
     def poll(cls, context):
         return ColliderDescription.is_present(context.object)
-    
+
     def draw(self, context):
         row = self.layout.row()
-        row.label(text="A collider so this object can collide with things (when coupled with a rigidbody somewhere)")
+        row.label(
+            text="A collider so this object can collide with things (when coupled with a rigidbody somewhere)")
 
-        fields = ["friction", "restitution", "is_sensor", "density", "collider_shape"]
+        fields = ["friction", "restitution",
+                  "is_sensor", "density", "collider_shape"]
 
         for field in fields:
             row = self.layout.row()
             row.prop(context.object.rapier_collider_description, field)
 
 
-
 def update_draw_bounds(obj):
     """ Changes how the object is shown in the viewport in order to
     display the bounds to the user """
     if ColliderDescription.is_present(obj):
         collider_type_id = int(obj.rapier_collider_description.collider_shape)
         collider_type_data = COLLIDER_SHAPES[collider_type_id].draw_type
-        
+
         obj.show_bounds = True
         obj.display_bounds_type = collider_type_data
-    
+
     else:
         obj.show_bounds = False
 
+
 def collider_shape_changed(_, context):
     """ Runs when the enum selecting the shape is changed """
     update_draw_bounds(context.object)
 
+
 class ColliderDescriptionProperties(bpy.types.PropertyGroup):
     present: bpy.props.BoolProperty(name="Present", default=False)
 
     friction: bpy.props.FloatProperty(name="friction", default=0.5)
     restitution: bpy.props.FloatProperty(name="restitution", default=0.5)
     is_sensor: bpy.props.BoolProperty(name="is_sensor", default=False)
-    
+
     density: bpy.props.FloatProperty(name="density", default=0.5)
 
     shape_items = [(str(i), s.name, "") for i, s in enumerate(COLLIDER_SHAPES)]
 
     collider_shape: bpy.props.EnumProperty(
-        name="collider_shape", 
-        default=0, 
+        name="collider_shape",
+        default=0,
         items=shape_items,
         update=collider_shape_changed
-    )
+    )

blender_bevy_toolkit/utils.py

@@ -1,5 +1,10 @@
 import mathutils
 import bpy
+import json
+
+def jdict(**kwargs):
+    return json.dumps(dict(**kwargs))
+
 
 def iterable_to_string(data, start="[", end="]", joiner=","):
     return start + joiner.join(encode(d) for d in data) + end