Python脚本执行与源代码及输出同步展示教程

本教程旨在介绍一种实用的方法，通过简单的Bash脚本，实现Python源代码的显示与脚本执行输出的同步记录。这种方法能够帮助开发者在调试、文档生成或代码审查时，清晰地追踪脚本的输入（源代码）和输出（执行结果），有效解决了标准Python执行方式只显示输出而不显示源代码的问题。

引言：Python脚本执行与日志记录的需求

在Python开发过程中，我们经常需要运行脚本来验证功能或观察输出。然而，标准的Python解释器执行（例如 python your_script.py）通常只会在终端显示脚本的执行结果，而不会显示脚本本身的源代码。这对于需要同时审查输入代码和对应输出的场景（如教学示例、自动化测试日志、生成包含代码块的报告）来说，是一个不便之处。

开发者有时期望获得类似于Python交互式会话的输出格式，即每行输入代码后紧跟着其执行结果，并带有 >>> 或 ... 提示符。虽然完全模拟交互式会话需要更复杂的机制，但本教程将提供一个简洁高效的Bash脚本方案，能够先完整展示Python脚本的源代码，然后执行该脚本并显示其输出，从而满足“同步显示源代码和输出”的核心需求。

核心解决方案：利用Bash脚本组合cat和python命令

要实现先显示源代码再显示执行输出，我们可以利用Linux/Unix系统中的两个基本命令：cat（用于显示文件内容）和 python（用于执行Python脚本）。通过一个简单的Bash脚本将这两个命令结合起来，即可达到目的。

1. 创建Bash脚本

首先，创建一个名为 run_and_log.sh 的文件，并添加以下内容：

#!/bin/sh

# 检查是否提供了Python文件作为参数
if [ -z "$1" ]; then
    echo "用法: $0 "
    echo "示例: $0 my_script.py"
    exit 1
fi

PYTHON_FILE="$1"

echo "--- Python 源代码开始 ---"
# 使用cat命令显示Python文件的内容
cat "${PYTHON_FILE}"
echo "--- Python 源代码结束 ---"
echo "" # 添加空行以分隔源代码和输出

echo "--- 脚本执行输出开始 ---"
# 使用python命令执行Python文件
python "${PYTHON_FILE}"
echo "--- 脚本执行输出结束 ---"

2. 脚本解析

#!/bin/sh: 这是一个shebang，指定该脚本应由 /bin/sh（通常是Bash的符号链接）解释执行。
if [ -z "$1" ]; then ... fi: 这段代码用于检查脚本是否收到了一个命令行参数。$1 代表第一个参数，-z 检查字符串是否为空。如果为空，则打印使用说明并退出。
PYTHON_FILE="$1": 将第一个命令行参数（即Python文件名）赋值给变量 PYTHON_FILE，方便后续使用。
echo "--- Python 源代码开始 ---" 等：这些是简单的 echo 命令，用于在输出中添加分隔符和说明，提高可读性。
cat "${PYTHON_FILE}": 这是关键一步，cat 命令会将指定Python文件的全部内容输出到标准输出，从而在终端显示源代码。
python "${PYTHON_FILE}": 在 cat 命令执行完毕后，python 命令会执行相同的Python文件，其产生的任何输出（如 print() 语句的结果、错误信息等）也将被打印到标准输出。

3. 使用方法

按照以下步骤来运行您的Python脚本并查看其源代码和输出：

保存脚本： 将上述Bash脚本内容保存为 run_and_log.sh 文件。
赋予执行权限： 在终端中，使用 chmod 命令为脚本添加执行权限。
```
chmod +x run_and_log.sh
```
运行脚本： 将您的Python文件作为参数传递给 run_and_log.sh。
```
./run_and_log.sh your_python_script.py
```

示例演示

假设我们有一个名为 temp.py 的Python文件，内容如下：

# temp.py
1+1
if True:
    print('True')

msg = "Hello, world!"
print(msg)

现在，我们使用 run_and_log.sh 来执行它：

./run_and_log.sh temp.py

您将看到以下输出：

--- Python 源代码开始 ---
1+1
if True:
    print('True')

msg = "Hello, world!"
print(msg)
--- Python 源代码结束 ---

--- 脚本执行输出开始 ---
2
True
Hello, world!
--- 脚本执行输出结束 ---

这个输出清晰地展示了 temp.py 的完整源代码，紧接着是其执行产生的输出结果，有效地实现了源代码与输出的同步展示。

注意事项与局限性

非交互式会话模拟： 此方法直接将源代码文本打印出来，然后执行脚本并打印其结果。它不会模拟Python交互式会话中常见的 >>> 和 ... 提示符。如果您的目标是精确复现带有这些提示符的交互式会话日志，则需要采用更复杂的工具，例如使用 script 命令记录一个真实的交互式终端会话，或者编写一个自定义的Python脚本来解析并模拟REPL行为（可能涉及 code 模块）。本教程提供的是一个更直接、更轻量级的解决方案，专注于展示源代码内容和执行结果。
错误处理： 如果Python脚本在执行过程中遇到语法错误或运行时错误，python 命令会将相应的错误信息（包括回溯信息）打印到标准错误流（通常也会显示在终端），这些信息将出现在“脚本执行输出”部分。
管道与重定向： 您可以通过标准的Shell重定向功能将整个输出保存到文件中，例如：
```
./run_and_log.sh your_python_script.py > logfile.txt
```
这将把源代码和执行输出一并保存到 logfile.txt 中。
适用场景： 这种方法特别适用于需要生成简单报告、调试日志或教学示例，其中代码和其直接输出的对应关系是关键信息。对于大型、复杂的项目或需要精细控制输入输出流的场景，可能需要结合其他日志记录框架或更专业的测试工具。

总结

通过结合 cat 和 python 命令的简单Bash脚本，我们能够高效地实现Python源代码与执行输出的同步展示。这种方法虽然不完全模拟交互式会话的提示符，但它提供了一个简洁、直接且易于理解的解决方案，能够满足大多数需要同时查看代码和结果的场景。掌握这一技巧，将有助于提升您在Python开发和文档生成过程中的效率和清晰度。

# linux # python # 工具 # unix # python脚本

返回目录在线咨询

上一篇：PHP 实现字符串翻转（包含中文汉字）的实现代码
下一篇：多屏建站系统中的数据分析工具如何帮助我们了解用户行为并改进网站？

您的项目需求

*请认真填写需求信息，我们会在24小时内与您取得联系。

全网整合营销服务商