實(shí)戰(zhàn) | 如何用 Python 統(tǒng)計(jì) Jira 數(shù)據(jù)并可視化

大家好，我是安果！

目前公司使用 Jira 作為項(xiàng)目管理工具，在每一次迭代完成后的復(fù)盤會(huì)上，我們都需要針對(duì)本次迭代的 Bug 進(jìn)行數(shù)據(jù)統(tǒng)計(jì)，以幫助管理層能更直觀的了解研發(fā)的代碼質(zhì)量

本篇文章將介紹如何利用統(tǒng)計(jì) Jira 數(shù)據(jù)，并進(jìn)行可視化

1. 準(zhǔn)備

首先，安裝 Python 依賴庫(kù)

  1. # 安裝依賴庫(kù)
  2. pip3 install jira
  3. pip3 install html-table
  4. pip3 install pyecharts
  5. pip3 install snapshot_selenium

其中

  • jira 使用 jsql 語(yǔ)法從在項(xiàng)目中獲取需要的數(shù)據(jù)

  • html-table 用于生成一個(gè) HTML 格式的表格數(shù)據(jù)

  • pyecharts 和 snapshot_selenium 用于數(shù)據(jù)可視化

2. 實(shí)戰(zhàn)一下

下面我們通過(guò) 7 個(gè)步驟來(lái)實(shí)現(xiàn)上面的功能

2-1 登錄獲取客戶端連接對(duì)象

  1. from jira import JIRA
  2.  
  3. class JiraObj(object):
  4.     def __init__(self, bug_style, project_type):
  5.         """
  6.         :param project_name
  7.         :param sprint: 迭代號(hào)碼
  8.         :param bug_style: BUG狀態(tài)
  9.         """
  10.         # Jira首頁(yè)地址
  11.         self.server = 'https://jira.**.team'
  12.  
  13.         # Jira登錄賬號(hào)信息
  14.         self.basic_auth = ('用戶名', '密碼')
  15.  
  16.         # 創(chuàng)建一個(gè)客戶端連接信息
  17.         self.jiraClinet = JIRA(server=self.server, basic_auth=self.basic_auth)

2-2 根據(jù)項(xiàng)目類型獲取看板 id

  1. ...
  2.         # 獲取boards看板
  3.         # 所有看板信息
  4.         boards = [(item.id, item.name) for item in self.jiraClinet.boards()]
  5.         board_id = self.__get_board_id(boards, project_type)
  6.         print("看板id：", board_id)
  7. ...
  8.     def __get_board_id(self, boards, project_type):
  9.         """
  10.         獲取看板id
  11.         :param project_type:
  12.         :return:
  13.         """
  14.         board_id = 1
  15.         for item in boards:
  16.             if (project_type == PROJ_TYPE.Type1 and item[1] == 't1') or (
  17.                     project_type == PROJ_TYPE.Type2 and item[1] == 't2'):
  18.                 board_id = item[0]
  19.                 break
  20.         return board_id
  21. ..

2-3 根據(jù)看板 id 獲取迭代 id 及迭代名稱

  1. ...
  2.  # 獲取項(xiàng)目Sprint，讓用戶進(jìn)行選擇
  3.         sprints = self.jiraClinet.sprints(board_id=board_id)
  4.         for item in sprints:
  5.             if str(sprint_no) in item.name:
  6.                 self.sprint_id = item.id
  7.                 self.sprint_name = item.name
  8.                 print(f"選擇Sprint，id：{self.sprint_id},name：{self.sprint_name}")
  9.                 break
  10. ...

2-4  根據(jù)項(xiàng)目名、Bug 類型、迭代 id 組成 jsql 語(yǔ)句，并查詢數(shù)據(jù)

  1. ...
  2.  def get_bug_status_jsql(self, bug_status: BUG_STATUS):
  3.         """
  4.         通過(guò)bug狀態(tài)，獲取jsql
  5.         :param bug_status:
  6.         :return:
  7.         """
  8.         status_jsql = ''
  9.         if bug_status == BUG_STATUS.ALL:
  10.             status_jsql = ' '
  11.         elif bug_status == BUG_STATUS.TO_VERIFY:
  12.             # 待驗(yàn)證（已解決）
  13.             status_jsql = ' AND status = 已解決 '
  14.         elif bug_status == BUG_STATUS.TO_FIXED:
  15.             # 待解決（打開(kāi)、重新打開(kāi)、處理中）
  16.             status_jsql = ' AND status in (打開(kāi), 重新打開(kāi), 處理中) '
  17.         elif bug_status == BUG_STATUS.CLOSED:
  18.             # 關(guān)閉
  19.             status_jsql = ' AND status = Closed '
  20.         elif bug_status == BUG_STATUS.TO_FIXED_CONTAIN_DELAY:
  21.             # 待解決（打開(kāi)、重新打開(kāi)、處理中、延期處理）
  22.             status_jsql = ' AND status in (打開(kāi), 延期處理, 重新打開(kāi), 處理中) '
  23.         return status_jsql
  24. ...
  25. jql = f'project = {project_name} and issuetype = 故障  {self.get_bug_status_jsql(self.bug_style)} 
  26. AND Sprint = {self.sprint_id} ORDER BY priority desc, updated DESC'
  27.         print(jql)
  28.         lists = self.get_issue_list(jql)
  29. ...

2-5  生成本地 HTML 統(tǒng)計(jì)數(shù)據(jù)






需要注意的是，使用 a 標(biāo)簽組裝的鏈接不能直接跳轉(zhuǎn)，需要針對(duì)數(shù)據(jù)進(jìn)行二次替換才能正常進(jìn)行鏈接跳轉(zhuǎn) 

  1. from HTMLTable import (
  2.     HTMLTable
  3. )
  4.  
  5. ...
  6.  def gen_html_table(self, datas):
  7.         """
  8.         初始化表單樣式
  9.         :return:
  10.         """
  11.         table = HTMLTable(caption=f'實(shí)時(shí)BUG統(tǒng)計(jì)【{self.project_name}】，一共{len(datas)}個(gè)')
  12.  
  13.         # 表頭行
  14.         table.append_header_rows((('ID', '狀態(tài)', '優(yōu)先級(jí)', '責(zé)任人', '終端', 'URL'),))
  15.  
  16.         # 添加數(shù)據(jù)
  17.         table.append_data_rows(datas)
  18.  
  19.         # 設(shè)置樣式
  20.         table.caption.set_style({'font-size': '15px'})
  21.  
  22.         # 其他樣式設(shè)置
  23.         ...
  24.  
  25.         # 替換數(shù)據(jù)，便于展示href地址
  26.         html = table.to_html().replace("&lt;", "<").replace("&gt;", ">").replace("&quot;", '"')
  27.  
  28.         with open(f"./output/{self.project_name}-bug_{current_time()}.html", 'w', encoding='utf-8') 
  29. as file:
  30.             file.write(html)
  31. ...
  32. # 生成本地文件的數(shù)據(jù)
  33. output_tuples = tuple([
  34.             (item.get("key"), item.get("status"), item.get("priority"), item.get('duty'), 
  35. item.get('end_type'),
  36.              f'<a href="{item.get("url")}" target="_blank">點(diǎn)我查看</a>') for item in lists])
  37.  
  38. # 生成本地HTML文件
  39. self.gen_html_table(output_tuples)
  40. ..

2-6 數(shù)據(jù)統(tǒng)計(jì)

首先，這里按 Bug 責(zé)任人進(jìn)行分組，然后按數(shù)目進(jìn)行降序排列

然后，按 Bug 優(yōu)先等級(jí)進(jìn)行降序排列

最后，獲取每一個(gè)端的 Bug 總數(shù)

  1. ...
  2.         # 2、統(tǒng)計(jì)每個(gè)人（按數(shù)目）
  3.         datas_by_count = {}
  4.         for item in lists:
  5.             datas_by_count[item.get("duty")] = datas_by_count.get(item.get("duty"), 0) + 1
  6.  
  7.         # 降序排序
  8.         datas_by_count = sorted(datas_by_count.items(), key=lambda item: item[1], reverse=True)
  9.  
  10.         # print("按Bug總數(shù)排序:", datas_by_count)
  11.  
  12.         # 3、統(tǒng)計(jì)每個(gè)人（按優(yōu)先級(jí)）
  13.         datas_by_priority = {}
  14.  
  15.         for item in datas_by_count:
  16.             # 責(zé)任人
  17.             name = item[0]
  18.             # 5個(gè)優(yōu)先級(jí)對(duì)應(yīng)的數(shù)目
  19.             counts = self.get_assignee_count(lists, name)
  20.             datas_by_priority[name] = counts
  21.  
  22.         # 排序（按優(yōu)先級(jí)多條件降序排列）
  23.         datas_by_priority = sorted(datas_by_priority.items(),
  24.                                    key=lambda item: (item[1][0], item[1][1], 
  25. item[1][2], item[1][3]), reverse=True)
  26.  
  27.         # print("按Bug優(yōu)先級(jí)排序:", datas_by_priority)
  28.  
  29.         # 4、根據(jù)終端進(jìn)行統(tǒng)計(jì)分類
  30.         keys, values = self.get_end_type_count(lists)
  31. ...

2-7 可視化

針對(duì)上面的 3 組數(shù)據(jù)，使用 pyecharts 繪制成柱狀圖和餅狀圖

  1. ...
  2.       def draw_image(self, datas_by_count, datas_by_priority, keys, values):
  3.         """
  4.         繪制圖片
  5.         :param values:
  6.         :param keys:
  7.         :param datas_by_count: 按bug總數(shù)排序結(jié)果
  8.         :param datas_by_priority: 按bug優(yōu)先級(jí)排序結(jié)果
  9.         :return:
  10.         """
  11.         # 1、按BUG總數(shù)排序繪制
  12.         bar = (
  13.             Bar().set_global_opts(
  14.                 title_opts=opts.TitleOpts(title=f"{self.project_name}", 
  15. subtitle=f"{self.sprint_name}")))
  16.         bar.add_xaxis([item[0] for item in datas_by_count])
  17.         bar.add_yaxis(f"BUG總數(shù)", [item[1] for item in datas_by_count])
  18.  
  19.         # render 會(huì)生成本地 HTML 文件，默認(rèn)會(huì)在當(dāng)前目錄生成 render.html 文件
  20.         # 也可以傳入路徑參數(shù)，如 bar.render("mycharts.html")
  21.         # bar.render(path=f'{sprint_name}-BUG總數(shù).html')
  22.         make_snapshot(snapshot, bar.render(), "./output/1.png")
  23.  
  24.         # 2、按優(yōu)先級(jí)排序繪制
  25.         bar2 = (
  26.             # Bar(init_opts=opts.InitOpts(theme=ThemeType.INFOGRAPHIC))
  27.             Bar()
  28.                 .add_xaxis([item[0] for item in datas_by_priority])
  29.                 .add_yaxis(self.__get_priority(BUG_PRIORITY.Highest), 
  30. [item[1][0] for item in datas_by_priority],
  31.                            color='#6aa84f')
  32.                 .add_yaxis(self.__get_priority(BUG_PRIORITY.High), 
  33. [item[1][1] for item in datas_by_priority],
  34.                            color='#a2c4c9')
  35.                 .add_yaxis(self.__get_priority(BUG_PRIORITY.Medium), 
  36. [item[1][2] for item in datas_by_priority],
  37.                            color="#ff9900")
  38.                 .add_yaxis(self.__get_priority(BUG_PRIORITY.Low), 
  39. [item[1][3] for item in datas_by_priority],
  40.                            color="#ea9999")
  41.                 .add_yaxis(self.__get_priority(BUG_PRIORITY.Lowest), 
  42. [item[1][4] for item in datas_by_priority],
  43.                            color="#980000")
  44.                 .set_global_opts(
  45.                 title_opts=opts.TitleOpts(title=f"{self.project_name}", 
  46. subtitle=f"{self.sprint_name}"))
  47.         )
  48.         # bar2.render(path=f'{sprint_name}-BUG優(yōu)先級(jí).html')
  49.         make_snapshot(snapshot, bar2.render(), "./output/2.png")
  50.  
  51.         # 3、根據(jù)終端來(lái)繪制餅圖
  52.         if len(keys) > 0 and len(values) > 0:
  53.             c = (
  54.                 Pie()
  55.                     .add("", [list(z) for z in zip(keys, values)])
  56.                     .set_global_opts(title_opts=opts.TitleOpts(title="各端BUG分布"))
  57.                     .set_series_opts(label_opts=opts.LabelOpts(formatter=": {c}"))
  58.             )
  59.             make_snapshot(snapshot, c.render(), f"./output/{self.project_name}_end.png")
  60.  
  61.         # 4、合并兩張圖片
  62.         self.concatenate_img(['./output/1.png', './output/2.png'], 
  63. img_name=f'./output/{self.sprint_name}_bug.png',
  64.                              axis=1)
  65. ...

3. 總結(jié)

通過(guò)上面的操作，每次只需要輸入項(xiàng)目類型、迭代版本號(hào)、要統(tǒng)計(jì)的 Bug 類型，就能統(tǒng)計(jì)出所需要的數(shù)據(jù)并繪制成圖表


作者：星安果


歡迎關(guān)注微信公眾號(hào) ：AirPython