Python Gitlab API -列出组/子组的共享项目

6g8kf2rb  于 2023-08-02  发布在  Python
关注(0)|答案(4)|浏览(209)

我需要找到Gitlab组中的所有项目和共享项目。我设法列出了所有项目的名称如下:

group = gl.groups.get(11111, lazy=True)

# find all projects, also in subgroups
projects=group.projects.list(include_subgroups=True, all=True)
for prj in projects:
    print(prj.attributes['name'])
print("")

字符串
我所缺少的是列出组内的共享项目。或者换句话说:找出我的小组是成员的所有项目。Python API可以做到这一点吗?

62o28rlo

62o28rlo1#

所以,受到sytech的回答的启发,我发现它一开始就不起作用,因为共享项目仍然隐藏在子组中。所以我想出了下面的代码,它可以通过所有不同级别的子组来查找所有共享项目。我想这可以写得更优雅,但它对我来说很有效:

# group definition
main_group_id = 11111

# create empty list that will contain final result
list_subgroups_id_all = []

# create empty list that act as temporal storage of the results outside the function
list_subgroups_id_stored = []


# function to create a list of subgroups of a group (id)
def find_subgroups(group_id):

    # retrieve group object
    group = gl.groups.get(group_id)

    # create empty lists to store id of subgroups
    list_subgroups_id = []

    #iterate through group to find id of all subgroups
    for sub in group.subgroups.list():
        list_subgroups_id.append(sub.id)

    return(list_subgroups_id)

# function to iterate over the various groups for subgroup detection
def iterate_subgroups(group_id, list_subgroups_id_all):

    # for a given id, find existing subgroups (id) and store them in a list
    list_subgroups_id = find_subgroups(group_id)

    # add the found items to the list storage variable, so that the results are not overwritten
    list_subgroups_id_stored.append(list_subgroups_id)

    # for each found subgroup_id, test if it is already part of the total id list
    # if not, keep store it and test for more subgroups
    for test_id in list_subgroups_id:
        if test_id not in list_subgroups_id_all:

            # add it to total subgroup id list (final results list)
            list_subgroups_id_all.append(test_id)

            # check whether test_id contains more subgroups
            list_subgroups_id_tmp = iterate_subgroups(test_id, list_subgroups_id_all)

            #if so, append to stored subgroup list that is currently checked
            list_subgroups_id_stored.append(list_subgroups_id_tmp)

    return(list_subgroups_id_all)

# find all subgroup and subsubgroups, etc... store ids in list
list_subgroups_id_all = iterate_subgroups(main_group_id , list_subgroups_id_all)

print("***ids of all subgroups***")
print(list_subgroups_id_all)
print("")

print("***names of all subgroups***")
list_names = []
for ids in list_subgroups_id_all:
    group = gl.groups.get(ids)
    group_name = group.attributes['name']
    list_names.append(group_name)
print(list_names)
#print(list_subgroups_name_all)
print("")

# print all directly integrated projects of the main group, also those in subgroups
print("***integrated projects***")
group = gl.groups.get(main_group_id)
projects=group.projects.list(include_subgroups=True, all=True)
for prj in projects:
    print(prj.attributes['name'])
print("")

# print all shared projects
print("***shared projects***")
for sub in list_subgroups_id_all:
    group = gl.groups.get(sub)
    for shared_prj in group.shared_projects:
        print(shared_prj['path_with_namespace'])
print("")

字符串
还有一个问题-在一开始我通过它的id检索主组(在这里:11111),但是我实际上也可以通过查找组的名称来获得这个id吗?类似于:group_id = gl.group.get(attribute={'name','foo'})(不工作)?

n3ipq98p

n3ipq98p2#

您可以通过.shared_projects属性获取共享项目:

group = gl.groups.get(11111)
for proj in group.shared_projects:
    print(proj['path_with_namespace'])

字符串
但是,不能对gl.groups.get使用lazy=True参数。

>>> group = gl.groups.get(11111, lazy=True)
>>> group.shared_projects
AttributeError: shared_projects

pxq42qpu

pxq42qpu3#

这段代码将查询每个子组中的所有项目,并处理子组中的多个子组。它工作得很完美,我希望它能帮助其他人。

import gitlab
import os

# Set your GitLab API access token
access_token = 'GITLAB_ACCESS_TOKEN'
if not access_token:
    raise ValueError("No GitLab access token found. Please set the GITLAB_ACCESS_TOKEN environment variable.")

# Set the URL of your GitLab instance
gitlab_url = os.getenv('GITLAB_URL', 'https://gitLab.com/')

# Replace this with your target subgroup path
subgroup_path = '2323' #'your/subgroup/path or your subgroup number'

# Initialize the GitLab connection
gl = gitlab.Gitlab(gitlab_url, private_token=access_token)

# Recursively find all projects in the subgroup and its subgroups
def find_projects_in_group(group):
    projects = gl.groups.get(group.id).projects.list(all=True)
    
    subgroups = gl.groups.get(group.id).subgroups.list(all=True)
    
    for subgroup in subgroups:
        projects.extend(find_projects_in_group(subgroup))
    return projects

# Find the target subgroup
try:
    target_group = gl.groups.get(subgroup_path)
except gitlab.exceptions.GitlabGetError:
    raise ValueError("Subgroup not found: " + subgroup_path)

# Get the list of projects
projects = find_projects_in_group(target_group)

# Print the list of projects
for project in projects:
    print("project path:["+project.ssh_url_to_repo+"]" )

字符串

gfttwv5a

gfttwv5a4#

# This code will list all files with specific extension (*.pdf)


import gitlab
import re

gl = gitlab.Gitlab('<gitlab url>', private_token='<private gitlab token')
f = open('result.txt', 'w')

def processGroup(groupName, parentGroup):
    # print(groupName)

    group = gl.groups.get(groupName)

    # print('***** ' + group.name + ' ******')

    projects = group.projects.list(iterator=True)
    for project in projects:
        print('\n' + parentGroup + '/' + group.name + '/' + project.name + '\n *********************************************')
        f.write('\n' + parentGroup + '/' + group.name + '/' + project.name + '\n *********************************************\n')
    
        prj = gl.projects.get(project.id)
        try:
            for filename in prj.repository_tree(recursive=True, iterator=True):
                # print(filename.get('path'))
                filenamePath = filename.get('path')
                if re.search('[.]pdf$', filenamePath):
                    print(group.name + '/' + project.name + '/' + filenamePath)
                    f.write(group.name + '/' + project.name + '/' + filenamePath + '\n')
        except:
            print('No files in ' + prj.name) 

    parentGroup = parentGroup + '/' if len(parentGroup) else '' + groupName
    for subGroup in group.subgroups.list(iterator=True):
            processGroup(subGroup.id, parentGroup)
    
 

processGroup('<gitlab group>', '')
f.close()

字符串

相关问题