materialx_serializer.Util Class Reference

Utility class for inspecting and debugging Protobuf MaterialXDocument messages. More...

Public Member Functions
	from_string (data)
	Convert string data to Protobuf document.
	to_string (pb_doc)
	Convert Protobuf document to string.
	to_json (pb_doc, indent=2)
	Convert Protobuf document to JSON string.
	from_string (data)
	Convert string data to Protobuf document.
	to_string (pb_doc)
	Convert Protobuf document to string.
	to_json (pb_doc, indent=2)
	Convert Protobuf document to JSON string.

Static Public Member Functions
	debug_inspect (pb_doc, max_depth=10, _current_depth=0)
	debug_inspect_compact (pb_doc, max_depth=10, _current_depth=0)
	debug_inspect_simple (pb_doc)
	generate_mermaid_diagram (pb_doc)
	Generate a Mermaid diagram (graph LR) from a protobuf document hierarchy.
	debug_inspect (pb_doc, max_depth=10, _current_depth=0)
	debug_inspect_compact (pb_doc, max_depth=10, _current_depth=0)
	debug_inspect_simple (pb_doc)
	generate_mermaid_diagram (pb_doc)
	Generate a Mermaid diagram (graph LR) from a protobuf document hierarchy.

Detailed Description

Utility class for inspecting and debugging Protobuf MaterialXDocument messages.

• Print the protobuf document structure in various formats.
• Generate Mermaid diagrams for visualization of the document hierarchy.

Member Function Documentation

debug_inspect() [1/2]

materialx_serializer.Util.debug_inspect ( pb_doc, max_depth = 10, _current_depth = 0 )

static

    def debug_inspect(pb_doc, max_depth=10, _current_depth=0):
        
        data = MessageToDict(pb_doc)
        
        def print_element(element, depth):
            indent = "  " * depth
            name = element.get('name', 'unnamed')
            elem_type = element.get('type', 'no-type')
            print(f"{indent}{name} ({elem_type})")
            # Print attributes (now a list of dicts)
            attrs = element.get('attributes', [])
            for attr in attrs:
                key = attr.get('key', '')
                value = attr.get('value', '')
                print(f"{indent}  │ {key}: {value}")
            # Print children recursively
            children = element.get('children', [])
            if children:
                print(f"{indent}  └─ Children ({len(children)}):")
                for child in children:
                    print_element(child, depth + 2)
        
        pb_version = pb_doc.schema_version
        print("Schema Version:", f"{pb_version.major}.{pb_version.minor}.{pb_version.patch}")
 
        attribs = ", ".join([f"{attr.get('key', '')}={attr.get('value', '')}" for attr in data.get('attributes', [])])
        print("Document:" + (f" [{attribs}]" if attribs else ""))
 
        for element in data.get('elements', []):
            print_element(element, 0)
        
        return data
 

debug_inspect() [2/2]

materialx_serializer.Util.debug_inspect ( pb_doc, max_depth = 10, _current_depth = 0 )

static

    def debug_inspect(pb_doc, max_depth=10, _current_depth=0):
        
        data = MessageToDict(pb_doc)
        
        def print_element(element, depth):
            indent = "  " * depth
            name = element.get('name', 'unnamed')
            elem_type = element.get('type', 'no-type')
            print(f"{indent}{name} ({elem_type})")
            # Print attributes (now a list of dicts)
            attrs = element.get('attributes', [])
            for attr in attrs:
                key = attr.get('key', '')
                value = attr.get('value', '')
                print(f"{indent}  │ {key}: {value}")
            # Print children recursively
            children = element.get('children', [])
            if children:
                print(f"{indent}  └─ Children ({len(children)}):")
                for child in children:
                    print_element(child, depth + 2)
        
        pb_version = pb_doc.schema_version
        print("Schema Version:", f"{pb_version.major}.{pb_version.minor}.{pb_version.patch}")
 
        attribs = ", ".join([f"{attr.get('key', '')}={attr.get('value', '')}" for attr in data.get('attributes', [])])
        print("Document:" + (f" [{attribs}]" if attribs else ""))
 
        for element in data.get('elements', []):
            print_element(element, 0)
        
        return data
 

debug_inspect_compact() [1/2]

materialx_serializer.Util.debug_inspect_compact ( pb_doc, max_depth = 10, _current_depth = 0 )

static

    def debug_inspect_compact(pb_doc, max_depth=10, _current_depth=0):
        
        data = MessageToDict(pb_doc)
 
        def print_attributes(element, depth):
            indent = "  " * depth
            name = element.get('name', '')
            elem_type = element.get('type', '')
            if elem_type: 
                elem_type = f'({elem_type})'
            attrs = element.get('attributes', [])
            attrs_preview = ", ".join([f"{attr.get('key', '')}={attr.get('value', '')}" for attr in attrs[:2]])
            if attrs_preview:
                attrs_preview = f" [{attrs_preview}]"
            print(f"{indent}{name} {elem_type}{attrs_preview}")
 
        def print_element(element, depth):
            if depth > max_depth:
                return
            # Compact line showing key info
            print_attributes(element, depth)
            children_count = len(element.get('children', []))
 
            # Recursively print children
            for child in element.get('children', []):
                print_element(child, depth + 1)
        
        pb_version = pb_doc.schema_version
        print("Schema Version:", f"{pb_version.major}.{pb_version.minor}.{pb_version.patch}")
 
        attribs = ", ".join([f"{attr.get('key', '')}={attr.get('value', '')}" for attr in data.get('attributes', [])])
        print("Document:" + (f" [{attribs}]" if attribs else ""))
 
        for element in data.get('elements', []):
            print_element(element, 0)
        
        return data
 

debug_inspect_compact() [2/2]

materialx_serializer.Util.debug_inspect_compact ( pb_doc, max_depth = 10, _current_depth = 0 )

static

    def debug_inspect_compact(pb_doc, max_depth=10, _current_depth=0):
        
        data = MessageToDict(pb_doc)
 
        def print_attributes(element, depth):
            indent = "  " * depth
            name = element.get('name', '')
            elem_type = element.get('type', '')
            if elem_type: 
                elem_type = f'({elem_type})'
            attrs = element.get('attributes', [])
            attrs_preview = ", ".join([f"{attr.get('key', '')}={attr.get('value', '')}" for attr in attrs[:2]])
            if attrs_preview:
                attrs_preview = f" [{attrs_preview}]"
            print(f"{indent}{name} {elem_type}{attrs_preview}")
 
        def print_element(element, depth):
            if depth > max_depth:
                return
            # Compact line showing key info
            print_attributes(element, depth)
            children_count = len(element.get('children', []))
 
            # Recursively print children
            for child in element.get('children', []):
                print_element(child, depth + 1)
        
        pb_version = pb_doc.schema_version
        print("Schema Version:", f"{pb_version.major}.{pb_version.minor}.{pb_version.patch}")
 
        attribs = ", ".join([f"{attr.get('key', '')}={attr.get('value', '')}" for attr in data.get('attributes', [])])
        print("Document:" + (f" [{attribs}]" if attribs else ""))
 
        for element in data.get('elements', []):
            print_element(element, 0)
        
        return data
 

debug_inspect_simple() [1/2]

materialx_serializer.Util.debug_inspect_simple ( pb_doc )

static

    def debug_inspect_simple(pb_doc):
        
        def print_tree(element, prefix="", is_last=True):
            """Print tree structure with branches"""
            connector = "└── " if is_last else "├── "
            print(f"{prefix}{connector}{element.get('name', 'unnamed')} ({element.get('type', 'no-type')})")
            
            # Update prefix for children
            new_prefix = prefix + ("    " if is_last else "│   ")
            
            # Print children
            children = element.get('children', [])
            for i, child in enumerate(children):
                print_tree(child, new_prefix, i == len(children) - 1)
        
        data = MessageToDict(pb_doc)
        
        pb_version = pb_doc.schema_version
        print("Schema Version:", f"{pb_version.major}.{pb_version.minor}.{pb_version.patch}")
 
        attribs = ", ".join([f"{attr.get('key', '')}={attr.get('value', '')}" for attr in data.get('attributes', [])])
        print("Document:" + (f" [{attribs}]" if attribs else ""))
        for i, element in enumerate(data.get('elements', [])):
            print_tree(element, "", i == len(data.get('elements', [])) - 1)
        
        return data    
    

debug_inspect_simple() [2/2]

materialx_serializer.Util.debug_inspect_simple ( pb_doc )

static

    def debug_inspect_simple(pb_doc):
        
        def print_tree(element, prefix="", is_last=True):
            """Print tree structure with branches"""
            connector = "└── " if is_last else "├── "
            print(f"{prefix}{connector}{element.get('name', 'unnamed')} ({element.get('type', 'no-type')})")
            
            # Update prefix for children
            new_prefix = prefix + ("    " if is_last else "│   ")
            
            # Print children
            children = element.get('children', [])
            for i, child in enumerate(children):
                print_tree(child, new_prefix, i == len(children) - 1)
        
        data = MessageToDict(pb_doc)
        
        pb_version = pb_doc.schema_version
        print("Schema Version:", f"{pb_version.major}.{pb_version.minor}.{pb_version.patch}")
 
        attribs = ", ".join([f"{attr.get('key', '')}={attr.get('value', '')}" for attr in data.get('attributes', [])])
        print("Document:" + (f" [{attribs}]" if attribs else ""))
        for i, element in enumerate(data.get('elements', [])):
            print_tree(element, "", i == len(data.get('elements', [])) - 1)
        
        return data    
    

from_string() [1/2]

materialx_serializer.Util.from_string

(

data

)

Convert string data to Protobuf document.

    def from_string(data):
        """Convert string data to Protobuf document."""              
        pb_doc = pb.MaterialXDocument()
        pb_doc.ParseFromString(data)
        return pb_doc
 

from_string() [2/2]

materialx_serializer.Util.from_string

(

data

)

Convert string data to Protobuf document.

    def from_string(data):
        """Convert string data to Protobuf document."""              
        pb_doc = pb.MaterialXDocument()
        pb_doc.ParseFromString(data)
        return pb_doc
 

generate_mermaid_diagram() [1/2]

materialx_serializer.Util.generate_mermaid_diagram ( pb_doc )

static

Generate a Mermaid diagram (graph LR) from a protobuf document hierarchy.

Parameters

pb_doc

Protobuf message describing the document

Returns

str Mermaid diagram source code.

    def generate_mermaid_diagram(pb_doc):
        """
        @brief Generate a Mermaid diagram (graph LR) from a protobuf document hierarchy.
        @param pb_doc Protobuf message describing the document
        @return str Mermaid diagram source code.
        """
        data = MessageToDict(pb_doc)
        mermaid_lines = ["graph LR"]
        
        def add_mermaid_elements(element):
            node_id = element.get('name').replace(' ', '_')
            label = f"{element.get('name')} : {element.get('type')}"
            mermaid_lines.append(f"    {node_id}[{label}]")
            
            for child in element.get('children', []):
                child_id = child.get('name').replace(' ', '_')
                add_mermaid_elements(child)
                mermaid_lines.append(f"    {node_id} --> {child_id}")
        
        for element in data.get('elements', []):
            add_mermaid_elements(element)
        
        mermaid_code = "\n".join(mermaid_lines)
        
        return mermaid_code
 

generate_mermaid_diagram() [2/2]

materialx_serializer.Util.generate_mermaid_diagram ( pb_doc )

static

Generate a Mermaid diagram (graph LR) from a protobuf document hierarchy.

Parameters

pb_doc

Protobuf message describing the document

Returns

str Mermaid diagram source code.

    def generate_mermaid_diagram(pb_doc):
        """
        @brief Generate a Mermaid diagram (graph LR) from a protobuf document hierarchy.
        @param pb_doc Protobuf message describing the document
        @return str Mermaid diagram source code.
        """
        data = MessageToDict(pb_doc)
        mermaid_lines = ["graph LR"]
        
        def add_mermaid_elements(element):
            node_id = element.get('name').replace(' ', '_')
            label = f"{element.get('name')} : {element.get('type')}"
            mermaid_lines.append(f"    {node_id}[{label}]")
            
            for child in element.get('children', []):
                child_id = child.get('name').replace(' ', '_')
                add_mermaid_elements(child)
                mermaid_lines.append(f"    {node_id} --> {child_id}")
        
        for element in data.get('elements', []):
            add_mermaid_elements(element)
        
        mermaid_code = "\n".join(mermaid_lines)
        
        return mermaid_code
 

to_json() [1/2]

materialx_serializer.Util.to_json	(		pb_doc,
			indent = 2 )

Convert Protobuf document to JSON string.

    def to_json(pb_doc, indent=2):
        """Convert Protobuf document to JSON string."""
        return MessageToJson(pb_doc, indent)
 

to_json() [2/2]

materialx_serializer.Util.to_json	(		pb_doc,
			indent = 2 )

Convert Protobuf document to JSON string.

    def to_json(pb_doc, indent=2):
        """Convert Protobuf document to JSON string."""
        return MessageToJson(pb_doc, indent)
 

to_string() [1/2]

materialx_serializer.Util.to_string

(

pb_doc

)

Convert Protobuf document to string.

    def to_string(pb_doc):
        """Convert Protobuf document to string."""              
        return (pb_doc.SerializeToString())
 

to_string() [2/2]

materialx_serializer.Util.to_string

(

pb_doc

)

Convert Protobuf document to string.

    def to_string(pb_doc):
        """Convert Protobuf document to string."""              
        return (pb_doc.SerializeToString())
 

---

The documentation for this class was generated from the following files:

• source/materialx_serializer.py
• build/lib/materialx_serializer.py