Golang解析缩进代码生成树形结构 - codetree使用指南

codetree是一个用于解析缩进代码并生成树形结构的Golang库，特别适合处理Python等基于缩进的代码，或者任何使用缩进表示层级结构的文本数据。

安装

go get github.com/aerogo/codetree

基本用法

1. 解析缩进文本生成树

package main

import (
	"fmt"
	"github.com/aerogo/codetree"
)

func main() {
	// 示例缩进文本
	text := `
root
    child1
        grandchild1
        grandchild2
    child2
        grandchild3
`

	// 解析文本生成树
	tree, err := codetree.New(text)
	if err != nil {
		panic(err)
	}

	// 打印树结构
	fmt.Println(tree.String())
}

2. 遍历树节点

// 深度优先遍历
func traverse(node *codetree.Node, level int) {
	// 打印当前节点，缩进表示层级
	fmt.Printf("%s%s\n", strings.Repeat("    ", level), node.Text)
	
	// 递归遍历子节点
	for _, child := range node.Children {
		traverse(child, level+1)
	}
}

// 使用
traverse(tree.Root, 0)

3. 查找特定节点

// 查找包含特定文本的节点
func findNode(node *codetree.Node, text string) *codetree.Node {
	if strings.Contains(node.Text, text) {
		return node
	}
	
	for _, child := range node.Children {
		if found := findNode(child, text); found != nil {
			return found
		}
	}
	
	return nil
}

// 使用
childNode := findNode(tree.Root, "child1")
if childNode != nil {
	fmt.Println("Found:", childNode.Text)
}

高级功能

1. 自定义缩进处理

// 使用Tab作为缩进
text := "root\n\tchild1\n\t\tgrandchild1\n\tchild2"

// 创建配置
config := &codetree.Config{
	Indentation: "\t", // 指定缩进字符
}

tree, err := codetree.NewWithConfig(text, config)

2. 处理空行和注释

config := &codetree.Config{
	SkipEmptyLines: true, // 跳过空行
	CommentPrefix:  "#",  // 指定注释前缀
}

3. 生成JSON格式

jsonData, err := tree.JSON()
if err != nil {
	panic(err)
}
fmt.Println(string(jsonData))

实际应用示例：解析Python类结构

func parsePythonClasses(code string) {
	tree, err := codetree.New(code)
	if err != nil {
		panic(err)
	}
	
	// 查找所有类定义
	for _, node := range tree.Root.Children {
		if strings.HasPrefix(node.Text, "class ") {
			className := strings.TrimPrefix(node.Text, "class ")
			fmt.Println("Class:", className)
			
			// 查找类中的方法
			for _, methodNode := range node.Children {
				if strings.HasPrefix(methodNode.Text, "def ") {
					methodName := strings.TrimPrefix(methodNode.Text, "def ")
					fmt.Println("  Method:", methodName)
				}
			}
		}
	}
}

性能考虑

codetree在处理大型文件时性能良好，但如果需要解析非常大的文件(超过10万行)，可以考虑：

1. 分批处理
2. 使用codetree.NewWithConfig并设置适当的缓冲区大小

错误处理

codetree会返回以下常见错误：

• ErrInconsistentIndentation - 缩进不一致
• ErrEmptyInput - 输入为空
• ErrNoRootNode - 没有根节点

建议总是检查错误：

tree, err := codetree.New(code)
if err != nil {
	if err == codetree.ErrInconsistentIndentation {
		fmt.Println("请检查代码缩进是否一致")
	} else {
		fmt.Println("解析错误:", err)
	}
	return
}

codetree是一个轻量级但功能强大的库，非常适合需要分析缩进结构文本的场景。通过灵活的配置和简单的API，可以快速集成到各种文本处理应用中。