Обсуждение ускорения Shutil.copytree

Напишите здесь

Это обсуждение, см.: https://discuss.python.org/t/speed-up-shutil-copytree/62078. Если у вас есть идеи, пришлите мне, пожалуйста!

Фон

shutil — очень полезный модуль на Python. Вы можете найти его в github: https://github.com/python/cpython/blob/master/Lib/shutil.py

shutil.copytree — это функция, которая копирует папку в другую папку.

В этой функции для копирования вызывается функция _copytree.

Что делает _copytree?

1. Игнорирование указанных файлов/каталогов.
2. Создание каталогов назначения.
3. Копирование файлов или каталогов при обработке символических ссылок.
4. Сбор и, в конечном итоге, обнаружение обнаруженных ошибок (например, проблемы с разрешениями).
5. Репликация метаданных исходного каталога в целевой каталог.

Проблемы

Скорость _copytree не очень высокая, если количество файлов велико или размер файла велик.

Протестируйте здесь:

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)

Результат:

write_in_5000_files занимает 4,084963083267212 секунды
копирование занимает 27,12768316268921 секунды

Что я сделал

Многопоточность

Я использую многопоточность для ускорения процесса копирования. И я переименовываю функцию _copytree_single_threaded, добавляя новую функцию _copytree_multithreaded. Вот 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

Я добавляю решение, использовать многопоточность или нет.

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)

Тест

Я записываю 50000 файлов в исходную папку. Контрольная оценка:

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")

Впишите:

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()

Два сравнения:

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

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

• "my_shutil" — это моя модифицированная версия Shutil.

копия1 стоит 173,04780609999943 с
копия 2 стоит 155,81321870000102 с

copy2 намного быстрее, чем copy1. Вы можете бегать много раз.

Преимущества и недостатки

Использование многопоточности может ускорить процесс копирования. Но это увеличит использование памяти. Но нам не нужно переписывать многопоточность в коде.

Асинхронный

Спасибо «Барри Скотту». Я последую его/ее предложению :

Вы можете получить такое же улучшение с меньшими издержками, используя асинхронный ввод-вывод.

Я пишу этот код:

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()

Выход:

копия1 стоит 187,21 с
копия2 стоит 244,33 секунды
copy3 стоит 111,27 с

Вы можете видеть, что асинхронная версия работает быстрее, чем однопоточная. Но однопоточная версия быстрее многопоточной. (Возможно, моя тестовая среда не очень хороша, вы можете попробовать отправить мне результат в ответ)

Спасибо, Барри Скотт!

Преимущества и недостатки

Async — хороший выбор. Но ни одно решение не является идеальным. Если вы обнаружите какую-то проблему, вы можете отправить мне ответ.

Конец

Я впервые пишу обсуждение на python.org. Если есть какие-либо проблемы, пожалуйста, дайте мне знать. Спасибо.

Мой Github: https://github.com/mengqinyuan
Мой Dev.to: https://dev.to/mengqinyuan