shutil — High-level file operations¶
The shutil module offers a number of high-level operations on files and collections of files. In particular, functions are provided which support file copying and removal. For operations on individual files, see also the os module.
Even the higher-level file copying functions ( shutil.copy() , shutil.copy2() ) cannot copy all file metadata.
On POSIX platforms, this means that file owner and group are lost as well as ACLs. On Mac OS, the resource fork and other metadata are not used. This means that resources will be lost and file type and creator codes will not be correct. On Windows, file owners, ACLs and alternate data streams are not copied.
Directory and files operations¶
Copy the contents of the file-like object fsrc to the file-like object fdst. The integer length, if given, is the buffer size. In particular, a negative length value means to copy the data without looping over the source data in chunks; by default the data is read in chunks to avoid uncontrolled memory consumption. Note that if the current file position of the fsrc object is not 0, only the contents from the current file position to the end of the file will be copied.
shutil. copyfile ( src , dst , * , follow_symlinks = True ) ¶
Copy the contents (no metadata) of the file named src to a file named dst and return dst in the most efficient way possible. src and dst are path-like objects or path names given as strings.
dst must be the complete target file name; look at copy() for a copy that accepts a target directory path. If src and dst specify the same file, SameFileError is raised.
The destination location must be writable; otherwise, an OSError exception will be raised. If dst already exists, it will be replaced. Special files such as character or block devices and pipes cannot be copied with this function.
If follow_symlinks is false and src is a symbolic link, a new symbolic link will be created instead of copying the file src points to.
Raises an auditing event shutil.copyfile with arguments src , dst .
Changed in version 3.3: IOError used to be raised instead of OSError . Added follow_symlinks argument. Now returns dst.
Changed in version 3.4: Raise SameFileError instead of Error . Since the former is a subclass of the latter, this change is backward compatible.
Changed in version 3.8: Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See Platform-dependent efficient copy operations section.
This exception is raised if source and destination in copyfile() are the same file.
New in version 3.4.
Copy the permission bits from src to dst. The file contents, owner, and group are unaffected. src and dst are path-like objects or path names given as strings. If follow_symlinks is false, and both src and dst are symbolic links, copymode() will attempt to modify the mode of dst itself (rather than the file it points to). This functionality is not available on every platform; please see copystat() for more information. If copymode() cannot modify symbolic links on the local platform, and it is asked to do so, it will do nothing and return.
Raises an auditing event shutil.copymode with arguments src , dst .
Changed in version 3.3: Added follow_symlinks argument.
Copy the permission bits, last access time, last modification time, and flags from src to dst. On Linux, copystat() also copies the “extended attributes” where possible. The file contents, owner, and group are unaffected. src and dst are path-like objects or path names given as strings.
If follow_symlinks is false, and src and dst both refer to symbolic links, copystat() will operate on the symbolic links themselves rather than the files the symbolic links refer to—reading the information from the src symbolic link, and writing the information to the dst symbolic link.
Not all platforms provide the ability to examine and modify symbolic links. Python itself can tell you what functionality is locally available.
If os.chmod in os.supports_follow_symlinks is True , copystat() can modify the permission bits of a symbolic link.
If os.utime in os.supports_follow_symlinks is True , copystat() can modify the last access and modification times of a symbolic link.
If os.chflags in os.supports_follow_symlinks is True , copystat() can modify the flags of a symbolic link. ( os.chflags is not available on all platforms.)
On platforms where some or all of this functionality is unavailable, when asked to modify a symbolic link, copystat() will copy everything it can. copystat() never returns failure.
Please see os.supports_follow_symlinks for more information.
Raises an auditing event shutil.copystat with arguments src , dst .
Changed in version 3.3: Added follow_symlinks argument and support for Linux extended attributes.
Copies the file src to the file or directory dst. src and dst should be path-like objects or strings. If dst specifies a directory, the file will be copied into dst using the base filename from src. If dst specifies a file that already exists, it will be replaced. Returns the path to the newly created file.
If follow_symlinks is false, and src is a symbolic link, dst will be created as a symbolic link. If follow_symlinks is true and src is a symbolic link, dst will be a copy of the file src refers to.
copy() copies the file data and the file’s permission mode (see os.chmod() ). Other metadata, like the file’s creation and modification times, is not preserved. To preserve all file metadata from the original, use copy2() instead.
Raises an auditing event shutil.copyfile with arguments src , dst .
Raises an auditing event shutil.copymode with arguments src , dst .
Changed in version 3.3: Added follow_symlinks argument. Now returns path to the newly created file.
Changed in version 3.8: Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See Platform-dependent efficient copy operations section.
Identical to copy() except that copy2() also attempts to preserve file metadata.
When follow_symlinks is false, and src is a symbolic link, copy2() attempts to copy all metadata from the src symbolic link to the newly created dst symbolic link. However, this functionality is not available on all platforms. On platforms where some or all of this functionality is unavailable, copy2() will preserve all the metadata it can; copy2() never raises an exception because it cannot preserve file metadata.
copy2() uses copystat() to copy the file metadata. Please see copystat() for more information about platform support for modifying symbolic link metadata.
Raises an auditing event shutil.copyfile with arguments src , dst .
Raises an auditing event shutil.copystat with arguments src , dst .
Changed in version 3.3: Added follow_symlinks argument, try to copy extended file system attributes too (currently Linux only). Now returns path to the newly created file.
Changed in version 3.8: Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See Platform-dependent efficient copy operations section.
This factory function creates a function that can be used as a callable for copytree() ‘s ignore argument, ignoring files and directories that match one of the glob-style patterns provided. See the example below.
shutil. copytree ( src , dst , symlinks = False , ignore = None , copy_function = copy2 , ignore_dangling_symlinks = False , dirs_exist_ok = False ) ¶
Recursively copy an entire directory tree rooted at src to a directory named dst and return the destination directory. All intermediate directories needed to contain dst will also be created by default.
Permissions and times of directories are copied with copystat() , individual files are copied using copy2() .
If symlinks is true, symbolic links in the source tree are represented as symbolic links in the new tree and the metadata of the original links will be copied as far as the platform allows; if false or omitted, the contents and metadata of the linked files are copied to the new tree.
When symlinks is false, if the file pointed by the symlink doesn’t exist, an exception will be added in the list of errors raised in an Error exception at the end of the copy process. You can set the optional ignore_dangling_symlinks flag to true if you want to silence this exception. Notice that this option has no effect on platforms that don’t support os.symlink() .
If ignore is given, it must be a callable that will receive as its arguments the directory being visited by copytree() , and a list of its contents, as returned by os.listdir() . Since copytree() is called recursively, the ignore callable will be called once for each directory that is copied. The callable must return a sequence of directory and file names relative to the current directory (i.e. a subset of the items in its second argument); these names will then be ignored in the copy process. ignore_patterns() can be used to create such a callable that ignores names based on glob-style patterns.
If exception(s) occur, an Error is raised with a list of reasons.
If copy_function is given, it must be a callable that will be used to copy each file. It will be called with the source path and the destination path as arguments. By default, copy2() is used, but any function that supports the same signature (like copy() ) can be used.
If dirs_exist_ok is false (the default) and dst already exists, a FileExistsError is raised. If dirs_exist_ok is true, the copying operation will continue if it encounters existing directories, and files within the dst tree will be overwritten by corresponding files from the src tree.
Raises an auditing event shutil.copytree with arguments src , dst .
Changed in version 3.3: Copy metadata when symlinks is false. Now returns dst.
Changed in version 3.2: Added the copy_function argument to be able to provide a custom copy function. Added the ignore_dangling_symlinks argument to silence dangling symlinks errors when symlinks is false.
Changed in version 3.8: Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See Platform-dependent efficient copy operations section.
New in version 3.8: The dirs_exist_ok parameter.
Delete an entire directory tree; path must point to a directory (but not a symbolic link to a directory). If ignore_errors is true, errors resulting from failed removals will be ignored; if false or omitted, such errors are handled by calling a handler specified by onerror or, if that is omitted, they raise an exception.
On platforms that support the necessary fd-based functions a symlink attack resistant version of rmtree() is used by default. On other platforms, the rmtree() implementation is susceptible to a symlink attack: given proper timing and circumstances, attackers can manipulate symlinks on the filesystem to delete files they wouldn’t be able to access otherwise. Applications can use the rmtree.avoids_symlink_attacks function attribute to determine which case applies.
If onerror is provided, it must be a callable that accepts three parameters: function, path, and excinfo.
The first parameter, function, is the function which raised the exception; it depends on the platform and implementation. The second parameter, path, will be the path name passed to function. The third parameter, excinfo, will be the exception information returned by sys.exc_info() . Exceptions raised by onerror will not be caught.
Raises an auditing event shutil.rmtree with arguments path , dir_fd .
Changed in version 3.3: Added a symlink attack resistant version that is used automatically if platform supports fd-based functions.
Changed in version 3.8: On Windows, will no longer delete the contents of a directory junction before removing the junction.
Changed in version 3.11: The dir_fd parameter.
Indicates whether the current platform and implementation provides a symlink attack resistant version of rmtree() . Currently this is only true for platforms supporting fd-based directory access functions.
New in version 3.3.
Recursively move a file or directory (src) to another location (dst) and return the destination.
If the destination is an existing directory, then src is moved inside that directory. If the destination already exists but is not a directory, it may be overwritten depending on os.rename() semantics.
If the destination is on the current filesystem, then os.rename() is used. Otherwise, src is copied to dst using copy_function and then removed. In case of symlinks, a new symlink pointing to the target of src will be created in or as dst and src will be removed.
If copy_function is given, it must be a callable that takes two arguments src and dst, and will be used to copy src to dst if os.rename() cannot be used. If the source is a directory, copytree() is called, passing it the copy_function() . The default copy_function is copy2() . Using copy() as the copy_function allows the move to succeed when it is not possible to also copy the metadata, at the expense of not copying any of the metadata.
Raises an auditing event shutil.move with arguments src , dst .
Changed in version 3.3: Added explicit symlink handling for foreign filesystems, thus adapting it to the behavior of GNU’s mv. Now returns dst.
Changed in version 3.5: Added the copy_function keyword argument.
Changed in version 3.8: Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See Platform-dependent efficient copy operations section.
Changed in version 3.9: Accepts a path-like object for both src and dst.
Return disk usage statistics about the given path as a named tuple with the attributes total, used and free, which are the amount of total, used and free space, in bytes. path may be a file or a directory.
New in version 3.3.
Changed in version 3.8: On Windows, path can now be a file or directory.
Change owner user and/or group of the given path.
user can be a system user name or a uid; the same applies to group. At least one argument is required.
See also os.chown() , the underlying function.
Raises an auditing event shutil.chown with arguments path , user , group .
New in version 3.3.
Return the path to an executable which would be run if the given cmd was called. If no cmd would be called, return None .
mode is a permission mask passed to os.access() , by default determining if the file exists and executable.
When no path is specified, the results of os.environ() are used, returning either the “PATH” value or a fallback of os.defpath .
On Windows, the current directory is always prepended to the path whether or not you use the default or provide your own, which is the behavior the command shell uses when finding executables. Additionally, when finding the cmd in the path, the PATHEXT environment variable is checked. For example, if you call shutil.which("python") , which() will search PATHEXT to know that it should look for python.exe within the path directories. For example, on Windows:
New in version 3.3.
Changed in version 3.8: The bytes type is now accepted. If cmd type is bytes , the result type is also bytes .
This exception collects exceptions that are raised during a multi-file operation. For copytree() , the exception argument is a list of 3-tuples (srcname, dstname, exception).
Platform-dependent efficient copy operations¶
Starting from Python 3.8, all functions involving a file copy ( copyfile() , copy() , copy2() , copytree() , and move() ) may use platform-specific “fast-copy” syscalls in order to copy the file more efficiently (see bpo-33671). “fast-copy” means that the copying operation occurs within the kernel, avoiding the use of userspace buffers in Python as in “ outfd.write(infd.read()) ”.
On macOS fcopyfile is used to copy the file content (not metadata).
On Linux os.sendfile() is used.
On Windows shutil.copyfile() uses a bigger default buffer size (1 MiB instead of 64 KiB) and a memoryview() -based variant of shutil.copyfileobj() is used.
If the fast-copy operation fails and no data was written in the destination file then shutil will silently fallback on using less efficient copyfileobj() function internally.
Changed in version 3.8.
copytree example¶
An example that uses the ignore_patterns() helper:
This will copy everything except .pyc files and files or directories whose name starts with tmp .
Another example that uses the ignore argument to add a logging call:
rmtree example¶
This example shows how to remove a directory tree on Windows where some of the files have their read-only bit set. It uses the onerror callback to clear the readonly bit and reattempt the remove. Any subsequent failure will propagate.
Archiving operations¶
New in version 3.2.
Changed in version 3.5: Added support for the xztar format.
High-level utilities to create and read compressed and archived files are also provided. They rely on the zipfile and tarfile modules.
shutil. make_archive ( base_name , format [ , root_dir [ , base_dir [ , verbose [ , dry_run [ , owner [ , group [ , logger ] ] ] ] ] ] ] ) ¶
Create an archive file (such as zip or tar) and return its name.
base_name is the name of the file to create, including the path, minus any format-specific extension. format is the archive format: one of “zip” (if the zlib module is available), “tar”, “gztar” (if the zlib module is available), “bztar” (if the bz2 module is available), or “xztar” (if the lzma module is available).
root_dir is a directory that will be the root directory of the archive, all paths in the archive will be relative to it; for example, we typically chdir into root_dir before creating the archive.
base_dir is the directory where we start archiving from; i.e. base_dir will be the common prefix of all files and directories in the archive. base_dir must be given relative to root_dir. See Archiving example with base_dir for how to use base_dir and root_dir together.
root_dir and base_dir both default to the current directory.
If dry_run is true, no archive is created, but the operations that would be executed are logged to logger.
owner and group are used when creating a tar archive. By default, uses the current owner and group.
logger must be an object compatible with PEP 282, usually an instance of logging.Logger .
The verbose argument is unused and deprecated.
Raises an auditing event shutil.make_archive with arguments base_name , format , root_dir , base_dir .
This function is not thread-safe when custom archivers registered with register_archive_format() are used. In this case it temporarily changes the current working directory of the process to perform archiving.
Changed in version 3.8: The modern pax (POSIX.1-2001) format is now used instead of the legacy GNU format for archives created with format="tar" .
Changed in version 3.10.6: This function is now made thread-safe during creation of standard .zip and tar archives.
Return a list of supported formats for archiving. Each element of the returned sequence is a tuple (name, description) .
By default shutil provides these formats:
zip: ZIP file (if the zlib module is available).
tar: Uncompressed tar file. Uses POSIX.1-2001 pax format for new archives.
gztar: gzip’ed tar-file (if the zlib module is available).
bztar: bzip2’ed tar-file (if the bz2 module is available).
xztar: xz’ed tar-file (if the lzma module is available).
You can register new formats or provide your own archiver for any existing formats, by using register_archive_format() .
shutil. register_archive_format ( name , function [ , extra_args [ , description ] ] ) ¶
Register an archiver for the format name.
function is the callable that will be used to unpack archives. The callable will receive the base_name of the file to create, followed by the base_dir (which defaults to os.curdir ) to start archiving from. Further arguments are passed as keyword arguments: owner, group, dry_run and logger (as passed in make_archive() ).
If given, extra_args is a sequence of (name, value) pairs that will be used as extra keywords arguments when the archiver callable is used.
description is used by get_archive_formats() which returns the list of archivers. Defaults to an empty string.
shutil. unregister_archive_format ( name ) ¶
Remove the archive format name from the list of supported formats.
shutil. unpack_archive ( filename [ , extract_dir [ , format [ , filter ] ] ] ) ¶
Unpack an archive. filename is the full path of the archive.
extract_dir is the name of the target directory where the archive is unpacked. If not provided, the current working directory is used.
format is the archive format: one of “zip”, “tar”, “gztar”, “bztar”, or “xztar”. Or any other format registered with register_unpack_format() . If not provided, unpack_archive() will use the archive file name extension and see if an unpacker was registered for that extension. In case none is found, a ValueError is raised.
The keyword-only filter argument, which was added in Python 3.11.4, is passed to the underlying unpacking function. For zip files, filter is not accepted. For tar files, it is recommended to set it to ‘data’ , unless using features specific to tar and UNIX-like filesystems. (See Extraction filters for details.) The ‘data’ filter will become the default for tar files in Python 3.14.
Raises an auditing event shutil.unpack_archive with arguments filename , extract_dir , format .
Never extract archives from untrusted sources without prior inspection. It is possible that files are created outside of the path specified in the extract_dir argument, e.g. members that have absolute filenames starting with “/” or filenames with two dots “..”.
Changed in version 3.7: Accepts a path-like object for filename and extract_dir.
Changed in version 3.11.4: Added the filter argument.
Registers an unpack format. name is the name of the format and extensions is a list of extensions corresponding to the format, like .zip for Zip files.
function is the callable that will be used to unpack archives. The callable will receive:
the path of the archive, as a positional argument;
the directory the archive must be extracted to, as a positional argument;
possibly a filter keyword argument, if it was given to unpack_archive() ;
additional keyword arguments, specified by extra_args as a sequence of (name, value) tuples.
description can be provided to describe the format, and will be returned by the get_unpack_formats() function.
shutil. unregister_unpack_format ( name ) ¶
Unregister an unpack format. name is the name of the format.
Return a list of all registered formats for unpacking. Each element of the returned sequence is a tuple (name, extensions, description) .
By default shutil provides these formats:
zip: ZIP file (unpacking compressed files works only if the corresponding module is available).
tar: uncompressed tar file.
gztar: gzip’ed tar-file (if the zlib module is available).
bztar: bzip2’ed tar-file (if the bz2 module is available).
xztar: xz’ed tar-file (if the lzma module is available).
You can register new formats or provide your own unpacker for any existing formats, by using register_unpack_format() .
Archiving example¶
In this example, we create a gzip’ed tar-file archive containing all files found in the .ssh directory of the user:
The resulting archive contains:
Archiving example with base_dir¶
In this example, similar to the one above, we show how to use make_archive() , but this time with the usage of base_dir. We now have the following directory structure:
In the final archive, please_add.txt should be included, but do_not_add.txt should not. Therefore we use the following:
Listing the files in the resulting archive gives us:
Querying the size of the output terminal¶
Get the size of the terminal window.
For each of the two dimensions, the environment variable, COLUMNS and LINES respectively, is checked. If the variable is defined and the value is a positive integer, it is used.
When COLUMNS or LINES is not defined, which is the common case, the terminal connected to sys.__stdout__ is queried by invoking os.get_terminal_size() .
If the terminal size cannot be successfully queried, either because the system doesn’t support querying, or because we are not connected to a terminal, the value given in fallback parameter is used. fallback defaults to (80, 24) which is the default size used by many terminal emulators.
The value returned is a named tuple of type os.terminal_size .
See also: The Single UNIX Specification, Version 2, Other Environment Variables.
Import shutil python что это
Shutil module offers high-level operation on a file like a copy, create, and remote operation on the file. It comes under Python’s standard utility modules. This module helps in automating the process of copying and removal of files and directories. In this article, we will learn this module.
Copying Files to another directory
shutil.copy() method in Python is used to copy the content of the source file to the destination file or directory. It also preserves the file’s permission mode but other metadata of the file like the file’s creation and modification times is not preserved.
The source must represent a file but the destination can be a file or a directory. If the destination is a directory then the file will be copied into the destination using the base filename from the source. Also, the destination must be writable. If the destination is a file and already exists then it will be replaced with the source file otherwise a new file will be created.
Syntax: shutil.copy(source, destination, *, follow_symlinks = True)
Parameter:
- source: A string representing the path of the source file.
- destination: A string representing the path of the destination file or directory.
- follow_symlinks (optional) : The default value of this parameter is True. If it is False and source represents a symbolic link then destination will be created as a symbolic link.
Example 1:
Python3
Output:
Example 2: If the destination is a directory.
Python3
Output:
Copying the Metadata along with File
shutil.copy2() method in Python is used to copy the content of the source file to the destination file or directory. This method is identical to shutil.copy() method but it also tries to preserve the file’s metadata.
Syntax: shutil.copy2(source, destination, *, follow_symlinks = True)
- source: A string representing the path of the source file.
- destination: A string representing the path of the destination file or directory.
- follow_symlinks (optional) : The default value of this parameter is True. If it is False and source represents a symbolic link then it attempts to copy all metadata from the source symbolic link to the newly-created destination symbolic link. This functionality is platform dependent.
Python3
Output:
Before copying file:
[‘archive (2)’, ‘c.jpg’, ‘c.PNG’, ‘Capture.PNG’, ‘cc.jpg’, ‘check.zip’, ‘cv.csv’, ‘d.png’, ‘Done! Terms And Conditions Generator – The Fastest Free Terms and Conditions Generator!.pdf’, ‘file1.csv’, ‘gfg’, ‘haarcascade_frontalface_alt2.xml’, ‘log_transformed.jpg’, ‘main.py’, ‘nba.csv’, ‘new_gfg.png’, ‘r.gif’, ‘Result -_ Terms and Conditions are Ready!.pdf’, ‘rockyou.txt’, ‘sample.txt’]
Metadata: os.stat_result(st_mode=33206, st_ino=2251799814202896, st_dev=1689971230, st_nlink=1, st_uid=0, st_gid=0, st_size=1916, st_atime=1612953710, st_mtime=1612613202, st_ctime=1612522940)
After copying file:
[‘archive (2)’, ‘c.jpg’, ‘c.PNG’, ‘Capture.PNG’, ‘cc.jpg’, ‘check.zip’, ‘cv.csv’, ‘d.png’, ‘Done! Terms And Conditions Generator – The Fastest Free Terms and Conditions Generator!.pdf’, ‘file1.csv’, ‘gfg’, ‘haarcascade_frontalface_alt2.xml’, ‘log_transformed.jpg’, ‘main.py’, ‘nba.csv’, ‘new_gfg.png’, ‘r.gif’, ‘Result -_ Terms and Conditions are Ready!.pdf’, ‘rockyou.txt’, ‘sample.txt’]
Metadata: os.stat_result(st_mode=33206, st_ino=2251799814202896, st_dev=1689971230, st_nlink=1, st_uid=0, st_gid=0, st_size=1916, st_atime=1612953710, st_mtime=1612613202, st_ctime=1612522940)
Destination path: csv/gfg/check.txt
Example 2: If the destination is a directory
Python3
Output:
Copying the content of one file to another
shutil.copyfile() method in Python is used to copy the content of the source file to the destination file. The metadata of the file is not copied. Source and destination must represent a file and destination must be writable. If the destination already exists then it will be replaced with the source file otherwise a new file will be created.
If source and destination represent the same file then SameFileError exception will be raised.
Python Shutil Module: 10 Methods You Should Know
Firstly, Python Shutil module in Python provides many functions to perform high-level operations on files and collections of files. Secondly, It is an inbuilt module that comes with the automation process of copying and removing files and directories. Thirdly, this module also takes care of low-level semantics like creating, closing files once they are copied, and focusing on the business logic.
How does the python shutil module work?
The basic syntax to use shutil module is as follows:
File-Directory operations
1. Python shutil.copy()
shutil.copy(): This function is used to copy the content or text of the source file to the destination file or directories. It also preserves the file’s permission mode, but another type of metadata of the file like the file’s creation and file’s modification is not preserved.
Output:
Explanation:
In this code, Firstly, we are checking with the files present in the directory. Secondly, then we will print the file permissions and give the source path of the file. Thirdly, we will give the destination path the copy of the content there in a new file. At last, we will again print all the files in the directory and check if the copy was created of that file or not.
2. Python shutil.copy2()
Firstly, this function is just like the copy() function except for the fact that it maintains metadata of the source file.
Output:
Explanation:
In this code, we have written the function copy2() is the same as a copy, just it performs one extra operation that maintains the metadata.
3. Python shutil.copyfile()
In this function file, names get copied, which means the original file is copied by the specified name in the same directory. It says that the duplicate of the file is present in the same directory.
Output:
Explanation:
In this code, we have written the function copyfile() the same file name gets copied for the new file just copy is added in the new file name. see in the output.
4. Python shutil.copytree()
This function copies the file and the subdirectories in one directory to another directory. That means that the file is present in the source as well as the destination. The names of both the parameters must be in the string.
Output:
Explanation:
In this code, we have written the function copytree() so that we can get duplicate of that file.
5. Python shutil.rmtree()
This function is used to remove the particular file and subdirectory from the specified directory, which means that the directory is deleted from the system.
Output:
Explanation:
In this code, we have written the function rmtree(), which is used to remove the file or directory. Firstly, we have listed all the files and applied the function to remove and again listed the file so that we can see if the file is deleted or not.
6. shutil.which()
The which() a function is an excellent tool that is used to find the file path in your machine to easily reach the particular destination by knowing the path of the file.
output:
Explanation:
In this code, we have written the function that () so that we can find any of the files when required.
7. Python shutil.disk_usage()
This function is used to understand how much information is present in our file system by just calling the disk_usage() function.
Output:
Explanation:
In this code, we have written the function disk_usage() to get to know about the total, used, and free disk space.
8. Python shutil.move()
This function is used to move the file and directory from one directory to another directory and removes it from the previous directory. It can be said as renaming the file or directory also.
Output:
Explanation:
In this code, we have written the function move() to move the file or directory from one place to another.
9. Python shutil.make_archive()
This function is used to build an archive (zip or tar) of files in the root directory.
output:
Explanation:
In this code, we have written the functionmake_archive() with telling them the name of the root directory to build the archive of files in the root directory.
10. Python shutil.get_archive_formats()
This function gives us all the supported archive formats in the file or directory.
output:
Explanation:
In this code, we have written the function get_archive_formats() to get the supportive archive formats in the file or directory.
Advantages
- The shutil module helps you in the automation of copying files and directories.
- This module saves the steps of opening, reading, writing, and closing files when there is no actual processing, simply moving files.
Must Read
Conclusion
In this article, we have studied many types of operations that how we can work on high-level file operations like copying contents of a file and create a new copy of a file, etc. without diving into complex File Handling operations with shutil module in Python.
However, if you have any doubts or questions, do let me know in the comment section below. I will try to help you as soon as possible.
Работа с каталогами в Python
Каталог — это набор файлов и подкаталогов. Каталог внутри каталога называется подкаталогом. В Python есть модуль os, который предоставляет множество полезных методов для работы с каталогами и файлами.
Текущий каталог в Python
Мы можем вывести текущий каталог с помощью метода getcwd() модуля os . Этот метод возвращает текущий рабочий каталог в виде строки. Например:
Изменение каталога в Python
В Python мы можем изменить текущий рабочий каталог с помощью метода chdir(). Новый путь, который мы хотим использовать, нужно указать при вызове этого метода в виде строки. При этом для разделения элементов пути мы можем использовать как прямую косую черту / , так и обратную косую черту \ . Например:
Список каталогов и файлов в Python
Все файлы и подкаталоги внутри каталога можно получить с помощью метода listdir(). Этот метод принимает путь и возвращает список подкаталогов и файлов по указанному пути.
Если путь не указан, возвращается список подкаталогов и файлов из текущего рабочего каталога.