]j#xSSKJr "SS5r"SS\5r"SS\5r"SS \5r\"5=rrg ) )wrapsc\rSrSrSrSSjrSrSrSrSr S r S r S r SS jr SS jrSrSrSrSr\SSj5rSrg)Callbackah 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 HXlX lU=(d 0UlX@lgN)sizevaluehookskw)selfr r r kwargss M/home/mande/repo/quber/.venv/lib/python3.13/site-packages/fsspec/callbacks.py__init__Callback.__init__s  [b cU$rr s r __enter__Callback.__enter__s rc$UR5 grclose)r exc_argss r__exit__Callback.__exit__"s  rcg)zClose callback.Nrrs rrCallback.close%src RURXU5 URS[5$)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_2rs rbranchedCallback.branched(s$: FF+zz*&677rcD^^[T5S[4UU4Sjj5nU$)z9 Wraps a coroutine, and pass a new child callback to it. path2c># TR"X40UD6nT"X4SU0UD6IShvN sSSS5 $N !,(df  g=f7f)Nr!)r()path1r+rchildfnr s rfunc"Callback.branch_coro..funcNsAu6v6%GuGGG76G76s%A646 A6 AA)rstr)r r/r0s`` r branch_coroCallback.branch_coroIs, r HS H  H rc0XlUR5 g)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)r call)r r s rset_sizeCallback.set_sizeUs  rc0XlUR5 g)zU Set the internal value state Triggers ``call()`` Parameters ---------- value: int Nr r6)r r s rabsolute_updateCallback.absolute_updatecs  rcNU=RU- slUR5 g)z[ Delta increment the internal counter Triggers ``call()`` Parameters ---------- inc: int Nr:)r incs rrelative_updateCallback.relative_updateps c  rc UR(dgURR5nURU5 U(a;XR;agURU"URUR 40UD6$URR 5=(d /H!nU"URUR 40UD6 M# g)z 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 copyupdater r values)r hook_namerr hooks rr6 Callback.call}szz  WW\\^ &  *::i(DJJE"E EJJ%%'-2-D DJJ -" -.rc#F# UHnUR5 Uv M g7f)z Wrap an iterable to call ``relative_update`` on each iterations Parameters ---------- iterable: Iterable The iterable that is being wrapped N)r?)r iterableitems rwrap Callback.wraps"D  "Js!cg)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 ------- Nrr%s rr"Callback.branchs,rcgrr)r ___s rno_opCallback.no_ops rcUR$)z@ If undefined methods are called on this class, nothing happens )rR)r rJs r __getattr__Callback.__getattr__szzrcUc[$U$)zTransform 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. )r$)clsmaybe_callbacks r as_callbackCallback.as_callbacks  !# #r)r r r r )NrN)r)__name__ __module__ __qualname____firstlineno____doc__rrrrr(r3r7r;r?r6rKr"rRrU classmethodrZ__static_attributes__rrrrrsb( 8B    .. 0    rrc\rSrSrSrSrSrg) NoOpCallbackz6 This implementation of Callback does exactly nothing cgrrr argsrs rr6NoOpCallback.callsrrN)r]r^r_r`rar6rcrrrreres rrec<^\rSrSrSrSU4SjjrSrSrSrU=r $)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>Xl[TU]"S0UD6 g)Nr)chrsuperr)r chr_to_printr __class__s rrDotPrinterCallback.__init__s "6"rc [S5US'g)z;Mutate kwargs to add new instance with different print char.r!N)rlr%s rr"DotPrinterCallback.branchs/4zrc ,[URSS9 g)zJust outputs a character)endN)printro)r rs rr6DotPrinterCallback.calls dhhBr)ro)#) r]r^r_r`rarr"r6rc __classcell__rrs@rrlrls#5  rrlcB^\rSrSrSrSU4SjjrSrSrSrSr U=r $) TqdmCallbacka7 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) c>SSKJn URSU5UlU=(d 0UlSUl[ TU]"U0UD6 g![an[S5UeSnAff=f)Nr)tqdmz0Using TqdmCallback requires tqdm to be installedtqdm_cls)r ImportErrorr# _tqdm_cls _tqdm_kwargsrpr)r tqdm_kwargsrirrexcerrs rrTqdmCallback.__init__'sj  ! J5'-2  $)&) B  sA A# AA#c&URc-UR"SSUR0URD6UlURURlURR UR URR- 5 g)Ntotalr)rrr rrrCr nrhs rr6TqdmCallback.call5s` 99 LTYYL$:K:KLDI))  diikk12rcbURb"URR5 SUlggr)rrrs rrTqdmCallback.close;s& 99 IIOO DI !rc"UR5$rrrs r__del__TqdmCallback.__del__@szz|r)rrrr) r]r^r_r`rarr6rrrcr}r~s@rrrs"7r *3  rrN) functoolsrrrerlrr$_DEFAULT_CALLBACKrrrrsLHHV8  *T8Tn(4~5$r