code-reviewer

PySBS Code Reviewer

Review PySBS code for best practices, potential issues, and improvements.

Trigger Phrases

• "review pysbs"
• "코드 검토"
• "pysbs 코드 리뷰"
• "substance 코드 확인"

Review Checklist

1. Context & Document Handling

• Context is properly initialized
• Document is parsed before accessing content
• Document is saved after modifications
• Error handling for file operations

# Good
ctx = context.Context()
doc = substance.SBSDocument(ctx, path)
doc.parseDoc()  # Don't forget!
# ... modifications ...
doc.writeDoc()

# Bad - missing parseDoc
doc = substance.SBSDocument(ctx, path)
graph = doc.getSBSGraph('Name')  # Will fail!

2. Null Checks

• Check if graph/node exists before using
• Handle None returns from get methods

# Good
graph = doc.getSBSGraph('MyGraph')
if graph is None:
    raise ValueError("Graph not found")

# Bad
graph = doc.getSBSGraph('MyGraph')
node = graph.createCompFilterNode(...)  # May crash if graph is None

3. Enum Usage

• Using correct enum types
• Enum values match expected types

# Good
node.setParameterValue(
    sbsenum.CompNodeParamEnum.OUTPUT_SIZE,
    [sbsenum.OutputSizeEnum.SIZE_1024, sbsenum.OutputSizeEnum.SIZE_1024]
)

# Bad - wrong value type
node.setParameterValue(
    sbsenum.CompNodeParamEnum.OUTPUT_SIZE,
    1024  # Should be OutputSizeEnum
)

4. Resource Handling

• Resource paths are valid
• Resources exist before creating nodes
• Using correct ResourceTypeEnum

5. Connection Handling

• Nodes exist before connecting
• Compatible types are connected
• Output/Input pins specified when ambiguous

6. Parameter Inheritance

• Appropriate ParamInheritanceEnum used
• ABSOLUTE vs PARENT vs INPUT understood

7. Memory & Performance

• Not loading unnecessary data
• Proper cleanup after operations
• Efficient iteration patterns

8. Code Organization

• Functions are focused and reusable
• Error messages are descriptive
• Comments explain complex logic

Common Issues

Issue: Missing parseDoc()

# Wrong
doc = substance.SBSDocument(ctx, path)
graphs = doc.getSBSGraphList()  # Empty or error

# Correct
doc = substance.SBSDocument(ctx, path)
doc.parseDoc()
graphs = doc.getSBSGraphList()

Issue: Wrong Enum Type

# Wrong
aFilter=sbsenum.FilterEnum.BITMAP  # For filter node
aResourceTypeEnum=sbsenum.FilterEnum.BITMAP  # Wrong enum!

# Correct
aResourceTypeEnum=sbsenum.ResourceTypeEnum.BITMAP

Issue: Missing Error Handling

# Risky
def modify(path):
    doc = substance.SBSDocument(ctx, path)
    doc.parseDoc()
    # modifications...
    doc.writeDoc()

# Better
def modify(path):
    try:
        doc = substance.SBSDocument(ctx, path)
        doc.parseDoc()
        # modifications...
        doc.writeDoc()
    except Exception as e:
        print(f"Error: {e}")
        return False
    return True

Review Output Format

=== PySBS Code Review ===

File: path/to/file.py

[CRITICAL] Line 42: Missing parseDoc() before accessing document content

[WARNING] Line 67: No null check before using graph object

[SUGGESTION] Line 89: Consider using ParamInheritanceEnum.PARENT for output size

[GOOD] Line 15: Proper context initialization

Overall Score: 7/10
- Critical Issues: 1
- Warnings: 3
- Suggestions: 5