【python脚本】ICer的脚本入门训练——find_key

 我们的目标是┏ (゜ω゜)=☞芯片前端全栈工程师~喵！

前言

往期回顾：

【python脚本】ICer的脚本入门训练——svn_back_尼德兰的喵的博客-CSDN博客_svn back文件

【python脚本】ICer的脚本入门训练——gen_tc_尼德兰的喵的博客-CSDN博客

查找关键词这一类脚本，之前写过针对word文档查找关键字的：

针对word.docx文档的关键词索引器_尼德兰的喵的博客-CSDN博客_docx预览跳到指定关键词位置

而这次作为脚本训练呢，是用来查找编译文件内的关键字（其实这个脚本我也写过几次，不过都在内网上(⊙﹏⊙)）。具体使用的场景呢，举个例子，比如说我想找一个parameter是在哪个文件定义的，或者一个宏定义的位置，或者某个uvm关键字的声明位置，那么就可以使用脚本吃编译的log（或者综合的log），然后按文件去查找关键字所在的位置完成索引过程。

组织脚本

脚本gen_python find_key.py，起手式如下：

import sys
import os
import re
import argparse

def input_args_proc():#{{{
    parser = argparse.ArgumentParser(description="argparse info")
    parser.add_argument('-o', action='store_true', default=False, help='open this script')
    result = parser.parse_args()
    if result.o == True:
        os.system("gvim %s" % __file__)
        sys.exit(0)
pass#}}}

def main():
    input_args_proc()
pass

if __name__ == "__main__":
    print("%s is working" % __file__)
    main()

这个命令参考：【我有一个大胆的想法】用perl搞个脚本来自动gen_python哈哈哈哈哈_尼德兰的喵的博客-CSDN博客 ， 这个格式主要的目的是通过-o来直接打开脚本，避免之前出现过的改了半天脚本结果发现执行的不是改的那个脚本的情况（我linux下的全局路径比较多）。

那么在此基础上我们先来增加几个输入参数：

def input_args_proc():#{{{
    parser = argparse.ArgumentParser(description="argparse info")
    parser.add_argument('-o', action='store_true', default=False, help='open this script')
    parser.add_argument('-k', help='key word')
    parser.add_argument('-f', help='log path')
    parser.add_argument('-n', help='return file num')
    result = parser.parse_args()
    if result.o == True:
        os.system("gvim %s" % __file__)
        sys.exit(0)
    if result.k:
        key_word = result.k
    else:
        raise ValueError("No key word input")
    if result.f: 
        file_path = result.f
    else:
        file_path = r"./sim_base/log/sim.log"
    if result.n:
        find_num = result.n
    else:
        find_num = -1
    print("Find \"{0}\" in log {1}, max return {2} files".format(key_word, file_path, find_num))
    return key_word, file_path, find_num
pass#}}}

对于查找脚本，需要的三个变量就是：查找的关键词、编译的log文件以及需要查找多少个文件，比如要找一个变量的定义位置那么大概率只需要找第一个文件即可。在上面的代码中，-k用于输入查找关键词，-f用于指定log，-n用于标记找到多少个文件后停止查找。三个输入参数均通过parser机制输入。

完成该函数后，将函数添加到main()中：

key_word, file_path, find_num = input_args_proc()

然后我们来观察下log文件的格式，内部编译的文件格式都是非常一致的：

Parsing design file '/home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/uvm_pkg.sv'
Parsing included file '/home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/uvm_macros.svh'.
Parsing included file '/home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/macros/uvm_version_defines.svh'.
Back to file '/home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/uvm_macros.svh'.
Parsing included file '/home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/macros/uvm_global_defines.svh'.
Back to file '/home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/uvm_macros.svh'.
Parsing included file '/home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/macros/uvm_message_defines.svh'.

那么根据这个格式，通过re.search来把所有编译的文件提出来就可以了：

def read_log(file_path):#{{{
    file_list = []
    with open(file_path, "r") as hd:
        handle = hd.readlines()
        for line in handle:
            res = re.search(r"file \'(.*)\'", line)
            if res:
                file_list.append(res.group(1))
                #print(res.group(1))
    return file_list
pass#}}}

而后，将read_log也添加到main()中：

file_list = read_log(file_path)

最后一步，使用os.popen(cmd)方法，在python中执行grep命令，检查每个文件中是否包含关键字key_word，如果包含则将文件路径打印并判定返回的文件数量是否超过了设置的find_num值：

def find_key_in_file(key_word, find_num, file_list):#{{{
    num = 0
    for file in file_list:
        #print(file)
        ret = os.popen("grep {0} {1} -l".format(key_word, file)).readlines() 
        if ret:
            print("    " + ret[0].strip())
            num += 1
            if num >= int(find_num) and int(find_num) >= 0:
                break
pass#}}}

最后把find_key_in_file()函数也加入main()中即可：

find_key_in_file(key_word, find_num, file_list)

测试一下效果：

$./find_key.py -k uvm_factory -n 10
./find_key.py is working
Find "uvm_factory" in log ./sim_base/log/sim.log, max return 10 files as：
    /home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/macros/uvm_deprecated_defines.svh
    /home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/base/uvm_base.svh
    /home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/base/uvm_coreservice.svh
    /home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/base/uvm_base.svh
    /home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/base/uvm_base.svh
    /home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/base/uvm_base.svh
    /home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/base/uvm_misc.svh
    /home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/base/uvm_base.svh
    /home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/base/uvm_object.svh
    /home/synopsys/vcs/O-2018.09-SP2/etc/uvm-1.2/base/uvm_base.svh

初步看，是可以满足使用需求的，最后将之存档：

find_key.py · 尼德兰的喵/myscript_python - Gitee.com