OOIdGddZGddeZGddeZGddeZeZdS) cfeZdZdZddZdZdZddZdd Zd Z d Z d Z d Z e ddZdS)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 B||_||_|pi|_||_dSN)sizevaluehookskw)selfrrr kwargss 0lib/python3.11/site-packages/fsspec/callbacks.py__init__zCallback.__init__s&  [b c<||_|dS)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  rc<||_|dS)z Set the internal value state Triggers ``call()`` Parameters ---------- value: int Nrr)r rs r absolute_updatezCallback.absolute_update*s  rcN|xj|z c_|dS)z Delta increment the internal counter Triggers ``call()`` Parameters ---------- inc: int Nrr incs r relative_updatezCallback.relative_update7s% c  rc 0|jsdS|j}|||r*||jvrdS|j||j|jfi|S|jpgD]}||j|jfi|dS)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)r r copyupdaterrvalues)r hook_namer r hooks r rz Callback.callDsz  F W\\^^ &  F **(4:i(DJEE"EE EJ%%''-2 . .D DDJ - -" - - - - . .rc#DK|D]}||VdS)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  " " "JJJJ  rcdS)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 ,trcdSrr')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__s zrc|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)NrNrr)__name__ __module__ __qualname____doc__rrrrrr%r+r/r1 classmethodr6r'rr rrs(          .....   0       [   rrceZdZdZdZdS) NoOpCallbackz> This implementation of Callback does exactly nothing cdSrr')r argsr s r rzNoOpCallback.callstrN)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 H||_tjdi|dS)Nr')chrsuperr)r chr_to_printr __class__s r rzDotPrinterCallback.__init__s-""6"""""rc*td|d<dS)z;Mutate kwargs to add new instance with different print char.callbackN)rBr(s r r+zDotPrinterCallback.branchs/44zrc 2t|jddS)zJust outputs a character)endN)printrE)r r s r rzDotPrinterCallback.calls dhBr)rC)r8r9r:r;rr+r __classcell__rHs@r rBrBse######555       rrBc8eZdZdZdfd ZdZd dZdZxZS) 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"}), ) Nc ddl}||_n"#t$r}td|d}~wwxYw|pi|_t j|i|dS)Nrz0Using TqdmCallback requires tqdm to be installed)tqdm_tqdm ImportError _tqdm_kwargsrFr)r tqdm_kwargsr@r rUexcerHs r rzTqdmCallback.__init__s  KKKDJJ   B   (-2$)&)))))s  .).cB|jjdd|i|j|_dS)Ntotalr')rVrUrXrs r rzTqdmCallback.set_sizes)#DJODD$D$2CDD rrc:|j|dSr)rUrrs r rzTqdmCallback.relative_updates rcF|jd|_dSr)rUclose)r s r __del__zTqdmCallback.__del__s  rrr7) r8r9r:r;rrrr`rPrQs@r rSrSs}B * * * * * *EEErrSN)rr>rBrSr3r'rr rasRRRRRRRRj8        *777778777t!LNNr