Python JIRA的简单介绍与使用

JIRA Python 文档

安装： pip install jira

认证并且获取JIRA操作对象

from jira import JIRA
jiraObj=JIRA(server='http://jira.xxx.com',auth=('username','password'))

项目(Project)的主要属性获取

属性	代码示例
访问权限的项目列表	jiraObj.projects()
项目key	jiraObj.project(“AA”).key
项目名称	jiraObj.project(“AA”).name
项目描述	jiraObj.project(“AA”).descrition
项目负责人	jiraObj.project(“AA”).lead
项目模块	jiraObj.project(“AA”).components
项目版本	jiraObj.project(“AA”).versions
项目的原始数据	jiraObj.project(“AA”).lead
项目负责人	jiraObj.project(“AA”).raw

问题(Issue)主要属性及获取

属性	代码示例
问题的id	jiraObj.issue(“AA-1”).id
问题的key	jiraObj.issue(“AA-1”).key
问题的链接	jiraObj.issue(“AA-1”).permalink()
问题的原始api数据	jiraObj.issue(“AA-1”).raw
问题的配置域	jiraObj.issue(“AA-1”).fields

配置域(Fields)常用属性

属性	代码示例
经办人	jiraObj.issue(“AA-1”).fields.assignee
创建人	jiraObj.issue(“AA-1”).fields.creator
报告人	jiraObj.issue(“AA-1”).fields.reportor
创建时间	jiraObj.issue(“AA-1”).fields.created
标签	jiraObj.issue(“AA-1”).fields.labels
优先级	jiraObj.issue(“AA-1”).fields.priority
问题类型	jiraObj.issue(“AA-1”).fields.issuetype
状态	jiraObj.issue(“AA-1”).fields.status
问题描述	jiraObj.issue(“AA-1”).fields.summary

如果想要获取更多属性的情况，可以打印出json.dumps(jiras.issue('AA-1').raw, indent=4)的内容来查看

JIRA中问题的创建/分配/转换

操作	api
创建问题	jiraObj.create_issue(fields=issue_dict)
批量创建问题	jiraObj.create_issues(field_list=issue_list)
分配问题	jiraObj.assign_issue(issue, “assignee”)
获取问题的工作流	jiraObj.transitions()
转换问题	jiraObj.transition_issue()

创建issue示例

from jira import JIRA

jiraObj=JIRA(server='http://jira.xxx.com',auth=('username','password'))
issue_dict = {
    'project': {'key': "AA"},  # 项目id
    'summary': 'this is a bug',  # BUG概要
    'description': 'this bug is hard',  # BUG详情
    'priority': {'name': 'P3'},  # bug优先级
    'assignee': {'name': 'jack'},  # 分配人
    'labels': ['block'],  # 所属项目
    'issuetype': {'name': "Bug"}  # 问题类型-故障
}
jiraObj.create_issue(fields=issue_dict)

JIRA中关注者/评论/附件

操作	api
问题的关注者	jiraObj.watchers(issue)
添加关注者	jiraObj.add_watcher(issue, watcher)
移除关注者	jiraObj.remove_watcher(issue, watcher)
问题的所有评论	jiraObj.comments(issue)
问题的某条评论	jiraObj.comment(issue,comment)
添加评论	jiraObj.add_comment(issue, “add comment”)
更新评论	comment.update(body=“update comment”)
删除评论	comment.delete()
添加附件	jiraObj.add_attachment(issue, attachment)

更多api使用方法请查看python jira库官方文档