Git¶

Git 辅助工具是 git 命令的一个轻量级包装器。它可用于不同的目的

在 set_version() 方法中获取当前标签，并将其赋值给 self.version
在 source() 方法中克隆第三方或开源包配方的源代码（通常，建议使用 download() 或 get() 获取发布版压缩包）
在 export() 方法中捕获您自己包源代码的“scm”坐标（url，commit），以便稍后能够从源代码重现构建，并在 source() 方法中检索代码。请参阅 git-scm 捕获示例。

Git() 构造函数接收当前文件夹作为参数，但如有必要可以更改，例如在 source() 中克隆某个仓库的源代码

def source(self):
   git = Git(self)  # by default, the current folder "."
   git.clone(url="<repourl>", target="target") # git clone url target
   # we need to cd directory for next command "checkout" to work
   git.folder = "target"                       # cd target
   git.checkout(commit="<commit>")             # git checkout commit

一种替代的、等效的方法是

def source(self):
   git = Git(self, "target")
   # Cloning in current dir, not a children folder
   git.clone(url="<repourl>", target=".")
   git.checkout(commit="<commit>")

class Git(conanfile, folder='.', excluded=None)¶

Git 是用于 git 工具的几种常见模式的包装器。

参数:

conanfile – Conanfile 实例。
folder – 当前目录，默认为 .，即当前工作目录。
excluded – 要从“脏”检查中排除的文件。它将与配置 core.scm:excluded 结合使用（该配置具有更高优先级）。它是一个用于 fnmatch 的模式列表。

run(cmd, hidden_output=None)¶

执行 git <cmd>

返回值:: 命令的控制台输出。

get_commit(repository=False)¶

参数:: repository – 默认获取定义文件夹的提交，使用 repo=True 则获取仓库的提交。
返回值:: 当前提交，使用 git rev-list HEAD -n 1 -- <folder>。返回最新的提交，不考虑本地未提交的更改。

get_remote_url(remote='origin')¶

获取远程 Git 仓库的 URL，使用 git remote -v

警告! 请注意，此方法将获取 git remote -v 的输出。如果您在 URL 中向远程添加了令牌或凭据，它们将被暴露。不应将凭据添加到 Git 远程定义中，而应使用凭据管理器或类似机制。如果您仍希望使用此方法，则您有责任从结果中去除凭据。

参数:: remote – 远程 Git 仓库的名称（默认为 'origin'）。
返回值:: 远程 Git 仓库的 URL。

commit_in_remote(commit, remote='origin')¶

检查给定提交是否存在于远程仓库中，使用 branch -r --contains <commit> 并检查该远程仓库中是否存在该提交所包含的分支。

参数:

commit – 要检查的提交。
remote – 远程 Git 仓库的名称（默认为 'origin'）。

返回值:

如果给定提交存在于远程仓库中，则为 True，否则为 False。

is_dirty(repository=False)¶

返回当前文件夹是否为脏，通过运行 git status -s。Git(..., excluded=[]) 参数和 core.scm:excluded 配置将定义要从此检查中跳过的文件模式。

参数:: repository – 默认检查当前文件夹是否为脏。如果 repository=True，则会检查根仓库文件夹，而不是当前文件夹。
返回值:: 如果当前文件夹为脏，则为 True。否则为 False。

get_url_and_commit(remote='origin', repository=False)¶

这是一个高级方法，返回当前提交和远程仓库 URL。此方法旨在捕获用于包创建的当前远程坐标，以便稍后可以从相同的提交源再次构建。这是其行为方式

如果仓库为脏，将引发异常。捕获脏内容的坐标没有意义，因为它将不可重现。如果有本地更改，并且用户想要测试本地 conan create，应首先提交更改（本地提交，而不是推送更改）。
如果仓库不脏，但给定远程仓库中不存在该提交，则该方法将返回该提交以及本地用户签出的 URL。这样，可以在将更改推送到远程仓库之前，在本地创建 Conan 包并测试一切是否正常。
如果仓库不脏，并且指定远程仓库中存在该提交，它将返回该提交和远程仓库的 URL。

警告! 请注意，此方法将获取 git remote -v 的输出。如果您在 URL 中向远程添加了令牌或凭据，它们将被暴露。不应将凭据添加到 Git 远程定义中，而应使用凭据管理器或类似机制。如果您仍希望使用此方法，则您有责任从结果中去除凭据。

参数:

remote – 远程 Git 仓库的名称（默认为 'origin'）。
repository – 默认获取定义文件夹的提交，使用 repo=True 则获取仓库的提交。

返回值:

(url, commit) 元组

get_repo_root()¶

使用 git rev-parse --show-toplevel 获取当前仓库的根文件夹

返回值:: 仓库根文件夹。

clone(url, target='', args=None, hide_url=True)¶

执行 git clone <url> <args> <target> 操作，其中 target 是目标目录。

参数:

url – 远程仓库的 URL。
target – 目标文件夹。
args – 作为列表传递给 git clone 的额外参数。
hide_url – 从日志输出中隐藏 URL，以防止意外的凭据泄露。可以通过传入 False 来禁用。

fetch_commit(url, commit, hide_url=True)¶

实验性功能: 执行单个提交的获取和检出，而不是完整克隆，速度应该更快。

参数:

url – 远程仓库的 URL。
commit – 要检出的提交引用。
hide_url – 从日志输出中隐藏 URL，以防止意外的凭据泄露。可以通过传入 False 来禁用。

checkout(commit)¶

使用 git checkout <commit> 检出给定提交。

参数:: commit – 要检出的提交。

included_files()¶

运行 git ls-files --full-name --others --cached --exclude-standard 以获取列表: 未被 .gitignore 忽略的文件。

返回值:: 文件列表。

coordinates_to_conandata(repository=False)¶

从 Git 仓库捕获“url”和“commit”，调用 get_url_and_commit()，然后将其存储在 conandata.yml 的“scm”键下。这些信息可以用于稍后克隆和检出用于创建此包的精确源代码点，即使配方使用 exports_sources 作为嵌入源代码的机制，它也可能很有用。

参数:: repository – 默认获取定义文件夹的提交，使用 repository=True 则获取仓库的提交。

checkout_from_conandata_coordinates()¶: 从 conandata.yml 读取“scm”字段，该字段必须至少包含“url”和“commit”，然后执行 clone(url, target=".")、fetch <commit>，最后执行 checkout(commit)。