主页 / coding / 问题 / 77736895
Accepted
Joshua Shew
Asked: 2023-12-31 01:54:30 +0800 CST

如何设置污迹和清理过滤器，以便它引用存储库跟踪的脚本

  • 772

我有一个使用 Jupyter Notebook 文件进行数据分析的项目，我使用 clean/smudge 过滤器将输出和某些元数据保留在 git 之外。有时我会对过滤器进行调整，我希望自动应用这些更改，而不必git config每次都要求我的协作者运行命令。

如何配置过滤器来运行存储库跟踪的脚本？

出于此问题的目的，我们假设 clean 命令是如何在使用 git commit 时清除 Jupyter Notebook 的输出和元数据？:

jupyter nbconvert --ClearOutputPreprocessor.enabled=True --ClearMetadataPreprocessor.enabled=True --to=notebook --stdin --stdout --log-level=ERROR

这通常配置为...

git config filter.<filter-name>.clean "<command>"

...并与.gitattributes包含以下内容的 a 一起使用。

*.ipynb filter=<filter-name>

相关问题

git

2 个回答

  1. Best Answer

    要在 Git 中设置引用存储库跟踪的脚本的污迹或清理过滤器，您需要使用项目根目录中存储库中脚本的相对路径（实际上，相对于.gitattributes声明过滤器的 ）

    +--------------------+
| Git Repository     |
|                    |
| +----------------+ |
| | .git           | |
| +----------------+ |
| +----------------+ |
| | Scripts        | |
| | +------------+ | |
| | | clean.sh   | | | <--- The script for the clean filter
| | +------------+ | |
| +----------------+ |
| +----------------+ |
| | .gitattributes | | <--- Specifies the filter for .ipynb files
| +----------------+ |
+--------------------+

    对于 Jupyter Notebook 文件的特定场景，您可以通过将 clean 脚本放置在存储库中来设置 clean 过滤器，例如scripts/clean_jupyter.sh. 该脚本（应该是可执行的：）chmod +x scripts/clean_jupyter.sh将包含您提到的命令：

    #!/bin/bash
jupyter nbconvert --ClearOutputPreprocessor.enabled=True --ClearMetadataPreprocessor.enabled=True --to=notebook --stdin --stdout --log-level=ERROR

    配置您的.gitattributes文件以将此脚本用于 Jupyter Notebook 文件：

    echo "*.ipynb filter=jupyterClean" >> .gitattributes

# result in your .gitattributes:
*.ipynb filter=jupyterClean

    设置 clean 过滤器.git/config以引用您的脚本：

    git config filter.jupyterClean.clean "scripts/clean_jupyter.sh"

    要将这些更改自动应用于所有协作者，您可以在项目的 中包含说明README.md，或设置一个初始化脚本，他们可以运行一次以配置其本地存储库设置。出于安全原因，Git 不允许自动应用存储库中的过滤器配置，因此需要手动设置。

    要回答您关于我的旧答案“如何跟踪存储库/项目中特定于系统的配置文件？ ”的问题：

    你说“这样，污迹引用的脚本（用 Git 管理）”。到底如何在污迹过滤器中引用由 git 管理的脚本？我对脚本和 git 过滤器比较陌生，但我真的很想让它在我的项目中发挥作用。

    or过滤器是一个脚本，它是smudge ：clean

    • 1

  2. 如果您想要配置 Git 过滤器来运行存储库跟踪的脚本，您可以使用相对路径来引用过滤器配置中的脚本。以下是如何修改 .git/config 文件中的过滤器配置来实现此目的：

    假设您有这样的目录结构：

    project_root/
|-- scripts/
|   |-- clean_script.py
|   |-- smudge_script.py
|-- .git/
|-- .gitattributes
|-- other_files/
    1. 更新.gitattributes：

    您的 .gitattributes 文件应使用存储库根目录的相对路径引用脚本：

    *.ipynb filter=jupyter-notebook
    1. 更新.git/config：

    使用脚本的相对路径更新 .git/config 文件中的过滤器配置：

    [filter "jupyter-notebook"]

clean = python scripts/clean_script.py

smudge = python scripts/smudge_script.py

    确保根据您的实际项目结构以及清理和涂抹 Jupyter Notebook 文件所需的命令来调整路径和命令。

    1. 提交并分享：

    将更新的 .gitattributes 和 .git/config 文件提交到您的存储库：

    git add .gitattributes .git/config

git commit -m "Update Git filter configuration for Jupyter Notebook scripts"

git push

    这样，当协作者克隆存储库时，过滤器配置将使用相对路径引用脚本，并且脚本将根据其在项目结构中的位置执行。根据您的具体项目设置相应地调整路径。

    • -1

相关问题