XjJ dZddlZddlZddlmZddlmZmZmZddl Z ddl m Z m Z m Z mZmZmZmZmZmZmZmZmZddlmZddlmZmZdd lmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&dd l'm(Z(m)Z)dd l*m+Z+dd l,m-Z-m.Z.m/Z/m0Z0e&d Z1e&dZ2e13e2de&dZ4e13e4dee5e(dfZ6ede5de5dzde5dzdeefdZ7e18dgd dtdee5dze(dfdee5dze)d d!fd"e-d#ee5dze)d$fd%ed&e d'e.d(ed)ed*e"de/d+ee9e)d,d-fde!ddfd.Z:e18d/d0d1id2d3g4 dude6d5ee;e5e(d6fd7ee5dze)d8d9d:fd%ed(ed;eeZ=e18d?d0d1id@dAg4 dvde6d5ee;e5e(dBfd7ee5dze)d8d9d:fd%ed(ede/de!ddfdCZ>e18dDdEdFg dwdGee5e(dHfdIee5e(dJfde/de!ddf dKZ?e18dLgdM dxdee5dze(dNfdOee9e)dPdQfdRee9e)dSdTdUfde/de!ddf dVZ@e28dgdWdde ddddfdee5dze(dXfd"e-dYeeAe)dZdd[e d\]fd^eeAdze)d_dd`]fd#ee5dze)dafde/de!ddfdbZBe28dcddg dwde/de!ddfdeZCe28dfdgg dydhee5e(difdRee9e)dSdTdUfde/de!ddf djZDdke5e;e5zde5fdlZEdede5fdmZFe48dcdng dwde6de/de!ddfdoZGe48dLdpg dwde6dqeeAe(drfde/de!ddf dsZHdS)zzCContains commands to run and manage sandboxes on Hugging Face Jobs.N)contextmanager) AnnotatedAnyIterator) DEFAULT_IDLE_TIMEOUT DEFAULT_IMAGEDEFAULT_SANDBOXES_PER_HOST MODE_LABEL MODE_POOL POOL_LABEL SANDBOX_LABEL SHARED_ID_SEPSandbox SandboxPoolSandboxProcess_split_sandbox_id)delete_pool_cache)CLIError SandboxError) EnvFileOptEnvOptSecretsFileOpt SecretsOptTokenOpt VolumesOpt get_hf_api parse_env_map parse_volumes typer_factory)ArgumentOption)out) FlavorOpt LabelsOpt NamespaceOpt_parse_labels_mapz;Run and manage experimental sandboxes on Hugging Face Jobs.)helpzhWarm host VM pools and spawn experimental shared sandboxes for workloads within the same trust boundary.pool)namez8List and stop background processes running in a sandbox.processz1The sandbox id as printed by `hf sandbox create`. sandbox_id namespacetokenreturnc#Ktj|||} |V|dS#|wxYw)zIReattach to a sandbox and close the HTTP client when the command is done.r-r.N)rconnectclose)r,r-r.sandboxs LC:\Projects\Historical\venv\Lib\site-packages\huggingface_hub/cli/sandbox.py_connectr6DsOojIUKKKG   s 5A create)zhf sandbox createzhf sandbox create ubuntu:24.04z%hf sandbox create --flavor a10g-smallz/hf sandbox create --label controller-run=run-42z@hf sandbox create --pool pool-ab12cd34ef56 --env LOG_LEVEL=debug)examplesFimagezDocker image (needs /bin/sh).z--poolzJSpawn a cheap shared sandbox in this pool (from `hf sandbox pool create`).flavor idle_timeoutzTAuto-terminate the sandbox after this much inactivity (e.g. '10m'). Defaults to 10m.envsecretslabelenv_file secrets_filevolumeforward_hf_tokenz--forward-hf-tokenz0Inject your HF token as HF_TOKEN in the sandbox.c tj} ||nt}|||| rtd|s|rtd|rtdtj|| | t |||| }tjd|j |j |tj| z dd  tj d |j d tj d |j ddStj|pt|pd|t ||t ||t| | | t||  }|tjd|j |jtj| z dd tj d |j d tj d |j ddS)aCreate a sandbox: a dedicated VM by default, or a cheap shared one with `--pool`. Env and idle-timeout apply to the sandbox in both modes. With `--pool`, the image and flavor come from the pool, so passing them here is an error; `--secrets` is also rejected since pooled sandboxes have no encrypted-secrets channel (use `--env`). Define a pool first with `hf sandbox pool create`. NzQ--pool fixes the image/flavor (and volumes aren't supported); drop those options.z--pool has no encrypted-secrets channel. Pass the values with --env/--env-file: on a pooled sandbox they are delivered to the host at creation and are not stored in the job metadata, but they are not encrypted at rest.z2--label is only supported for dedicated sandboxes.r1)r<r;rBz Sandbox ready.1fs)idhostr)elapsedz$Run a command with `hf sandbox exec z -- echo hello`.z#Terminate it with `hf sandbox kill `. cpu-basic) r9r:r;r<r=volumesr-rBlabelsr.)rFr9rH)timerrrr2r7rr#resultrFhost_idhintrrrr'r3r9)r9r)r:r;r<r=r>r?r@rAr-rBr.startidlesbxr4s r5sandbox_createrTNs*P IKKE'3<<9MD    2f 2noo o  l 6   QOPP P!$)5IIIPPc8,,-Q   ?svCKdW[W`WbWbejWjTqTqTqTqrrrr PPPPQQQ AsvAAABBBn$}$ #x ( (g|44f%%) ''   G MMOOOJ7:W]ty{{]bObLiLiLiLijjjjH PGJ P P PQQQH A7: A A ABBBBBexecignore_unknown_optionsTz5hf sandbox exec -- python -c "print(42)"z1hf sandbox exec -w /app -- pytest -x)context_settingsr8commandzThe command to run.workdirz-wz --workdirzWorking directory. exec_timeoutz --timeoutz)Kill the command after this many seconds.c dtddfd}dtddfd} t|||5} | t|t |||||| dd} dddn #1swxYwY| jr?t jd |d tj | j pd | j d kr.tj | j | j nd dS)zRun a command in a sandbox, streaming output. Exits with the command's exit code. To start a long-running command in the background instead of waiting for it, use `hf sandbox spawn`. datar/Nctj|tjdSN)sysstdoutwriteflushr]s r5 write_stdoutz"sandbox_exec..write_stdout2  rUctj|tjdSr_)r`stderrrbrcrds r5 write_stderrz"sandbox_exec..write_stderrrfrUr1F)r<cwdtimeout on_stdout on_stderrcapture_outputcheckzCommand timed out after zs.|)coderr) strr6runlistr timed_outr#errorclick exceptionsExit exit_code) r,rYrZr<r?r[r-r.rerir4rNs r5 sandbox_execr{s|43434 *  ? ? ?  7 MMc8,, ""                    B =\===>>>##)9)@S#AAA 1##V=M=Y)9)9_`#aaas9A22A69A6spawnz;hf sandbox spawn -- python -m http.server 8000z8hf sandbox spawn -w /app -- uvicorn app:appz%The command to run in the background.cjt|||5}|t|t|||d}dddn #1swxYwYt jd||jt jd|dt jd |d |jddS) zStart a long-running command in the background and return its pid (don't wait). List a sandbox's processes with `hf sandbox process ls` and stop one with `hf sandbox process kill`. r1T)r<rj backgroundNzProcess startedr4pidz+List processes with `hf sandbox process ls rIz&Stop it with `hf sandbox process kill  )r6rsrtrr#rNrrP) r,rYrZr<r?r-r.r4r+s r5 sandbox_spawnrs, *  ? ? ?m7++d7mmsH1M1MSZgk+llmmmmmmmmmmmmmmmJ *'+FFFFH I: I I IJJJH Rj R R7; R R RSSSSSs5AAAcpz2hf sandbox cp data.csv :/data/data.csvz7hf sandbox cp :/app/result.json result.jsonsrcz,Source: a local path or :.dstz1Destination: a local path or :.cdtdttdztffd}||\}}||\}}|du|dukrtd|Ft|||5} | j||dddn #1swxYwYnI|Jt|||5} | j||dddn #1swxYwYtjd||dS) zCCopy a file between the local machine and a sandbox (docker-style).refr/Ncd|vrE|ds0|dd\}}t|dkr||fSd|fS)N:)./~r) startswithsplitlen)rr,paths r5parsezsandbox_cp..parses[ #::cnn_==:"yya00 J:""!4''SyrUzHExactly one of SRC and DST must be a sandbox path (:).r1Copied)rr) rrtuplerr6filesdownloaduploadr#rN) rrr-r.r src_sandboxsrc_path dst_sandboxdst_pathr4s r5 sandbox_cprs35tS1"E#JJK!E#JJKt!455abbb kYe D D D 7 M " "8X 6 6 6 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7&&& kYe D D D 5 M 8 4 4 4 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5JxSc******s$1BB B;C##C'*C'kill)zhf sandbox kill zKhf sandbox kill # kills a whole shared host (all its sandboxes)zhf sandbox kill --allz$The sandbox or host id to terminate.all_z--allz2Terminate every sandbox and host in the namespace.yesz-yz--yesz$Answer Yes to prompts automatically.cHt|}|rt|ddgtdi|}|st jddSt jdt|d | |D](}||j |j j )t j d t| dS|tdt||\}} t|vr t!|||5} | dddn #1swxYwYn/#t$$r"} tt'| | d} ~ wwxYwt j d|dS||| }|jpit.t0krXt jd|d| ||j |j j t j d|dS t!|||5} | dddn #1swxYwYn/#t$$r"} tt'| | d} ~ wwxYwt j d|dS)z@Terminate a sandbox, a whole shared host, or everything (--all).r.RUNNING SCHEDULING1statusrLr-zNo running sandboxes.N Terminate zA sandbox job(s) (including shared hosts and all their sandboxes)?rjob_idr- Terminated)jobsz*Provide a sandbox id, a host id, or --all.r1zSandbox terminated)rFzTerminate shared host z and all of its sandboxes?zHost terminated)rrt list_jobsr r#textconfirmr cancel_jobrFownerr*rNrrrr6rrrr inspect_jobrLgetr r ) r,rrr-r.apirjobsidnsr4es r5 sandbox_killrs5 5 ! ! !C CMM)\)BM[^K_ktMuuvv  H, - - - F mTmmmsvwwww D DC NN#&CINN C C C C D=D1% D=1D55D=8D59D== E)E$$E)I0I IIIII J 'JJ )zhf sandbox pool createz5hf sandbox pool create python:3.12 --flavor cpu-basicz7hf sandbox pool create --per-host 50 --idle-timeout 30mz+Docker image for the hosts (needs /bin/sh).per_hostz --per-hostz&Sandboxes packed per host VM (default z).)minr( max_hostsz --max-hostsz'Optional cap on the number of host VMs.zZShut a host down once it has had no sandboxes for this long (e.g. '10m'). Defaults to 10m.c ptj}|pt}t||pd||||nt||}|j} |j} t jd| ||pd| dtj|z ddt jd | d t jd | d dS) zRWarm a pool: boot one host VM now, tagged so it can be found later by its pool id.rJN)r9r:sandboxes_per_hostrr;r-r.z Pool createdrrDrE)rFr9r:rGrHz/Spawn a sandbox with `hf sandbox create --pool rIz=Delete the pool (and its hosts) with `hf sandbox pool delete ) rMrrrr*host_idsr#rNrP) r9r:rrr;r-r.rQr)pool_idrs r5 pool_createrSs4 IKKE  "]E $#%1%=\\CW   DiG}HJ $ a[9;;&---- H Jw J J JKKKH XW X X XYYYYYrUz ls | listzhf sandbox pool lsc nt|}i}|dtti|D]}|jpit }|s&t|jtr|jni}| |||j p|j |j |dddd}|dxxd z cc<t|}t!j|d |st!jd dSt!jd dS)z9List running sandbox pools (grouped from their host VMs).rrr SBX_CAPACITYr)rFr9r:rhostsrrrFid_keyz)Create one with `hf sandbox pool create`.z5Spawn a sandbox with `hf sandbox create --pool `.N)rrr r rLrr isinstance environmentdict setdefault docker_imagespace_idr:rtvaluesr#tablerP) r-r.rpoolsrrr<inforowss r5pool_lsrsG 5 ! ! !C')E}}Iz96MYb}cczR$$Z00  !+COT!B!BJcoo )9S\*GGNB77       W     DId4    J <===== HIIIIIrUz delete | rmz hf sandbox pool delete rzPool id to delete.c t|}t|ddgttt |i|}|s)t |tjd|ddStj dt|d |d | |D](}| |j |j j )t |tjd |t|dS)zDTerminate every host VM of a pool (and therefore all its sandboxes).rrrrzNo running hosts for pool 'z'.Nrz host(s) of pool 'z' (and all their sandboxes)?rrz Pool deleted)rFhosts_terminated)rrtrr r r rr#rrrrrFrr*rN)rrr-r.rrrs r5 pool_deleters 5 ! ! !C  |, :w?     E '""" :w:::;;;K`SZZ``7```fijjjj@@ cf ????gJ~'CJJGGGGGGrUcmdcZt|tr|nd|S)Nr)rrrjoin)rs r5_fmt_cmdrs%S#&& 933CHHSMM9rUc<|jrdS|jdn d|jdS)Nrunningexitedzexited ())rrz)r+s r5 _fmt_statusrs2y(0886UAR6U6U6UUrUz"hf sandbox process ls c.t|||5}|}dddn #1swxYwYd|D}tj|d|stjd|ddStjd|d dS) zUList the background processes running in a sandbox (started with `hf sandbox spawn`).r1Ncbg|],}|jt|t|jd-S))rrr)rrrr).0ps r5 zprocess_ls..s3 ` ` `QRAE[^^HQUOO L L ` ` `rUrrz!Start one with `hf sandbox spawn z -- `.z'Stop one with `hf sandbox process kill z `.)r6 processesr#rrP)r,r-r.r4rrs r5 process_lsrs *  ? ? ?(7%%'' ((((((((((((((( ` `V_ ` ` `DId5!!!! Q LZLLLMMMMM O:OOOPPPPPs 488z*hf sandbox process kill rz.The pid as printed by `hf sandbox process ls`.c>t|||5}tfd|Dd}|tdd|d|dddn #1swxYwYt jd|dS) z/Stop a background process running in a sandbox.r1c32K|]}|jk |VdSr_)r)rrrs r5 zprocess_kill..s)GGa!%3,,,,,,GGrUNzNo process with pid z in sandbox rzProcess stoppedr)r6nextrrrr#rN)r,rr-r.r4r+s ` r5 process_killrs *  ? ? ?7GGGG7#4#4#6#6GGGNN ?P#PP:PPPQQ Q   J *#>>>>>>sAA;;A?A?) NNNNNNNNNNNFN)NNNNNN)NNNNN)NN)NFFNN)FNN)I__doc__r`rM contextlibrtypingrrrrwhuggingface_hub._sandboxrrr r r r r rrrrrhuggingface_hub._sandbox_cacherhuggingface_hub.errorsrr _cli_utilsrrrrrrrrrr _frameworkr!r"_outputr#rr$r%r&r' sandbox_clipool_cli add_group process_clirr SandboxIdArgr6rYboolrTrtfloatr{rrrintrrrrrrrrUr5rs JI %%%%%%++++++++++                             =<<<<<99999999                        )(((((((GGGGGGGGGGGGm!^___ = s    hV,,,m![\\\ k 222hh,_````a C$JsTzhW^N_    TX  #'" +FCFC S4Z/N!O!O!OO PFC  d xjkkk m FC  FC d jkkk mFC FCFC FCFC!FC !FC"#FC$  ff)0bcccc%FC* +FC, -FCFCFC  FCR  .5?;\` ")b)b)b tCy((0E"F"F"FF G)bsTz66$ BV#W#W#WW X)b  )b  )b   ff[/Z[[[[ )b)b )b )b)b)b)bX  .5EB\`"TTT tCy((0W"X"X"XX YTsTz66$ BV#W#W#WW XT  T  T  T T TTTT* <A# ++ 3&TUUUU V+ 3&YZZZZ [++  +  ++++@  `dhm_d" /4/4#*hh4Z&[&[&[[\/4 D&&/cdddd e/4 4g4Z[[[[ \/4 /4  /4  /4/4/4/4d  bf #  "(Z(Z S4Z/\!]!]!]] ^(Z (Z |)pRl)p)p)pqqq s(Z d FF=a6_````(Z d pqqq s(Z(Z (Z  !(Z(Z(Z(ZV +)=(>??"JJJ J JJJ@?J> 0 1 `e" HH sHH*>???? @H 4g4Z[[[[ \HH  H  HHH H4:#S /:c::::VVCVVVV  [,P+QRR# Q Q Q Q  Q Q Q QSR Q  V'S&TUU# ? ? ? 3&VWWWW X ? ?  ?  ? ? ?VU ? ? ?rU