langchain_community.utilities.gitlab.GitLabAPIWrapper

class langchain_community.utilities.gitlab.GitLabAPIWrapper[source]

继承自: BaseModel

GitLab API 的包装器。

通过解析和验证关键参数中的输入数据创建新的模型。

如果输入数据无法解析为有效的模型,则引发ValidationError异常。

参数 gitlab_base_branch: Optional[str] = None

GitLab存储库中的基础分支,用于比较。通常是'main'或'master'。默认为'main'。

参数 gitlab_branch: Optional[str] = None

GitLab存储库中bot将进行提交的具体分支。默认为'main'。

参数 gitlab_personal_access_token: Optional[str] = None

用于认证的GitLab服务的个人访问令牌。

参数 gitlab_repository: Optional[str] = None

GitLab存储库的名称,形式为{用户名}/{repo名称}。

comment_on_issue(comment_query: str) str[源代码]

向GitLab issue添加注释 参数

comment_query(str): 包含问题编号、两个换行符和注释的字符串。例如:“1

我现在正在处理”

将注释“我现在正在处理”添加到问题1

返回

str: 成功或失败信息

参数

comment_query (str) –

返回类型

str

create_file(file_query: str) str[源代码]

在GitLab存储库中创建新文件 参数

file_query(str): 包含文件路径和文件内容的字符串。文件路径是字符串的第一行,内容是其余部分。例如,“hello_world.md

# Hello World!”
返回

str: 成功或失败信息

参数

file_query (str) –

返回类型

str

create_pull_request(pr_query: str) str[来源]

从机器人的分支向基础分支创建拉取请求。参数

pr_query(str): 包含PR标题和PR正文的字符串。标题是该字符串的第一行,正文是该字符串的其余部分。例如,“Updated README

对文档进行修改,添加信息”
返回

str: 成功或失败信息

参数

pr_query (str) –

返回类型

str

delete_file(file_path: str) str[来源]

从仓库中删除文件::param file_path: 文件所在的路径::type file_path: str

返回

成功或失败信息

返回类型

str

参数

file_path (str) –

get_issue(issue_number: int) Dict[str, Any][来源]

获取一个特定的问题及其前10条评论::param issue_number: gitlab问题的编号::type issue_number: int

返回

包含问题的标题、正文及评论字符串的字典

返回类型

dict

参数

issue_number (int) –

get_issues() str[来源]

从仓库中获取所有未解决的问题

返回

包含问题数量以及每个问题的标题和编号的纯文本报告

返回类型

str

parse_issues(issues: List[Issue]) List[dict][来源]

从每个Issue中提取标题和编号并将它们放入字典中::param issues: 包含gitlab Issue对象的列表::type issues: List[Issue]

返回

问题标题和编号的字典

返回类型

列表[字典]

参数

问题 (列表[问题]) –

read_file(file_path: str) str[源代码]

从 gitlab 仓库读取文件 :param file_path: 文件路径 :type file_path: str

返回

解码为字符串的文件

返回类型

str

参数

file_path (str) –

run(mode: str, query: str) str[源代码]
参数
  • mode (str) –

  • query (str) –

返回类型

str

update_file(file_query: str) str[源代码]

使用新内容更新文件。 :param file_query: 包含文件路径和文件内容。

旧文件内容用 OLD <<<< 和 >>>> OLD 包围,新文件内容用 NEW <<<< 和 >>>> NEW 包围。例如:test/hello.txt OLD <<<< Hello Earth! >>>> OLD NEW <<<< Hello Mars! >>>> NEW

返回

成功或失败的消息

参数

file_query (str) –

返回类型

str

使用 GitLabAPIWrapper 的示例