Como usar o git filter-repo como uma biblioteca com a interface do módulo Python?

Question

Eu sei que dou o código Python como uma string na linha de comando, por exemplo:

git-filter-repo --name-callback 'return name.replace(b"Wiliam", b"William")'

mas, especialmente à medida que entro em scripts mais complexos, isso fica muito desajeitado.

Em vez disso, existe uma maneira de fazer algo como:

main.py

import git_filter_repo

def name_callback(name):
    return name.replace(b"Wiliam", b"William")

git_filter_repo.name_callback(name_callback)

O README do projeto menciona que ele pode ser usado como uma biblioteca, e consegui instalar o pacote Python com:

python3 -m pip install --user git-filter-repo

mas não consegui encontrar facilmente a documentação sobre como fazer um hello world com a API Python.

Answer 1

As últimas linhas da fonte https://github.com/newren/git-filter-repo/blob/7b3e714b94a6e5b9f478cb981c7f560ef3f36506/git-filter-repo#L3946 foram um bom ponto de partida, então posso fazer algo assim:

#!/usr/bin/env python

import git_filter_repo

def blob_callback(blob, callback_metadata):
    blob.data = blob.data.replace(b'd1', b'asdf')

# Args deduced from:
# print(git_filter_repo.FilteringOptions.parse_args(['--refs', 'HEAD', '--force'], error_on_empty=False))
args = git_filter_repo.FilteringOptions.default_options()
args.force = True
args.partial = True
args.refs = ['HEAD']
args.repack=False
args.replace_refs='update-no-add'

git_filter_repo.RepoFilter(
   args,
   blob_callback=blob_callback
).run()

que se destina a ser equivalente a:

git filter-repo --refs HEAD <(echo 'd1==>asdf') --force

Isso também responde: Como substituir texto de arquivos no histórico do git?

Como saber também o caminho do blob: Como modificar um blob considerando o caminho do arquivo e os dados com git filter-repo?

Testado em git-filter-repo ac039ecc095d com este repo de teste: https://github.com/cirosantilli/test-git-filter-repo