wkea commited on
Commit
b8d2078
·
verified ·
1 Parent(s): 5658532

Support SPACEAPIKEY secret name (no underscore)

Browse files
Files changed (4) hide show
  1. .gitignore +3 -0
  2. README.md +1 -1
  3. app.py +4 -2
  4. call_space.py +52 -9
.gitignore CHANGED
@@ -23,4 +23,7 @@ outputs/
23
  *.jpeg
24
  *.webp
25
 
 
 
 
26
 
 
23
  *.jpeg
24
  *.webp
25
 
26
+ # Hugging Face Space “伪私有”调用脚本用(避免误提交Key)
27
+ space_api_key.txt
28
+
29
 
README.md CHANGED
@@ -10,7 +10,7 @@ app_file: app.py
10
 
11
  ### Hugging Face Spaces(在线API + 伪私有)
12
  - **Space入口文件**:`app.py`
13
- - **伪私有方式**:在 Space 的 `Settings -> Secrets` 配置 `SPACE_API_KEY`,所有推理请求必须携带该 Key 才会执行。
14
  - **checkpoint来源(二选一)**:
15
  - 配置 `BD_CKPT_PATH`(Space仓库内的文件路径)
16
  - 或配置 `BD_CKPT_REPO` + `BD_CKPT_FILENAME`(从 Hugging Face Hub 下载;私有仓库可再配 `HF_TOKEN`)
 
10
 
11
  ### Hugging Face Spaces(在线API + 伪私有)
12
  - **Space入口文件**:`app.py`
13
+ - **伪私有方式**:在 Space 的 `Settings -> Secrets` 配置 `SPACE_API_KEY`(若网页端不允许下划线则用 `SPACEAPIKEY`),所有推理请求必须携带该 Key 才会执行。
14
  - **checkpoint来源(二选一)**:
15
  - 配置 `BD_CKPT_PATH`(Space仓库内的文件路径)
16
  - 或配置 `BD_CKPT_REPO` + `BD_CKPT_FILENAME`(从 Hugging Face Hub 下载;私有仓库可再配 `HF_TOKEN`)
app.py CHANGED
@@ -38,10 +38,12 @@ def _require_space_api_key() -> str:
38
  """
39
  Space 的“伪私有”Key:建议在 Hugging Face Space Settings -> Secrets 里配置。
40
  """
41
- key = _get_env("SPACE_API_KEY", "")
 
 
42
  if not key:
43
  # 失败更安全:避免误部署成“无鉴权公开推理”
44
- raise RuntimeError("缺少环境变量 SPACE_API_KEY(请在 Space Secrets 中配置)")
45
  return key
46
 
47
 
 
38
  """
39
  Space 的“伪私有”Key:建议在 Hugging Face Space Settings -> Secrets 里配置。
40
  """
41
+ # 注意:Hugging Face 网页端对 Secret 名称有时会限制为字母数字且字母开头,
42
+ # 导致带下划线的 `SPACE_API_KEY` 无法创建;因此这里兼容 `SPACEAPIKEY`。
43
+ key = _get_env("SPACE_API_KEY", "") or _get_env("SPACEAPIKEY", "")
44
  if not key:
45
  # 失败更安全:避免误部署成“无鉴权公开推理”
46
+ raise RuntimeError("缺少环境变量 SPACE_API_KEY/SPACEAPIKEY(请在 Space Secrets 中配置)")
47
  return key
48
 
49
 
call_space.py CHANGED
@@ -22,6 +22,7 @@ from typing import Any, List, Tuple
22
 
23
 
24
  DEFAULT_SPACE = "wkea/blockdiffusion-api"
 
25
 
26
 
27
  def _now_tag() -> str:
@@ -33,6 +34,40 @@ def _ensure_dir(p: str) -> str:
33
  return p
34
 
35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
  def _as_path(maybe_path: Any) -> str | None:
37
  """
38
  gradio_client 的 Image/Gallery 返回值常见形式:
@@ -122,8 +157,8 @@ def parse_args() -> argparse.Namespace:
122
  p.add_argument(
123
  "--api_key",
124
  type=str,
125
- default=os.getenv("SPACE_API_KEY", ""),
126
- help="伪私有 API_KEY(优先从环境变量 SPACE_API_KEY 读取)",
127
  )
128
  p.add_argument("--prompt", type=str, default="stone block texture", help="提示词(条件模型可用;留空=无条件)")
129
  p.add_argument("--cfg_scale", type=float, default=3.0)
@@ -137,24 +172,32 @@ def parse_args() -> argparse.Namespace:
137
  p.add_argument("--batch", type=int, default=1)
138
  p.add_argument("--seed", type=int, default=123)
139
  p.add_argument("--preview_upscale", type=int, default=16)
140
- p.add_argument("--out_dir", type=str, default="space_outputs", help="输出目录")
 
141
  return p.parse_args()
142
 
143
 
144
  def main() -> None:
145
  args = parse_args()
146
- if not (args.api_key or "").strip():
147
- raise RuntimeError("缺少 --api_key 或环境变量 SPACE_API_KEY(Space端要求必填)")
 
 
 
148
 
149
  use_ema = bool(args.use_ema) and (not bool(args.no_use_ema))
150
  use_ddim = bool(args.use_ddim) and (not bool(args.no_use_ddim))
151
 
152
- out_dir = _ensure_dir(args.out_dir)
 
 
 
 
153
  tag = _now_tag()
154
 
155
  info, grid, gallery = _call_space(
156
  space=args.space,
157
- api_key=args.api_key,
158
  prompt=args.prompt,
159
  cfg_scale=float(args.cfg_scale),
160
  use_ema=use_ema,
@@ -172,13 +215,13 @@ def main() -> None:
172
  Path(info_path).write_text(info, encoding="utf-8")
173
 
174
  # 保存 grid
175
- grid_path = os.path.join(out_dir, f"grid_{tag}.png")
176
  _save_one(grid, grid_path)
177
 
178
  # 保存 gallery(如果有)
179
  saved = 0
180
  for i, one in enumerate(gallery):
181
- p = os.path.join(out_dir, f"img_{tag}_{i:02d}.png")
182
  if _save_one(one, p):
183
  saved += 1
184
 
 
22
 
23
 
24
  DEFAULT_SPACE = "wkea/blockdiffusion-api"
25
+ DEFAULT_KEY_FILENAME = "space_api_key.txt"
26
 
27
 
28
  def _now_tag() -> str:
 
34
  return p
35
 
36
 
37
+ def _script_dir() -> Path:
38
+ return Path(__file__).resolve().parent
39
+
40
+
41
+ def _read_text_first_line(path: Path) -> str:
42
+ try:
43
+ txt = path.read_text(encoding="utf-8", errors="ignore")
44
+ except Exception:
45
+ return ""
46
+ # 只取第一行,避免误把多行内容当作 key
47
+ return (txt.splitlines()[0].strip() if txt.splitlines() else "").strip()
48
+
49
+
50
+ def _resolve_api_key(arg_key: str) -> str:
51
+ """
52
+ 优先级:
53
+ 1) 命令行 --api_key
54
+ 2) 环境变量 SPACE_API_KEY(或 SPACEAPIKEY,兼容 Space 端命名限制)
55
+ 3) 脚本同目录的 space_api_key.txt(仅为“直接运行”方便;注意不要提交到git)
56
+ """
57
+ k = (arg_key or "").strip()
58
+ if k:
59
+ return k
60
+ k = (os.getenv("SPACE_API_KEY", "") or "").strip()
61
+ if not k:
62
+ k = (os.getenv("SPACEAPIKEY", "") or "").strip()
63
+ if k:
64
+ return k
65
+ kfile = _script_dir() / DEFAULT_KEY_FILENAME
66
+ if kfile.is_file():
67
+ return _read_text_first_line(kfile)
68
+ return ""
69
+
70
+
71
  def _as_path(maybe_path: Any) -> str | None:
72
  """
73
  gradio_client 的 Image/Gallery 返回值常见形式:
 
157
  p.add_argument(
158
  "--api_key",
159
  type=str,
160
+ default="",
161
+ help="伪私有 API_KEY(优先从环境变量 SPACE_API_KEY 或同目录 space_api_key.txt 读取)",
162
  )
163
  p.add_argument("--prompt", type=str, default="stone block texture", help="提示词(条件模型可用;留空=无条件)")
164
  p.add_argument("--cfg_scale", type=float, default=3.0)
 
172
  p.add_argument("--batch", type=int, default=1)
173
  p.add_argument("--seed", type=int, default=123)
174
  p.add_argument("--preview_upscale", type=int, default=16)
175
+ # 默认输出到脚本所在目录,方便“直接运行就有结果”
176
+ p.add_argument("--out_dir", type=str, default=".", help="输出目录(相对路径默认相对于脚本目录)")
177
  return p.parse_args()
178
 
179
 
180
  def main() -> None:
181
  args = parse_args()
182
+ api_key = _resolve_api_key(args.api_key)
183
+ if not api_key:
184
+ raise RuntimeError(
185
+ f"缺少API_KEY:请设置环境变量 SPACE_API_KEY,或在脚本同目录创建 {DEFAULT_KEY_FILENAME}(第一行写入Key),或传入 --api_key"
186
+ )
187
 
188
  use_ema = bool(args.use_ema) and (not bool(args.no_use_ema))
189
  use_ddim = bool(args.use_ddim) and (not bool(args.no_use_ddim))
190
 
191
+ # 输出目录:相对路径按“脚本目录”解析,避免你在不同cwd运行导致输出位置乱跳
192
+ out_dir_p = Path(args.out_dir or ".")
193
+ if not out_dir_p.is_absolute():
194
+ out_dir_p = _script_dir() / out_dir_p
195
+ out_dir = _ensure_dir(str(out_dir_p))
196
  tag = _now_tag()
197
 
198
  info, grid, gallery = _call_space(
199
  space=args.space,
200
+ api_key=api_key,
201
  prompt=args.prompt,
202
  cfg_scale=float(args.cfg_scale),
203
  use_ema=use_ema,
 
215
  Path(info_path).write_text(info, encoding="utf-8")
216
 
217
  # 保存 grid
218
+ grid_path = os.path.join(out_dir, f"space_grid_{tag}.png")
219
  _save_one(grid, grid_path)
220
 
221
  # 保存 gallery(如果有)
222
  saved = 0
223
  for i, one in enumerate(gallery):
224
+ p = os.path.join(out_dir, f"space_img_{tag}_{i:02d}.png")
225
  if _save_one(one, p):
226
  saved += 1
227