需求:将xmind文件转为Excel文件
需求一句话就讲清楚了,但实际上还需要做很多工作:
- 了解Xmind文件结构
- 提取xmind文件分支内容(重点)
- 接续提取内容(次重点)
- 写入Excel
了解Xmind结构
常见Xmind结构写出来的用例形式(不同写法,只是解析需要更改而已)
提取XMind文件
用“from xmindparser import xmind_to_dict”,用xmindparser包将其转化为字典格式再做处理。
XMind内容可以简化为上图形式
这个xmind文件通过xmind_to_dict可以转换结果如下
{'title': 'A', 'topics': [{'title': 'B1'}, {'title': 'B2', 'topics': [{'title': 'C1'}, {'title': 'C2'}]}, {'title': 'B3'}]}
内容装在一个list里,字典最外层title为“画布1”,topic装有我们需要的内容(可以看出其他位置叫topics),这是xmind文件中没有的,经验证这是个固定值,可以忽略。然后通过取list,A是字典中value值,key为title,其子节点装在topics的分支中。处理后是这样,最外层是dict:
那么问题来了,如何将其处理为想要的形式呢?一层层的取key、value吗?
当然不是,那工作量将非常庞大,而且不利于阅读和修改。还记得刚才的思考内容吗?这里我们就需要用到你所想的,没错,递归。
为什么要用递归,我们仔细看看结构:
A的三个子节点分别为B1,B2,B3,B2 的子节点为C1C2,参看上图你想到了什么?
1,标题和子节点放在不同的item里,即topic放根节点,那topics则放其子节点。
2,topics无子节点呢?像C1C2那样的点没有子节点,我们发现,它也没有topics;同时,没有子节点证明它是这条分支的最后一层了;试想,如果A没子节点,就只有它一个呢?正如你所想,它只有一个title,没有topics。
3,A的子节点是一个list,list可以有多个子节点,子节点若还有子节点则有topics,若没有则没有topics。
4,title永远装的是string,而topics可以装list,list里还有dict,也可以没有topics。
看了四点还是觉得很乱?
我们需要一层层取子节点才可以得到我们想要的A\B2\C1、A\B2\C2,节点值永远在title里,而子节点却在dict、list里的dict里,而且子节点里有的只有一个title,有的有一个title加一个topics,前文已经说过,有topics的是还有其子节点的。
那么现在应该清晰点了吧?还不清楚?那伪代码再来一遍:
如果 输入字典:
当字典只有有title时:
操作1
当字典有title和topics时:
操作2
如果 输入list:
遍历list里的字典:
对每个字典进行操作3
如果 输入的既不是字典也不是list:
输出值
思路框架已经搭建了,那操作1、2、3是什么呢?其实就是本框架的重复操作,调用下自己就可以了,不严谨的说这就是递归的通俗解释。
def TraversalXmind(root,rootstring):
if isinstance(root, dict):
if len(root) == 2:
TraversalXmind(root['topics'], str(rootstring) )
if len(root) == 1:
TraversalXmind(root['title'],str(rootstring) )
elif isinstance(root, list):
for sonroot in root:
TraversalXmind(sonroot, str(rootstring) + "\\" + sonroot['title'])
elif isinstance(root,str):
print(str(rootstring) )
# TraversalXmind(root, "\\AA")
如上方代码所示,这就是对XMind文件完成了解析
问题:
- 如果用例不规范,出现缺少步骤或者输出的时候,这种时候一般需要补足列表,
- 如果是需要额外添加如用例优先级、前置条件等其他条件,需要根据解析增加列表内容
XMind实际解析代码
def traversal_xmind(root, rootstring, lisitcontainer):
"""
功能:递归dictionary文件得到容易写入Excel形式的格式。
注意:rootstring都用str来处理中文字符
@param root: 将xmind处理后的dictionary文件
@param rootstring: xmind根标题
"""
if isinstance(root, dict):
if 'title' in root.keys() and 'topics' in root.keys():
traversal_xmind(root['topics'], str(rootstring), lisitcontainer)
if 'title' in root.keys() and 'topics' not in root.keys():
traversal_xmind(root['title'], str(rootstring), lisitcontainer)
elif isinstance(root, list):
for sonroot in root:
if 'makers' in sonroot and 'callout' in sonroot:
traversal_xmind(sonroot, str(rootstring) + "&" + sonroot['title'] + "&" + str(sonroot['makers'][0]) +
"&" + str(sonroot['callout'][0]), lisitcontainer)
elif 'callout' in sonroot and 'makers' not in sonroot:
traversal_xmind(sonroot, str(rootstring) + "&" + sonroot['title'] + "&" + str(sonroot['callout'][0]),
lisitcontainer)
elif 'makers' in sonroot and 'callout' not in sonroot:
traversal_xmind(sonroot, str(rootstring) + "&" + sonroot['title'] + "&" + str(sonroot['makers'][0]) +
"&" + '', lisitcontainer)
else:
traversal_xmind(sonroot, str(rootstring) + "&" + sonroot['title'], lisitcontainer)
elif isinstance(root, str):
# lisitcontainer.append(str(rootstring.replace('\n', ''))) # 此处是去掉一步骤多结果情况直接拼接
lisitcontainer.append(str(rootstring)) # 此处是一步骤多结果时,多结果合并
上述为解析xmind的代码部分
解析列表
列表解析就比较简单了,方法都是各自实际情况进行解析,怎么方便怎么来
def deal_with_list(list):
'''
处理从xmind转换过来的用例list,并写入Excel中
:param list: 传入从xmind转换好的用例列表
:return:
'''
b = 1 # 记录写了多少行
for i in list:
j = i.split("&")
print(j)
if 'priority-1' in j or 'priority-2' in j or 'priority-3' in j:
# print(j)
x = 0
if 'priority-1' in j:
x = j.index('priority-1')
elif 'priority-2' in j:
x = j.index('priority-2')
elif 'priority-3' in j:
x = j.index('priority-3')
maker = maker_judgment(j[x])
callout = j[x+1]
if j[x+1] == j[-1]:
result = ""
step = ""
elif j[x+2] == j[-1]:
result = ""
step = j[-1]
elif j[x+3] == j[-1]:
result = j[-1]
step = j[-2]
filename = j[1]
name = ''
for a in j[2:x]:
name += a
# print(filename, name, maker, callout, step, result)
write_sheet(b, filename, name, maker, callout, step, result) # 写入Excel
b += 1
此时就写好了用例的元素获取包括文件夹、标题、用例等级、前置条件、步骤、预期结果并写入了Excel中
在项目中,导入用例只能用给出的模板,所以还封装了处理模板的模块
def deal_excle(filename):
'''
tapd导入用例必须使用自有模板,因为此处复制模板Excel后生成新表
:param filename: 模板地址
:return:
'''
workbook = xlrd.open_workbook('用例模板.xls')
readbook = copy(workbook)
idx = workbook.sheet_names()[0]
readbook.get_sheet(idx).name = str(root["title"])
worksheet = readbook.get_sheet(0)
return readbook, worksheet
到这里,xmind转Excel就基本结束了
源代码附上:
from xmindparser import xmind_to_dict
import xlwt, xlrd
from xlutils.copy import copy
def traversal_xmind(root, rootstring, lisitcontainer):
"""
功能:递归dictionary文件得到容易写入Excel形式的格式。
注意:rootstring都用str来处理中文字符
@param root: 将xmind处理后的dictionary文件
@param rootstring: xmind根标题
"""
if isinstance(root, dict):
if 'title' in root.keys() and 'topics' in root.keys():
traversal_xmind(root['topics'], str(rootstring), lisitcontainer)
if 'title' in root.keys() and 'topics' not in root.keys():
traversal_xmind(root['title'], str(rootstring), lisitcontainer)
elif isinstance(root, list):
for sonroot in root:
# traversal_xmind(sonroot, str(rootstring) + "&" + sonroot['title'], lisitcontainer)
if 'makers' in sonroot and 'callout' in sonroot:
traversal_xmind(sonroot, str(rootstring) + "&" + sonroot['title'] + "&" + str(sonroot['makers'][0]) +
"&" + str(sonroot['callout'][0]), lisitcontainer)
elif 'callout' in sonroot and 'makers' not in sonroot:
traversal_xmind(sonroot, str(rootstring) + "&" + sonroot['title'] + "&" + str(sonroot['callout'][0]),
lisitcontainer)
elif 'makers' in sonroot and 'callout' not in sonroot:
traversal_xmind(sonroot, str(rootstring) + "&" + sonroot['title'] + "&" + str(sonroot['makers'][0]) +
"&" + '', lisitcontainer)
else:
traversal_xmind(sonroot, str(rootstring) + "&" + sonroot['title'], lisitcontainer)
elif isinstance(root, str):
# lisitcontainer.append(str(rootstring.replace('\n', ''))) # 此处是去掉一步骤多结果情况直接拼接
lisitcontainer.append(str(rootstring)) # 此处是一步骤多结果时,多结果合并
def get_case(root):
rootstring = root['title']
lisitcontainer = []
traversal_xmind(root, rootstring, lisitcontainer)
# for lisitcontaine in lisitcontainer:
# print(lisitcontaine)
return lisitcontainer
def maker_judgment(makers):
maker = 4
if '1' in makers:
maker = 0
elif '2' in makers:
maker = 1
elif '3' in makers:
maker = 2
return maker
def write_sheet(b, filename, name, maker, callout, step, result):
worksheet.write(b, 0, filename) # ,模块
worksheet.write(b, 1, name) # 用例名称
worksheet.write(b, 2, maker) # 优先级
worksheet.write(b, 3, callout) # 细节秒速
worksheet.write(b, 4, step) # 用例步骤
worksheet.write(b, 5, result) # 预期结果
def deal_with_list(list):
'''
处理从xmind转换过来的用例list,并写入Excel中
:param list: 传入从xmind转换好的用例列表
:return:
'''
b = 1 # 记录写了多少行
for i in list:
j = i.split("&")
print(j)
if 'priority-1' in j or 'priority-2' in j or 'priority-3' in j:
# print(j)
x = 0
if 'priority-1' in j:
x = j.index('priority-1')
elif 'priority-2' in j:
x = j.index('priority-2')
elif 'priority-3' in j:
x = j.index('priority-3')
maker = maker_judgment(j[x])
callout = j[x+1]
if j[x+1] == j[-1]:
result = ""
step = ""
elif j[x+2] == j[-1]:
result = ""
step = j[-1]
elif j[x+3] == j[-1]:
result = j[-1]
step = j[-2]
filename = j[1]
name = ''
for a in j[2:x]:
name += a
# print(filename, name, maker, callout, step, result)
write_sheet(b, filename, name, maker, callout, step, result) # 写入Excel
b += 1
def deal_excle(filename):
'''
tapd导入用例必须使用自有模板,因为此处复制模板Excel后生成新表
:param filename: 模板地址
:return:
'''
workbook = xlrd.open_workbook('用例模板.xls')
readbook = copy(workbook)
idx = workbook.sheet_names()[0]
readbook.get_sheet(idx).name = str(root["title"])
worksheet = readbook.get_sheet(0)
return readbook, worksheet
if __name__ == '__main__':
root = xmind_to_dict("xxx.xmind")[0]['topic']
file_name = '用例模板.xls'
readbook, worksheet = deal_excle(file_name)
case = get_case(root)
deal_with_list(case)
readbook.save('/Users/xxx/Desktop/' + root["title"] + ".xls") # 此处可以填写生成位置,
转换效果
答疑:
- 出现用例存在部分缺失时:
在解析XMind的时候,如果有的解析为空时,需要手动加入为空的情况,保证有实际占位,保证后续解析不会出现错误 - 其他添加额外条件时,看清楚额外条件在解析后JSON中的位置,在traversal_xmind函数里面完成对应的解析就OK
声明
本人水平有限,如果文章和代码有表述不当之处,还请不吝赐教,可以交流讨论。
鸣谢:感谢puppet洛洛的支持
引用: python xmind转Excel(puppet洛洛原创) - puppet洛洛 - 博客园 (cnblogs.com)