Let’s say we want to copy or move files and directories around, but don’t want to do it by calling out to shell commands. The shutil module has portable implementations of functions for copying files and directories.
import shutil # Copy src to dst. (cp src dst)shutil.copy(src, dst) # Copy files, but preserve metadata (cp -p src dst)shutil.copy2(src, dst) # Copy directory tree (cp -R src dst)shutil.copytree(src, dst) # Move src to dst (mv src dst)shutil.move(src, dst) |
The arguments to these functions are all strings supplying file or directory names. The underlying semantics tries to emulate that of similar Unix commands, as shown in the comments. By default, symbolic links are followed by these commands. For example, if the source file is a symbolic link, then the destination file will be a copy of the file the link points to.
To copy the symbolic link instead, supply the follow_symlinks keyword argument as shown in the code below:
Code #2 :
shutil.copy2(src, dst, follow_symlinks = False) # To preserve symbolic links in copied directoriesshutil.copytree(src, dst, symlinks = True) |
The copytree() optionally allows to ignore certain files and directories during the copy process. To do this, supply an ignore function that takes a directory name and filename listing as input, and returns a list of names to ignore as a result. The example is shown in the code below –
Code #3 :
def ignore_pyc_files(dirname, filenames): return [name in filenames if name.endswith('.pyc')] shutil.copytree(src, dst, ignore = ignore_pyc_files) |
Since ignoring filename patterns is common, a utility function ignore_patterns() has already been provided to do it as shown in the code given below.
Code #4 :
shutil.copytree(src, dst, ignore = shutil.ignore_patterns('*~', '*.pyc')) |
How it works?
- Using shutil to copy files and directories is mostly straightforward.
- However, one caution concerning file metadata is that functions such as copy2() only make the best effort in preserving this data.
- Basic information, such as access times, creation times, and permissions, will always be preserved, but the preservation of owners, ACLs, resource forks, and other extended file metadata may or may not work depending on the underlying operating system and the user’s own access permissions.
- The user probably wouldn’t want to use a function like shutil.copytree() to perform system backups.
When working with filenames, make sure to use the functions in os.path for the greatest portability (especially if working with both Unix and Windows).
Code #5 : Example
filename = '/Users/gfg/programs/abc.py' import os.pathos.path.basename(filename) |
'abc.py'
os.path.dirname(filename) |
'/Users/gfg/programs'
os.path.split(filename) |
('/Users/gfg/programs', 'abc.py')
os.path.join('/new/dir', os.path.basename(filename)) |
'/new/dir/spam.py'
os.path.expanduser('~/gfg/programs/spam.py') |
'/Users/gfg/programs/abc.py'
One tricky bit about copying directories with copytree() is the handling of errors. For example, in the process of copying, the function might encounter broken symbolic links, files that can’t be accessed due to permission problems, and so on.
