/
utils.py
1061 lines (905 loc) 路 32.5 KB
/
utils.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import annotations
import asyncio
import base64
import copy
import json
import mimetypes
import os
import pkgutil
import secrets
import shutil
import tempfile
import warnings
from concurrent.futures import CancelledError
from dataclasses import dataclass, field
from datetime import datetime
from enum import Enum
from pathlib import Path
from threading import Lock
from typing import Any, Callable, Literal, Optional, TypedDict
import fsspec.asyn
import httpx
import huggingface_hub
from huggingface_hub import SpaceStage
from websockets.legacy.protocol import WebSocketCommonProtocol
API_URL = "api/predict/"
SSE_URL_V0 = "queue/join"
SSE_DATA_URL_V0 = "queue/data"
SSE_URL = "queue/data"
SSE_DATA_URL = "queue/join"
WS_URL = "queue/join"
UPLOAD_URL = "upload"
LOGIN_URL = "login"
CONFIG_URL = "config"
API_INFO_URL = "info"
RAW_API_INFO_URL = "info?serialize=False"
SPACE_FETCHER_URL = "https://gradio-space-api-fetcher-v2.hf.space/api"
RESET_URL = "reset"
SPACE_URL = "https://hf.space/{}"
STATE_COMPONENT = "state"
INVALID_RUNTIME = [
SpaceStage.NO_APP_FILE,
SpaceStage.CONFIG_ERROR,
SpaceStage.BUILD_ERROR,
SpaceStage.RUNTIME_ERROR,
SpaceStage.PAUSED,
]
class Message(TypedDict, total=False):
msg: str
output: dict[str, Any]
event_id: str
rank: int
rank_eta: float
queue_size: int
success: bool
progress_data: list[dict]
log: str
level: str
def get_package_version() -> str:
try:
package_json_data = (
pkgutil.get_data(__name__, "package.json").decode("utf-8").strip() # type: ignore
)
package_data = json.loads(package_json_data)
version = package_data.get("version", "")
return version
except Exception:
return ""
__version__ = get_package_version()
class TooManyRequestsError(Exception):
"""Raised when the API returns a 429 status code."""
pass
class QueueError(Exception):
"""Raised when the queue is full or there is an issue adding a job to the queue."""
pass
class InvalidAPIEndpointError(Exception):
"""Raised when the API endpoint is invalid."""
pass
class SpaceDuplicationError(Exception):
"""Raised when something goes wrong with a Space Duplication."""
pass
class ServerMessage(str, Enum):
send_hash = "send_hash"
queue_full = "queue_full"
estimation = "estimation"
send_data = "send_data"
process_starts = "process_starts"
process_generating = "process_generating"
process_completed = "process_completed"
log = "log"
progress = "progress"
heartbeat = "heartbeat"
server_stopped = "server_stopped"
unexpected_error = "unexpected_error"
class Status(Enum):
"""Status codes presented to client users."""
STARTING = "STARTING"
JOINING_QUEUE = "JOINING_QUEUE"
QUEUE_FULL = "QUEUE_FULL"
IN_QUEUE = "IN_QUEUE"
SENDING_DATA = "SENDING_DATA"
PROCESSING = "PROCESSING"
ITERATING = "ITERATING"
PROGRESS = "PROGRESS"
FINISHED = "FINISHED"
CANCELLED = "CANCELLED"
LOG = "LOG"
@staticmethod
def ordering(status: Status) -> int:
"""Order of messages. Helpful for testing."""
order = [
Status.STARTING,
Status.JOINING_QUEUE,
Status.QUEUE_FULL,
Status.IN_QUEUE,
Status.SENDING_DATA,
Status.PROCESSING,
Status.PROGRESS,
Status.ITERATING,
Status.FINISHED,
Status.CANCELLED,
]
return order.index(status)
def __lt__(self, other: Status):
return self.ordering(self) < self.ordering(other)
@staticmethod
def msg_to_status(msg: str) -> Status:
"""Map the raw message from the backend to the status code presented to users."""
return {
ServerMessage.send_hash: Status.JOINING_QUEUE,
ServerMessage.queue_full: Status.QUEUE_FULL,
ServerMessage.estimation: Status.IN_QUEUE,
ServerMessage.send_data: Status.SENDING_DATA,
ServerMessage.process_starts: Status.PROCESSING,
ServerMessage.process_generating: Status.ITERATING,
ServerMessage.process_completed: Status.FINISHED,
ServerMessage.progress: Status.PROGRESS,
ServerMessage.log: Status.LOG,
ServerMessage.server_stopped: Status.FINISHED,
}[msg] # type: ignore
@dataclass
class ProgressUnit:
index: Optional[int]
length: Optional[int]
unit: Optional[str]
progress: Optional[float]
desc: Optional[str]
@classmethod
def from_msg(cls, data: list[dict]) -> list[ProgressUnit]:
return [
cls(
index=d.get("index"),
length=d.get("length"),
unit=d.get("unit"),
progress=d.get("progress"),
desc=d.get("desc"),
)
for d in data
]
@dataclass
class StatusUpdate:
"""Update message sent from the worker thread to the Job on the main thread."""
code: Status
rank: int | None
queue_size: int | None
eta: float | None
success: bool | None
time: datetime | None
progress_data: list[ProgressUnit] | None
log: tuple[str, str] | None = None
def create_initial_status_update():
return StatusUpdate(
code=Status.STARTING,
rank=None,
queue_size=None,
eta=None,
success=None,
time=datetime.now(),
progress_data=None,
)
@dataclass
class JobStatus:
"""The job status.
Keeps track of the latest status update and intermediate outputs (not yet implements).
"""
latest_status: StatusUpdate = field(default_factory=create_initial_status_update)
outputs: list[Any] = field(default_factory=list)
@dataclass
class Communicator:
"""Helper class to help communicate between the worker thread and main thread."""
lock: Lock
job: JobStatus
prediction_processor: Callable[..., tuple]
reset_url: str
should_cancel: bool = False
event_id: str | None = None
########################
# Network utils
########################
def is_http_url_like(possible_url) -> bool:
"""
Check if the given value is a string that looks like an HTTP(S) URL.
"""
if not isinstance(possible_url, str):
return False
return possible_url.startswith(("http://", "https://"))
def probe_url(possible_url: str) -> bool:
"""
Probe the given URL to see if it responds with a 200 status code (to HEAD, then to GET).
"""
headers = {"User-Agent": "gradio (https://gradio.app/; gradio-team@huggingface.co)"}
try:
with httpx.Client() as client:
head_request = client.head(possible_url, headers=headers)
if head_request.status_code == 405:
return client.get(possible_url, headers=headers).is_success
return head_request.is_success
except Exception:
return False
def is_valid_url(possible_url: str) -> bool:
"""
Check if the given string is a valid URL.
"""
warnings.warn(
"is_valid_url should not be used. "
"Use is_http_url_like() and probe_url(), as suitable, instead.",
)
return is_http_url_like(possible_url) and probe_url(possible_url)
async def get_pred_from_ws(
websocket: WebSocketCommonProtocol,
data: str,
hash_data: str,
helper: Communicator | None = None,
) -> dict[str, Any]:
completed = False
resp = {}
while not completed:
# Receive message in the background so that we can
# cancel even while running a long pred
task = asyncio.create_task(websocket.recv())
while not task.done():
if helper:
with helper.lock:
if helper.should_cancel:
# Need to reset the iterator state since the client
# will not reset the session
async with httpx.AsyncClient() as http:
reset = http.post(
helper.reset_url, json=json.loads(hash_data)
)
# Retrieve cancel exception from task
# otherwise will get nasty warning in console
task.cancel()
await asyncio.gather(task, reset, return_exceptions=True)
raise CancelledError()
# Need to suspend this coroutine so that task actually runs
await asyncio.sleep(0.01)
msg = task.result()
resp = json.loads(msg)
if helper:
with helper.lock:
has_progress = "progress_data" in resp
status_update = StatusUpdate(
code=Status.msg_to_status(resp["msg"]),
queue_size=resp.get("queue_size"),
rank=resp.get("rank", None),
success=resp.get("success"),
time=datetime.now(),
eta=resp.get("rank_eta"),
progress_data=ProgressUnit.from_msg(resp["progress_data"])
if has_progress
else None,
)
output = resp.get("output", {}).get("data", [])
if output and status_update.code != Status.FINISHED:
try:
result = helper.prediction_processor(*output)
except Exception as e:
result = [e]
helper.job.outputs.append(result)
helper.job.latest_status = status_update
if resp["msg"] == "queue_full":
raise QueueError("Queue is full! Please try again.")
if resp["msg"] == "send_hash":
await websocket.send(hash_data)
elif resp["msg"] == "send_data":
await websocket.send(data)
completed = resp["msg"] == "process_completed"
return resp["output"]
async def get_pred_from_sse_v0(
client: httpx.AsyncClient,
data: dict,
hash_data: dict,
helper: Communicator,
sse_url: str,
sse_data_url: str,
headers: dict[str, str],
cookies: dict[str, str] | None,
ssl_verify: bool,
) -> dict[str, Any] | None:
done, pending = await asyncio.wait(
[
asyncio.create_task(check_for_cancel(helper, headers, cookies, ssl_verify)),
asyncio.create_task(
stream_sse_v0(
client,
data,
hash_data,
helper,
sse_url,
sse_data_url,
headers,
cookies,
)
),
],
return_when=asyncio.FIRST_COMPLETED,
)
for task in pending:
task.cancel()
try:
await task
except asyncio.CancelledError:
pass
if len(done) != 1:
raise ValueError(f"Did not expect {len(done)} tasks to be done.")
for task in done:
return task.result()
async def get_pred_from_sse_v1_v2(
helper: Communicator,
headers: dict[str, str],
cookies: dict[str, str] | None,
pending_messages_per_event: dict[str, list[Message | None]],
event_id: str,
protocol: Literal["sse_v1", "sse_v2", "sse_v2.1"],
ssl_verify: bool,
) -> dict[str, Any] | None:
done, pending = await asyncio.wait(
[
asyncio.create_task(check_for_cancel(helper, headers, cookies, ssl_verify)),
asyncio.create_task(
stream_sse_v1_v2(helper, pending_messages_per_event, event_id, protocol)
),
],
return_when=asyncio.FIRST_COMPLETED,
)
for task in pending:
task.cancel()
try:
await task
except asyncio.CancelledError:
pass
if len(done) != 1:
raise ValueError(f"Did not expect {len(done)} tasks to be done.")
for task in done:
exception = task.exception()
if exception:
raise exception
return task.result()
async def check_for_cancel(
helper: Communicator,
headers: dict[str, str],
cookies: dict[str, str] | None,
ssl_verify: bool,
):
while True:
await asyncio.sleep(0.05)
with helper.lock:
if helper.should_cancel:
break
if helper.event_id:
async with httpx.AsyncClient(ssl_verify=ssl_verify) as http:
await http.post(
helper.reset_url,
json={"event_id": helper.event_id},
headers=headers,
cookies=cookies,
)
raise CancelledError()
async def stream_sse_v0(
client: httpx.AsyncClient,
data: dict,
hash_data: dict,
helper: Communicator,
sse_url: str,
sse_data_url: str,
headers: dict[str, str],
cookies: dict[str, str] | None,
) -> dict[str, Any]:
try:
async with client.stream(
"GET",
sse_url,
params=hash_data,
headers=headers,
cookies=cookies,
) as response:
async for line in response.aiter_lines():
line = line.rstrip("\n")
if len(line) == 0:
continue
if line.startswith("data:"):
resp = json.loads(line[5:])
if resp["msg"] in [ServerMessage.log, ServerMessage.heartbeat]:
continue
with helper.lock:
has_progress = "progress_data" in resp
status_update = StatusUpdate(
code=Status.msg_to_status(resp["msg"]),
queue_size=resp.get("queue_size"),
rank=resp.get("rank", None),
success=resp.get("success"),
time=datetime.now(),
eta=resp.get("rank_eta"),
progress_data=ProgressUnit.from_msg(resp["progress_data"])
if has_progress
else None,
)
output = resp.get("output", {}).get("data", [])
if output and status_update.code != Status.FINISHED:
try:
result = helper.prediction_processor(*output)
except Exception as e:
result = [e]
helper.job.outputs.append(result)
helper.job.latest_status = status_update
if resp["msg"] == "queue_full":
raise QueueError("Queue is full! Please try again.")
elif resp["msg"] == "send_data":
event_id = resp["event_id"]
helper.event_id = event_id
req = await client.post(
sse_data_url,
json={"event_id": event_id, **data, **hash_data},
headers=headers,
cookies=cookies,
)
req.raise_for_status()
elif resp["msg"] == "process_completed":
return resp["output"]
else:
raise ValueError(f"Unexpected message: {line}")
raise ValueError("Did not receive process_completed message.")
except asyncio.CancelledError:
raise
async def stream_sse_v1_v2(
helper: Communicator,
pending_messages_per_event: dict[str, list[Message | None]],
event_id: str,
protocol: Literal["sse_v1", "sse_v2", "sse_v2.1"],
) -> dict[str, Any]:
try:
pending_messages = pending_messages_per_event[event_id]
pending_responses_for_diffs = None
while True:
if len(pending_messages) > 0:
msg = pending_messages.pop(0)
else:
await asyncio.sleep(0.05)
continue
if msg is None:
raise CancelledError()
with helper.lock:
log_message = None
if msg["msg"] == ServerMessage.log:
log = msg.get("log")
level = msg.get("level")
if log and level:
log_message = (log, level)
status_update = StatusUpdate(
code=Status.msg_to_status(msg["msg"]),
queue_size=msg.get("queue_size"),
rank=msg.get("rank", None),
success=msg.get("success"),
time=datetime.now(),
eta=msg.get("rank_eta"),
progress_data=ProgressUnit.from_msg(msg["progress_data"])
if "progress_data" in msg
else None,
log=log_message,
)
output = msg.get("output", {}).get("data", [])
if msg["msg"] == ServerMessage.process_generating and protocol in [
"sse_v2",
"sse_v2.1",
]:
if pending_responses_for_diffs is None:
pending_responses_for_diffs = list(output)
else:
for i, value in enumerate(output):
prev_output = pending_responses_for_diffs[i]
new_output = apply_diff(prev_output, value)
pending_responses_for_diffs[i] = new_output
output[i] = new_output
if output and status_update.code != Status.FINISHED:
try:
result = helper.prediction_processor(*output)
except Exception as e:
result = [e]
helper.job.outputs.append(result)
helper.job.latest_status = status_update
if msg["msg"] == ServerMessage.process_completed:
del pending_messages_per_event[event_id]
return msg["output"]
elif msg["msg"] == ServerMessage.server_stopped:
raise ValueError("Server stopped.")
except asyncio.CancelledError:
raise
def apply_diff(obj, diff):
obj = copy.deepcopy(obj)
def apply_edit(target, path, action, value):
if len(path) == 0:
if action == "replace":
return value
elif action == "append":
return target + value
else:
raise ValueError(f"Unsupported action: {action}")
current = target
for i in range(len(path) - 1):
current = current[path[i]]
last_path = path[-1]
if action == "replace":
current[last_path] = value
elif action == "append":
current[last_path] += value
elif action == "add":
if isinstance(current, list):
current.insert(int(last_path), value)
else:
current[last_path] = value
elif action == "delete":
if isinstance(current, list):
del current[int(last_path)]
else:
del current[last_path]
else:
raise ValueError(f"Unknown action: {action}")
return target
for action, path, value in diff:
obj = apply_edit(obj, path, action, value)
return obj
########################
# Data processing utils
########################
def create_tmp_copy_of_file(file_path: str, dir: str | None = None) -> str:
directory = Path(dir or tempfile.gettempdir()) / secrets.token_hex(20)
directory.mkdir(exist_ok=True, parents=True)
dest = directory / Path(file_path).name
shutil.copy2(file_path, dest)
return str(dest.resolve())
def download_tmp_copy_of_file(
url_path: str, hf_token: str | None = None, dir: str | None = None
) -> str:
"""Kept for backwards compatibility for 3.x spaces."""
if dir is not None:
os.makedirs(dir, exist_ok=True)
headers = {"Authorization": "Bearer " + hf_token} if hf_token else {}
directory = Path(dir or tempfile.gettempdir()) / secrets.token_hex(20)
directory.mkdir(exist_ok=True, parents=True)
file_path = directory / Path(url_path).name
with httpx.stream(
"GET", url_path, headers=headers, follow_redirects=True
) as response:
response.raise_for_status()
with open(file_path, "wb") as f:
for chunk in response.iter_raw():
f.write(chunk)
return str(file_path.resolve())
def get_mimetype(filename: str) -> str | None:
if filename.endswith(".vtt"):
return "text/vtt"
mimetype = mimetypes.guess_type(filename)[0]
if mimetype is not None:
mimetype = mimetype.replace("x-wav", "wav").replace("x-flac", "flac")
return mimetype
def get_extension(encoding: str) -> str | None:
encoding = encoding.replace("audio/wav", "audio/x-wav")
type = mimetypes.guess_type(encoding)[0]
if type == "audio/flac": # flac is not supported by mimetypes
return "flac"
elif type is None:
return None
extension = mimetypes.guess_extension(type)
if extension is not None and extension.startswith("."):
extension = extension[1:]
return extension
def encode_file_to_base64(f: str | Path):
with open(f, "rb") as file:
encoded_string = base64.b64encode(file.read())
base64_str = str(encoded_string, "utf-8")
mimetype = get_mimetype(str(f))
return (
"data:"
+ (mimetype if mimetype is not None else "")
+ ";base64,"
+ base64_str
)
def encode_url_to_base64(url: str):
resp = httpx.get(url)
resp.raise_for_status()
encoded_string = base64.b64encode(resp.content)
base64_str = str(encoded_string, "utf-8")
mimetype = get_mimetype(url)
return (
"data:" + (mimetype if mimetype is not None else "") + ";base64," + base64_str
)
def encode_url_or_file_to_base64(path: str | Path):
path = str(path)
if is_http_url_like(path):
return encode_url_to_base64(path)
return encode_file_to_base64(path)
def download_byte_stream(url: str, hf_token=None):
arr = bytearray()
headers = {"Authorization": "Bearer " + hf_token} if hf_token else {}
with httpx.stream("GET", url, headers=headers) as r:
for data in r.iter_bytes():
arr += data
yield data
yield arr
def decode_base64_to_binary(encoding: str) -> tuple[bytes, str | None]:
extension = get_extension(encoding)
data = encoding.rsplit(",", 1)[-1]
return base64.b64decode(data), extension
def strip_invalid_filename_characters(filename: str, max_bytes: int = 200) -> str:
"""Strips invalid characters from a filename and ensures that the file_length is less than `max_bytes` bytes."""
filename = "".join([char for char in filename if char.isalnum() or char in "._- "])
filename_len = len(filename.encode())
if filename_len > max_bytes:
while filename_len > max_bytes:
if len(filename) == 0:
break
filename = filename[:-1]
filename_len = len(filename.encode())
return filename
def sanitize_parameter_names(original_name: str) -> str:
"""Cleans up a Python parameter name to make the API info more readable."""
return (
"".join([char for char in original_name if char.isalnum() or char in " _"])
.replace(" ", "_")
.lower()
)
def decode_base64_to_file(
encoding: str,
file_path: str | None = None,
dir: str | Path | None = None,
prefix: str | None = None,
):
directory = Path(dir or tempfile.gettempdir()) / secrets.token_hex(20)
directory.mkdir(exist_ok=True, parents=True)
data, extension = decode_base64_to_binary(encoding)
if file_path is not None and prefix is None:
filename = Path(file_path).name
prefix = filename
if "." in filename:
prefix = filename[0 : filename.index(".")]
extension = filename[filename.index(".") + 1 :]
if prefix is not None:
prefix = strip_invalid_filename_characters(prefix)
if extension is None:
file_obj = tempfile.NamedTemporaryFile(
delete=False, prefix=prefix, dir=directory
)
else:
file_obj = tempfile.NamedTemporaryFile(
delete=False,
prefix=prefix,
suffix="." + extension,
dir=directory,
)
file_obj.write(data)
file_obj.flush()
return file_obj
def dict_or_str_to_json_file(jsn: str | dict | list, dir: str | Path | None = None):
if dir is not None:
os.makedirs(dir, exist_ok=True)
file_obj = tempfile.NamedTemporaryFile(
delete=False, suffix=".json", dir=dir, mode="w+"
)
if isinstance(jsn, str):
jsn = json.loads(jsn)
json.dump(jsn, file_obj)
file_obj.flush()
return file_obj
def file_to_json(file_path: str | Path) -> dict | list:
with open(file_path) as f:
return json.load(f)
###########################
# HuggingFace Hub API Utils
###########################
def set_space_timeout(
space_id: str,
hf_token: str | None = None,
timeout_in_seconds: int = 300,
):
headers = huggingface_hub.utils.build_hf_headers(
token=hf_token,
library_name="gradio_client",
library_version=__version__,
)
try:
httpx.post(
f"https://huggingface.co/api/spaces/{space_id}/sleeptime",
json={"seconds": timeout_in_seconds},
headers=headers,
)
except httpx.HTTPStatusError as e:
raise SpaceDuplicationError(
f"Could not set sleep timeout on duplicated Space. Please visit {SPACE_URL.format(space_id)} "
"to set a timeout manually to reduce billing charges."
) from e
########################
# Misc utils
########################
def synchronize_async(func: Callable, *args, **kwargs) -> Any:
"""
Runs async functions in sync scopes. Can be used in any scope.
Example:
if inspect.iscoroutinefunction(block_fn.fn):
predictions = utils.synchronize_async(block_fn.fn, *processed_input)
Args:
func:
*args:
**kwargs:
"""
return fsspec.asyn.sync(fsspec.asyn.get_loop(), func, *args, **kwargs) # type: ignore
class APIInfoParseError(ValueError):
pass
def get_type(schema: dict):
if "const" in schema:
return "const"
if "enum" in schema:
return "enum"
elif "type" in schema:
return schema["type"]
elif schema.get("$ref"):
return "$ref"
elif schema.get("oneOf"):
return "oneOf"
elif schema.get("anyOf"):
return "anyOf"
elif schema.get("allOf"):
return "allOf"
elif "type" not in schema:
return {}
else:
raise APIInfoParseError(f"Cannot parse type for {schema}")
FILE_DATA_FORMATS = [
"Dict(path: str, url: str | None, size: int | None, orig_name: str | None, mime_type: str | None)",
"Dict(path: str, url: str | None, size: int | None, orig_name: str | None, mime_type: str | None, is_stream: bool)",
"Dict(path: str, url: str | None, size: int | None, orig_name: str | None, mime_type: str | None, is_stream: bool, meta: Dict())",
]
CURRENT_FILE_DATA_FORMAT = FILE_DATA_FORMATS[-1]
def json_schema_to_python_type(schema: Any) -> str:
type_ = _json_schema_to_python_type(schema, schema.get("$defs"))
return type_.replace(CURRENT_FILE_DATA_FORMAT, "filepath")
def _json_schema_to_python_type(schema: Any, defs) -> str:
"""Convert the json schema into a python type hint"""
if schema == {}:
return "Any"
type_ = get_type(schema)
if type_ == {}:
if "json" in schema.get("description", {}):
return "Dict[Any, Any]"
else:
return "Any"
elif type_ == "$ref":
return _json_schema_to_python_type(defs[schema["$ref"].split("/")[-1]], defs)
elif type_ == "null":
return "None"
elif type_ == "const":
return f"Literal[{schema['const']}]"
elif type_ == "enum":
return (
"Literal[" + ", ".join(["'" + str(v) + "'" for v in schema["enum"]]) + "]"
)
elif type_ == "integer":
return "int"
elif type_ == "string":
return "str"
elif type_ == "boolean":
return "bool"
elif type_ == "number":
return "float"
elif type_ == "array":
items = schema.get("items", [])
if "prefixItems" in items:
elements = ", ".join(
[_json_schema_to_python_type(i, defs) for i in items["prefixItems"]]
)
return f"Tuple[{elements}]"
elif "prefixItems" in schema:
elements = ", ".join(
[_json_schema_to_python_type(i, defs) for i in schema["prefixItems"]]
)
return f"Tuple[{elements}]"
else:
elements = _json_schema_to_python_type(items, defs)
return f"List[{elements}]"
elif type_ == "object":
def get_desc(v):
return f" ({v.get('description')})" if v.get("description") else ""
props = schema.get("properties", {})
des = [
f"{n}: {_json_schema_to_python_type(v, defs)}{get_desc(v)}"
for n, v in props.items()
if n != "$defs"
]
if "additionalProperties" in schema:
des += [
f"str, {_json_schema_to_python_type(schema['additionalProperties'], defs)}"
]
des = ", ".join(des)
return f"Dict({des})"
elif type_ in ["oneOf", "anyOf"]:
desc = " | ".join([_json_schema_to_python_type(i, defs) for i in schema[type_]])
return desc
elif type_ == "allOf":
data = ", ".join(_json_schema_to_python_type(i, defs) for i in schema[type_])
desc = f"All[{data}]"
return desc
else:
raise APIInfoParseError(f"Cannot parse schema {schema}")
def traverse(json_obj: Any, func: Callable, is_root: Callable[..., bool]) -> Any:
if is_root(json_obj):
return func(json_obj)
elif isinstance(json_obj, dict):
new_obj = {}
for key, value in json_obj.items():
new_obj[key] = traverse(value, func, is_root)
return new_obj
elif isinstance(json_obj, (list, tuple)):
new_obj = []
for item in json_obj:
new_obj.append(traverse(item, func, is_root))
return new_obj
else:
return json_obj
def value_is_file(api_info: dict) -> bool:
info = _json_schema_to_python_type(api_info, api_info.get("$defs"))
return any(file_data_format in info for file_data_format in FILE_DATA_FORMATS)
def is_filepath(s) -> bool:
"""
Check if the given value is a valid str or Path filepath on the local filesystem, e.g. "path/to/file".
"""
return isinstance(s, (str, Path)) and Path(s).exists() and Path(s).is_file()
def is_file_obj(d) -> bool:
"""
Check if the given value is a valid FileData object dictionary in versions of Gradio<=4.20, e.g.
{
"path": "path/to/file",
}
"""