o Vګe@sHGdddZGdddeZGdddeZGdddeZeZdS) c@sleZdZdZdddZddZdd Zdd d Zdd dZddZ ddZ ddZ ddZ e dddZdS)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)`` NcKs ||_||_|p i|_||_dSN)sizevaluehookskw)selfrrrkwargsr g/vol/project/2023/60021/g236002117/DeepSeek-Coder/venv/lib/python3.10/site-packages/fsspec/callbacks.py__init__s  zCallback.__init__cC||_|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)rcallrrr r r set_sizes zCallback.set_sizecCr )z Set the internal value state Triggers ``call()`` Parameters ---------- value: int Nrr)rrr r r absolute_update*s zCallback.absolute_updatecCs|j|7_|dS)z Delta increment the internal counter Triggers ``call()`` Parameters ---------- inc: int Nrrincr r r relative_update7s zCallback.relative_updatecKsz|jsdS|j}|||r&||jvrdS|j||j|jfi|S|jp,gD] }||j|jfi|q-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)rrcopyupdaterrvalues)r hook_namer rhookr r r rDs    z Callback.callccs|D] }||VqdS)z Wrap an iterable to call ``relative_update`` on each iterations Parameters ---------- iterable: Iterable The iterable that is being wrapped N)r)riterableitemr r r wrap[s  z Callback.wrapcCsdS)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 rpath_1path_2r r r r branchhszCallback.branchcOdSrr )r___r r r no_opzCallback.no_opcCs|jS)zP If undefined methods are called on this class, nothing happens )r&)rrr r r __getattr__szCallback.__getattr__cCs|durtS|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. N)_DEFAULT_CALLBACK)clsmaybe_callbackr r r as_callbackszCallback.as_callback)NrNrr)__name__ __module__ __qualname____doc__r rrrrrr"r&r( classmethodr,r r r r rs   rc@seZdZdZddZdS) NoOpCallbackz> This implementation of Callback does exactly nothing cOr#rr )rargsr r r r rr'zNoOpCallback.callN)r.r/r0r1rr r r r r3s r3cs2eZdZdZd fdd ZddZddZZS) 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 s||_tjdi|dS)Nr )chrsuperr )r chr_to_printr  __class__r r r szDotPrinterCallback.__init__cCstd|d<dS)z;Mutate kwargs to add new instance with different print char.callbackN)r5rr r r r"szDotPrinterCallback.branchcKst|jdddS)zJust outputs a character)endN)printr7)rr r r r rszDotPrinterCallback.call)r6)r.r/r0r1r r"r __classcell__r r r:r r5s r5cs<eZdZdZd fdd ZddZd dd Zd d ZZS) 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 sVz ddl}||_Wnty}ztd|d}~ww|pi|_tj|i|dS)Nrz0Using TqdmCallback requires tqdm to be installed)tqdm_tqdm ImportError _tqdm_kwargsr8r )r tqdm_kwargsr4r rCexcer:r r r s  zTqdmCallback.__init__cCs|jjdd|i|j|_dS)Ntotalr )rDrCrFrr r r rszTqdmCallback.set_sizercCs|j|dSr)rCrrr r r rszTqdmCallback.relative_updatecCs|jd|_dSr)rCclose)rr r r __del__s  zTqdmCallback.__del__rr-) r.r/r0r1r rrrKrAr r r:r rBs ! rBN)rr3r5rBr)r r r r s   :