gTTS 开源项目安装与使用指南

目录结构及介绍

在克隆或下载了 gTTS 项目之后，您将看到以下主要目录和文件：

• docs: 文档目录，包含了详细的API参考和其他相关文档。
• examples: 示例代码目录，这里提供了如何使用 gTTS 的基本示例。
• gtts: 主要模块目录，其中包含了用于处理文本转语音功能的所有类和函数。
  • _core.py: 包含核心逻辑和方法定义。
  • _util.py: 提供各种辅助工具和实用程序。
  • _lang.py: 处理语言识别和支持的功能。
• tests: 测试脚本目录，确保代码库的质量和正确性。
• setup.py: 项目设置和打包所需的文件。
• LICENSE: 许可证文件，指定项目的开放源代码许可。

重要文件说明:

1. gtts/_core.py

这个文件包含了 gTTS 类的主要实现。它定义了如何从Google翻译的TTS API获取音频数据并将其保存到文件中。其中包括预处理、令牌化以及错误处理等功能。

2. gtts/_lang.py

此模块负责处理支持的不同语言以及其对应的发音方式（例如“口音”）。它还提供了一个函数来检查是否支持输入的语种。

3. examples/example_cli.py

这是一个简单的命令行接口示例，展示如何通过命令行调用 gTTS 来生成语音文件。

---

启动文件介绍

gTTS 本身作为一个库提供服务，没有专门的“入口点”，但可以通过导入 gtts.tts 模块并在您的应用程序中创建 tts 对象实例来使用。如果您想使用命令行界面，则可以执行 gtts-cli 脚本。

使用Python脚本的方式

在您的应用中，您可以这样引入 gTTS 并使用它：

from gtts import gTTS

mytext = "Hello world!"
language = 'en'
myobj = gTTS(text=mytext, lang=language, slow=False)
myobj.save("output.mp3")

命令行界面(CLI)

对于CLI模式，只需运行以下命令即可使用gTTS将文本转换为语音：

gtts-cli "Your text here" --lang=en > output.mp3

---

配置文件介绍

gTTS 不依赖于配置文件进行初始化。所有选项都可通过构造函数参数传递给 gTTS() 实例。然而，在一些情况下，如改变默认行为或调试，可能希望自定义某些设置。

可选参数

当实例化一个 gTTS 对象时，下列参数可用于定制行为：

• text: 必填项；要被转换成语音的文本字符串。
• tld: (顶级域名); 默认 'com'; 可以是其他顶级域名，如 'co.uk' 或 'de'，这会影响语音质量。
• lang: 语言码，默认 'en'；表示使用的语言和口音。
• slow: 是否慢速播放，默认 False；若设为真，则语音速度较慢。
• lang_check: 是否检查语言的有效性，默认 True；如果为 False，则不验证提供的语言码。

为了便于使用和扩展，所有的这些选项都可以在代码或命令行上动态调整，无需任何外部配置文件。