当前位置：首页 > Python > 正文

Python Fire库使用教程 - 快速创建命令行工具

JiangYue
Python
2025-08-19
862

Python Fire库使用教程：快速创建命令行工具

更新于 2023年10月 | 阅读时间 8分钟

Fire是Google开发的一个Python库，只需少量代码即可将任何Python对象转换为命令行接口（CLI）。本教程将教你如何使用Fire快速构建强大的命令行工具。

为什么选择Fire库？

Python Fire是一个由Google开发的库，它能够自动将任何Python组件（函数、类、对象、字典等）转换为命令行接口。主要优势包括：

开发效率高：只需添加一行代码即可创建CLI
学习曲线低：无需学习新的API，使用现有Python知识
自动生成帮助：Fire自动生成帮助文档和错误提示
灵活性强：支持函数、类、对象、模块等多种类型
交互模式：提供REPL环境用于调试和探索

安装Python Fire

使用pip可以轻松安装Fire库：

pip install fire

安装完成后，通过以下命令验证安装是否成功：

python -c "import fire; print(fire.__version__)"

基本用法：函数转CLI

创建一个简单的Python文件（greet.py）：

import fire

def greet(name="World", greeting="Hello"):
    """显示问候语
    
    Args:
        name: 要问候的人名
        greeting: 问候语
    """
    print(f"{greeting}, {name}!")

if __name__ == '__main__':
    fire.Fire(greet)

现在你可以通过命令行使用这个程序：

# 使用默认参数
python greet.py

# 指定名字
python greet.py --name=Alice

# 同时指定名字和问候语
python greet.py --name=Bob --greeting="Good morning"

# 使用缩写形式
python greet.py --name Bob --greeting "Good morning"

参数处理与类型转换

Fire会自动处理参数类型转换：

import fire

def calculate(num1, num2, operation='add'):
    """执行数学运算
    
    Args:
        num1: 第一个数字
        num2: 第二个数字
        operation: 操作类型 (add, sub, mul, div)
    """
    if operation == 'add':
        result = num1 + num2
    elif operation == 'sub':
        result = num1 - num2
    elif operation == 'mul':
        result = num1 * num2
    elif operation == 'div':
        result = num1 / num2
    else:
        raise ValueError("无效的操作类型")
    
    print(f"结果: {result}")

if __name__ == '__main__':
    fire.Fire(calculate)

命令行使用示例：

python calculate.py 10 5 --operation=mul
# 输出: 结果: 50

python calculate.py 20 4 --operation=div
# 输出: 结果: 5.0

类和方法转CLI

Fire可以轻松将整个类转换为CLI，每个方法成为子命令：

import fire

class Calculator:
    """一个简单的计算器类"""
    
    def add(self, a, b):
        """两数相加"""
        return a + b
    
    def subtract(self, a, b):
        """两数相减"""
        return a - b
    
    def multiply(self, a, b):
        """两数相乘"""
        return a * b
    
    def divide(self, a, b):
        """两数相除"""
        if b == 0:
            raise ValueError("除数不能为零")
        return a / b

if __name__ == '__main__':
    fire.Fire(Calculator)

使用示例：

# 查看帮助
python calculator.py --help

# 使用add命令
python calculator.py add 5 3
# 输出: 8

# 使用multiply命令
python calculator.py multiply 4 6
# 输出: 24

链式命令与分组

Fire支持链式命令调用和命令分组：

import fire

class FileManager:
    """文件管理工具"""
    
    def __init__(self, base_dir='.'):
        self.base_dir = base_dir
    
    def list(self, pattern='*'):
        """列出匹配的文件"""
        # 实际实现中会使用glob等库
        print(f"列出 {self.base_dir} 中匹配 {pattern} 的文件")
    
    def copy(self, source, destination):
        """复制文件"""
        print(f"从 {source} 复制到 {destination}")
    
    def move(self, source, destination):
        """移动文件"""
        print(f"从 {source} 移动到 {destination}")

class TextUtils:
    """文本处理工具"""
    
    def count_lines(self, file_path):
        """计算文件行数"""
        # 实际实现会读取文件
        print(f"计算 {file_path} 的行数")
    
    def find_text(self, file_path, text):
        """在文件中查找文本"""
        print(f"在 {file_path} 中查找 '{text}'")

class MyCLI:
    """我的多功能命令行工具"""
    
    def __init__(self):
        self.file = FileManager()
        self.text = TextUtils()

if __name__ == '__main__':
    fire.Fire(MyCLI)

使用示例：

# 文件管理命令
python mycli.py file list --pattern="*.txt"

# 文本处理命令
python mycli.py text count_lines --file_path="data.log"

# 链式调用
python mycli.py file copy source.txt destination.txt

实际应用示例：文件处理工具

创建一个实用的文件处理工具：

import fire
import os
import glob
import shutil

class FileProcessor:
    """文件处理工具"""
    
    def __init__(self, verbose=False):
        self.verbose = verbose
    
    def _log(self, message):
        if self.verbose:
            print(f"[LOG] {message}")
    
    def list_files(self, directory='.', pattern='*'):
        """列出目录中匹配模式的文件"""
        path = os.path.join(directory, pattern)
        files = glob.glob(path)
        for file in files:
            print(file)
        return files
    
    def rename(self, pattern, new_name):
        """批量重命名文件"""
        files = glob.glob(pattern)
        if not files:
            print("未找到匹配的文件")
            return
        
        for i, file in enumerate(files):
            dir_name = os.path.dirname(file)
            ext = os.path.splitext(file)[1]
            new_file = os.path.join(dir_name, f"{new_name}_{i+1}{ext}")
            os.rename(file, new_file)
            self._log(f"重命名 {file} -> {new_file}")
        
        print(f"成功重命名 {len(files)} 个文件")
    
    def backup(self, source, destination):
        """备份文件或目录"""
        if os.path.isdir(source):
            shutil.copytree(source, destination)
            self._log(f"已备份目录 {source} 到 {destination}")
        else:
            shutil.copy2(source, destination)
            self._log(f"已备份文件 {source} 到 {destination}")
        print("备份完成")

if __name__ == '__main__':
    fire.Fire(FileProcessor)

使用示例：

# 列出所有文本文件
python filetool.py list_files --pattern="*.txt"

# 批量重命名图片文件
python filetool.py rename "images/*.jpg" vacation

# 备份目录（启用详细日志）
python filetool.py backup --source=docs --destination=backup/docs --verbose