hutool.core.io.resource¶
资源工具模块
Module Contents¶
Classes¶
资源工具类 |
API¶
- class hutool.core.io.resource.ResourceUtil¶
资源工具类
- _resource_paths: List[str] = []¶
- classmethod add_resource_path(path: str) None¶
添加资源搜索路径
- 参数:
path – 资源目录的绝对或相对路径
- static get_resource(path: str) str¶
获取资源的绝对路径
按以下顺序查找资源: 1. 绝对路径直接返回 2. 当前工作目录 3. 已注册的资源搜索路径
- 参数:
path – 资源的相对或绝对路径
- 返回:
资源的绝对路径
- 抛出:
FileNotFoundError – 资源不存在时抛出
- static get_resource_bytes(path: str) bytes¶
读取资源为字节数组
- 参数:
path – 资源的相对或绝对路径
- 返回:
资源内容的字节数组
- 抛出:
FileNotFoundError – 资源不存在时抛出
- static get_resource_str(path: str, charset: str = 'utf-8') str¶
读取资源为字符串
- 参数:
path – 资源的相对或绝对路径
charset – 字符编码,默认 utf-8
- 返回:
资源内容的字符串
- 抛出:
FileNotFoundError – 资源不存在时抛出
- static get_resource_stream(path: str) IO¶
获取资源的文件流
调用方负责关闭返回的文件流。
- 参数:
path – 资源的相对或绝对路径
- 返回:
可读的文件对象
- 抛出:
FileNotFoundError – 资源不存在时抛出
- static get_resources(pattern: str) List[str]¶
根据模式匹配获取资源列表
支持通配符模式(如 “.txt”、”data/.csv”)。 在当前工作目录和已注册的资源搜索路径中搜索。
- 参数:
pattern – 文件名匹配模式(支持 * 和 ? 通配符)
- 返回:
匹配的资源绝对路径列表
- static _search_in_dir(base_dir: str, pattern: str, results: List[str]) None¶
在指定目录中递归搜索匹配的文件
- 参数:
base_dir – 基础搜索目录
results – 结果列表(原地修改)
- Pattern:
文件名匹配模式