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.
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 :
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 :
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 :
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
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.
- Listing out directories and files in Python
- copy in Python (Deep Copy and Shallow Copy)
- Downloading files from web using Python
- Working with zip files in Python
- Working with PDF files in Python
- Working with csv files in Python
- Python | How to use Multiple kv files in kivy
- Python | Reading .ini Configuration Files
- Python | Merge two text files
- Rename multiple files using Python
- Writing files in background in Python
- Reading and Writing to text files in Python
- Python | Sort and store files with same extension
- Python | Create Archives and Find Files by Name
- Python | Speech recognition on large audio files
If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to firstname.lastname@example.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.
Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.