Python jira库使用方法

1. Python的jira库概述

Jira是Atlassian公司出品的一款事务管理软件。该软件会提供网页界面给用户。在工作中,有时需要批量的处理操作,在网页上无法进行。这个时候,使用Python来操作Jira是一个很好的选择。
下面link是一个非常友好的python jira库,可按如下操作安装:
https://pypi.org/project/jira/

pip install jira

2. Python的jira库API介绍

2.1. JIRA对象

JIRA类的定义请见如下link:
https://github.com/pycontribs/jira/blob/main/jira/client.py

  1. 可通过如下方式来生成JIRA对象:
form jira import JIRA
jira = JIRA('http://jira.***.com/', auth=(username, password))
  1. 通过JIRA对象搜索
    搜索使用的API是search_issues(),其参数maxResults为-1表示返回所有issue对象。
    如果搜索的内容比较多,服务器可能会因此而断掉连接,需要分页搜索:
    def paging_search_jira_issues(self, search_str):
        all_issues = self.jira.search_issues(search_str, startAt=0, maxResults=50)
        start = 0
        while True:
            issues = self.jira.search_issues(search_str, startAt=start, maxResults=50)
            if(len(issues)==0):
                break
            all_issues = all_issues + issues
        return all_issues
  1. 通过issue key获取issue对象:
issue = jira.issue(issue_key)
  1. 转移issue给new assignee:
jira.assign_issue(issue, new_assignee)
  1. 改变issue的状态:
jira.transition_issue(issue, 'Accept')
jira.transition_issue(issue, 'Deliver')
  1. 给issue添加comment:
jira.add_comment(issue, 'Please handle it. Thanks.')
  1. 返回project列表:
jira.projects()
  1. 获取groups以及获取一个group的成员:
jira.groups()
# 获取group的成员一般需要授权
jira.group_members('System Team')

2.2. Issue对象

Issue类的定义请参考如下link:
https://github.com/pycontribs/jira/blob/main/jira/resources.py

  1. 修改issue的部分字段,比如customfield_1和customfield_2字段:
issue.update({'customfield_1':{'value':'Yes'}, 'customfield_2':'Platform Default Support'})
  1. 获取issue key:
issue.key
  1. 获取created time,该时间戳格式可转为iso format,方便后续处理:
from datetime import datetime

issue.fields.created
# 2021-12-10T10:45:12.000+0800 -> 2021-12-10 10:45:12.000+08:00
issue_created_isoformat = (issue.fields.created[0:-2] + ':' + issue.fields.created[-2:]).replace('T', ' ')
dt = datetime.fromisoformat(issue_created_isoformat)
dt.timestamp()
  1. issue.fields
    fields包含了issue的所有字段。在jira网站,打开一个issue,然后查看网页源代码,可以获取到这些字段field的名称。根据这些field的名称,通过dir()、type()等方式获取到其属性和类型,从属性中可以猜出哪些是需要的。

3. 参考文档

Python操作Jira
https://www.cnblogs.com/superhin/p/11693280.html
Jira入门教程 敏捷开发管理(一)
https://www.jianshu.com/p/145b5c33f7d0
Python Jira
https://jira.readthedocs.io/
Jira官网资料
https://support.atlassian.com/jira-software-cloud/resources/
而ALM没有python库可以操作:
How Automate Application Lifecycle Management using python
https://stackoverflow.com/questions/66318291/how-automate-application-lifecycle-management-using-python
https://admhelp.microfocus.com/alm/api_refs/REST_TECH_PREVIEW/Content/REST_API_Tech_Preview/General/Overview.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,002评论 6 509
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,777评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,341评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,085评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,110评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,868评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,528评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,422评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,938评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,067评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,199评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,877评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,540评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,079评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,192评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,514评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,190评论 2 357

推荐阅读更多精彩内容