blockdiffusion-api / call_space.py
wkea's picture
Improve error messages for client calls
eacd242 verified
Raw History Blame Contribute Delete
8.16 kB
from __future__ import annotations
"""
调用 Hugging Face Spaces:wkea/blockdiffusion-api
用途:
- 以“伪私有”方式调用 Space(必须提供 SPACE_API_KEY)
- 传入 prompt / CFG / DDIM 等参数
- 将返回的 grid 与 gallery 图片保存到本地目录
说明:
- 本脚本优先使用 gradio_client(推荐且最稳定)
- 若你的环境缺少 gradio_client,请先安装后再运行(通常安装 gradio 时会自带)
"""
import argparse
import os
import shutil
from datetime import datetime
from pathlib import Path
from typing import Any, List, Tuple
DEFAULT_SPACE = "wkea/blockdiffusion-api"
DEFAULT_KEY_FILENAME = "space_api_key.txt"
def _now_tag() -> str:
return datetime.now().strftime("%Y%m%d-%H%M%S")
def _ensure_dir(p: str) -> str:
Path(p).mkdir(parents=True, exist_ok=True)
return p
def _script_dir() -> Path:
return Path(__file__).resolve().parent
def _read_text_first_line(path: Path) -> str:
try:
txt = path.read_text(encoding="utf-8", errors="ignore")
except Exception:
return ""
# 只取第一行,避免误把多行内容当作 key
return (txt.splitlines()[0].strip() if txt.splitlines() else "").strip()
def _resolve_api_key(arg_key: str) -> str:
"""
优先级:
1) 命令行 --api_key
2) 环境变量 SPACE_API_KEY(或 SPACEAPIKEY,兼容 Space 端命名限制)
3) 脚本同目录的 space_api_key.txt(仅为“直接运行”方便;注意不要提交到git)
"""
k = (arg_key or "").strip()
if k:
return k
k = (os.getenv("SPACE_API_KEY", "") or "").strip()
if not k:
k = (os.getenv("SPACEAPIKEY", "") or "").strip()
if k:
return k
kfile = _script_dir() / DEFAULT_KEY_FILENAME
if kfile.is_file():
return _read_text_first_line(kfile)
return ""
def _as_path(maybe_path: Any) -> str | None:
"""
gradio_client 的 Image/Gallery 返回值常见形式:
- 本地文件路径(str)
- {"path": "..."} / {"name": "..."} 之类的 dict
本函数尽量从这些结构中提取本地路径。
"""
if maybe_path is None:
return None
if isinstance(maybe_path, str):
return maybe_path
if isinstance(maybe_path, dict):
for k in ("path", "name", "file", "filepath"):
v = maybe_path.get(k, None)
if isinstance(v, str) and v:
return v
return None
def _save_one(src: Any, dst_path: str) -> str | None:
"""
把 gradio_client 返回的文件对象/路径落盘到 dst_path。
"""
sp = _as_path(src)
if not sp:
return None
if not os.path.isfile(sp):
return None
_ensure_dir(str(Path(dst_path).parent))
shutil.copyfile(sp, dst_path)
return dst_path
def _call_space(
space: str,
api_key: str,
prompt: str,
cfg_scale: float,
use_ema: bool,
use_ddim: bool,
ddim_steps: int,
ddim_eta: float,
n_images: int,
batch: int,
seed: int,
preview_upscale: int,
) -> Tuple[str, Any, List[Any]]:
"""
返回:(info_text, grid_obj, gallery_objs)
"""
try:
from gradio_client import Client # type: ignore
from gradio_client.exceptions import AppError # type: ignore
except Exception as e:
raise RuntimeError("缺少依赖:gradio_client(建议安装 gradio 时一并安装)") from e
# Space 是公开的,通常不需要 hf_token;仅当 Space 本身是私有才需要。
client = Client(space)
# 输入顺序必须与 Space 的 gradio inputs 一致(见 app.py run.click(inputs=...))
try:
res = client.predict(
api_key,
prompt,
float(cfg_scale),
bool(use_ema),
bool(use_ddim),
int(ddim_steps),
float(ddim_eta),
int(n_images),
int(batch),
int(seed),
int(preview_upscale),
fn_index=0,
)
except AppError as e:
# 让报错更可读:通常是 Space 端 gr.Error 抛出的信息
raise RuntimeError(f"Space调用失败:{e}") from e
# 期望输出:(info, grid, gallery)
if not isinstance(res, (list, tuple)) or len(res) != 3:
raise RuntimeError(f"Space返回结构异常:{type(res)} len={getattr(res, '__len__', lambda: 'NA')()}")
info, grid, gallery = res[0], res[1], res[2]
if not isinstance(gallery, list):
gallery = []
return str(info), grid, gallery
def parse_args() -> argparse.Namespace:
p = argparse.ArgumentParser(description="调用 Hugging Face Space:BlockDiffusion API(伪私有)")
p.add_argument("--space", type=str, default=DEFAULT_SPACE, help="Space 名称,例如 wkea/blockdiffusion-api")
p.add_argument(
"--api_key",
type=str,
default="",
help="伪私有 API_KEY(优先从环境变量 SPACE_API_KEY 或同目录 space_api_key.txt 读取)",
)
p.add_argument("--prompt", type=str, default="stone block texture", help="提示词(条件模型可用;留空=无条件)")
p.add_argument("--cfg_scale", type=float, default=3.0)
p.add_argument("--use_ema", action="store_true", help="使用 EMA 权重(推荐)")
p.add_argument("--no_use_ema", action="store_true", help="禁用 EMA(仅排查用)")
p.add_argument("--use_ddim", action="store_true", help="使用 DDIM(更快)")
p.add_argument("--no_use_ddim", action="store_true", help="禁用 DDIM(用 DDPM)")
p.add_argument("--ddim_steps", type=int, default=50)
p.add_argument("--ddim_eta", type=float, default=0.0)
p.add_argument("--n", type=int, default=1, help="生成张数(Space建议<=8)")
p.add_argument("--batch", type=int, default=1)
p.add_argument("--seed", type=int, default=123)
p.add_argument("--preview_upscale", type=int, default=16)
# 默认输出到脚本所在目录,方便“直接运行就有结果”
p.add_argument("--out_dir", type=str, default=".", help="输出目录(相对路径默认相对于脚本目录)")
return p.parse_args()
def main() -> None:
args = parse_args()
api_key = _resolve_api_key(args.api_key)
if not api_key:
raise RuntimeError(
f"缺少API_KEY:请设置环境变量 SPACE_API_KEY,或在脚本同目录创建 {DEFAULT_KEY_FILENAME}(第一行写入Key),或传入 --api_key"
)
use_ema = bool(args.use_ema) and (not bool(args.no_use_ema))
use_ddim = bool(args.use_ddim) and (not bool(args.no_use_ddim))
# 输出目录:相对路径按“脚本目录”解析,避免你在不同cwd运行导致输出位置乱跳
out_dir_p = Path(args.out_dir or ".")
if not out_dir_p.is_absolute():
out_dir_p = _script_dir() / out_dir_p
out_dir = _ensure_dir(str(out_dir_p))
tag = _now_tag()
info, grid, gallery = _call_space(
space=args.space,
api_key=api_key,
prompt=args.prompt,
cfg_scale=float(args.cfg_scale),
use_ema=use_ema,
use_ddim=use_ddim,
ddim_steps=int(args.ddim_steps),
ddim_eta=float(args.ddim_eta),
n_images=int(args.n),
batch=int(args.batch),
seed=int(args.seed),
preview_upscale=int(args.preview_upscale),
)
# 保存 info
info_path = os.path.join(out_dir, f"info_{tag}.txt")
Path(info_path).write_text(info, encoding="utf-8")
# 保存 grid
grid_path = os.path.join(out_dir, f"space_grid_{tag}.png")
_save_one(grid, grid_path)
# 保存 gallery(如果有)
saved = 0
for i, one in enumerate(gallery):
p = os.path.join(out_dir, f"space_img_{tag}_{i:02d}.png")
if _save_one(one, p):
saved += 1
print(f"[ok] out_dir={out_dir} grid={grid_path} gallery_saved={saved} info={info_path}")
if __name__ == "__main__":
main()