Merge pull request #19 from networktocode-llc/gfm-dsync-print-detailed

Add print_detailed() API to DSync and DSyncModel classes

Author: glennmatthews

dsync/__init__.py

@@ -158,6 +158,26 @@ def __repr__(self):
     def __str__(self):
         return self.get_unique_id()
 
+    def print_detailed(self, dsync: "Optional[DSync]" = None, indent: int = 0):
+        """Print this model and its children."""
+        margin = " " * indent
+        if not dsync:
+            dsync = self.dsync
+        print(f"{margin}{self.get_type()}: {self.get_unique_id()}")
+        for modelname, fieldname in self._children.items():
+            print(f"{margin}  {modelname}")
+            child_ids = getattr(self, fieldname)
+            if not child_ids:
+                print(f"{margin}    (none)")
+            for child_id in child_ids:
+                child = None
+                if dsync:
+                    child = dsync.get(modelname, child_id)
+                if not child:
+                    print(f"{margin}    {child_id} (no details available)")
+                else:
+                    child.print_detailed(dsync, indent + 4)
+
     @classmethod
     def create(cls, dsync: "DSync", ids: dict, attrs: dict) -> Optional["DSyncModel"]:
         """Instantiate this class, along with any platform-specific data creation.
@@ -378,6 +398,17 @@ def load(self):
         """Load all desired data from whatever backend data source into this instance."""
         # No-op in this generic class
 
+    def print_detailed(self, indent: int = 0):
+        """Recursively print this DSync and its contained models."""
+        margin = " " * indent
+        for modelname in self.top_level:
+            print(f"{margin}{modelname}")
+            models = self.get_all(modelname)
+            if not models:
+                print(f"{margin}  (none)")
+            for model in models:
+                model.print_detailed(self, indent + 2)
+
     # ------------------------------------------------------------------------------
     # Synchronization between DSync instances
     # ------------------------------------------------------------------------------

examples/example1/README.md

@@ -16,10 +16,15 @@ from backend_c import BackendC
 
 a = BackendA()
 a.load()
+a.print_detailed()
+
 b = BackendB()
 b.load()
+b.print_detailed()
+
 c = BackendC()
 c.load()
+c.print_detailed()
 ```
 
 Configure verbosity of DSync's structured logging to console; the default is full verbosity (all logs including debugging)

examples/example1/main.py

@@ -32,14 +32,17 @@ def main():
     print("Initializing and loading Backend A...")
     backend_a = BackendA(name="Backend-A")
     backend_a.load()
+    backend_a.print_detailed()
 
     print("Initializing and loading Backend B...")
     backend_b = BackendB(name="Backend-B")
     backend_b.load()
+    backend_b.print_detailed()
 
     print("Initializing and loading Backend C...")
     backend_c = BackendC()
     backend_c.load()
+    backend_c.print_detailed()
 
     print("Getting diffs from Backend A to Backend B...")
     diff_a_b = backend_a.diff_to(backend_b, diff_class=MyDiff)