feat: enhance logging functionality across examples and core modules

Author: Alexboiboi

docs/examples/cuboids_demagnetization.md

@@ -36,9 +36,16 @@ import magpylib as magpy
 import numpy as np
 import pandas as pd
 import plotly.express as px
-from magpylib_material_response import get_dataset
+from magpylib_material_response import get_dataset, configure_logging
 from magpylib_material_response.demag import apply_demag
 from magpylib_material_response.meshing import mesh_all
+from magpylib_material_response.logging_config import get_logger
+
+# Configure logging to see progress messages
+configure_logging()
+
+# Initialize logger for contextualized logging
+logger = get_logger("magpylib_material_response.examples.cuboids_demagnetization")
 
 if magpy.__version__.split(".")[0] != "5":
     raise RuntimeError(
@@ -89,15 +96,19 @@ coll_meshed.show()
 # apply demagnetization with varying number of cells
 colls = [coll]
 for target_elems in [1, 2, 8, 16, 32, 64, 128, 256]:
-    with logger.contextualize(target_elems=target_elems):
-        coll_meshed = mesh_all(
-            coll, target_elems=target_elems, per_child_elems=True, min_elems=1
-        )
-        coll_demag = apply_demag(
-            coll_meshed,
-            style={"label": f"Coll_demag ({len(coll_meshed.sources_all):3d} cells)"},
-        )
-        colls.append(coll_demag)
+    logger.info("🔄 Processing demagnetization with {target_elems} target elements", target_elems=target_elems)
+    
+    coll_meshed = mesh_all(
+        coll, target_elems=target_elems, per_child_elems=True, min_elems=1
+    )
+    
+    coll_demag = apply_demag(
+        coll_meshed,
+        style={"label": f"Coll_demag ({len(coll_meshed.sources_all):3d} cells)"},
+    )
+    colls.append(coll_demag)
+    
+    logger.info("✅ Completed demagnetization: {actual_cells} cells created", actual_cells=len(coll_meshed.sources_all))
 ```
 
 ## Compare with FEM analysis

docs/examples/soft_magnets.md

@@ -35,8 +35,16 @@ import magpylib as magpy
 import numpy as np
 import pandas as pd
 import plotly.express as px
+from magpylib_material_response import configure_logging
 from magpylib_material_response.demag import apply_demag
 from magpylib_material_response.meshing import mesh_all
+from magpylib_material_response.logging_config import get_logger
+
+# Configure logging to see progress messages
+configure_logging()
+
+# Initialize logger for contextualized logging
+logger = get_logger("magpylib_material_response.examples.soft_magnets")
 
 magpy.defaults.display.backend = "plotly"
 
@@ -83,15 +91,19 @@ magpy.show(*coll_meshed)
 # apply demagnetization with varying number of cells
 colls = [coll]
 for target_elems in [1, 2, 8, 16, 32, 64, 128, 256]:
-    with logger.contextualize(target_elems=target_elems):
-        coll_meshed = mesh_all(
-            coll, target_elems=target_elems, per_child_elems=True, min_elems=1
-        )
-        coll_demag = apply_demag(
-            coll_meshed,
-            style={"label": f"Coll_demag ({len(coll_meshed.sources_all):3d} cells)"},
-        )
-        colls.append(coll_demag)
+    logger.info("🔄 Processing demagnetization with {target_elems} target elements", target_elems=target_elems)
+    
+    coll_meshed = mesh_all(
+        coll, target_elems=target_elems, per_child_elems=True, min_elems=1
+    )
+    
+    coll_demag = apply_demag(
+        coll_meshed,
+        style={"label": f"Coll_demag ({len(coll_meshed.sources_all):3d} cells)"},
+    )
+    colls.append(coll_demag)
+    
+    logger.info("✅ Completed demagnetization: {actual_cells} cells created", actual_cells=len(coll_meshed.sources_all))
 ```
 
 +++ {"user_expressions": []}

src/magpylib_material_response/demag.py

@@ -395,20 +395,23 @@ def apply_demag(
         if not isinstance(src, BaseMagnet | BaseCurrent | magpy.Sensor)
     ]
     if others_list:
+        counts_others = Counter(s.__class__.__name__ for s in others_list)
+        counts_str = ", ".join(f"{count} {name}" for name, count in counts_others.items())
         msg = (
             "Only Magnet and Current sources supported. "
-            "Incompatible objects found: "
-            f"{Counter(s.__class__.__name__ for s in others_list)}"
+            f"Incompatible objects found: {counts_str}"
         )
         raise TypeError(msg)
     n = len(magnets_list)
     counts = Counter(s.__class__.__name__ for s in magnets_list)
     inplace_str = f"""{" (inplace)" if inplace else ""}"""
     lbl = collection.style.label
     coll_str = lbl if lbl else str(collection)
+    # Create a clean message without problematic formatting characters
+    counts_str = ", ".join(f"{count} {name}" for name, count in counts.items())
     demag_msg = (
         f"Demagnetization{inplace_str} of <blue>{coll_str}</blue>"
-        f" with {n} cells - {counts}"
+        f" with {n} cells ({counts_str})"
     )
     with timelog(demag_msg, min_log_time=min_log_time):
         # set up mr

src/magpylib_material_response/logging_config.py

@@ -83,16 +83,32 @@ def configure_logging(
         )
 
     if sink is None:
-        sink = sys.stderr
-
-    # Build format string
-    time_part = "<green>{time:YYYY-MM-DD HH:mm:ss}</green> | " if show_time else ""
-    format_str = (
-        f"{time_part}"
-        "<level>{level:^8}</level> | "
-        "<cyan>{extra[module]}</cyan> | "
-        "{level.icon:<2} {message}"
-    )
+        sink = sys.stdout
+
+    # Custom format function to display structured data cleanly
+    def format_record(record):
+        time_part = f"<green>{record['time'].strftime('%Y-%m-%d %H:%M:%S')}</green> | " if show_time else ""
+        
+        # Base format
+        base = (
+            f"{time_part}"
+            f"<level>{record['level'].name:^8}</level> | "
+            f"<cyan>{record['extra'].get('module', 'unknown')}</cyan> | "
+            f"{record['level'].icon:<2} {record['message']}"
+        )
+        
+        # Add extra context (excluding 'module' since it's already shown)
+        extra_items = []
+        for key, value in record['extra'].items():
+            if key != 'module':
+                extra_items.append(f"<dim>{key}={value}</dim>")
+        
+        if extra_items:
+            base += " | " + " | ".join(extra_items)
+        
+        return base + "\n"
+    
+    format_str = format_record
 
     # Configure the logger
     logger.add(

src/magpylib_material_response/meshing.py

@@ -429,9 +429,11 @@ def mesh_all(
     else:
         target_elems_by_child = [max(min_elems, target_elems)] * len(supported_objs)
     if incompatible_objs:
+        counts_incompatible = Counter(s.__class__.__name__ for s in incompatible_objs)
+        counts_str = ", ".join(f"{count} {name}" for name, count in counts_incompatible.items())
         msg = (
             "Incompatible objects found: "
-            f"{Counter(s.__class__.__name__ for s in incompatible_objs)}"
+            f"{counts_str}"
             f"\nSupported: {[s.__name__ for s in supported]}."
         )
         raise TypeError(msg)

src/magpylib_material_response/utils.py

@@ -42,7 +42,7 @@ def run(self):
                 and time.time() - self.thread_start > self.min_log_time
                 and not self._msg_displayed
             ):
-                logger.info("Starting operation", operation=self.msg)
+                logger.info("🔄 Starting: {operation}", operation=self.msg)
                 self._msg_displayed = True
             # include a delay here so the thread doesn't uselessly thrash the CPU
             time.sleep(max(0.01, self.min_log_time / 5))
@@ -62,11 +62,13 @@ def timelog(msg, min_log_time=1):
         thread_timer.stop()
         thread_timer.join()
         if end is None:
-            logger.exception("Operation failed", operation=msg)
+            logger.exception("❌ Failed: {operation}", operation=msg)
 
     if end > min_log_time:
         logger.info(
-            "Operation completed", operation=msg, duration_seconds=round(end, 3)
+            "✅ Completed: {operation} in {duration}s", 
+            operation=msg, 
+            duration=round(end, 3)
         )