如何通过Python或GitLab API在项目中创建新目录？

Git本身不追踪空目录，所以GitLab也没有直接创建空目录的API或库方法。要实现创建目录的效果，通常的做法是在目标目录下创建一个占位文件（比如.gitkeep），这样Git就会识别并保留这个目录。以下是两种实现方式：

方式一：使用python-gitlab库 #

python-gitlab库虽然没有直接的"创建目录"方法，但可以通过创建目录下的占位文件来间接实现：

1. 先安装依赖：

pip install python-gitlab

2. 示例代码：

import gitlab

# 初始化GitLab连接（替换为你的GitLab地址和访问令牌）
gl = gitlab.Gitlab('https://your-gitlab-instance.com', private_token='your-access-token')

# 获取目标项目（替换为项目ID或路径）
project = gl.projects.get('your-project-id-or-path')

# 要创建的目录路径和占位文件名
dir_path = 'new_directory'
file_path = f'{dir_path}/.gitkeep'
branch = 'main'  # 替换为目标分支

# 创建占位文件
try:
    project.files.create({
        'file_path': file_path,
        'branch': branch,
        'content': '',  # 空内容即可
        'commit_message': f'Create directory {dir_path}'
    })
    print(f"目录 {dir_path} 创建成功")
except gitlab.GitlabCreateError as e:
    print(f"创建失败: {e}")

方式二：直接调用GitLab API #

如果不想用python-gitlab库，也可以用requests直接调用GitLab的文件创建API：

1. 安装依赖：

pip install requests

2. 示例代码：

import requests

# 配置参数
gitlab_url = 'https://your-gitlab-instance.com'
project_id = 'your-project-id'
private_token = 'your-access-token'
dir_path = 'new_directory'
file_path = f'{dir_path}/.gitkeep'
branch = 'main'
commit_message = f'Create directory {dir_path}'

# 构建API请求URL
url = f"{gitlab_url}/api/v4/projects/{project_id}/repository/files/{requests.utils.quote(file_path, safe='')}"

headers = {
    'PRIVATE-TOKEN': private_token,
    'Content-Type': 'application/json'
}

payload = {
    'branch': branch,
    'content': '',
    'commit_message': commit_message
}

# 发送POST请求
response = requests.post(url, json=payload, headers=headers)

if response.status_code == 201:
    print(f"目录 {dir_path} 创建成功")
else:
    print(f"创建失败: {response.json()}")

注意事项 #

• 确保你的访问令牌拥有项目的写入权限，令牌需要包含api或write_repository的scope。
• 如果目标目录已经存在，创建.gitkeep文件不会产生冲突（除非该文件已存在）。
• 若需要创建多级目录（比如dir1/dir2/dir3），直接指定完整的file_path（如dir1/dir2/dir3/.gitkeep）即可，GitLab会自动创建不存在的父目录。

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