在面对一个庞大且复杂的代码库时，是否曾经感到迷失？无数的文件和嵌套的文件夹让你无从下手，想要找到一个文件或理解项目架构往往要花费大量时间。这样的问题不仅耗费精力，还可能导致严重的代码管理问题。别担心，我们的这篇指南将为你揭示如何使用 Python 构建一个智能项目目录结构分析工具，并结合 GPT-4o 提供的架构建议，帮助你迅速厘清项目结构，让代码管理从此变得井井有条。立即掌握这项技能，告别代码迷宫！
代码概述
我们将从构建 BasicStructureAnalyzer 类开始。该类的主要功能是递归读取项目目录，并将其结构存储在一个字典中。然后，我们可以选择将该目录结构转换为字符串形式，以便进一步分析或发送至 GPT-4o。
主要功能
1. 读取目录结构
def read_structure(self):
for root, dirs, files in os.walk(self.directory):
relative_path = os.path.relpath(root, self.directory)
depth = relative_path.count(os.sep)
if self.max_depth is not None and depth >= self.max_depth:
continue # 超过最大层级深度则跳过
if relative_path == '.':
relative_path = ''
if len(files) > self.file_limit:
self.structure[relative_path] = {
'file_count': len(files),
'example_files': files[:self.file_limit]
}
else:
self.structure[relative_path] = files
在 read_structure 方法中，使用 os.walk 递归遍历指定目录的所有子目录。对于每一个目录，计算其相对路径和层级深度，并根据用户设置的最大层级深度决定是否继续遍历。为了避免输出过多文件，还可以设置每个目录中文件的输出数量限制。
2. 目录结构分析与转换
def analyze(self):
self.read_structure()
return self.structure
def get_structure_as_string(self):
structure_str = ""
for folder, content in self.structure.items():
structure_str += f"{folder}/\n"
if isinstance(content, dict):
structure_str += f" - 文件数: {content['file_count']}, 示例文件: {', '.join(content['example_files'])}\n"
else:
for file in content:
structure_str += f" - {file}\n"
return structure_str
analyze 方法调用 read_structure 来生成项目的目录结构，并返回结果。而 get_structure_as_string 方法则将结构转化为字符串形式，以便于输出或发送给 GPT-4o 进行进一步分析。
3. 模拟人类输入与发送至 GPT-4o
为了使结果更符合实际操作，我们可以通过 type_like_human 方法模拟人类键入的效果：
def type_like_human(text, typing_speed=0.05):
for char in text:
print(char, end='', flush=True)
time.sleep(typing_speed)
print() # 输出完成后换行
接下来，我们可以将目录结构发送至 GPT-4o 进行架构分析：
def send_to_gpt4o(structure_str):
client = OpenAI(
api_key="your_api_key_here"
)
conversation_history = [
{"role": "system", "content": "你是一个专业的软件架构分析师。"}
]
chunks = [structure_str[i:i + 4096] for i in range(0, len(structure_str), 4096)]
full_response = ""
for i, chunk in enumerate(chunks):
conversation_history.append({"role": "user", "content": f"以下是项目的目录结构的第{i+1}部分，请分析其架构并提供专业的建议:\n\n{chunk}"})
completion = client.chat.completions.create(
model="gpt-4o",
messages=conversation_history
)
chat_response = completion.choices[0].message.content
full_response += f"第{i+1}部分分析结果:\n{chat_response}\n"
conversation_history.append({"role": "assistant", "content": chat_response})
return full_response
该方法将目录结构分割为多个块，每块最多 4096 个字符，然后逐块发送给 GPT-4o 进行分析。每一部分的分析结果将被拼接起来形成最终输出。
使用示例
在实际使用中，我们可以通过以下代码段来执行目录结构分析并获取 GPT-4o 的反馈：
if __name__ == "__main__":
project_directory = input("请输入要分析的项目目录路径: ")
max_depth = input("请输入要输出的最大层级深度 (默认无限制): ")
max_depth = int(max_depth) if max_depth.isdigit() else None
file_limit = input("请输入单个目录中文件的输出数量限制 (默认10): ")
file_limit = int(file_limit) if file_limit.isdigit() else 10
analyzer = BasicStructureAnalyzer(project_directory, max_depth=max_depth, file_limit=file_limit)
project_structure = analyzer.analyze()
print("\n项目目录结构分析结果:")
for folder, content in project_structure.items():
print(f"{folder}/")
if isinstance(content, dict):
print(f" - 文件数: {content['file_count']}, 示例文件: {content['example_files']}")
else:
for file in content:
print(f" - {file}")
total_chars = analyzer.calculate_structure_length()
print(f"\n目录结构的总字符数: {total_chars}")
structure_str = analyzer.get_structure_as_string()
gpt4o_response = send_to_gpt4o(structure_str)
type_like_human(f'\nGPT-4o分析结果: {gpt4o_response}')
在这个示例中，我们首先获取用户输入的项目目录路径和其他参数，然后通过 BasicStructureAnalyzer 对目录结构进行分析，最后将结果发送至 GPT-4o 进行更深入的架构建议。
完整代码如下：
import os
import time
from openai import OpenAI
class BasicStructureAnalyzer:
"""
初步分析项目的基本目录结构。
"""
def __init__(self, directory, max_depth=None, file_limit=10):
"""
初始化分析器，指定要分析的项目目录，并可选地设置最大层级深度和文件数量限制。
:param directory: 要分析的项目根目录路径
:param max_depth: 输出的最大层级深度，None 表示不限制
:param file_limit: 如果某目录中的文件超过这个数量，则只输出文件数量和部分示例
"""
self.directory = directory
self.max_depth = max_depth
self.file_limit = file_limit
self.structure = {}
def read_structure(self):
"""
读取项目的目录结构，保存到 self.structure 中，并根据 max_depth 限制输出层级。
对于文件数超过 file_limit 的目录，只输出文件数量和示例文件。
"""
for root, dirs, files in os.walk(self.directory):
relative_path = os.path.relpath(root, self.directory)
depth = relative_path.count(os.sep)
if self.max_depth is not None and depth >= self.max_depth:
continue # 超过最大层级深度则跳过
if relative_path == '.':
relative_path = ''
if len(files) > self.file_limit:
self.structure[relative_path] = {
'file_count': len(files),
'example_files': files[:self.file_limit]
}
else:
self.structure[relative_path] = files
def analyze(self):
"""
进行目录结构的基础分析，返回项目的基本结构信息。
:return: 包含项目结构的字典
"""
self.read_structure()
return self.structure
def calculate_structure_length(self):
"""
计算当前项目结构输出的总字符数。
:return: 字符数总计
"""
structure_str = self.get_structure_as_string()
return len(structure_str)
def get_structure_as_string(self):
"""
将当前项目结构转换为字符串形式，便于发送给GPT-4进行分析。
:return: 项目结构的字符串表示
"""
structure_str = ""
for folder, content in self.structure.items():
structure_str += f"{folder}/\n"
if isinstance(content, dict):
structure_str += f" - 文件数: {content['file_count']}, 示例文件: {', '.join(content['example_files'])}\n"
else:
for file in content:
structure_str += f" - {file}\n"
return structure_str
def type_like_human(text, typing_speed=0.05):
"""
模拟人类敲键盘的函数
"""
for char in text:
print(char, end='', flush=True)
time.sleep(typing_speed)
print() # 输出完成后换行
def send_to_gpt4o(structure_str):
"""
将目录结构字符串发送到GPT-4进行分析
"""
client = OpenAI(
api_key="your_api_key_here"
)
conversation_history = [
{"role": "system", "content": "你是一个专业的软件架构分析师。"}
]
# 将结构字符串分割为多个块，每块最多 4096 个字符
chunks = [structure_str[i:i + 4096] for i in range(0, len(structure_str), 4096)]
full_response = ""
for i, chunk in enumerate(chunks):
conversation_history.append({"role": "user", "content": f"以下是项目的目录结构的第{i+1}部分，请分析其架构并提供专业的建议:\n\n{chunk}"})
completion = client.chat.completions.create(
model="gpt-4o",
messages=conversation_history
)
chat_response = completion.choices[0].message.content
full_response += f"第{i+1}部分分析结果:\n{chat_response}\n"
conversation_history.append({"role": "assistant", "content": chat_response})
return full_response
if __name__ == "__main__":
project_directory = input("请输入要分析的项目目录路径: ")
max_depth = input("请输入要输出的最大层级深度 (默认无限制): ")
max_depth = int(max_depth) if max_depth.isdigit() else None
file_limit = input("请输入单个目录中文件的输出数量限制 (默认10): ")
file_limit = int(file_limit) if file_limit.isdigit() else 10
analyzer = BasicStructureAnalyzer(project_directory, max_depth=max_depth, file_limit=file_limit)
project_structure = analyzer.analyze()
print("\n项目目录结构分析结果:")
for folder, content in project_structure.items():
print(f"{folder}/")
if isinstance(content, dict):
print(f" - 文件数: {content['file_count']}, 示例文件: {content['example_files']}")
else:
for file in content:
print(f" - {file}")
# 计算并输出目录结构的字符数
total_chars = analyzer.calculate_structure_length()
print(f"\n目录结构的总字符数: {total_chars}")
# 获取目录结构字符串
structure_str = analyzer.get_structure_as_string()
# 将目录结构发送给GPT-4o进行分析（自动处理字符超出4096的情况）
gpt4o_response = send_to_gpt4o(structure_str)
type_like_human(f'\nGPT-4o分析结果: {gpt4o_response}')
总结
本文介绍了如何使用 Python 构建一个简单的项目目录结构分析工具，并结合 GPT-4o 进行架构分析。通过该工具，开发者可以快速了解项目的目录结构，并得到专业的架构建议，进而更有效地进行项目管理和代码审查。
此工具的灵活性和扩展性也为进一步开发打下了良好的基础，未来可以考虑增加更多功能，如自动生成项目报告、识别潜在问题等。
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
