larkfunc 0.1.1

一个轻量级的 Python 实用函数工具库，涵盖文件读写、文本处理、JSON 解析、网络响应处理和 LLM 调用。

larkfunc

一个轻量级的 Python 实用函数工具库，涵盖文件读写、文本处理、JSON 解析、网络响应处理和 LLM 调用等常见场景，帮助你快速构建数据处理流水线。

功能特性

• 文件读写 (larkfunc.io) - 文本文件读取、JSON 保存、目录管理
• 文本处理 (larkfunc.text) - LLM 响应清理、文件名提取、LinkedIn ID 解析
• 网络请求 (larkfunc.network) - HTTP 响应内容解码
• JSON 处理 (larkfunc.json_utils) - 安全的 JSON 解析，不会因格式错误崩溃
• LLM 调用 (larkfunc.llm) - 带自动重试的 LLM 调用封装

安装和环境配置

环境要求

• Python >= 3.7

从 PyPI 安装（发布后）

pip install larkfunc

本地开发安装

git clone https://github.com/lark/larkfunc.git
cd larkfunc
pip install -e .

使用示例

快速开始

from larkfunc import read_txt_data, parse_json_safely, clean_llm_response

# 读取文本文件
content = read_txt_data("data/sample.txt")

# 安全解析 JSON
data = parse_json_safely('{"name": "lark", "version": 1}')

# 清理 LLM 返回的带代码块标记的文本
raw = '```json\n{"result": "ok"}\n```'
clean = clean_llm_response(raw)  # '{"result": "ok"}'

文件读写

from larkfunc.io import read_txt_to_list, save_json_to_file, ensure_directory_exists

# 按行读取文本文件
lines = read_txt_to_list("urls.txt")

# 确保输出目录存在
ensure_directory_exists("output/reports")

# 保存 JSON 文件
save_json_to_file({"key": "value"}, "output/result.json")

文本处理

from larkfunc.text import extract_linkedin_id, extract_filename_without_extension

# 提取 LinkedIn 用户 ID
uid = extract_linkedin_id("https://www.linkedin.com/in/johndoe/")
print(uid)  # 'johndoe'

# 提取不带扩展名的文件名
name = extract_filename_without_extension("/data/reports/summary.pdf")
print(name)  # 'summary'

LLM 调用

from larkfunc.llm import call_llm_with_retry

def my_chat(prompt: str) -> str:
    # 替换为你的 LLM API 调用实现
    import openai
    response = openai.ChatCompletion.create(
        model="gpt-3.5-turbo",
        messages=[{"role": "user", "content": prompt}]
    )
    return response.choices[0].message.content

result = call_llm_with_retry(
    content="这是一份简历...",
    prompt_template="\n请提取关键信息并以 JSON 格式返回：",
    chat_func=my_chat,
    max_retries=3
)

内置帮助文档查询

忘记函数用法时，无需查阅文档，直接在代码中调用 help_doc() 即可。

import larkfunc

# 查看所有可用函数概览（按子模块分组）
larkfunc.help_doc()

# 查看指定函数的完整文档（参数、返回值、示例、注意事项）
larkfunc.help_doc("read_txt_data")
larkfunc.help_doc("parse_json_safely")
larkfunc.help_doc("call_llm_with_retry")

# 也可使用 Python 原生 help()
help(larkfunc.clean_llm_response)

API 接口说明

larkfunc.io - 文件读写模块

函数	说明	参数	返回值
read_txt_data(filepath)	读取文本文件全部内容	filepath: str	Optional[str]
read_txt_to_list(filepath)	按行读取文本文件	filepath: str	List[str]
save_json_to_file(data, output_path)	保存字典为 JSON 文件	data: dict, output_path: str	bool
ensure_directory_exists(path)	确保目录存在	path: str	None

larkfunc.text - 文本处理模块

函数	说明	参数	返回值
clean_llm_response(response)	清理 LLM 响应中的代码块标记	response: str	str
extract_filename_without_extension(filepath)	提取不带扩展名的文件名	filepath: str	str
extract_linkedin_id(url)	从 LinkedIn URL 提取用户 ID	url: str	str

larkfunc.network - 网络请求模块

函数	说明	参数	返回值
decode_response_content(response)	解码 HTTP 响应为字符串	response: Response	Optional[str]

larkfunc.json_utils - JSON 处理模块

函数	说明	参数	返回值
parse_json_safely(json_str)	安全解析 JSON 字符串	json_str: str	dict

larkfunc.llm - LLM 调用模块

函数	说明	参数	返回值
call_llm_with_retry(content, prompt_template, chat_func, max_retries)	带重试的 LLM 调用	content: str, prompt_template: str, chat_func: Callable, max_retries: int	str

依赖项

依赖包	版本要求	用途
requests	任意版本	HTTP 请求支持（network 模块）
Python	>= 3.7	运行环境

贡献指南与许可证

贡献指南

1. Fork 本仓库
2. 创建特性分支：git checkout -b feature/your-feature
3. 提交更改：git commit -m "Add your feature"
4. 推送分支：git push origin feature/your-feature
5. 创建 Pull Request

许可证

本项目基于 MIT License 开源。