"hhGddZGddeZGddeZGddeZeZy) c^eZdZdZd dZdZdZddZddZdZ d Z d Z d Z e dd Zy)Callbacka Base class and interface for callback mechanism This class can be used directly for monitoring file transfers by providing ``callback=Callback(hooks=...)`` (see the ``hooks`` argument, below), or subclassed for more specialised behaviour. Parameters ---------- size: int (optional) Nominal quantity for the value that corresponds to a complete transfer, e.g., total number of tiles or total number of bytes value: int (0) Starting internal counter value hooks: dict or None A dict of named functions to be called on each update. The signature of these must be ``f(size, value, **kwargs)`` Nc D||_||_|xsi|_||_yN)sizevaluehookskw)selfrrrkwargss M/var/www/html/sandstorm/venv/lib/python3.12/site-packages/fsspec/callbacks.py__init__zCallback.__init__s"  [b c2||_|jy)z Set the internal maximum size attribute Usually called if not initially set at instantiation. Note that this triggers a ``call()``. Parameters ---------- size: int N)rcallr rs r set_sizezCallback.set_sizes  rc2||_|jy)z Set the internal value state Triggers ``call()`` Parameters ---------- value: int Nrr)r rs r absolute_updatezCallback.absolute_update*s  rcN|xj|z c_|jy)z Delta increment the internal counter Triggers ``call()`` Parameters ---------- inc: int Nrr incs r relative_updatezCallback.relative_update7s c  rc n|jsy|jj}|j||r:||jvry|j||j|j fi|S|jj xsgD] }||j|j fi|"y)a Execute hook(s) with current state Each function is passed the internal size and current value Parameters ---------- hook_name: str or None If given, execute on this hook kwargs: passed on to (all) hook(s) N)rr copyupdaterrvalues)r hook_namer r hooks r rz Callback.callDszz  WW\\^ &  *(4::i(DJJE"E EJJ%%'-2 .D DJJ -" - .rc#BK|D]}|j|yw)z Wrap an iterable to call ``relative_update`` on each iterations Parameters ---------- iterable: Iterable The iterable that is being wrapped N)r)r iterableitems r wrapz Callback.wrap[s( D  "J scy)a; Set callbacks for child transfers If this callback is operating at a higher level, e.g., put, which may trigger transfers that can also be monitored. The passed kwargs are to be *mutated* to add ``callback=``, if this class supports branching to children. Parameters ---------- path_1: str Child's source path path_2: str Child's destination path kwargs: dict arguments passed to child method, e.g., put_file. Returns ------- Nr path_1path_2r s r branchzCallback.branchhs,rcyrr%)r ___s r no_opzCallback.no_ops rc|jS)zP If undefined methods are called on this class, nothing happens )r-)r r"s r __getattr__zCallback.__getattr__szzrc|tS|S)aTransform callback=... into Callback instance For the special value of ``None``, return the global instance of ``NoOpCallback``. This is an alternative to including ``callback=_DEFAULT_CALLBACK`` directly in a method signature. )_DEFAULT_CALLBACK)clsmaybe_callbacks r as_callbackzCallback.as_callbacks  !$ $r)NNr)__name__ __module__ __qualname____doc__r rrrrr#r)r-r/ classmethodr4r%rr rrsH(   .. 0    rrceZdZdZdZy) NoOpCallbackz> This implementation of Callback does exactly nothing cyrr%)r argsr s r rzNoOpCallback.callsrN)r8r9r:r;rr%rr r>r>s rr>c0eZdZdZdfd ZdZdZxZS)DotPrinterCallbackz Simple example Callback implementation Almost identical to Callback with a hook that prints a char; here we demonstrate how the outer layer may print "#" and the inner layer "." c 2||_t|di|y)Nr%)chrsuperr )r chr_to_printr __class__s r r zDotPrinterCallback.__init__s "6"rc td|d<y)z;Mutate kwargs to add new instance with different print char.callbackN)rBr&s r r)zDotPrinterCallback.branchs/4zrc 2t|jdy)zJust outputs a character)endN)printrD)r r s r rzDotPrinterCallback.calls dhhBr)#)r8r9r:r;r r)r __classcell__rGs@r rBrBs#5 rrBc8eZdZdZdfd ZdZddZdZxZS) TqdmCallbackae A callback to display a progress bar using tqdm Parameters ---------- tqdm_kwargs : dict, (optional) Any argument accepted by the tqdm constructor. See the `tqdm doc `_. Will be forwarded to tqdm. Examples -------- >>> import fsspec >>> from fsspec.callbacks import TqdmCallback >>> fs = fsspec.filesystem("memory") >>> path2distant_data = "/your-path" >>> fs.upload( ".", path2distant_data, recursive=True, callback=TqdmCallback(), ) You can forward args to tqdm using the ``tqdm_kwargs`` parameter. >>> fs.upload( ".", path2distant_data, recursive=True, callback=TqdmCallback(tqdm_kwargs={"desc": "Your tqdm description"}), ) c ddl}||_|xsi|_t ||i|y#t$r}td|d}~wwxYw)Nr5z0Using TqdmCallback requires tqdm to be installed)tqdm_tqdm ImportError _tqdm_kwargsrEr )r tqdm_kwargsr@r rUexcerGs r r zTqdmCallback.__init__sX  DJ (-2 $)&)  B  s ) A >Ac^|jjdd|i|j|_y)Ntotalr%)rVrUrXrs r rzTqdmCallback.set_sizes&#DJJOOD$D$2C2CD rc:|jj|yr)rUrrs r rzTqdmCallback.relative_updates rcF|jjd|_yr)rUclose)r s r __del__zTqdmCallback.__del__s  rrr6) r8r9r:r;r rrr`rPrQs@r rSrSsB *ErrSN)rr>rBrSr1r%rr rasARRj8  *787t!Nr