Git¶

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

在 set_version() 方法中获取当前标签，并将其赋值给 self.version
在 source() 方法中克隆第三方或开源包的源代码（通常情况下，首选 download() 或 get() 来获取发布 tarball）
在 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。这样，可以在将某些更改推送到远程之前，在本地创建包，并测试所有功能正常。
如果仓库不是脏的，并且提交存在于指定的远程仓库中，它将返回该提交和远程仓库的 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)。