os模块篇（十四）

os.renames(old, new)

os.renames(old, new) 是 Python 的 os 模块中的一个函数，用于在单个操作中重命名文件或目录。这个函数尝试将 old（旧路径）指定的文件或目录重命名为 new（新路径）指定的名称。与 os.rename() 函数不同，os.renames() 在重命名过程中会处理跨文件系统的重命名，并在必要时使用临时文件以确保数据的完整性。

参数：

• old：源文件或目录的当前路径（字符串类型）。
• new：源文件或目录的新路径（字符串类型）。

os.renames() 函数会尝试将 old 路径指定的文件或目录重命名为 new 路径。如果 old 和 new 路径位于不同的文件系统中，os.renames() 将使用一种安全的方式来完成重命名操作，这通常涉及到创建一个临时文件，然后将临时文件重命名为新名称，最后删除原始文件。这样可以确保在重命名过程中数据的完整性和安全性。

如果重命名操作成功，os.renames() 函数将返回 None。如果发生错误，例如源文件不存在或目标文件已存在，将引发 OSError 异常。

下面是一个使用 os.renames() 函数的例子：

import os

# 指定要重命名的文件或目录的当前路径
old_path = '/path/to/old_file.txt'
# 指定文件或目录的新路径
new_path = '/path/to/new_file.txt'

try:
    # 重命名文件或目录
    os.renames(old_path, new_path)
    print(f"File or directory '{old_path}' has been renamed to '{new_path}' successfully.")
except OSError as e:
    print(f"An error occurred while renaming: {e}")

在这个例子中，我们尝试将名为 old_file.txt 的文件或目录重命名为 new_file.txt。如果重命名操作成功，将打印一条消息确认重命名已完成。如果发生错误，将捕获 OSError 异常并打印错误详情。

需要注意的是，由于 os.renames() 在必要时会使用临时文件来确保数据完整性，因此它可能比简单的 os.rename() 函数要慢一些，尤其是在跨文件系统重命名时。然而，这种额外的复杂性通常只在处理重要文件或需要保证数据完整性的情况下才是必要的。

os.replace(src, dst, *, src_dir_fd=None, dst_dir_fd=None)

os.replace(src, dst, *, src_dir_fd=None, dst_dir_fd=None) 是 Python 3.8 中新增的一个函数，用于替换文件或目录。它的行为类似于 os.rename(src, dst)，但有一个重要的区别：如果目标路径 dst 已经存在，os.replace() 会先删除它，然后再将 src 重命名为 dst。这意味着它允许你在不重命名 src 的情况下覆盖一个已存在的文件或目录。

参数：

• src：源文件或目录的路径（字符串类型）。
• dst：目标路径，即要替换为 src 的文件或目录的路径（字符串类型）。
• src_dir_fd：可选参数，表示已打开的文件描述符，它指向包含 src 的目录。
• dst_dir_fd：可选参数，表示已打开的文件描述符，它指向要替换的 dst 的目录。

如果 src_dir_fd 或 dst_dir_fd 被指定，那么 src 和 dst 应该是相对于各自文件描述符的路径。

返回值：

None：如果替换成功，则函数返回 None。

下面是一个使用 os.replace() 的例子：

import os

# 源文件路径
src_path = 'old_file.txt'
# 目标文件路径
dst_path = 'new_file.txt'

try:
    # 替换文件
    os.replace(src_path, dst_path)
    print(f"File '{src_path}' has been replaced with '{dst_path}'")
except FileNotFoundError:
    print(f"File '{src_path}' does not exist.")
except PermissionError:
    print(f"Permission denied while trying to replace '{src_path}' with '{dst_path}'")
except OSError as e:
    print(f"An error occurred: {e}")

在这个例子中，我们尝试用 old_file.txt 替换 new_file.txt。如果 new_file.txt 已经存在，它会被删除，然后 old_file.txt 会被重命名为 new_file.txt。如果操作成功，会打印一条消息确认替换已完成。如果发生错误，会捕获异常并打印相应的错误信息。

需要注意的是，由于 os.replace() 在替换时会先删除目标文件，因此如果源文件和目标文件位于不同的文件系统中，它可能会失败，因为跨文件系统移动文件通常需要特殊的权限。此外，如果源文件不存在，或者没有权限删除或重命名文件，也会引发异常

os.rmdir(path, *, dir_fd=None)

os.rmdir(path, *, dir_fd=None) 是 Python 的 os 模块中的一个函数，用于删除一个空目录。这意味着它只能删除那些不包含任何文件或其他子目录的目录。如果目录不为空，os.rmdir() 将引发 OSError 异常。

参数：

• path：要删除的目录的路径（字符串类型）。
• dir_fd：一个可选参数，表示一个已经打开的文件描述符，它指向包含要删除目录的父目录。如果提供了 dir_fd，则 path 应该是相对于该目录的描述符的路径。

dir_fd 参数在 Python 3.4 版本中引入，它允许你通过文件描述符而不是文件名来指定目录。这在某些高级文件操作中可能很有用，比如当你已经有一个打开的文件描述符指向目录时。

返回值：

• None：如果目录成功删除，则函数返回 None。

下面是一个使用 os.rmdir() 的例子：

import os

# 要删除的目录路径
dir_path = 'empty_directory'

try:
    # 删除目录
    os.rmdir(dir_path)
    print(f"Directory '{dir_path}' has been removed successfully.")
except OSError as e:
    print(f"An error occurred while trying to remove the directory: {e}")

在这个例子中，我们尝试删除名为 empty_directory 的目录。如果该目录确实为空，它将被成功删除，并打印一条确认消息。如果目录不为空或发生其他错误，将捕获 OSError 异常并打印错误详情。

需要注意的是，os.rmdir() 仅适用于空目录。如果你想删除一个可能包含文件或其他子目录的目录，你应该使用 shutil.rmtree() 函数，这个函数能够递归地删除整个目录树。然而，使用 shutil.rmtree() 时要小心，因为它不会询问你是否确定要删除目录和其中的所有内容。

os.scandir(path=‘.’)

os.scandir(path=‘.’) 是 Python 的 os 模块中的一个函数，用于在目录树中迭代文件或目录的入口（entries）。os.scandir() 返回一个迭代器，它会产生每个在给定路径中的文件和子目录的 os.DirEntry 对象。

参数 path 指定了要扫描的目录的路径。默认值是 ‘.’，表示当前目录。

os.DirEntry 对象包含有关目录条目的信息，如名称、是否是一个目录、文件大小等。你可以使用 os.DirEntry 的方法（如 is_dir(), is_file(), stat() 等）来获取这些信息。

使用 os.scandir() 比使用 os.listdir() 通常更高效，因为 os.scandir() 提供了更底层的接口，并且只在需要时才从文件系统中检索信息。

下面是一个使用 os.scandir() 的例子：

import os

# 扫描当前目录
for entry in os.scandir('.'):
    # 判断是文件还是目录
    if entry.is_dir():
        print(f"{entry.name} 是一个目录")
    elif entry.is_file():
        print(f"{entry.name} 是一个文件")
    # 你可以进一步使用 entry.stat() 来获取文件的详细信息

# 如果你只想获取目录中的文件（不包括子目录中的文件），可以使用 os.walk()
for root, dirs, files in os.walk('.'):
    for file in files:
        print(os.path.join(root, file))

在这个例子中，我们遍历了当前目录（.）中的所有文件和目录，并打印出它们的名称以及它们是文件还是目录。

需要注意的是，os.scandir() 在 Python 3.5 及更高版本中可用。如果你使用的是更早的 Python 版本，你可能需要使用 os.listdir() 结合 os.path.isdir() 和 os.path.isfile() 来达到类似的效果，但效率可能会较低。

os.stat(path, *, dir_fd=None, follow_symlinks=True)

os.stat(path, *, dir_fd=None, follow_symlinks=True) 是 Python 中 os 模块的一个函数，用于获取文件或文件系统的状态信息。它返回一个 os.stat_result 对象，该对象包含有关指定路径的文件或目录的详细信息。

参数：

• path：要获取状态信息的文件或目录的路径（字符串类型）。
• dir_fd：一个可选参数，表示一个已经打开的文件描述符，它指向包含要查询的文件或目录的目录。如果提供了 dir_fd，则 path 应该是相对于该目录的描述符的路径。
• follow_symlinks：一个可选的布尔值参数，默认为 True。如果为 True，并且 path 是一个符号链接，os.stat() 将返回符号链接指向的实际文件或目录的信息。如果为 False，则返回符号链接本身的信息。

返回值：

• os.stat_result：一个命名元组，包含以下属性（这些属性可能因操作系统而异）：
  • st_mode：文件模式（权限和类型）。
  • st_ino：文件的 inode 号。
  • st_dev：文件所在的设备号。
  • st_nlink：文件的硬链接数。
  • st_uid：文件的用户 ID。
  • st_gid：文件的组 ID。
  • st_size：文件大小（字节数）。
  • st_atime：最后一次访问时间。
  • st_mtime：最后一次修改时间。
  • st_ctime：文件元数据（如权限或所有权）最后一次更改的时间。

下面是一个使用 os.stat() 的例子：

import os
import time

# 文件路径
file_path = 'example.txt'

try:
    # 获取文件状态信息
    stat_info = os.stat(file_path)
    
    # 输出文件信息
    print(f"File mode: {stat_info.st_mode}")
    print(f"File size: {stat_info.st_size} bytes")
    print(f"Last modified time: {time.ctime(stat_info.st_mtime)}")
    
except FileNotFoundError:
    print(f"File '{file_path}' not found.")
except OSError as e:
    print(f"An error occurred: {e}")

在这个例子中，我们获取了名为 example.txt 的文件的状态信息，并打印了文件的模式、大小和最后修改时间。如果文件不存在或发生其他错误，会捕获相应的异常并打印错误消息。

注意：os.stat() 返回的信息可能因操作系统而异，并且不是所有属性在所有平台上都可用。因此，在编写跨平台的代码时，建议检查属性是否存在，或者考虑使用更高级的库（如 shutil、pathlib），这些库提供了更一致和方便的接口来处理文件和目录。

os.statvfs(path)

os.statvfs(path) 是 Python 的 os 模块中的一个函数，用于获取文件系统的状态信息。它返回一个 os.statvfs_result 对象，该对象包含了关于指定路径所在文件系统的信息，如总空间、可用空间、已使用的空间等。

参数：

• path：一个字符串，表示要查询的文件系统或挂载点的路径。

返回值：

• os.statvfs_result：一个命名元组，包含以下属性：
  • f_bsize：文件系统块的大小（以字节为单位）。
  • f_frsize：基础文件系统块的大小（以字节为单位）。
  • f_blocks：文件系统中数据块的总数。
  • f_bfree：非特权用户可用的数据块数。
  • f_bavail：非特权用户可用的数据块数，考虑到了文件系统的保留空间。
  • f_files：文件系统中文件节点的总数。
  • f_ffree：非特权用户可用的文件节点数。
  • f_favail：非特权用户可用的文件节点数，考虑到了文件系统的保留空间。
  • f_fsid：文件系统的唯一标识符。
  • f_flag：文件系统的标志位。
  • f_namemax：文件系统中文件名的最大长度。

这些信息对于文件系统管理和监控来说是非常有用的，因为它们可以帮助你了解文件系统的空间使用情况、文件数量等。

下面是一个使用 os.statvfs() 的例子：

import os

# 获取文件系统状态信息
fs_info = os.statvfs('/')

# 输出一些关键信息
print(f"Total blocks: {fs_info.f_blocks}")
print(f"Free blocks: {fs_info.f_bfree}")
print(f"Available blocks: {fs_info.f_bavail}")
print(f"Total file nodes: {fs_info.f_files}")
print(f"Free file nodes: {fs_info.f_ffree}")
print(f"Available file nodes: {fs_info.f_favail}")
print(f"Maximum file name length: {fs_info.f_namemax}")

在这个例子中，我们获取了根目录（/）所在文件系统的状态信息，并打印了一些关键指标，如总块数、可用块数、文件节点数等。这些信息对于评估文件系统的容量和使用情况非常有帮助。