shutil
就业培训 下载中心 Wiki 联络 登录 注册 首页 Python 3.12.4 索引 模块 下一 上一 Python 标准库 文件和目录访问 shutil — 高级文件操作 shutil — 高级文件操作 ¶ 源代码： Lib/shutil.py The shutil 模块为文件和文件集合提供了许多高级操作。 尤其，提供了支持文件拷贝和移除的函数。对于单个文件的操作，另请参阅 os 模块。 警告 更高级文件拷贝函数 ( shutil.copy() , shutil.copy2() ) 无法拷贝所有文件元数据。 在 POSIX (便携式操作系统接口) 平台，这意味着文件所有者、组及 ACL 会丢失。在 Mac OS，将不使用资源分叉和其它元数据。这意味着资源会丢失，且文件类型和创建者代码将不正确。在 Windows，将不拷贝文件所有者、ACL 和替代数据流。 目录和文件操作 ¶ shutil. copyfileobj ( fsrc , fdst [ , length ] ) ¶ Copy the contents of the 像文件对象 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 并返回 dst in the most efficient way possible. src and dst are 像路径对象 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 被引发。 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. 若 follow_symlinks 为 False 且 src is a symbolic link, a new symbolic link will be created instead of copying the file src points to. 引发 审计事件 shutil.copyfile 采用自变量 src , dst . 3.3 版改变： IOError 用于被引发而不是 OSError 。添加 follow_symlinks 自变量。现有返回 dst . 3.4 版改变： 引发 SameFileError 而不是 Error . Since the former is a subclass of the latter, this change is backward compatible. 3.8 版改变： Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See 从属平台的高效拷贝操作 章节。 exception shutil. SameFileError ¶ This exception is raised if source and destination in copyfile() 是同一文件。 Added in version 3.4. shutil. copymode ( src , dst , * , follow_symlinks = True ) ¶ 拷贝权限位从 src to dst . The file contents, owner, and group are unaffected. src and dst are 像路径对象 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. 引发 审计事件 shutil.copymode 采用自变量 src , dst . 3.3 版改变： 添加 follow_symlinks 自变量。 shutil. copystat ( src , dst , * , follow_symlinks = True ) ¶ Copy the permission bits, last access time, last modification time, and flags from src to dst 。在 Linux， copystat() also copies the “extended attributes” where possible. The file contents, owner, and group are unaffected. src and dst are 像路径对象 or path names given as strings. 若 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. 若 os.chmod in os.supports_follow_symlinks is True , copystat() can modify the permission bits of a symbolic link. 若 os.utime in os.supports_follow_symlinks is True , copystat() can modify the last access and modification times of a symbolic link. 若 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. 请参阅 os.supports_follow_symlinks 了解更多信息。 引发 审计事件 shutil.copystat 采用自变量 src , dst . 3.3 版改变： 添加 follow_symlinks argument and support for Linux extended attributes. shutil. copy ( src , dst , * , follow_symlinks = True ) ¶ 拷贝文件 src to the file or directory dst . src and dst 应该为 像路径对象 or strings. If dst specifies a directory, the file will be copied into dst using the base filename from src 。若 dst specifies a file that already exists, it will be replaced. Returns the path to the newly created file. 若 follow_symlinks is false, and src is a symbolic link, dst will be created as a symbolic link. If follow_symlinks 为 True 和 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() 代替。 引发 审计事件 shutil.copyfile 采用自变量 src , dst . 引发 审计事件 shutil.copymode 采用自变量 src , dst . 3.3 版改变： 添加 follow_symlinks argument. Now returns path to the newly created file. 3.8 版改变： Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See 从属平台的高效拷贝操作 章节。 shutil. copy2 ( src , dst , * , follow_symlinks = True ) ¶ 等同于 copy() 除了 copy2() 还试图保留文件元数据。 当 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() 使用 copystat() to copy the file metadata. Please see copystat() for more information about platform support for modifying symbolic link metadata. 引发 审计事件 shutil.copyfile 采用自变量 src , dst . 引发 审计事件 shutil.copystat 采用自变量 src , dst . 3.3 版改变： 添加 follow_symlinks argument, try to copy extended file system attributes too (currently Linux only). Now returns path to the newly created file. 3.8 版改变： Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See 从属平台的高效拷贝操作 章节。 shutil. ignore_patterns ( * patterns ) ¶ 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() . 若 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. 当 symlinks is false, if the file pointed to 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() . 若 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() 。由于 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. 若发生异常， Error is raised with a list of reasons. 若 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. 若 dirs_exist_ok is false (the default) and dst already exists, a FileExistsError 被引发。若 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. 引发 审计事件 shutil.copytree 采用自变量 src , dst . 3.2 版改变： 添加 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 为 False。 3.3 版改变： 拷贝元数据当 symlinks is false. Now returns dst . 3.8 版改变： Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See 从属平台的高效拷贝操作 章节。 3.8 版改变： 添加 dirs_exist_ok 参数。 shutil. rmtree ( path , ignore_errors = False , onerror = None , * , onexc = None , dir_fd = None ) ¶ 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 onexc or onerror or, if both are omitted, exceptions are propagated to the caller. 此函数可以支持 相对于目录描述符的路径 . 注意 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. 若 onexc is provided, it must be a callable that accepts three parameters: function , path ，和 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 , is the exception that was raised. Exceptions raised by onexc will not be caught. The deprecated onerror 类似于 onexc , except that the third parameter it receives is the tuple returned from sys.exc_info() . 引发 审计事件 shutil.rmtree 采用自变量 path , dir_fd . 3.3 版改变： Added a symlink attack resistant version that is used automatically if platform supports fd-based functions. 3.8 版改变： On Windows, will no longer delete the contents of a directory junction before removing the junction. 3.11 版改变： 添加 dir_fd 参数。 Changed in version 3.12: 添加 onexc parameter, deprecated onerror . rmtree. avoids_symlink_attacks ¶ 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. Added in version 3.3. shutil. move ( src , dst , copy_function = copy2 ) ¶ Recursively move a file or directory ( src ) to another location and return the destination. 若 dst is an existing directory or a symlink to a directory, then src is moved inside that directory. The destination path in that directory must not already exist. 若 dst already exists but is not a directory, it may be overwritten depending on os.rename() 语义。 If the destination is on the current filesystem, then os.rename() is used. Otherwise, src is copied to the destination using copy_function and then removed. In case of symlinks, a new symlink pointing to the target of src will be created as the destination and src will be removed. 若 copy_function is given, it must be a callable that takes two arguments, src and the destination, and will be used to copy src to the destination if os.rename() cannot be used. If the source is a directory, copytree() is called, passing it the copy_function 。默认 copy_function is copy2() 。使用 copy() 作为 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. 引发 审计事件 shutil.move 采用自变量 src , dst . 3.3 版改变： Added explicit symlink handling for foreign filesystems, thus adapting it to the behavior of GNU’s mv . Now returns dst . 3.5 版改变： 添加 copy_function 关键词自变量。 3.8 版改变： Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See 从属平台的高效拷贝操作 章节。 3.9 版改变： 接受 像路径对象 for both src and dst . shutil. disk_usage ( path ) ¶ Return disk usage statistics about the given path as a 命名元组 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. 注意 On Unix filesystems, path must point to a path within a mounted filesystem partition. On those platforms, CPython doesn’t attempt to retrieve disk usage information from non-mounted filesystems. Added in version 3.3. 3.8 版改变： 在 Windows， path can now be a file or directory. 可用性 ：Unix、Windows。 shutil. chown ( path , user = None , group = None ) ¶ Change owner user and/or group 为给定 path . user can be a system user name or a uid; the same applies to group . At least one argument is required. 另请参阅 os.chown() ，底层函数。 引发 审计事件 shutil.chown 采用自变量 path , user , group . 可用性 ：Unix。 Added in version 3.3. shutil. which ( cmd , mode = os.F_OK | os.X_OK , path = None ) ¶ 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 is 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 prepended to the path if mode does not include os.X_OK 。当 mode does include os.X_OK , the Windows API NeedCurrentDirectoryForExePathW will be consulted to determine if the current directory should be prepended to path . To avoid consulting the current working directory for executables: set the environment variable NoDefaultCurrentDirectoryInExePath . Also on Windows, the PATHEXT variable is used to resolve commands that may not already include an extension. 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: >>> shutil.which("python") 'C:\\Python33\\python.EXE' This is also applied when cmd is a path that contains a directory component: >> shutil.which("C:\\Python33\\python") 'C:\\Python33\\python.EXE' Added in version 3.3. 3.8 版改变： The bytes 类型现在接受。若 cmd 类型为 bytes ，结果类型也是 bytes . Changed in version 3.12: On Windows, the current directory is no longer prepended to the search path if mode 包括 os.X_OK and WinAPI NeedCurrentDirectoryForExePathW(cmd) is false, else the current directory is prepended even if it is already in the search path; PATHEXT is used now even when cmd includes a directory component or ends with an extension that is in PATHEXT ; and filenames that have no extension can now be found. Changed in version 3.12.1: 在 Windows，若 mode 包括 os.X_OK , executables with an extension in PATHEXT will be preferred over executables without a matching extension. This brings behavior closer to that of Python 3.11. exception shutil. Error ¶ 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 ). 从属平台的高效拷贝操作 ¶ 从 Python 3.8 开始，所有涉及文件拷贝的函数 ( copyfile() , copy() , copy2() , copytree() ，和 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()) 。 在 macOS fcopyfile is used to copy the file content (not metadata). 在 Linux os.sendfile() 被使用。 在 Windows shutil.copyfile() uses a bigger default buffer size (1 MiB instead of 64 KiB) and a memoryview() -based variant of shutil.copyfileobj() 被使用。 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. 3.8 版改变。 copytree 范例 ¶ An example that uses the ignore_patterns() helper: from shutil import copytree, ignore_patterns copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*')) 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: from shutil import copytree import logging def _logpath(path, names): logging.info('Working in %s', path) return [] # nothing will be ignored copytree(source, destination, ignore=_logpath) rmtree 范例 ¶ 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 onexc callback to clear the readonly bit and reattempt the remove. Any subsequent failure will propagate. import os, stat import shutil def remove_readonly(func, path, _): "Clear the readonly bit and reattempt the removal" os.chmod(path, stat.S_IWRITE) func(path) shutil.rmtree(directory, onexc=remove_readonly) 存档操作 ¶ Added in version 3.2. 3.5 版改变： 添加支持 xztar 格式。 High-level utilities to create and read compressed and archived files are also provided. They rely on the zipfile and tarfile 模块。 shutil. make_archive ( base_name , format [ , root_dir [ , base_dir [ , verbose [ , dry_run [ , owner [ , group [ , logger ] ] ] ] ] ] ] ) ¶ 创建存档文件 (譬如 zip 或 tar) 并返回其名称。 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 。见 Archiving example with base_dir for how to use base_dir and root_dir 在一起。 root_dir and base_dir both default to the current directory. 若 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. 引发 审计事件 shutil.make_archive 采用自变量 base_name , format , root_dir , base_dir . 注意 This function is not thread-safe when custom archivers registered with register_archive_format() do not support the root_dir argument. In this case it temporarily changes the current working directory of the process to root_dir to perform archiving. 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. shutil. get_archive_formats ( ) ¶ Return a list of supported formats for archiving. Each element of the returned sequence is a tuple (name, description) . 默认情况下 shutil 提供这些格式： 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() ). 若 function has the custom attribute function.supports_root_dir 设为 True ， root_dir argument is passed as a keyword argument. Otherwise the current working directory of the process is temporarily changed to root_dir before calling function . In this case make_archive() is not thread-safe. 若给定， extra_args is a sequence of (name, value) pairs that will be used as extra keywords arguments when the archiver callable is used. description 用于 get_archive_formats() which returns the list of archivers. Defaults to an empty string. Changed in version 3.12: Added support for functions supporting the root_dir 自变量。 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 被引发。 The keyword-only filter argument 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. 引发 审计事件 shutil.unpack_archive 采用自变量 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 “..”. 3.7 版改变： 接受 像路径对象 for filename and extract_dir . Changed in version 3.12: 添加 filter 自变量。 shutil. register_unpack_format ( name , extensions , function [ , extra_args [ , description ] ] ) ¶ 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() 函数。 shutil. unregister_unpack_format ( name ) ¶ Unregister an unpack format. name is the name of the format. shutil. get_unpack_formats ( ) ¶ Return a list of all registered formats for unpacking. Each element of the returned sequence is a tuple (name, extensions, description) . 默认情况下 shutil 提供这些格式： 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() . 存档范例 ¶ In this example, we create a gzip’ed tar-file archive containing all files found in the .ssh directory of the user: >>> from shutil import make_archive >>> import os >>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive')) >>> root_dir = os.path.expanduser(os.path.join('~', '.ssh')) >>> make_archive(archive_name, 'gztar', root_dir) '/Users/tarek/myarchive.tar.gz' The resulting archive contains: $ tar -tzvf /Users/tarek/myarchive.tar.gz drwx------ tarek/staff 0 2010-02-01 16:23:40 ./ -rw-r--r-- tarek/staff 609 2008-06-09 13:26:54 ./authorized_keys -rwxr-xr-x tarek/staff 65 2008-06-09 13:26:54 ./config -rwx------ tarek/staff 668 2008-06-09 13:26:54 ./id_dsa -rwxr-xr-x tarek/staff 609 2008-06-09 13:26:54 ./id_dsa.pub -rw------- tarek/staff 1675 2008-06-09 13:26:54 ./id_rsa -rw-r--r-- tarek/staff 397 2008-06-09 13:26:54 ./id_rsa.pub -rw-r--r-- tarek/staff 37192 2010-02-06 18:23:10 ./known_hosts 存档范例采用 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: $ tree tmp tmp └── root └── structure ├── content └── please_add.txt └── do_not_add.txt In the final archive, please_add.txt should be included, but do_not_add.txt should not. Therefore we use the following: >>> from shutil import make_archive >>> import os >>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive')) >>> make_archive( ... archive_name, ... 'tar', ... root_dir='tmp/root', ... base_dir='structure/content', ... ) '/Users/tarek/my_archive.tar' Listing the files in the resulting archive gives us: $ python -m tarfile -l /Users/tarek/myarchive.tar structure/content/ structure/content/please_add.txt 查询输出终端的大小 ¶ shutil. get_terminal_size ( fallback = (columns, lines) ) ¶ 获取终端窗口的大小。 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. 当 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 默认为 (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, 其它环境变量 . Added in version 3.3. 3.11 版改变： The fallback values are also used if os.get_terminal_size() returns zeroes. 内容表 shutil — 高级文件操作 目录和文件操作 从属平台的高效拷贝操作 copytree 范例 rmtree 范例 存档操作 存档范例 存档范例采用 base_dir 查询输出终端的大小 上一话题 linecache — 随机访问文本行 下一话题 数据持久性 本页 报告 Bug 展示源 快速搜索 键入搜索术语或模块、类、函数名称。 首页 Python 3.12.4 索引 模块 下一 上一 Python 标准库 文件和目录访问 shutil — 高级文件操作
源代码： Lib/shutil.py
The shutil 模块为文件和文件集合提供了许多高级操作。 尤其，提供了支持文件拷贝和移除的函数。对于单个文件的操作，另请参阅 os 模块。
os
警告
更高级文件拷贝函数 ( shutil.copy() , shutil.copy2() ) 无法拷贝所有文件元数据。
shutil.copy()
shutil.copy2()
在 POSIX (便携式操作系统接口) 平台，这意味着文件所有者、组及 ACL 会丢失。在 Mac OS，将不使用资源分叉和其它元数据。这意味着资源会丢失，且文件类型和创建者代码将不正确。在 Windows，将不拷贝文件所有者、ACL 和替代数据流。
Copy the contents of the 像文件对象 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.
Copy the contents (no metadata) of the file named src to a file named dst 并返回 dst in the most efficient way possible. src and dst are 像路径对象 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 被引发。
copy()
SameFileError
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.
OSError
若 follow_symlinks 为 False 且 src is a symbolic link, a new symbolic link will be created instead of copying the file src points to.
引发 审计事件 shutil.copyfile 采用自变量 src , dst .
shutil.copyfile
src
dst
3.3 版改变： IOError 用于被引发而不是 OSError 。添加 follow_symlinks 自变量。现有返回 dst .
IOError
3.4 版改变： 引发 SameFileError 而不是 Error . Since the former is a subclass of the latter, this change is backward compatible.
Error
3.8 版改变： Platform-specific fast-copy syscalls may be used internally in order to copy the file more efficiently. See 从属平台的高效拷贝操作 章节。
This exception is raised if source and destination in copyfile() 是同一文件。
copyfile()
Added in version 3.4.
拷贝权限位从 src to dst . The file contents, owner, and group are unaffected. src and dst are 像路径对象 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.
copymode()
copystat()
引发 审计事件 shutil.copymode 采用自变量 src , dst .
shutil.copymode
3.3 版改变： 添加 follow_symlinks 自变量。
Copy the permission bits, last access time, last modification time, and flags from src to dst 。在 Linux， copystat() also copies the “extended attributes” where possible. The file contents, owner, and group are unaffected. src and dst are 像路径对象 or path names given as strings.
若 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.
若 os.chmod in os.supports_follow_symlinks is True , copystat() can modify the permission bits of a symbolic link.
os.chmod in os.supports_follow_symlinks
True
若 os.utime in os.supports_follow_symlinks is True , copystat() can modify the last access and modification times of a symbolic link.
os.utime in os.supports_follow_symlinks
若 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.)
os.chflags in os.supports_follow_symlinks
os.chflags
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.
请参阅 os.supports_follow_symlinks 了解更多信息。
os.supports_follow_symlinks
引发 审计事件 shutil.copystat 采用自变量 src , dst .
shutil.copystat
3.3 版改变： 添加 follow_symlinks argument and support for Linux extended attributes.
拷贝文件 src to the file or directory dst . src and dst 应该为 像路径对象 or strings. If dst specifies a directory, the file will be copied into dst using the base filename from src 。若 dst specifies a file that already exists, it will be replaced. Returns the path to the newly created file.
若 follow_symlinks is false, and src is a symbolic link, dst will be created as a symbolic link. If follow_symlinks 为 True 和 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() 代替。
os.chmod()
copy2()
3.3 版改变： 添加 follow_symlinks argument. Now returns path to the newly created file.
等同于 copy() 除了 copy2() 还试图保留文件元数据。
当 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() 使用 copystat() to copy the file metadata. Please see copystat() for more information about platform support for modifying symbolic link metadata.
3.3 版改变： 添加 follow_symlinks argument, try to copy extended file system attributes too (currently Linux only). Now returns path to the newly created file.
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.
copytree()
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() .
若 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.
当 symlinks is false, if the file pointed to 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() .
os.symlink()
若 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() 。由于 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.
os.listdir()
ignore_patterns()
若发生异常， Error is raised with a list of reasons.
若 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.
若 dirs_exist_ok is false (the default) and dst already exists, a FileExistsError 被引发。若 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.
FileExistsError
引发 审计事件 shutil.copytree 采用自变量 src , dst .
shutil.copytree
3.2 版改变： 添加 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 为 False。
3.3 版改变： 拷贝元数据当 symlinks is false. Now returns dst .
3.8 版改变： 添加 dirs_exist_ok 参数。
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 onexc or onerror or, if both are omitted, exceptions are propagated to the caller.
此函数可以支持 相对于目录描述符的路径 .
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.
rmtree()
rmtree.avoids_symlink_attacks
若 onexc is provided, it must be a callable that accepts three parameters: function , path ，和 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 , is the exception that was raised. Exceptions raised by onexc will not be caught.
The deprecated onerror 类似于 onexc , except that the third parameter it receives is the tuple returned from sys.exc_info() .
sys.exc_info()
引发 审计事件 shutil.rmtree 采用自变量 path , dir_fd .
shutil.rmtree
path
dir_fd
3.3 版改变： Added a symlink attack resistant version that is used automatically if platform supports fd-based functions.
3.8 版改变： On Windows, will no longer delete the contents of a directory junction before removing the junction.
3.11 版改变： 添加 dir_fd 参数。
Changed in version 3.12: 添加 onexc parameter, deprecated onerror .
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.
Added in version 3.3.
Recursively move a file or directory ( src ) to another location and return the destination.
若 dst is an existing directory or a symlink to a directory, then src is moved inside that directory. The destination path in that directory must not already exist.
若 dst already exists but is not a directory, it may be overwritten depending on os.rename() 语义。
os.rename()
If the destination is on the current filesystem, then os.rename() is used. Otherwise, src is copied to the destination using copy_function and then removed. In case of symlinks, a new symlink pointing to the target of src will be created as the destination and src will be removed.
若 copy_function is given, it must be a callable that takes two arguments, src and the destination, and will be used to copy src to the destination if os.rename() cannot be used. If the source is a directory, copytree() is called, passing it the copy_function 。默认 copy_function is copy2() 。使用 copy() 作为 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.
引发 审计事件 shutil.move 采用自变量 src , dst .
shutil.move
3.3 版改变： Added explicit symlink handling for foreign filesystems, thus adapting it to the behavior of GNU’s mv . Now returns dst .
3.5 版改变： 添加 copy_function 关键词自变量。
3.9 版改变： 接受 像路径对象 for both src and dst .
Return disk usage statistics about the given path as a 命名元组 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.
On Unix filesystems, path must point to a path within a mounted filesystem partition. On those platforms, CPython doesn’t attempt to retrieve disk usage information from non-mounted filesystems.
3.8 版改变： 在 Windows， path can now be a file or directory.
可用性 ：Unix、Windows。
Change owner user and/or group 为给定 path .
user can be a system user name or a uid; the same applies to group . At least one argument is required.
另请参阅 os.chown() ，底层函数。
os.chown()
引发 审计事件 shutil.chown 采用自变量 path , user , group .
shutil.chown
user
group
可用性 ：Unix。
Return the path to an executable which would be run if the given cmd was called. If no cmd would be called, return None .
None
mode is a permission mask passed to os.access() , by default determining if the file exists and is executable.
os.access()
When no path is specified, the results of os.environ() are used, returning either the “PATH” value or a fallback of os.defpath .
os.environ()
os.defpath
On Windows, the current directory is prepended to the path if mode does not include os.X_OK 。当 mode does include os.X_OK , the Windows API NeedCurrentDirectoryForExePathW will be consulted to determine if the current directory should be prepended to path . To avoid consulting the current working directory for executables: set the environment variable NoDefaultCurrentDirectoryInExePath .
os.X_OK
NeedCurrentDirectoryForExePathW
NoDefaultCurrentDirectoryInExePath
Also on Windows, the PATHEXT variable is used to resolve commands that may not already include an extension. 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:
PATHEXT
shutil.which("python")
which()
python.exe
>>> shutil.which("python") 'C:\\Python33\\python.EXE'
This is also applied when cmd is a path that contains a directory component:
>> shutil.which("C:\\Python33\\python") 'C:\\Python33\\python.EXE'
3.8 版改变： The bytes 类型现在接受。若 cmd 类型为 bytes ，结果类型也是 bytes .
bytes
Changed in version 3.12: On Windows, the current directory is no longer prepended to the search path if mode 包括 os.X_OK and WinAPI NeedCurrentDirectoryForExePathW(cmd) is false, else the current directory is prepended even if it is already in the search path; PATHEXT is used now even when cmd includes a directory component or ends with an extension that is in PATHEXT ; and filenames that have no extension can now be found.
NeedCurrentDirectoryForExePathW(cmd)
Changed in version 3.12.1: 在 Windows，若 mode 包括 os.X_OK , executables with an extension in PATHEXT will be preferred over executables without a matching extension. This brings behavior closer to that of Python 3.11.
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 ).
从 Python 3.8 开始，所有涉及文件拷贝的函数 ( copyfile() , copy() , copy2() , copytree() ，和 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()) 。
move()
outfd.write(infd.read())
在 macOS fcopyfile is used to copy the file content (not metadata).
在 Linux os.sendfile() 被使用。
os.sendfile()
在 Windows shutil.copyfile() uses a bigger default buffer size (1 MiB instead of 64 KiB) and a memoryview() -based variant of shutil.copyfileobj() 被使用。
shutil.copyfile()
memoryview()
shutil.copyfileobj()
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.
copyfileobj()
3.8 版改变。
An example that uses the ignore_patterns() helper:
from shutil import copytree, ignore_patterns copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*'))
This will copy everything except .pyc files and files or directories whose name starts with tmp .
.pyc
tmp
Another example that uses the ignore argument to add a logging call:
from shutil import copytree import logging def _logpath(path, names): logging.info('Working in %s', path) return [] # nothing will be ignored copytree(source, destination, ignore=_logpath)
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 onexc callback to clear the readonly bit and reattempt the remove. Any subsequent failure will propagate.
import os, stat import shutil def remove_readonly(func, path, _): "Clear the readonly bit and reattempt the removal" os.chmod(path, stat.S_IWRITE) func(path) shutil.rmtree(directory, onexc=remove_readonly)
Added in version 3.2.
3.5 版改变： 添加支持 xztar 格式。
High-level utilities to create and read compressed and archived files are also provided. They rely on the zipfile and tarfile 模块。
zipfile
tarfile
创建存档文件 (譬如 zip 或 tar) 并返回其名称。
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).
zlib
bz2
lzma
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 。见 Archiving example with base_dir for how to use base_dir and root_dir 在一起。
root_dir and base_dir both default to the current directory.
若 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 .
logging.Logger
The verbose argument is unused and deprecated.
引发 审计事件 shutil.make_archive 采用自变量 base_name , format , root_dir , base_dir .
shutil.make_archive
base_name
format
root_dir
base_dir
This function is not thread-safe when custom archivers registered with register_archive_format() do not support the root_dir argument. In this case it temporarily changes the current working directory of the process to root_dir to perform archiving.
register_archive_format()
3.8 版改变： The modern pax (POSIX.1-2001) format is now used instead of the legacy GNU format for archives created with format="tar" .
format="tar"
Changed in version 3.10.6: This function is now made thread-safe during creation of standard .zip and tar archives.
.zip
Return a list of supported formats for archiving. Each element of the returned sequence is a tuple (name, description) .
(name, description)
默认情况下 shutil 提供这些格式：
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() .
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() ).
os.curdir
make_archive()
若 function has the custom attribute function.supports_root_dir 设为 True ， root_dir argument is passed as a keyword argument. Otherwise the current working directory of the process is temporarily changed to root_dir before calling function . In this case make_archive() is not thread-safe.
function.supports_root_dir
若给定， extra_args is a sequence of (name, value) pairs that will be used as extra keywords arguments when the archiver callable is used.
(name, value)
description 用于 get_archive_formats() which returns the list of archivers. Defaults to an empty string.
get_archive_formats()
Changed in version 3.12: Added support for functions supporting the root_dir 自变量。
Remove the archive format name from the list of supported formats.
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 被引发。
register_unpack_format()
unpack_archive()
ValueError
The keyword-only filter argument 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.
'data'
引发 审计事件 shutil.unpack_archive 采用自变量 filename , extract_dir , format .
shutil.unpack_archive
filename
extract_dir
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 “..”.
3.7 版改变： 接受 像路径对象 for filename and extract_dir .
Changed in version 3.12: 添加 filter 自变量。
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() 函数。
get_unpack_formats()
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) .
(name, extensions, description)
zip : ZIP file (unpacking compressed files works only if the corresponding module is available).
tar : uncompressed tar file.
You can register new formats or provide your own unpacker for any existing formats, by using register_unpack_format() .
In this example, we create a gzip’ed tar-file archive containing all files found in the .ssh directory of the user:
.ssh
>>> from shutil import make_archive >>> import os >>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive')) >>> root_dir = os.path.expanduser(os.path.join('~', '.ssh')) >>> make_archive(archive_name, 'gztar', root_dir) '/Users/tarek/myarchive.tar.gz'
The resulting archive contains:
$ tar -tzvf /Users/tarek/myarchive.tar.gz drwx------ tarek/staff 0 2010-02-01 16:23:40 ./ -rw-r--r-- tarek/staff 609 2008-06-09 13:26:54 ./authorized_keys -rwxr-xr-x tarek/staff 65 2008-06-09 13:26:54 ./config -rwx------ tarek/staff 668 2008-06-09 13:26:54 ./id_dsa -rwxr-xr-x tarek/staff 609 2008-06-09 13:26:54 ./id_dsa.pub -rw------- tarek/staff 1675 2008-06-09 13:26:54 ./id_rsa -rw-r--r-- tarek/staff 397 2008-06-09 13:26:54 ./id_rsa.pub -rw-r--r-- tarek/staff 37192 2010-02-06 18:23:10 ./known_hosts
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:
$ tree tmp tmp └── root └── structure ├── content └── please_add.txt └── do_not_add.txt
In the final archive, please_add.txt should be included, but do_not_add.txt should not. Therefore we use the following:
please_add.txt
do_not_add.txt
>>> from shutil import make_archive >>> import os >>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive')) >>> make_archive( ... archive_name, ... 'tar', ... root_dir='tmp/root', ... base_dir='structure/content', ... ) '/Users/tarek/my_archive.tar'
Listing the files in the resulting archive gives us:
$ python -m tarfile -l /Users/tarek/myarchive.tar structure/content/ structure/content/please_add.txt
获取终端窗口的大小。
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.
COLUMNS
LINES
当 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() .
sys.__stdout__
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 默认为 (80, 24) which is the default size used by many terminal emulators.
fallback
(80, 24)
The value returned is a named tuple of type os.terminal_size .
os.terminal_size
See also: The Single UNIX Specification, Version 2, 其它环境变量 .
3.11 版改变： The fallback values are also used if os.get_terminal_size() returns zeroes.
linecache — 随机访问文本行
linecache
数据持久性
键入搜索术语或模块、类、函数名称。