Início / coding / Perguntas / 77736895
Accepted
Joshua Shew
Asked: 2023-12-31 01:54:30 +0800 CST

Como configurar um filtro de manchas e limpeza para que faça referência a um script rastreado pelo repositório

  • 772

Eu tenho um projeto que usa arquivos do Jupyter Notebook para análise de dados e mantenho a saída e alguns metadados fora do git com um filtro limpo/manchado. Às vezes, farei ajustes no filtro e quero que essas alterações sejam aplicadas automaticamente, em vez de ter que pedir aos meus colaboradores para executarem um git configcomando a cada vez.

Como posso configurar o filtro para executar scripts rastreados pelo repositório?

Para o propósito desta questão, vamos supor que o comando clean seja aquele de Como limpar a saída e os metadados do Jupyter Notebook ao usar o git commit? :

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

Isso normalmente é configurado como ...

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

...e usado com um .gitattributesque inclui o seguinte.

*.ipynb filter=<filter-name>

Perguntas relacionadas

git

2 respostas

  1. Best Answer

    Para configurar um filtro borrado ou limpo no Git que faça referência a um script rastreado pelo repositório, você precisa usar um caminho relativo para o script no repositório a partir do diretório raiz do projeto (na verdade, relativo ao seu , .gitattributesonde o filtro é declarado)

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

    Para o seu cenário específico com arquivos do Jupyter Notebook, você pode configurar o filtro limpo colocando o script limpo em seu repositório, por exemplo, scripts/clean_jupyter.sh. Esse script (que deve ser executável:) chmod +x scripts/clean_jupyter.shincluirá o comando que você mencionou:

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

    Configure seu .gitattributesarquivo para usar este script para seus arquivos do Jupyter Notebook:

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

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

    Configure o filtro limpo .git/configpara fazer referência ao seu script:

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

    Para que essas alterações sejam aplicadas automaticamente a todos os colaboradores, você pode incluir instruções no arquivo do seu projeto README.mdou configurar um script de inicialização que eles possam executar uma vez para definir as configurações do repositório local. O Git não permite a aplicação automática de configurações de filtro de um repositório por motivos de segurança, portanto a configuração manual é necessária.

    Para responder sua pergunta sobre minha resposta antiga sobre " Como posso rastrear arquivos de configuração específicos do sistema em um repositório/projeto? ":

    Você diz "Dessa forma, o script (gerenciado com Git) referenciado pela mancha". Como exatamente você faz referência a um script gerenciado pelo git no filtro de manchas? Sou relativamente novo em scripts e filtros git, mas realmente gostaria que isso funcionasse em meu projeto.

    O filtro smudge or cleané um script que é:

    • seja em relação ao seu arquivo .gitattributes (onde o filtro é declarado), como visto neste exemplo emgit/git/t/chainlint/token-pasting.test
    • ou um script no %PATH%ou $PATHda sua sessão shell; nesse caso, você pode referenciá-lo apenas pelo nome (sem caminho).
    • 1

  2. Se quiser configurar filtros do Git para executar scripts rastreados pelo repositório, você poderá usar caminhos relativos para fazer referência aos scripts na configuração do filtro. Veja como você pode modificar a configuração do filtro no arquivo .git/config para conseguir isso:

    Supondo que você tenha uma estrutura de diretórios como esta:

    project_root/
|-- scripts/
|   |-- clean_script.py
|   |-- smudge_script.py
|-- .git/
|-- .gitattributes
|-- other_files/
    1. Atualize atributos .git:

    Seu arquivo .gitattributes deve referenciar os scripts com um caminho relativo da raiz do seu repositório:

    *.ipynb filter=jupyter-notebook
    1. Atualize .git/config:

    Atualize a configuração do filtro no arquivo .git/config com caminhos relativos aos seus scripts:

    [filter "jupyter-notebook"]

clean = python scripts/clean_script.py

smudge = python scripts/smudge_script.py

    Certifique-se de ajustar os caminhos e comandos com base na estrutura real do seu projeto e nos comandos necessários para limpar e manchar os arquivos do Jupyter Notebook.

    1. Comprometa-se e compartilhe:

    Envie os arquivos .gitattributes e .git/config atualizados para seu repositório:

    git add .gitattributes .git/config

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

git push

    Dessa forma, quando os colaboradores clonarem o repositório, a configuração do filtro fará referência aos scripts por meio de caminhos relativos, e os scripts serão executados com base em sua localização na estrutura do projeto. Ajuste os caminhos de acordo com a configuração específica do seu projeto.

    • -1

relate perguntas