跳转到主要内容
并非一切都能成章。有些东西适合放进贴了标签的杂物抽屉。
当你阅读 HeavenBase 内部实现并需要识别某个 helper 时,请使用本页。编写新应用代码时,请优先使用本节中的专题页与功能文档。

1. 支持 Helper 菜单

当前的 heavenbase.utils.typing 是常见导入的迁移桥接,有意不提供 legacy autotypejsonschema_typeparse_func_sig

2. 运行命令

当你需要以数据形式获取 stdout、stderr 与退出码时,使用 cmd(...)
调用方只需其中一个字段时,可单独请求:
序列命令不会调用 shell,除非你传入 shell=True。对用户提供的值请优先使用序列命令。

3. 映射有界工作

当工作可并发执行且返回值必须保持输入顺序时,使用 pmap(...)
每个项作为关键字参数传入,因此 batch 项必须是 mapping。 当你需要每项状态、捕获异常、耗时或进度回调时,使用 batch(...)
异步代码通过 abatch(...)abatch_stream(...) 遵循相同契约。

4. 格式化错误与不匹配

当校验应建议最接近的支持值时,使用 raise_mismatch(...)
capture_error(...) 返回 ErrorRecord,可通过 record.reraise() 保留原始异常。

5. 使用作用域代理设置

当某次操作需要临时设置 HTTP_PROXYHTTPS_PROXYNO_PROXY 环境变量时,使用 NetworkProxy
上下文退出时会恢复原有环境值。传入空字符串会在上下文内禁用对应代理变量。

6. 日志与颜色诊断

使用 get_logger(...) 输出 HeavenBase 日志,使用 redirect_logs(...)suppress_logs(...) 做临时诊断路由。
cstr(...)color_success(...)strip_color(...) 等颜色 helper 用于终端诊断。不要在 JSON、行或基准测试产物中存储带颜色的字符串。

进一步探索

相关资源:
  • 概述 - 本节导览入口。
  • 文件系统 - 命令工作流使用的本地路径与文件。
  • 配置 - 并行 worker 限制与日志的配置默认值。
  • 目录 - 公开命名与对象发现。