+ &j#z^RIHt!RR4t!RR]4t!RR]4t!RR ]4t]!4;ttR #) wrapsca]tRt^toRtRRltRtRtRtRt Rt R t R t RR lt RR ltR tRtRtRt]RRl4tRtVtR#)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 LWnW nT;'g/VnW@nR#N)sizevaluehookskw)selfr r r kwargss&&&&,h/Users/jameslopez/projects/CWCArchive/cwc-podcast/.venv/lib/python3.14/site-packages/fsspec/callbacks.py__init__Callback.__init__s  [[b cV#rr s&r __enter__Callback.__enter__s rc&VP4R#rclose)r exc_argss&*r__exit__Callback.__exit__"s  rc R#)zClose callback.Nrrs&rrCallback.close%src RVPWV4VPR\4#)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*&677rc :aa\S4RVV3Rll4pV#)z9 Wraps a coroutine, and pass a new child callback to it. c$V^8dQhR\/#)path2)str)formats"r __annotate__*Callback.branch_coro..__annotate__Os H HS Hrc<"SP!W3/VB;_uu_4pS!W3RV/VBGRjxL uuRRR4#L +'giR#;i5i)r!N)r()path1r-rchildfnr s&&, rfunc"Callback.branch_coro..funcNsGu6v66%GuGGG76G766s%A?=? A? A Ar)r r5r6sff r branch_coroCallback.branch_coroIs* r H H  H rc 2WnVP4R#)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  rc 2WnVP4R#)zU Set the internal value state Triggers ``call()`` Parameters ---------- value: int Nr r;)r r s&&rabsolute_updateCallback.absolute_updatecs  rc XV;PV, unVP4R#)z[ Delta increment the internal counter Triggers ``call()`` Parameters ---------- inc: int Nr?)r incs&&rrelative_updateCallback.relative_updateps c  rc VP'gR#VPP4pVPV4V'dBWP9dR#VPV,!VPVP 3/VB#VPP 4;'g.F!pV!VPVP 3/VBK# R#)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&&, rr; Callback.call}szzz  WW\\^ &  *::i(DJJE"E EJJ%%'--2-D DJJ -" -.rc# H"VFpVP4VxK R#5i)z Wrap an iterable to call ``relative_update`` on each iterations Parameters ---------- iterable: Iterable The iterable that is being wrapped N)rD)r iterableitems&& rwrap Callback.wraps"D  "Js "c R#)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,rcR#rr)r ___s&*,rno_opCallback.no_ops rc VP#)z@ If undefined methods are called on this class, nothing happens )rW)r rOs&&r __getattr__Callback.__getattr__szzrc Vf\#V#)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(r8r<r@rDr;rPr"rWrZ classmethodr___static_attributes____classdictcell__ __classdict__s@rrrse( 8B    .. 0    rrc*a]tRt^toRtRtRtVtR#) NoOpCallbackz6 This implementation of Callback does exactly nothing cR#rrr argsrs&*,rr;NoOpCallback.callsrrN)rbrcrdrerfr;rhrirjs@rrmrmsrrmcFaa]tRt^toRtRV3RlltRtRtRtVt V;t #)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 4<Wn\SV`!R/VBR#)Nr)chrsuperr)r chr_to_printr __class__s&&,rrDotPrinterCallback.__init__s "6"rc "\R4VR&R#)z;Mutate kwargs to add new instance with different print char.r!N)rsr%s&&&&rr"DotPrinterCallback.branchs/4zrc 4\VPRR7R#)zJust outputs a character)endN)printru)r rs&,rr;DotPrinterCallback.calls dhhBr)ru)#) rbrcrdrerfrr"r;rhri __classcell__rxrks@@rrsrss#5  rrscLaa]tRt^toRtRV3RlltRtRtRtRt Vt V;t #) 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<^RIHpTPRT4TnT;'g/TnRTn\ ST`!T/TBR# \dp\R4ThRp?ii;i)r)tqdmz0Using TqdmCallback requires tqdm to be installedNtqdm_cls)r ImportErrorr# _tqdm_cls _tqdm_kwargsrvr)r tqdm_kwargsrprrexcerxs&&*, rrTqdmCallback.__init__'sm  ! J5'--2  $)&) B  sA A& A!!A&c2VPf.VP!RRVP/VPBVnVPVPnVPP VP VPP, 4R#)Ntotalr)rrr rrrHr nros&*,rr;TqdmCallback.call5s` 99 LTYYL$:K:KLDI))  diikk12rchVPe$VPP4RVnR#R#r)rrrs&rrTqdmCallback.close;s& 99 IIOO DI !rc"VP4#rrrs&r__del__TqdmCallback.__del__@szz|r)rrrr) rbrcrdrerfrr;rrrhrirrs@@rrrs$7r *3  rrN) functoolsrrrmrsrr$_DEFAULT_CALLBACKrrrrsLHHV8  *T8Tn(4~5$r