Python Koans 技术文档

1. 安装指南

1.1 下载 Python Koans

Python Koans 项目托管在 GitHub 上，您可以通过以下方式获取项目源码：

• 使用 Git 克隆项目：

  git clone https://github.com/gregmalcolm/python_koans.git
  

• 或者直接下载 ZIP 文件。

1.2 安装 Python 解释器

Python Koans 支持 Python 3.x 版本。您可以从 Python 官方网站 下载并安装最新版本的 Python。

安装完成后，确保 Python 可执行文件的路径已添加到系统的环境变量中，以便在命令行中可以直接运行 python 或 python3 命令。

1.3 安装依赖

Python Koans 不需要额外的依赖库，但如果您想使用 Sniffer 工具来自动运行测试，您需要安装以下依赖：

• 安装 Sniffer：

  python3 -m pip install sniffer
  

• 根据您的操作系统安装相应的文件监控库：
  • Linux:

    python3 -m pip install pyinotify
    

  • Windows:

    python3 -m pip install pywin32
    

  • macOS:

    python3 -m pip install MacFSEvents
    

2. 项目的使用说明

2.1 启动项目

在命令行中进入项目目录，运行以下命令启动 Python Koans：

python contemplate_koans.py

或者：

python3 contemplate_koans.py

2.2 修复测试

项目启动后，您将看到一个失败的测试。测试失败的提示信息会告诉您具体是哪个文件的哪一行代码出现了问题。您需要根据提示修复代码，使测试通过。

例如，您可能会看到类似以下的错误信息：

AssertionError: False is not True

您需要将 False 修改为 True，使测试通过。

2.3 使用 Sniffer 自动运行测试

如果您安装了 Sniffer，可以通过以下命令启动它：

sniffer

Sniffer 会监控 koans 目录中的文件变化，并在文件修改后自动重新运行测试。

3. 项目API使用文档

Python Koans 主要通过测试驱动开发（TDD）的方式来学习 Python。项目中没有传统的 API 文档，而是通过一系列的测试用例来引导用户学习 Python 的各个方面。

每个测试用例通常会包含一个或多个 assert 语句，您需要根据提示填写正确的代码或值，使测试通过。

例如：

self.assertEqual(__, 1+2)

您需要将 __ 替换为 3，使测试通过。

4. 项目安装方式

4.1 通过 Git 安装

git clone https://github.com/gregmalcolm/python_koans.git

4.2 通过下载 ZIP 文件安装

直接从 GitHub 页面下载 ZIP 文件，解压后即可使用。

4.3 通过 Gitpod 一键安装

您也可以通过 Gitpod 一键安装并启动项目。点击以下按钮即可：

[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/gregmalcolm/python_koans)

5. 总结

Python Koans 是一个通过测试驱动开发（TDD）方式学习 Python 的交互式教程。通过修复测试用例中的错误，您可以逐步掌握 Python 的语法和编程技巧。希望这篇文档能帮助您顺利开始学习 Python Koans。