Python Click：精准识别标准输入流（stdin）的方法

在python click应用中，准确判断命令行参数`-`所代表的输入是否为真正的标准输入（`sys.stdin`），而非一个名为``的普通文件，是一个常见需求。本文将深入探讨三种核心检测方法：直接比较`file == sys.stdin`、检查文件描述符`file.fileno() == 0`，以及使用`isatty()`（需注意其局限性），并通过详细示例代码演示它们的用法与适用场景。

在使用 click.File() 类型处理命令行输入时，如果用户通过 - 符号指示输入来自标准输入，Click 会将其解析为一个类似于 _io.TextIOWrapper name='<stdin>' 的文件对象。然而，如果用户恰好创建了一个名为 <stdin> 的文件并将其作为参数传入，Click 也会将其解析为 _io.TextIOWrapper name='<stdin>'。这两种情况下的文件对象虽然 name 属性相同，但在内部实现和行为上存在显著差异（例如编码可能不同），因此需要一种可靠的方法来区分它们。

方法一：直接与 sys.stdin 对象比较

最直接且可靠的方法是将被 Click 解析的文件对象与 Python 内置的 sys.stdin 对象进行比较。当 Click 接收到 - 参数时，它实际上会将 sys.stdin 对象包装成 click.File() 类型返回。因此，可以直接通过对象相等性判断来检测。

import click
import sys

@click.command()
@click.argument("file", type=click.File())
def cli(file):
    if file == sys.stdin:
        print("输入来自标准输入 (sys.stdin)")
    else:
        print(f"输入来自文件: {file.name}")

if __name__ == "__main__":
    cli()

示例运行：

Python v2.4 中文手册 chm

Python v2.4版chm格式的中文手册，内容丰富全面，不但是一本手册，你完全可以把她作为一本Python的入门教程，教你如何使用Python解释器、流程控制、数据结构、模板、输入和输出、错误和异常、类和标准库详解等方面的知识技巧。同时后附的手册可以方便你的查询。

2

查看详情

# 从标准输入读取
$ python your_script.py -
输入来自标准输入 (sys.stdin)

# 从名为'<stdin>'的文件读取
$ touch '<stdin>'
$ python your_script.py '<stdin>'
输入来自文件: <stdin>

这种方法简单明了，且具有高度的准确性。

立即学习“Python免费学习笔记（深入）”；

方法二：检查文件描述符 (fileno())

操作系统为每个打开的文件分配一个唯一的整数标识符，称为文件描述符（File Descriptor）。标准输入、标准输出和标准错误流通常具有固定的文件描述符：

• sys.stdin 的文件描述符通常为 0。
• sys.stdout 的文件描述符通常为 1。
• sys.stderr 的文件描述符通常为 2。

因此，可以通过检查文件对象的 fileno() 方法返回的值是否为 0 来判断它是否是标准输入。

import click
import sys

@click.command()
@click.argument("file", type=click.File())
def cli(file):
    if file.fileno() == 0:
        print("输入来自标准输入 (文件描述符为0)")
    else:
        print(f"输入来自文件: {file.name}, 文件描述符为: {file.fileno()}")

if __name__ == "__main__":
    cli()

这种方法同样非常可靠，因为它依赖于操作系统层面的文件标识。

方法三：使用 isatty() 方法（需注意局限性）

isatty() 方法用于检测文件是否连接到一个 TTY（Teletypewriter）设备，即通常所说的终端或控制台。当 sys.stdin 直接连接到交互式终端时，sys.stdin.isatty() 会返回 True。然而，这种方法存在以下局限性：

• 管道输入： 如果输入是通过管道（pipe）重定向的，例如 echo "hello" | python your_script.py -，sys.stdin 将不再连接到 TTY，isatty() 会返回 False。
• 文件重定向： 如果输入是从文件重定向的，例如 python your_script.py < input.txt，isatty() 也会返回 False。
• 非交互式环境： 在一些非交互式环境（如 cron job）中运行脚本时，sys.stdin 也可能不是 TTY。

因此，isatty() 并非判断是否为 sys.stdin 的通用可靠方法，但它在某些特定场景下非常有用，例如当你想根据输入是否来自交互式终端来调整程序的行为（如是否输出彩色文本）。

import click
import sys

@click.command()
@click.argument("file", type=click.File())
def cli(file):
    if file.isatty():
        print("输入来自交互式终端 (isatty()为True)")
    else:
        print(f"输入不来自交互式终端 (isatty()为False), 文件名: {file.name}")
        # 进一步判断是否为sys.stdin
        if file == sys.stdin:
            print("  但它是标准输入，可能通过管道或重定向输入")
        else:
            print("  它是一个普通文件")

if __name__ == "__main__":
    cli()

示例运行：

# 从标准输入（交互式终端）读取
$ python your_script.py -
输入来自交互式终端 (isatty()为True)

# 从管道读取
$ echo "test" | python your_script.py -
输入不来自交互式终端 (isatty()为False), 文件名: <stdin>
  但它是标准输入，可能通过管道或重定向输入

# 从文件读取
$ python your_script.py your_script.py
输入不来自交互式终端 (isatty()为False), 文件名: your_script.py
  它是一个普通文件

综合示例与最佳实践

为了更全面地理解这些方法，以下是一个结合了所有检测方式的综合示例：

import click
import sys

@click.command()
@click.argument("file", type=click.File())
def cli(file):
    print(f"文件对象: {file}")
    print(f"文件描述符 (fileno()): {file.fileno()}")
    print(f"与 sys.stdin 相同 (file == sys.stdin): {file == sys.stdin}")
    print(f"是否连接到 TTY (file.isatty()): {file.isatty()}")
    print(f"sys.stdin 是否连接到 TTY (sys.stdin.isatty()): {sys.stdin.isatty()}")
    print(f"sys.stdout 是否连接到 TTY (sys.stdout.isatty()): {sys.stdout.isatty()}")
    print("-" * 30)

    if file == sys.stdin:
        print("结论：此输入是真正的标准输入 (sys.stdin)。")
    elif file.fileno() == 0: # 理论上如果 file == sys.stdin 为 False，这里也应为 False
        print("结论：此输入的文件描述符为 0，表明是标准输入 (sys.stdin)，但对象比较可能存在特殊情况。")
    else:
        print(f"结论：此输入是一个名为 '{file.name}' 的普通文件。")

if __name__ == "__main__":
    cli()

运行结果分析：

1. 当输入为 - (标准输入) 且在交互式终端中：

   $ python3 ./your_script.py -
   文件对象: <_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8'>
   文件描述符 (fileno()): 0
   与 sys.stdin 相同 (file == sys.stdin): True
   是否连接到 TTY (file.isatty()): True
   sys.stdin 是否连接到 TTY (sys.stdin.isatty()): True
   sys.stdout 是否连接到 TTY (sys.stdout.isatty()): True
   ------------------------------
   结论：此输入是真正的标准输入 (sys.stdin)。

   登录后复制

   所有指标都明确指向标准输入且连接到 TTY。

2. 当输入为 your_script.py (普通文件)：

   $ python3 ./your_script.py your_script.py
   文件对象: <_io.TextIOWrapper name='your_script.py' mode='r' encoding='UTF-8'>
   文件描述符 (fileno()): 3 # 或其他非0值
   与 sys.stdin 相同 (file == sys.stdin): False
   是否连接到 TTY (file.isatty()): False
   sys.stdin 是否连接到 TTY (sys.stdin.isatty()): True
   sys.stdout 是否连接到 TTY (sys.stdout.isatty()): True
   ------------------------------
   结论：此输入是一个名为 'your_script.py' 的普通文件。

   登录后复制

   文件描述符非 0，且不与 sys.stdin 相同，isatty() 为 False。

3. 当输入通过管道 (echo "text" | python3 your_script.py -)：

   $ echo "hello world" | python3 ./your_script.py -
   文件对象: <_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8'>
   文件描述符 (fileno()): 0
   与 sys.stdin 相同 (file == sys.stdin): True
   是否连接到 TTY (file.isatty()): False
   sys.stdin 是否连接到 TTY (sys.stdin.isatty()): False
   sys.stdout 是否连接到 TTY (sys.stdout.isatty()): True
   ------------------------------
   结论：此输入是真正的标准输入 (sys.stdin)。

   登录后复制

   尽管 isatty() 返回 False，但 file == sys.stdin 和 file.fileno() == 0 依然准确地识别出它是标准输入。

总结

在 Python Click 应用中，要准确判断输入是否来自标准输入 sys.stdin，推荐使用以下两种方法：

1. file == sys.stdin： 这是最直接、最语义化的判断方式，也是最推荐的方法。
2. file.fileno() == 0： 检查文件描述符是否为 0 也是一个非常可靠且底层的判断方式。

file.isatty() 方法则不应作为判断是否为 sys.stdin 的主要依据，因为它只表明文件是否连接到交互式终端，而非文件本身的来源。它更适用于判断当前环境是否支持交互式操作（例如是否可以打印彩色输出）。根据实际需求选择最适合的检测方法，以确保程序的健壮性和准确性。

以上就是Python Click：精准识别标准输入流（stdin）的方法的详细内容，更多请关注php中文网其它相关文章！