当前位置:首页 > 技术文章 > 正文内容

Python 实现 | 通过 Gitlab API 获取项目工程、分支、commit 提交记录

前提

在 gitlab 中你的工程创建 Access Token


然后你会得到一个 21 位 access token,代码中需要用到。

代码

'''
说明:
1.登录gitlab的root账号(登录账号根据需要访问的项目而定)
2.gitlab_token是gitlab用户的setting中生成的字符串,使用户可以通过http的形式下载代码
3.在gitlab用户的Settings->Access Tokens,创建你的access token,它会生成一个21位的字符串(只出现一次,注意小心保管)
'''
# -*- coding:utf-8 -*-

import json
import requests

# gitlab地址
git_url = 'https://gitlab.xxx.com'
# gitlab的token
git_token = 'xxxxxxxxxxxxxxxxxxxxx'
headers = {
    'User-Agent': 'Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36',
}

session = requests.Session()
headers['PRIVATE-TOKEN'] = git_token
session.headers = headers
git_login = session.get(git_url, headers=headers)


# 获取当前账号有权限的全部工程列表
# 注意:参数per_page最大为100,传入超过100的值时,gitlab的url请求中的per_page默认取100
def gitlab_projects(per_page=100):
    print("正在获取gitlab上工程...")
    projects_api = git_url + '/api/v4/projects?simple=yes&per_page=%s' % per_page
    projects_headers = session.head(projects_api).headers
    projects_num = int(projects_headers['X-Total'])  # 获取工程总数
    projects_pages = int(projects_headers['X-Total-Pages'])  # 获取工程总页数
    print("工程总数:", projects_num)
    result = []
    for i in range(projects_pages):
        page = i + 1
        projects_url = projects_api + '&page=' + str(page)
        projects = session.get(projects_url).text
        projects_json = json.loads(projects)
        if type(projects_json) == list:
            result = result + projects_json
        else:
            print("projects_url: %s" % projects_url)
            print("headers: %s" % session.head(projects_api).headers)
            print("response: %s" % projects_json)
    print("工程获取完成~")
    return result


# 获取工程的分支
# 注意:参数per_page最大为100,传入超过100的值时,gitlab的url请求中的per_page默认取100
def gitlab_project_branches(project_id, project_name, page=1, per_page=100, get_all_branches=False, max_branch_count=200):
    print('工程id是' + str(project_id) + ':', '工程名是' + str(project_name))
    next_page = page
    branch_count = max_branch_count
    branch_names = []
    while next_page > 0 and branch_count > 0:
        project_branches_api = git_url + '/api/v4/projects/%s/repository/branches?page=%s&per_page=%s' % (project_id, next_page, per_page)
        branch_headers = session.head(project_branches_api).headers
        next_page = int(branch_headers['X-Next-Page']) if "X-Next-Page" in branch_headers and branch_headers['X-Next-Page'] != '' else 0
        if not get_all_branches:
            branch_count = branch_count - per_page
        branches_info = session.get(project_branches_api).text
        branches_info = json.loads(branches_info)
        for v in branches_info:
            branch_names.append(v["name"])
    print("分支信息获取完成~")
    if get_all_branches:
        return branch_names
    return branch_names[:max_branch_count]


# 增量获取所有工程所有分支的提交日志
# 注意:参数per_page最大为100,传入超过100的值时,gitlab的url请求中的per_page默认取100
def get_project_commits(project_id, project_branch_name, page=1, per_page=100, get_all_commits=False, max_commit_count=200):
    commit_all = []
    next_page = page
    commit_count = max_commit_count
    while next_page and commit_count > 0:
        if not get_all_commits:
            commit_count = commit_count - per_page
        commit_api = git_url + '/api/v4/projects/%s/repository/commits?ref_name=%s&page=%s&per_page=%s' % (project_id, project_branch_name, next_page, per_page)
        commit_headers = session.head(commit_api).headers
        next_page = commit_headers["X-Next-Page"]
        commit_info = session.get(commit_api).text
        commit_all = commit_all + json.loads(commit_info)
    print("%s分支获取的commit信息获取完成" % project_branch_name)
    if get_all_commits:
        return commit_all
    return commit_all[:max_commit_count]


# 1.获取所有的项目工程
project_result = gitlab_projects()
print(project_result)
print(len(project_result))

# 2.获取指定项目工程的分支名
branch_result = gitlab_project_branches(project_id=12345, project_name='my_project', page=1, per_page=100, get_all_branches=True)
print(branch_result)
print(len(branch_result))

# 3.获取指定项目工程的commit记录
commit_result = get_project_commits(project_id=12345, project_branch_name='master', page=1, per_page=100, get_all_commits=True)
print(commit_result)
print(len(commit_result))

相关文章

智能停车场管理系统五种收费类型设置

智能停车场管理系统五种收费类型设置  点击智能停车场管理系统收费标准设置图标,出现下图所示对话框,在这个界面里面可以对停车场系统需要使用的收费标准进行个性化设置:共有五种收费类型(标准收费类、通用标准...

Linux 发行版介绍 Zenwalk Linux(linux发行版2021)

Zenwalk Linux是基于Slackware的GNU/Linux发行版, 100%兼容Slackware。 致力于精简和快捷的图形桌面及多媒体使用。包含整套编程环境和运行库,还提供了常用服务器套...

Vue3开发极简入门(14):组件间通信之props、ref&defineExpose

组件间的关系可以分为:父子关系。以前文的代码为例,最典型的就是App.vue与Car.vue这种,APP是父,Car是子。祖孙关系。如果Car再引入一个子组件,这个子组件与App就是祖孙关系。其他。比...

Vue3开发极简入门(15.1):emits补完-结合v-model

之前代码是通过按钮触发emit,如果希望输入框里的内容在输入之后也能同步到父组件,就可以结合v-model的update事件来操作,具体如下。Son2.vue:<template>...

10个实例小练习,快速入门熟练 Vue3 核心新特性(一)

作者:xuying 全栈修炼转发链接:https://mp.weixin.qq.com/s/_n2seDbbiO5hXQfuUGbUCQ前言Vue3.0 发 beta 版都有一段时间了,正式版也不远了...

「2022」打算跳槽涨薪,必问面试题及答案——VUE篇

1、为什么选择VUE,解决了什么问题?vue.js 正如官网所说的,是一套构建用户界面的渐进式框架。与其它重量级框架不同的是,vue 被设计为可以自底向上逐层应用。vue 的核心库只关注视图层,不仅易...