1## 1.修改环境变量配置 2 3使用该工具前需要修改[constants.py](./src/utils/constants.py) 4文件下的StringConstant.LIB_CLG_PATH、StringConstant.REPLACE_WAREHOUSE、StringConstant.INCLUDE_LIB； 5StringConstant.LIB_CLG_PATH:共享库(本地的) 6REPLACE_WAREHOUSE：拉下来的interface_sdk_c仓的目录(本地的路径) --例如：(去掉磁盘的路径)\\interface_sdk_c 7StringConstant.INCLUDE_LIB：# 拉到本地仓的三方库路径 8 9## 2.环境： 10 111)python-3.11.4-amd64 12 132)PyCharm Community Edition 2023.2 14 153)下载[requirements.txt](./requirements.txt)下面的库 ---下载指令：pip install -r txt文件路径 16 174)需要把src目录设置为sources root(找到src目录，点击右键，将目标标记为里面) 18 195)在interface_sdk_c目录下运行的是src目录下的mian.py文件 20 21## 3.终端指令 22 23options: 24 -h, --help show this help message and exit 25 -N {collect, check, diff, collect_h, collect_file}, --tool-name {collect, check, diff, collect_h, collect_file} 26 工具名称 27 -P PARSER_PATH, --parser-path PARSER_PATH 28 解析路径 29 30例如：用的统计工具：终端指令：py -N collect -P 目录文件路径 ---就是调用CAPI统计工具的使用 31 32## 4.自动化测试 33 341）在test/ut下添加对应工具的测试用例 35 362）在test/expect下添加对应工具的期望结果 37 383）在test/testCase/run_main.py添加对应的方法执行测试用例的解析，将结果输出到test/output下，与expect对比期望结果 39 40添加的方法需要以test_开头 41 42## 5.统计工具使用指令 43 44注意：工作路径在interface_sdk_c下(也就是C仓下) 451）统计工具(C仓-含gn文件) 46在工作路径下执行：py main.py路径(相对工作路径) -N collect -P 目录文件路径 47生成文件名：result_total.xlsx--扫描结果api数据 48 492）统计工具(直接获取) 50在工作路径下执行：py main.py路径(相对工作路径) -N collect_h -P 目录文件路径/头文件路径 51生成文件名：parser_direct_data.xlsx--扫描结果api数据 52 533）统计工具(获取到文件级的kit、子系统和文件当前接口数) 54在工作路径下执行：py main.py路径(相对工作路径) -N collect_file -O 输出json文件路径名或者不加-O 55生成文件名(不加-O)：api_kit_c.json--文件级接口数据； 56生成文件名(加-O)：传入json文件路径名 57 58## 5.diff工具使用指令 59注意：工作路径在interface_sdk_c下(也就是C仓下) 60在工作路径下执行：py main.py路径(相对工作路径) -N diff -old 旧文件目录路径 -new 新文件目录路径 -O 输出文件路径 61生成文件名：在对应的输出文件路径会生成三个文件： 621）diff.xlsx --diff结果数据表格 632）diff_result.txt --diff结果数据txt文件 643）diff合集 --目录文件，里面是按kit名生成的md表格数据(其中NA或者nullOfKit是对应没有kit的数据) 65