AI编程实战：如何让AI生成带参数和返回值的Python函数——以PDF文本提取为例
引言：当效率需求遇上AI编程
在日常数据处理工作中，PDF转文本是个高频且痛苦的需求。手动复制粘贴不仅耗时，面对上百页文档时更是噩梦。传统解决方案需要掌握PyPDF2、pdfminer等库的复杂用法，这对初学者犹如天堑。而如今，借助AI编程助手，我们只需用自然语言描述需求，就能自动生成可运行的代码。更重要的是，我们可以通过迭代对话，教会AI生成高度定制化、带参数和返回值的专业级函数。本文将手把手带你体验这场生产力革命。
一、新手入门：零基础生成第一个PDF处理函数
1.1 明确你的基础需求
假设我们需要完成以下任务：
- 输入：一个PDF文件路径
- 输出：该PDF的所有文本内容
- 技术要求：使用流行的Python库，代码简洁健壮
1.2 向AI提出初始请求
提示词（Prompt）示例：
请用Python写一个函数，使用PyPDF2库提取PDF文件的全部文本内容。
要求处理可能出现的文件异常，最终返回完整文本字符串。
1.3 AI生成的初级代码
import PyPDF2def extract_pdf_text(file_path):"""提取PDF文件的全部文本内容:param file_path: PDF文件路径:return: 包含所有文本的字符串"""text = ""try:with open(file_path, 'rb') as file:reader = PyPDF2.PdfReader(file)for page in reader.pages:text += page.extract_text() + "\n"except Exception as e:print(f"处理文件时出错: {e}")return ""return text
1.4 代码解析（初学者必看）
| 代码片段 | 功能说明 | 新手注意事项 |
|---|---|---|
with open(...) | 安全打开文件 | 使用rb模式读取二进制文件 |
PdfReader() | 创建PDF阅读对象 | 替代旧版的PdfFileReader |
page.extract_text() | 提取单页文本 | 不同库的提取效果有差异 |
try...except | 异常处理 | 防止程序因文件错误崩溃 |
关键收获：通过自然语言描述，我们获得了可直接运行的完整函数，避免了查阅文档的时间成本。
二、进阶改造：给AI函数添加专业级参数
2.1 识别基础函数的不足
初始版本虽然可用，但存在明显缺陷：
- 无法选择提取特定页码
- 缺少文本清洗功能
- 没有处理加密文档的能力
- 返回纯文本难以定位内容来源
2.2 设计增强版参数方案
我们需要添加以下参数：
def extract_pdf_text(file_path: str,start_page: int = 0, # 起始页码(从0开始)end_page: int = None, # 结束页码(默认到末尾)password: str = None, # 文档密码remove_empty_lines: bool = True, # 删除空行include_page_numbers: bool = False # 包含页码标记
) -> str:
2.3 向AI发送改造指令
高阶Prompt技巧：
请升级之前的PDF提取函数，添加以下功能：
1. 增加start_page和end_page参数控制提取范围
2. 添加password参数处理加密文档
3. remove_empty_lines参数控制是否删除空行
4. include_page_numbers参数决定是否添加"[Page X]"标记
5. 使用类型注解和文档字符串说明
6. 返回字典结构：{'status': 'success'/'error', 'data': text, 'pages': 实际页数}
2.4 AI生成的增强版函数
def extract_pdf_text(file_path: str,start_page: int = 0,end_page: int = None,password: str = None,remove_empty_lines: bool = True,include_page_numbers: bool = False
) -> dict:"""增强版PDF文本提取函数:param file_path: PDF文件路径:param start_page: 起始页码(0-based):param end_page: 结束页码(不包含):param password: 文档密码(如有):param remove_empty_lines: 是否删除空行:param include_page_numbers: 是否添加页码标记:return: 结果字典 {'status': 'success'/'error', 'data': 文本, 'pages': 实际页数}"""result = {'status': 'success', 'data': '', 'pages': 0}try:with open(file_path, 'rb') as file:reader = PyPDF2.PdfReader(file)# 处理加密文档if reader.is_encrypted:if password:reader.decrypt(password)else:raise ValueError("Encrypted PDF requires password")total_pages = len(reader.pages)result['pages'] = total_pages# 设置实际结束页end = end_page if end_page is not None and end_page <= total_pages else total_pagesif start_page < 0 or start_page >= total_pages:raise IndexError(f"Invalid start page: {start_page}")# 逐页提取文本for i in range(start_page, end):page_text = reader.pages[i].extract_text()# 添加页码标记if include_page_numbers:page_text = f"[Page {i+1}]\n{page_text}\n"result['data'] += page_text# 空行处理if remove_empty_lines:lines = result['data'].split('\n')result['data'] = '\n'.join(line for line in lines if line.strip())except Exception as e:result['status'] = 'error'result['data'] = f"Error occurred: {str(e)}"return result
三、深度优化：工业级函数的诞生
3.1 性能与可靠性增强
通过多轮对话，我们进一步要求AI：
请进行以下优化：
1. 添加文本编码声明 # -*- coding: utf-8 -*-
2. 使用tqdm添加进度条可视化
3. 增加PDF文件校验(通过magic库)
4. 添加日志记录替代print
5. 支持大文件分块读取
3.2 最终工业级代码框架
# -*- coding: utf-8 -*-
import logging
import PyPDF2
from tqdm import tqdm
import magicdef extract_pdf_text_v2(file_path: str,# 参数列表同上...
) -> dict:"""专业级PDF文本提取方案"""# 配置日志logging.basicConfig(filename='pdf_extract.log', level=logging.INFO)# 文件类型验证if not magic.from_file(file_path, mime=True) == 'application/pdf':return {'status': 'error', 'data': 'Invalid PDF file'}# 分块读取处理 (伪代码示例)chunk_size = 1024 * 1024 # 1MBwith open(file_path, 'rb') as f:while chunk := f.read(chunk_size):process_chunk(chunk)# 进度条实现for i in tqdm(range(start_page, end), desc="Extracting Pages"):# 处理逻辑...return result
四、AI协作编程的黄金法则
4.1 高效Prompt设计模板
1. **角色定义**：你是一位资深Python工程师
2. **任务目标**：开发一个具有[具体功能]的函数
3. **核心要求**：- 输入参数：[参数1]类型, [参数2]类型...- 返回类型：[明确要求]- 异常处理：[指定异常类型]- 性能要求：[如处理1GB文件]
4. **约束条件**：- 必须使用[指定库]的[特定版本]- 禁止使用[某些方法]
5. **示例说明**：给出输入输出示例
4.2 参数设计最佳实践
| 参数类型 | 适用场景 | 示例 | 注意事项 |
|---|---|---|---|
| 必选参数 | 核心输入 | file_path | 放在参数列表最前 |
| 可选参数 | 功能扩展 | start_page=0 | 提供默认值 |
| 标志参数 | 行为开关 | remove_empty=True | 使用布尔类型 |
| 验证参数 | 数据校验 | max_size=1024 | 在函数开头验证 |
4.3 调试AI代码的必备技巧
- 边界测试：传入空文件、超大文件、错误页码
- 类型检查：使用
mypy验证类型注解
pip install mypy
mypy your_script.py
- 性能监控：用
cProfile检测瓶颈
import cProfile
cProfile.run('extract_pdf_text("large.pdf")')
五、超越PDF：通用函数生成方法论
5.1 函数设计模式扩展
| 需求类型 | 参数设计策略 | 返回结构建议 |
|---|---|---|
| 数据处理 | 添加format/output_format参数 | 返回{data, metadata} |
| 文件操作 | 增加overwrite/backup参数 | 返回{success_count, fail_list} |
| 网络请求 | 设置timeout/retry参数 | 返回{status_code, headers, data} |
5.2 跨任务函数生成示例
案例：数据库查询函数
def query_database(sql: str,connection_config: dict,fetch_mode: str = 'all', # 'one'/'many'/'all'max_rows: int = 1000,timeout: int = 30
) -> dict:"""安全执行SQL查询:param sql: SQL查询语句:param connection_config: 数据库连接配置:param fetch_mode: 数据获取模式:param max_rows: 最大返回行数:param timeout: 超时时间(秒):return: {status, data, rowcount, error}"""# AI生成的实现代码...
结语：人类与AI的协同进化
通过本文的PDF处理案例，我们见证了：
- 从基础功能实现到参数化接口设计的演进
- 从单一返回值到结构化数据返回的升级
- 从脚本级代码到工程级解决方案的蜕变
AI不会取代程序员，但会用AI的程序员将取代不用AI的程序员。当你能精准描述需求时，AI就成了无限延伸的技术外脑。记住：最高级的编程，是教会AI如何编程。