Discussão sobre como acelerar shutil.copytree

Escreva aqui

Esta é uma discussão sobre, consulte: https://discuss.python.org/t/speed-up-shutil-copytree/62078. Se você tiver alguma ideia, me envie por favor!

Fundo

shutil é um moudle muito útil em Python. Você pode encontrá-lo no github: https://github.com/python/cpython/blob/master/Lib/shutil.py

shutil.copytree é uma função que copia uma pasta para outra pasta.

Nesta função, ele chama a função _copytree para copiar.

O que _copytree faz?

1. Ignorando arquivos/diretórios especificados.
2. Criando diretórios de destino.
3. Copiar arquivos ou diretórios ao manipular links simbólicos.
4. Coletando e eventualmente levantando erros encontrados (por exemplo, problemas de permissão).
5. Replicando metadados do diretório de origem para o diretório de destino.

Problemas

A velocidade do _copytree não é muito rápida quando o número de arquivos é grande ou o tamanho do arquivo é grande.

Teste aqui:

import os
import shutil

os.mkdir('test')
os.mkdir('test/source')

def bench_mark(func, *args):
    import time
    start = time.time()
    func(*args)
    end = time.time()
    print(f'{func.__name__} takes {end - start} seconds')
    return end - start

# write in 3000 files
def write_in_5000_files():
    for i in range(5000):
        with open(f'test/source/{i}.txt', 'w') as f:
            f.write('Hello World'   os.urandom(24).hex())
            f.close()

bench_mark(write_in_5000_files)

def copy():
    shutil.copytree('test/source', 'test/destination')

bench_mark(copy)

O resultado é:

write_in_5000_files leva 4,084963083267212 segundos
a cópia leva 27,12768316268921 segundos

O que eu fiz

Multithreading

Eu uso multithread para acelerar o processo de cópia. E eu renomeio a função _copytree_single_threaded e adiciono uma nova função _copytree_multithreaded. Aqui está o copytree_multithreaded:

def _copytree_multithreaded(src, dst, symlinks=False, ignore=None, copy_function=shutil.copy2,
                            ignore_dangling_symlinks=False, dirs_exist_ok=False, max_workers=4):
    """Recursively copy a directory tree using multiple threads."""
    sys.audit("shutil.copytree", src, dst)

    # get the entries to copy
    entries = list(os.scandir(src))

    # make the pool
    with ThreadPoolExecutor(max_workers=max_workers) as executor:
        # submit the tasks
        futures = [
            executor.submit(_copytree_single_threaded, entries=[entry], src=src, dst=dst,
                            symlinks=symlinks, ignore=ignore, copy_function=copy_function,
                            ignore_dangling_symlinks=ignore_dangling_symlinks,
                            dirs_exist_ok=dirs_exist_ok)
            for entry in entries
        ]

        # wait for the tasks
        for future in as_completed(futures):
            try:
                future.result()
            except Exception as e:
                print(f"Failed to copy: {e}")
                raise

Eu adiciono um julgamento para escolher usar multithread ou não.

if len(entries) >= 100 or sum(os.path.getsize(entry.path) for entry in entries) >= 100*1024*1024:
        # multithreaded version
        return _copytree_multithreaded(src, dst, symlinks=symlinks, ignore=ignore,
                                        copy_function=copy_function,
                                        ignore_dangling_symlinks=ignore_dangling_symlinks,
                                        dirs_exist_ok=dirs_exist_ok)

else:
    # single threaded version
    return _copytree_single_threaded(entries=entries, src=src, dst=dst,
                                        symlinks=symlinks, ignore=ignore,
                                        copy_function=copy_function,
                                        ignore_dangling_symlinks=ignore_dangling_symlinks,
                                        dirs_exist_ok=dirs_exist_ok)

Teste

Eu escrevo 50.000 arquivos na pasta de origem. Marca de referência:

def bench_mark(func, *args):
    import time
    start = time.perf_counter()
    func(*args)
    end = time.perf_counter()
    print(f"{func.__name__} costs {end - start}s")

Escreva em:

import os
os.mkdir("Test")
os.mkdir("Test/source")

# write in 50000 files
def write_in_file():
    for i in range(50000):
         with open(f"Test/source/{i}.txt", 'w') as f:
             f.write(f"{i}")
             f.close()

Dois comparando:

def copy1():
    import shutil
    shutil.copytree('test/source', 'test/destination1')

def copy2():
    import my_shutil
    my_shutil.copytree('test/source', 'test/destination2')

• "my_shutil" é minha versão modificada do shutil.

cópia1 custa 173,04780609999943s
cópia2 custa 155,81321870000102s

copy2 é muito mais rápido que copy1. Você pode executar muitas vezes.

Vantagens e Desvantagens

O uso de multithread pode acelerar o processo de cópia. Mas aumentará o uso de memória. Mas não precisamos reescrever o multithread no código.

Assíncrono

Obrigado a "Barry Scott". Vou seguir a sugestão dele:

Você pode obter a mesma melhoria com menos sobrecarga usando E/S assíncrona.

Eu escrevo estes códigos:

import os
import shutil
import asyncio
from concurrent.futures import ThreadPoolExecutor
import time


# create directory
def create_target_directory(dst):
    os.makedirs(dst, exist_ok=True)

# copy 1 file
async def copy_file_async(src, dst):
    loop = asyncio.get_event_loop()
    await loop.run_in_executor(None, shutil.copy2, src, dst)

# copy directory
async def copy_directory_async(src, dst, symlinks=False, ignore=None, dirs_exist_ok=False):
    entries = os.scandir(src)
    create_target_directory(dst)

    tasks = []
    for entry in entries:
        src_path = entry.path
        dst_path = os.path.join(dst, entry.name)

        if entry.is_dir(follow_symlinks=not symlinks):
            tasks.append(copy_directory_async(src_path, dst_path, symlinks, ignore, dirs_exist_ok))
        else:
            tasks.append(copy_file_async(src_path, dst_path))

    await asyncio.gather(*tasks)
# choose copy method
def choose_copy_method(entries, src, dst, **kwargs):
    if len(entries) >= 100 or sum(os.path.getsize(entry.path) for entry in entries) >= 100 * 1024 * 1024:
        # async version
        asyncio.run(copy_directory_async(src, dst, **kwargs))
    else:
        # single thread version
        shutil.copytree(src, dst, **kwargs)
# test function
def bench_mark(func, *args):
    start = time.perf_counter()
    func(*args)
    end = time.perf_counter()
    print(f"{func.__name__} costs {end - start:.2f}s")

# write in 50000 files
def write_in_50000_files():
    for i in range(50000):
        with open(f"Test/source/{i}.txt", 'w') as f:
            f.write(f"{i}")

def main():
    os.makedirs('Test/source', exist_ok=True)
    write_in_50000_files()

    # 单线程复制
    def copy1():
        shutil.copytree('Test/source', 'Test/destination1')

    def copy2():
        shutil.copytree('Test/source', 'Test/destination2')

    # async
    def copy3():
        entries = list(os.scandir('Test/source'))
        choose_copy_method(entries, 'Test/source', 'Test/destination3')

    bench_mark(copy1)
    bench_mark(copy2)
    bench_mark(copy3)

    shutil.rmtree('Test')

if __name__ == "__main__":
    main()

Saída:

cópia1 custa 187,21s
copy2 custa 244,33s
copy3 custa 111,27s

Você pode ver que a versão assíncrona é mais rápida que a versão de thread único. Mas a versão single thread é mais rápida que a versão multithread. (Talvez meu ambiente de teste não seja muito bom, você pode tentar enviar seu resultado como resposta para mim)

Obrigado, Barry Scott!

Vantagens e Desvantagens

Async é uma boa escolha. Mas nenhuma solução é perfeita. Se você encontrar algum problema, pode me enviar uma resposta.

Fim

Esta é a primeira vez que escrevo uma discussão em python.org. Se houver algum problema, por favor me avise. Obrigado.

Meu Github: https://github.com/mengqinyuan
Meu Dev.to: https://dev.to/mengqinyuan