如何通过GitLab Python API删除项目指定目录下的空子目录

你没有找到对应方法是因为python-gitlab没有封装专门的子目录操作接口，所有目录相关的增删查逻辑都可以通过仓库文件接口、提交接口间接实现。

实现整体流程 #

• 第一步：认证并获取目标项目实例
  初始化GitLab客户端，传入私有token完成认证，通过项目ID或者群组名/项目名路径即可拿到指定的项目对象。
• 第二步：递归遍历目标父目录下的所有内容
  调用项目的repository_tree方法，指定path参数为你要清理的特定目录路径，recursive参数设为True就能拿到该目录下所有的文件和子目录条目，每个条目里的type字段为tree的就是目录，type为blob的就是文件。
• 第三步：筛选出空目录
  遍历所有拿到的tree条目，统计每个子目录下的blob数量，数量为0的就是要删除的空目录。如果目录层级多，注意从最深层的子目录开始删除，避免删了上层空目录后下层的目录找不到路径。
• 第四步：批量提交删除空目录的操作
  GitLab里删除目录不需要单独调用接口，只需要在提交的actions参数里，给每个要删除的空目录加一条action为delete的记录，指定目录路径即可，一次提交可以处理上千个操作，你有10000+待删目录的话拆分成分批提交即可。

核心代码示例 #

import gitlab

# 初始化GitLab客户端
gl = gitlab.Gitlab('https://你的GitLab服务域名', private_token='你的账号私有token')
# 获取目标项目，参数可以填项目ID或者 群组名/项目名 格式的路径
project = gl.projects.get('目标项目标识')

# 递归获取指定目录下所有内容，all=True自动翻页拉取全部条目
target_root = "你要清理的特定目录路径"
tree = project.repository_tree(path=target_root, recursive=True, all=True)

# 统计每个目录下的文件数量
dir_file_count = {}
for item in tree:
    if item['type'] == 'blob':
        # 提取文件所属的父目录路径
        dir_path = '/'.join(item['path'].split('/')[:-1])
        dir_file_count[dir_path] = dir_file_count.get(dir_path, 0) + 1
    elif item['type'] == 'tree':
        # 初始化目录计数，避免纯空目录没有被统计到
        if item['path'] not in dir_file_count:
            dir_file_count[item['path']] = 0

# 筛选所有空目录，按路径长度倒序排序，优先删除深层子目录
empty_dirs = sorted([p for p, cnt in dir_file_count.items() if cnt == 0], key=lambda x: len(x), reverse=True)

# 分批提交删除，可根据GitLab版本限制调整单次提交的数量
batch_size = 1000
for i in range(0, len(empty_dirs), batch_size):
    batch = empty_dirs[i:i+batch_size]
    actions = []
    for d in batch:
        actions.append({
            'action': 'delete',
            'path': d
        })
    # 提交本次批次的删除操作
    project.commits.create({
        'branch': '你要操作的目标分支，例如main',
        'commit_message': '批量清理空目录 批次{}'.format(i//batch_size + 1),
        'actions': actions
    })

注意事项 #

• 操作前先拉取最新的仓库代码备份，避免误删内容
• 如果你的GitLab版本比较老，单次提交的action数量上限可能更低，可根据实际情况调整batch_size的大小
• 如果目标目录下有.gitkeep这类占位文件，需要调整空目录的判断逻辑，排除这类占位文件后再统计文件数

内容的提问来源于stack exchange，提问作者Abhinav Dhiman