o h#@sXddlmZGdddZGdddeZGdddeZGdd d eZeZZd S) )wrapsc@seZdZdZd#ddZddZdd Zd d Zd d ZddZ ddZ ddZ d$ddZ d%ddZ ddZddZddZdd Zed%d!d"ZdS)&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)`` NrcKs ||_||_|p i|_||_dSN)sizevaluehookskw)selfrrrkwargsr d/var/www/html/construction_image-detection-poc/venv/lib/python3.10/site-packages/fsspec/callbacks.py__init__s  zCallback.__init__cCs|Srr r r r r __enter__zCallback.__enter__cGs |dSrclose)r exc_argsr r r __exit__"s zCallback.__exit__cCdS)zClose callback.Nr rr r r r%szCallback.closecKs|||||dtS)a Return callback 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 function returns a callback that has to be passed to the child method, e.g., put_file, as `callback=` argument. The implementation uses `callback.branch` for compatibility. When implementing callbacks, it is recommended to override this function instead of `branch` and avoid calling `super().branched(...)`. Prefer using this function over `branch`. Parameters ---------- path_1: str Child's source path path_2: str Child's destination path **kwargs: Arbitrary keyword arguments Returns ------- callback: Callback A callback instance to be passed to the child method callback)branchpopDEFAULT_CALLBACKr path_1path_2r r r r branched(s zCallback.branchedcs tdtffdd }|S)zI Wraps a coroutine, and pass a new child callback to it. path2csVj||fi|}||fd|i|IdHWdS1s$wYdS)Nr)r)path1rr childfnr r r funcNs$z"Callback.branch_coro..func)rstr)r r"r#r r!r branch_coroIszCallback.branch_corocC||_|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)rcall)r rr r r set_sizeUs zCallback.set_sizecCr&)z Set the internal value state Triggers ``call()`` Parameters ---------- value: int Nrr')r rr r r absolute_updatecs zCallback.absolute_updatecCs|j|7_|dS)z Delta increment the internal counter Triggers ``call()`` Parameters ---------- inc: int Nr))r incr r r relative_updateps 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 r'}s    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-)r iterableitemr r r wraps  z Callback.wrapcCr)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 rr r r rszCallback.branchcOdSrr )r ___r r r no_oprzCallback.no_opcCs|jS)zP If undefined methods are called on this class, nothing happens )r9)r r4r 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)r)clsmaybe_callbackr r r as_callbackszCallback.as_callback)NrN)r+r)__name__ __module__ __qualname____doc__r rrrrr%r(r*r-r'r5rr9r: classmethodr=r r r r rs$ !   rc@seZdZdZddZdS) NoOpCallbackz> This implementation of Callback does exactly nothing cOr6rr r argsr r r r r'rzNoOpCallback.callN)r>r?r@rAr'r r r r rCs rCcs2eZdZdZd 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.rN)rFrr r r rszDotPrinterCallback.branchcKst|jdddS)zJust outputs a character)endN)printrH)r r r r r r'szDotPrinterCallback.call)rG)r>r?r@rAr rr' __classcell__r r rKr rFs rFcs:eZdZdZd fdd ZddZddZd d ZZS) TqdmCallbacka 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_cls`. tqdm_cls: (optional) subclass of `tqdm.tqdm`. If not passed, it will default to `tqdm.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"}), ) You can also customize the progress bar by passing a subclass of `tqdm`. .. code-block:: python class TqdmFormat(tqdm): '''Provides a `total_time` format parameter''' @property def format_dict(self): d = super().format_dict total_time = d["elapsed"] * (d["total"] or 0) / max(d["n"], 1) d.update(total_time=self.format_interval(total_time) + " in total") return d >>> with TqdmCallback( tqdm_kwargs={ "desc": "desc", "bar_format": "{total_time}: {percentage:.0f}%|{bar}{r_bar}", }, tqdm_cls=TqdmFormat, ) as callback: fs.upload(".", path2distant_data, recursive=True, callback=callback) Nc shzddlm}Wnty}ztd|d}~ww|d||_|p$i|_d|_tj|i|dS)Nr)tqdmz0Using TqdmCallback requires tqdm to be installedtqdm_cls)rS ImportErrorr _tqdm_cls _tqdm_kwargsrIr )r tqdm_kwargsrEr rSexcerKr r r 's zTqdmCallback.__init__cOsH|jdur|jdd|ji|j|_|j|j_|j|j|jjdS)Ntotalr )rSrVrrWrZr/rnrDr r r r'5s  zTqdmCallback.callcCs"|jdur|jd|_dSdSr)rSrrr r r r;s   zTqdmCallback.closecCs|Srrrr r r __del__@szTqdmCallback.__del__r) r>r?r@rAr r'rr\rQr r rKr rRs 9rRN) functoolsrrrCrFrRr_DEFAULT_CALLBACKr r r r s L W