What is the purpose of the `distutils.dir_util.copy_tree` function and how can I ignore specific files?

The `distutils.dir_util.copy_tree` function in Python's `distutils` module is designed to recursively copy an entire directory tree to a new location. It handles the creation of necessary subdirectories and the copying of files, making it a convenient tool for moving or duplicating directory structures. However, the default `copy_tree` does not directly support file exclusion through a parameter.

To ignore specific files or directories, one approach is to use the `ignore` argument of the `shutil.copytree` function (which is a more modern replacement for `distutils.dir_util.copy_tree` and offers more options), or, alternatively, implement a custom filtering function when using `distutils.dir_util.copy_tree`.

Here's a detailed look at how you can achieve file exclusion using both methods:

1. Using `shutil.copytree` with `ignore` (Recommended):

- The `shutil.copytree` function offers an `ignore` parameter that takes a function as an argument. This function is called for each directory and returns a list of file or directory names to ignore. This approach is generally preferred due to its more robust design and cleaner integration with Python's standard library.

- Example code using `shutil.copytree` to ignore files with `.txt` and `.log` extensions:

import shutil
import os

def ignore_patterns(directory, contents):
  return [name for name in contents if name.endswith(('.txt', '.log'))]

source_dir = '/path/to/source/directory'
dest_dir = '/path/to/destination/directory'

shutil.copytree(source_dir, dest_dir, ignore=ignore_patterns)

- In the code above, the `ignore_patterns` function will filter out files ending with `.txt` and `.log` extensions. Adjust the patterns as needed to match your requirements.

2. Using `distutils.dir_util.copy_tree` with Custom Logic (Less Recommended):

- Since `distutils.dir_util.copy_tree` does not directly accept an ignore list, one approach is to pre-filter the list of files and directories within the source directory. This can be done using `os.listdir` and a list comprehension.

- Example code using `distutils.dir_util.copy_tree` with custom filtering logic:

from distutils.dir_util import copy_tree
import os

def copy_tree_with_ignore(source_dir, dest_dir, ignore_patterns):
  for root, _, files in os.walk(source_dir):
    filtered_files = [file for file in files if not any(file.endswith(pattern) for pattern in ignore_patterns)]
         target_root = root.replace(source_dir,dest_dir, 1)
    os.makedirs(target_root, exist_ok=True)
    for file in filtered_files:
      source_file = os.path.join(root, file)
      dest_file = os.path.join(target_root, file)
      shutil.copy2(source_file, dest_file)

source_dir = '/path/to/source/directory'
dest_dir = '/path/to/destination/directory'
ignore_patterns = ('.txt', '.log')

copy_tree_with_ignore(source_dir, dest_dir, ignore_patterns)

-This approach is less efficient and more verbose but can be used if the project explicitly requires `distutils` instead of `shutil`.

In summary, while `distutils.dir_util.copy_tree` is useful for directory copying, the `shutil.copytree` function with its `ignore` argument offers a more straightforward and maintainable way to exclude specific files and directories. The recommended method is to utilize `shutil.copytree` with a custom ignore function.

Learn more about this