【Python】解析CPP类定义代码，获取UML类图信息

原创 已于 2023-11-19 17:37:05 修改 · 656 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#python #uml #开发语言

于 2023-11-19 17:36:46 首次发布
本文介绍如何使用Python的CppHeaderParser库解析C++头文件，提取类的属性和成员函数信息，包括访问权限和参数类型，以支持UML类图绘制。

参考 & 鸣谢

目的

  • 解析CPP头文件中的类定义，获取UML中的属性。用于画UML类图。如下所示格式，图片来源-链接

  • 即获取，类名，成员函数，成员方法。
    • 后置函数返回值、参数类型。
    • +、-、# 区分不同的访问权限，public,private,protected。
  • 使用Python的CppHeaderPaser库完成CPP文件中类定义解析。

代码实现

import sys
import CppHeaderParser
import os
import shutil
import os
import re


type_hash = {'private' : '- ','protected' : '# ','public' : '+ '}

def get_mem_var(parse_conent,cur_class,target_type):
    for class_private_mem_var in parse_conent.classes[cur_class]['properties'][target_type]:
        # 组装private属性
        tmp_str = type_hash[target_type] + class_private_mem_var['name'] + ' : ' + class_private_mem_var['type']
        print(tmp_str)

def get_mem_func(parse_conent,cur_class,target_type):
    # 遍历方法 - public
    for class_mem_func in parse_conent.classes[class_name]['methods'][target_type]:
        tmp_str = ''
        tmp_str = type_hash[target_type] + class_mem_func['name'] + '('
        # 遍历函数参数
        if len(class_mem_func['parameters']):  # 有参数
            p_cnt = len(class_mem_func['parameters'])
            tmp_cnt = 0
            for one_param in class_mem_func['parameters']:  # 一个函数的多个参数，分多行
                tmp_cnt = tmp_cnt + 1
                tmp_str = tmp_str + one_param['name'] + " : " + one_param['type']
                if tmp_cnt != p_cnt:
                    tmp_str = tmp_str + ' , '
        tmp_str = tmp_str + ')' + " : "

        # 组装返回值
        tmp_str = tmp_str + class_mem_func['rtnType']
        print(tmp_str)



if __name__ == '__main__':
    while True:
        # file = input("文件路径: ")
        file = input("请输入头文件路径: ")
        dest_dir_path = './'
        # 源文件是否存在
        if os.path.exists(file):
            print()
            # 复制文件
            shutil.copy2(file,dest_dir_path)
            # 新的目标路径
            (file_path,file_name) = os.path.split(file)
            file = dest_dir_path + file_name
            # 拷贝的临时文件是否存在
            if os.path.exists(file):
                # 去除新文件中的中文
                tmp_new_content = ''
                with open(file,"r+",encoding='utf-8') as f:
                    old_file_content = f.read()
                    # print(old_file_content)
                    tmp_new_content = re.sub('[\u4e00-\u9fa5]','',old_file_content)
                # 重新打开，清空写入
                with open(file,"w+",encoding='utf-8') as f:
                    f.write(tmp_new_content)

                # 解析
                parse_conent = CppHeaderParser.CppHeader(file)
                # 遍历每个解析到的类
                for class_name in parse_conent.classes.keys():
                    # 当前类
                    print("###################################################")
                    print(class_name + '\n')
                    # 获取属性 - private - protected - public
                    get_mem_var(parse_conent, class_name, 'private')
                    get_mem_var(parse_conent, class_name, 'protected')
                    get_mem_var(parse_conent, class_name, 'public')
                    print()
                    # 获取方法 - private - protected - public
                    get_mem_func(parse_conent, class_name, 'private')
                    get_mem_func(parse_conent, class_name, 'protected')
                    get_mem_func(parse_conent, class_name, 'public')

                    # 分割线，划分不同类
                    print()
                    print("###################################################")
            else:
                print("拷贝文件不存在")
        else:
            print("源文件文件不存在")


        # 结束后删除临时文件
        os.remove(file)

使用

获取文件路径

  • shift + 右键选择文件，点击复制文件路径，即可获取该文件的绝对路径。
  • 或者使用VSCode，Clion，右键选择文件，复制文件路径。

启动程序，输入路径即可。

  • 这个类内容太多了，这里就截取了一部分。
  • 类名，成员变量，成员方法之间用空行隔开。多个类直接用#隔开。

存在问题

  • 部分新特性解析错误，例如:
  // 定时触发的回调函数
  std::function<void()> tick_;

  // 处理消息的回调函数
  std::function<Status(proto::MessagePtr)> step_;

会识别为成员函数。

  • 不完善的地方
    • 构造函数析构函数的，返回值类型，为void,应该为空
    • 析构函数检测不到波浪号~

  • CppHeaderParser打开文件编码问题(已经解决)，会提示如下报错
   headerFileStr = "".join(fd.readlines())
UnicodeDecodeError: 'gbk' codec can't decode byte 0x8c in position 830: illegal multibyte sequence

原因: 给定文件中有GBK无法表示的字符。例如中文。
解决方法(已在上述代码中使用): 拷贝文件，去掉其中的中文字符，保存文件，用GBK编码集保存。

Python读cpp文件去注释自动机实现
wuhaibin12的博客
01-04 454
class Remove_annotations: def __init__(self): self.state = 0 self.c1 = 0 self.c2 = 0 self.st = "" def change_state(self, c): if self.state == 0: ...
cppparser：将CC ++源解析为AST的库
02-04
cppparser：将CC ++源解析为AST的库
h2cppx:解析C++头文件并生成C++实现代码
06-26
解析c++头文件并生成c++实现代码 目的：提供“头文件转cpp文件”功能，为其他平台开发插件。 要求： python 2.x 添加一名作者 需要外部模块： yaml Cheetah 第三方： pyvisitor CppHeaderParser（修改） 帮助查询： h2cppx -h 例子： python h2cppx sample/sample.h 已经包含平台支持： vim 支持：vim-port 分支，只需使用“git checkout vim-port”即可。 关于程序退出的错误代码说明，参见doc/error_code.txt文件。 关于如何编写模板文件，请参见 doc/template.md 文件。
python写的软件怎么逆向_python逆向工程：通过代码生成类图
weixin_39807954的博客
12-08 562
python逆向工程：通过代码生成类图大致过程现在有一个core包，里面有python的代码。通过core包，生成python的类图，如下：实施步骤：1、首先安装graphviz，一个画图工具，地址为：http://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.28.0.msi或者百度下载中心，下载graphviz2、pyrever...
python使用tree-sitter解析cpp代码绘制出树形图可视化
sluck_0430的博客
11-03 4210
使用 python tree-sitter 绘制 C/C++ 源代码的AST/CST可视化树型图
UML类图精讲：面向对象设计的不传之秘
![UML类图精讲：面向对象设计的不传之秘](https://img-blog.csdnimg.cn/415081f6d9444c28904b6099b5bdacdd.png?x-oss-process=image/watermark,type_...本文对UML类图进行系统性的介绍，从基础元素的定义、关系种类的意
装饰模式实战解析：Python与C++示例代码
装饰模式的UML类图通常包含以下几个角色： 1. 抽象组件（Component）：这是一个抽象接口，用于给对象动态地添加职责。 2. 具体组件（Concrete Component）：定义了一个具体的对象，也可以给这个对象添加一些职责。 ...
python代码app自动生成器
12-31
另外还有一种叫做Pyreverse的方法可用于从现有Python项目中提取信息以绘制出其内部对象之间的关系图表——即所谓的UML（统一建模语言）中的类图表示形式。作为Pylint包的一部分被集成进来，这意味着只要正确设置了...
#include <iostream> // 输入输出流库，用于cin/cout操作 #include <string> // 字符串处理库 #include <cctype> // 字符处理函数库（虽然本例未直接使用，但通常用于输入验证） using namespace std; // 使用标准命名空间，避免重复写std:: // 课题类 - 表示单个课题的实体 class Topic { public: string title; // 课题标题（字符串类型） bool isSelected; // 课题是否已被选择（布尔类型） string selectedBy; // 选择该课题的学生姓名（字符串类型） // 构造函数 - 创建课题对象时自动调用 Topic(string t) : title(t), isSelected(false), selectedBy("") {} // 参数t: 传入的课题标题 // : 后是成员初始化列表 // title(t) - 将成员title初始化为传入的t // isSelected(false) - 初始状态设为未选择 // selectedBy("") - 初始选择者设为空字符串 }; // 类定义结束 // 课题管理系统类 - 管理课题集合 class TopicManager { private: Topic** topics; // 指向课题指针数组的指针（动态二维数组） int capacity; // 当前数组的容量（可容纳的最大课题数） int size; // 当前实际存储的课题数量 // 调整数组容量的私有方法 void resize(int newCapacity) { // 创建新容量的指针数组 Topic** newTopics = new Topic*[newCapacity]; // 将原数组内容复制到新数组 for (int i = 0; i < size; ++i) { newTopics[i] = topics[i]; // 复制指针（浅拷贝） } // 释放原数组内存 delete[] topics; // 先删除指针数组 topics = newTopics; // 将topics指向新数组 capacity = newCapacity; // 更新容量值 } public: // 构造函数 - 初始化管理系统 TopicManager() : topics(nullptr), capacity(0), size(0) {} // 初始化列表： // topics(nullptr) - 初始化为空指针 // capacity(0) - 初始容量为0 // size(0) - 初始课题数为0 // 析构函数 - 对象销毁时自动调用，释放内存 ~TopicManager() { // 遍历所有课题对象，释放每个课题的内存 for (int i = 0; i < size; ++i) { delete topics[i]; // 删除每个课题对象 } delete[] topics; // 删除课题指针数组 } // 增加课题的公共方法 void addTopic(string title) { // 检查是否需要扩容 if (size >= capacity) { // 计算新容量：初始为2，之后倍增 int newCapacity = (capacity == 0) ? 2 : capacity * 2; resize(newCapacity); // 调用扩容方法 } // 在数组末尾创建新课题 topics[size] = new Topic(title); // 动态分配内存 size++; // 课题数量增加 cout << "课题已添加: " << title << endl; // 操作反馈 } // 删除课题的公共方法 void deleteTopic(int index) { // 检查索引有效性 if (index >= 0 && index < size) { cout << "课题已删除: " << topics[index]->title << endl; // 反馈 delete topics[index]; // 释放该课题的内存 // 移动后续元素填补空缺 for (int i = index; i < size - 1; ++i) { topics[i] = topics[i + 1]; // 指针前移 } size--; // 课题数量减少 } else { cout << "无效的课题索引。" << endl; // 错误提示 } } // 修改课题的公共方法 void modifyTopic(int index, string newTitle) { // 检查索引有效性 if (index >= 0 && index < size) { topics[index]->title = newTitle; // 更新标题 cout << "课题已修改: " << newTitle << endl; // 反馈 } else { cout << "无效的课题索引。" << endl; // 错误提示 } } // 显示所有课题的公共方法 void displayTopics() { cout << "当前课题列表：" << endl; // 标题 // 遍历所有课题 for (int i = 0; i < size; ++i) { // 输出序号和标题 cout << i + 1 << ". " << topics[i]->title; // 如果课题已被选择，显示选择者信息 if (topics[i]->isSelected) { cout << " (已选择 by " << topics[i]->selectedBy << ")"; } cout << endl; // 换行 } } // 选择课题的公共方法 void selectTopic(int index, string studentName) { // 检查索引有效性 if (index >= 0 && index < size) { // 检查课题是否已被选择 if (!topics[index]->isSelected) { topics[index]->isSelected = true; // 标记为已选择 topics[index]->selectedBy = studentName; // 记录选择者 cout << "你已选择课题: " << topics[index]->title << endl; // 反馈 } else { // 课题已被选择时显示选择者信息 cout << "该课题已被选择 by " << topics[index]->selectedBy << endl; } } else { cout << "无效的课题索引。" << endl; // 错误提示 } } // 查看已选课题的公共方法 void viewSelectedTopics() { cout << "已选课题列表：" << endl; // 标题 // 遍历所有课题 for (int i = 0; i < size; ++i) { // 只显示已被选择的课题 if (topics[i]->isSelected) { // 输出课题标题和选择者 cout << topics[i]->title << " by " << topics[i]->selectedBy << endl; } } } }; // 菜单显示函数 void menu() { // 输出菜单选项 cout << "Menu:" << endl; cout << "1. 添加课题" << endl; cout << "2. 删除课题" << endl; cout << "3. 修改课题" << endl; cout << "4. 显示所有课题" << endl; cout << "5. 选择课题" << endl; cout << "6. 查看已选课题" << endl; cout << "7. 退出系统" << endl; } // 获取有效整数输入的函数 int getValidIntInput() { int value; // 存储输入值的变量 // 循环直到获得有效输入 while (!(cin >> value)) { cout << "输入无效，请重新输入: "; // 错误提示 cin.clear(); // 清除错误状态 cin.ignore(10000, '\n'); // 忽略缓冲区中的错误输入 } return value; // 返回有效整数 } // 主函数 - 程序入口点 int main() { TopicManager manager; // 创建课题管理器对象 int choice; // 存储用户选择的变量 // 主循环 do { menu(); // 显示菜单 cout << "请选择操作: "; choice = getValidIntInput(); // 获取有效整数输入 cin.ignore(); // 忽略换行符，防止影响后续输入 // 根据用户选择执行操作 switch (choice) { case 1: { // 添加课题 string title; cout << "请输入课题名称: "; getline(cin, title); // 读取整行输入 manager.addTopic(title); // 调用添加方法 break; } case 2: { // 删除课题 cout << "请输入要删除的课题索引: "; int index = getValidIntInput(); // 获取索引 manager.deleteTopic(index - 1); // 调用删除方法（索引-1转换为0-based） break; } case 3: { // 修改课题 cout << "请输入要修改的课题索引: "; int index = getValidIntInput(); // 获取索引 cin.ignore(); // 清除换行符 string newTitle; cout << "请输入新的课题名称: "; getline(cin, newTitle); // 读取新标题 manager.modifyTopic(index - 1, newTitle); // 调用修改方法 break; } case 4: // 显示所有课题 manager.displayTopics(); // 调用显示方法 break; case 5: { // 选择课题 cout << "请输入要选择的课题索引: "; int index = getValidIntInput(); // 获取索引 cin.ignore(); // 清除换行符 string studentName; cout << "请输入你的名字: "; getline(cin, studentName); // 读取学生姓名 manager.selectTopic(index - 1, studentName); // 调用选择方法 break; } case 6: // 查看已选课题 manager.viewSelectedTopics(); // 调用查看方法 break; case 7: // 退出系统 cout << "退出系统。" << endl; // 退出提示 break; default: // 无效选择处理 cout << "无效的选择。" << endl; break; } cout << endl; // 添加空行，使界面更清晰 } while (choice != 7); // 当选择7时退出循环 return 0; // 程序正常结束 }生成UML类图
最新发布
06-16
我们正在处理用户关于如何为给定的C++代码生成UML类图的问题。根据引用内容，我们有几种方法：1.使用clang-uml工具（引用[1]），它是一个高效的C++代码到UML图表生成器。2.使用RationalRose进行C++代码的逆向工程...
aiplantuml自动生成类图
03-23
AIPlantUML 是一种基于 PlantUML 的工具，能够通过分析代码自动生成 UML 类图。以下是关于如何使用该工具生成类图的相关说明。 #### 工具安装与配置 为了使用 AIPlantUML 自动化生成类图，需先完成环境搭建。通常...
Python代码调用CPP代码 简单易用 无需过多配置
星辰火之梦
08-30 909
pybind11是一个用于在 C++ 和 Python 之间创建绑定的库，使得 C++ 函数和类可以被 Python 脚本调用。下面是一个简单的步骤指南，展示如何使用pybind11来创建一个扩展模块，该模块包含一个简单的 C++ 函数，并在 Python 中调用它。
python cpp_cpp2python
weixin_32314595的博客
02-09 302
cpp2pythonThe script helps to convert C/C++ sources to C/C++ -like Python sources.It does some simple edit operations like removing semicolons and type declarations.After it you must edit code manuall...
Python pycparser(c文件解析)模块使用教程
m0_56208280的博客
08-13 7305
抽象语法树 ast 类型为 ...
python中生成类图
weixin_63468703的博客
07-03 681
Pylint 是 Python 2 或 3 的。最新版本支持 Python 3.8.0 及以上版本。Pylint 在不实际运行代码的情况下分析代码。它检查错误，强制执行 编码标准，寻找，并能对代码如何提出建议 可以重构。Graphviz是一个跨平台的图形可视化软件，使用DOT语言来描述图形，并通过布局引擎将这些描述转换为图形输出。
python学生管理系统类图_python 类图
weixin_39923110的博客
11-29 499
广告关闭腾讯云11.11云上盛惠 ，精选热门产品助力上云，云服务器首年88元起，买的越多返的越多，最高返5000元！python3中类有单继承和多继承，其中多继承与python2的继承顺序不同。 子类方法与父类重名，子类方法会覆盖父类 单继承：一言不合就上例子 classperson(object):def__init__(self,person_name):self.name=person_na...
python cpp_python和cpp的相互调用
weixin_39883091的博客
11-28 459
这两天干活遇到需要python与cpp代码之间的相互调用，我这边的应用复杂，都是取决于代码的多少，但是总的方法不变，这里用两个简单例子说明下，有兴趣的筒子可以探讨下~~我的测试环境：ubuntu1604，python2.7，g++5.4c++调用python代码头文件：我这里包含到了python2.7，可以自己去/usr/local/lib中去查看下，主要能找到Python.h就行；Py_Init...
Python 应用Graphviz画类图
GZKPeng的博客
09-08 931
1、安装Graphviz.exe 官网https://link.zhihu.com/?target=http%3A//www.graphviz.org/download/ 需要科学上网，我也下在了百度网盘。以本机为例该路径下有两个文件夹，我们所需要的是Scripts路径下的pyreverse.exe。参考的：https://zhuanlan.zhihu.com/p/365953969。如果不成功配置一下环境变量，将安装目录下，bin文件的目录放进去。最后，生成的.dot文件啥的，也是在example下。
Boost-python封装Cpp代码供Python调用
Sunshine_in_Moon的专栏
01-13 1688
好久没有写博客了，今天把自己有道云笔记上东西分享给大家。Boost::python的使用可以参考我的一篇博客，这里只列举几个简单的例子,对该篇博客的补充。封装一个单一的函数#include<iostream>#include<boost/python/def.hpp> #include<boost/python/module.hpp> #include<boost/python/args.hpp>
获取类型的基本信息（C/C++）
PixelProX的博客
09-12 334
通过sizeof运算符可以获取类型的字节大小，通过typeid运算符（C++特性）可以获取对象的类型信息，而通过模板元编程（C++特性）可以在编译期间获取类型的信息。需要注意的是，typeid运算符返回的是一个std::type_info对象，可以通过其name()函数获取类型名称。上述代码中，通过模板元编程的方式定义了printTypeInfo函数，该函数可以获取类型T的信息，并打印输出类型名称以及是否为整型或浮点型。通过获取类型的信息，我们可以在程序中进行类型检查、动态内存分配和对象操作等。
如何在Eclipse中安装并使用AmaterasUML画UML类图
根据提供的文件信息，可以推断出的知识点涉及Eclipse集成开发环境，UML（统一建模语言）以及AmaterasUML这个具体插件的安装和使用。 Eclipse 是一个开放源代码的集成开发环境（IDE），最初由IBM公司开发，主要用于...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

半生瓜のblog

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值