python：sys模块

Python sys 模块学习笔记
sys 模块是 Python 标准库中的一个核心模块，提供了与 Python 解释器及其环境相关的功能。

1. sys.argv

  sys.argv 是一个包含命令行参数的列表，其中第一个元素是脚本名称，之后的元素是在运行脚本时传递的参数。

# example_script.py
import sys

# 获取命令行参数
arguments = sys.argv

# 打印脚本名称
script_name = arguments[0]
print("脚本名称:", script_name)

# 打印其他命令行参数
if len(arguments) > 1:
    print("其他命令行参数:")
    for arg in arguments[1:]:
        print(arg)
else:
    print("没有其他命令行参数传递.")

假设运行以下命令：

python example_script.py arg1 arg2 arg3

脚本将输出：

脚本名称: example_script.py
其他命令行参数:
arg1
arg2
arg3

这说明 sys.argv 中的第一个元素是脚本的名称，而其余的元素是在运行脚本时传递的参数。

2. sys.exit(n)

sys.exit(n) 是 Python 中用于退出程序的方法。它接受一个整数参数 n，表示程序的退出状态码。通常，如果程序成功执行，退出状态码为 0；如果有错误或异常，可以选择使用其他非零状态码。

下面是一个简单的例子：

import sys

def main():
    try:
        # 一些代码执行
        result = 42 / 0
    except ZeroDivisionError:
        print("发生除零错误")
        sys.exit(1)  # 退出状态码为 1 表示错误

    print("程序正常执行完成")
    sys.exit(0)  # 退出状态码为 0 表示成功

if __name__ == "__main__":
    main()

  在这个例子中，如果发生除零错误，程序会打印错误消息并用 sys.exit(1) 退出，表示程序执行出现了错误。如果没有错误，程序会顺利执行，最后使用 sys.exit(0) 退出，表示成功执行。

  请注意，sys.exit(n) 会引发 SystemExit 异常，因此在使用时要注意处理可能的异常。

3.sys.getdefaultencoding()

  sys.getdefaultencoding() 是 Python 中 sys 模块提供的一个函数，用于获取当前 Python 解释器的默认字符编码。

  在 Python 中，字符串是以 Unicode 编码进行处理的，但在输入输出、文件读写等操作时，需要进行编码和解码。sys.getdefaultencoding() 返回的是当前 Python 解释器默认的字符编码，用于指示字符串在这些操作中的默认编码方式。

  通常情况下，Python 的默认字符编码是 ‘utf-8’。但是，这可能会因为系统环境、Python 版本等因素而有所不同。使用sys.getdefaultencoding() 可以查看当前环境下的默认字符编码。

下面是一个简单的示例：

import sys

default_encoding = sys.getdefaultencoding()
print(f"Default Encoding: {default_encoding}")

这段代码会打印当前 Python 解释器的默认字符编码。如果你的系统和 Python 版本都采用默认设置，那么它应该显示 ‘utf-8’。

4. sys.setdefaultencoding()

  在 Python 3 中，sys.setdefaultencoding() 函数已经被移除，因为在 Python 3 中，字符串的处理方式更为一致，使用 Unicode 进行编码，而不再需要设置默认的字符串编码。

  在 Python 2 中，sys.setdefaultencoding() 是用来设置默认字符串编码的函数。它允许你改变默认的字符串编码，但这在 Python 3 中被认为是不推荐的做法，因为 Python 3 更强调统一的 Unicode 字符串。

  在 Python 3 中，使用 Unicode 字符串，并根据需要进行编码和解码。以下是一个简单的例子，演示如何在 Python 3 中使用 Unicode 字符串：

# -*- coding: utf-8 -*-

# 定义一个 Unicode 字符串
unicode_string = "你好，世界！"

# 将 Unicode 字符串编码成字节串（bytes）
encoded_bytes = unicode_string.encode('utf-8')
print("Encoded Bytes:", encoded_bytes)

# 将字节串解码为 Unicode 字符串
decoded_string = encoded_bytes.decode('utf-8')
print("Decoded String:", decoded_string)

  在这个例子中，我们首先定义了一个 Unicode 字符串 unicode_string。然后，我们使用 encode() 方法将它编码成字节串（bytes），并使用 decode() 方法将字节串解码为 Unicode 字符串。请注意，我们指定了编码方式为 ‘utf-8’，这是一种常用的 Unicode 字符串编码方式。

5. sys.path

  sys.path 是一个包含用于导入模块的目录名称的列表。当你尝试导入一个模块时，Python 解释器会搜索这些目录以查找模块文件。

以下是关于 sys.path 的一些常见用法和示例：

查看当前 Python 解释器的模块搜索路径：

import sys
print(sys.path)

这将打印出一个列表，其中包含了 Python 解释器用于查找模块的目录。

将自定义目录添加到 sys.path 中：

import sys

# 添加自定义目录到 sys.path
custom_path = '/path/to/your/directory'
sys.path.append(custom_path)

# 查看更新后的 sys.path
print(sys.path)

通过将自定义目录添加到 sys.path 中，可以让 Python 解释器在搜索模块时包括这个目录。

临时修改 sys.path，在特定上下文中使用自定义路径：

import sys

# 保存当前 sys.path
original_path = sys.path.copy()

try:
    # 临时修改 sys.path
    custom_path = '/path/to/your/temporary/directory'
    sys.path.append(custom_path)

    # 在这里执行需要使用自定义路径的代码

finally:
    # 恢复原始的 sys.path
    sys.path = original_path

  这个例子演示了如何在特定上下文中临时修改 sys.path，并在执行完代码后将其恢复到原始状态。这样可以避免全局修改 sys.path 导致的潜在问题。

  请注意，在实际开发中，应该避免过度修改 sys.path，并采用更稳健的模块导入和包管理方法，例如使用虚拟环境、pip 安装依赖等。

6.sys.platform

  sys.platform 是一个字符串，表示当前运行 Python 解释器的平台。它返回的字符串标识了操作系统类型。以下是一些可能的 sys.platform 返回值：

'darwin': 表示 macOS
'linux': 表示 Linux
'win32': 表示 Windows
'cygwin': 表示 Cygwin（在 Windows 上运行的 POSIX 环境）
'sunos5': 表示 Solaris

示例：

import sys

platform = sys.platform
print(f"The platform is: {platform}")

  这将输出当前运行 Python 解释器的平台。你可以使用这个信息来编写与操作系统相关的代码，以便在不同平台上执行不同的操作。例如，可以根据平台选择合适的文件路径分隔符等。

7.sys.modules

  sys.modules 是一个字典，其中包含当前 Python 解释器中所有已导入的模块的缓存。字典的键是模块的名称，而值是对该模块的引用。这个字典提供了一种查看当前解释器中已加载的模块的方式。

示例：

import sys

# 导入一个模块
import math

# 获取已导入模块的字典
modules_dict = sys.modules

# 打印模块字典的一部分
print("Some modules in sys.modules:")
for module_name, module_ref in list(modules_dict.items())[:5]:
    print(f"{module_name}: {module_ref}")

  在这个例子中，math 模块被导入后，你可以在 sys.modules 字典中找到它。这对于检查已加载的模块以及防止重复导入同一模块很有用。

8.sys.stdin,sys.stdout,sys.stderr

  sys.stdin，sys.stdout 和 sys.stderr 是 sys 模块中的三个文件对象，分别用于标准输入、标准输出和标准错误。

1. sys.stdin: 这是一个类似文件的对象，用于接收用户的输入。默认情况下，它连接到终端（键盘输入）。
2. sys.stdout: 这是一个类似文件的对象，用于标准输出。默认情况下，它连接到终端（屏幕输出）。
3. sys.stderr: 这是一个类似文件的对象，用于标准错误输出。与 sys.stdout 类似，但通常用于输出错误和警告信息。

这些对象可以重定向，以便在程序运行时改变输入源、输出目标和错误处理。

示例：

import sys

# 保存原始的输出对象
original_stdout = sys.stdout

# 重定向标准输出到文件
with open('output.txt', 'w') as file:
    sys.stdout = file
    print("This goes to output.txt")

# 恢复原始的输出对象
sys.stdout = original_stdout

# 重定向标准错误到文件
with open('error.txt', 'w') as file:
    sys.stderr = file
    print("This goes to error.txt")

# 恢复原始的错误输出对象
sys.stderr = sys.__stderr__

在这个例子中，标准输出被重定向到文件 “output.txt”，标准错误被重定向到文件 “error.txt”。