← back to Atmos Game
assets/gen/.venv/lib/python3.12/site-packages/fsspec/__pycache__/callbacks.cpython-312.pyc
206 lines
�
c�bj�# � �x � d dl mZ G d� d� Z G d� de� Z G d� de� Z G d� d e� Z e� xZZy
) � )�wrapsc �| � e Zd ZdZdd�Zd� Zd� Zd� Zd� Zd� Z d � Z
d
� Z dd �Z dd �Z
d
� Zd� Zd� Zd� Zedd�� Zy)�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 �D � || _ || _ |xs i | _ || _ y �N)�size�value�hooks�kw)�selfr r r
�kwargss �g/Users/macstudio3/Projects/atmos-game/assets/gen/.venv/lib/python3.12/site-packages/fsspec/callbacks.py�__init__zCallback.__init__ s" � ��� ���
��[�b��
���� c � � | S r � �r s r � __enter__zCallback.__enter__ s � �� r c �$ � | j � y r ��close)r �exc_argss r �__exit__zCallback.__exit__" s � � �
�
� r c � � y)zClose callback.Nr r s r r zCallback.close% s � r c �T � | j |||� |j dt � S )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)�branch�pop�DEFAULT_CALLBACK�r �path_1�path_2r
s r �branchedzCallback.branched( s& � �:
� � �F�F�F�+��z�z�*�&6�7�7r c �@ � �� t �� dt f�� fd� � }|S )zI
Wraps a coroutine, and pass a new child callback to it.
�path2c � � �K � �j | |fi |��5 } �| |fd|i|��� d { ��� cd d d � S 7 �
# 1 sw Y y xY w�w)Nr )r# )�path1r% r
�child�fnr s ��r �funcz"Callback.branch_coro.<locals>.funcN sI �� �� � �� � �u�e�6�v�6�%� ��u� G�u� G�� G�G� 7�6�G�� 7�6�s$ �A�8�6�8�
A�8�A�A)r �str)r r) r* s `` r � branch_corozCallback.branch_coroI s, �� �
�r�� H�S� H�
� H� � r c �2 � || _ | j � y)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 r �set_sizezCallback.set_sizeU s � � �� � � � � r c �2 � || _ | j � y)z�
Set the internal value state
Triggers ``call()``
Parameters
----------
value: int
N�r r. )r r s r �absolute_updatezCallback.absolute_updatec s � � ��
� � � � r c �N � | xj |z
c_ | j � y)z�
Delta increment the internal counter
Triggers ``call()``
Parameters
----------
inc: int
Nr1 )r �incs r �relative_updatezCallback.relative_updatep s � �
�
�
�c��
� � � � r c �n � | j sy| j j � }|j |� |r:|| j vry | j | | j | j
fi |��S | j j
� xs g D ] } || j | j
fi |�� �" y)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 �copy�updater r �values)r � hook_namer
r �hooks r r. z
Callback.call} s� � � �z�z� �
�W�W�\�\�^��
� � �&�� ���
�
�*��(�4�:�:�i�(����D�J�J�E�"�E� E��J�J�%�%�'�-�2�-�D� ����D�J�J� -�"� -� .r c # �B K � |D ] }| j � |�� � y�w)z�
Wrap an iterable to call ``relative_update`` on each iterations
Parameters
----------
iterable: Iterable
The iterable that is being wrapped
N)r5 )r �iterable�items r �wrapz
Callback.wrap� s# � �� � �D� � � � "��J� �s � c � � y)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 r s r r zCallback.branch� s � �, r c � � y r r )r �_�__s r �no_opzCallback.no_op� s � � r c � � | j S )zP
If undefined methods are called on this class, nothing happens
)rD )r r> s r � __getattr__zCallback.__getattr__� s � � �z�z�r c � � |�t S |S )a Transform 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 )�cls�maybe_callbacks r � as_callbackzCallback.as_callback� s � � � !�#� #� � r )Nr N)� r )�__name__�
__module__� __qualname__�__doc__r r r r r# r, r/ r2 r5 r. r? r rD rF � classmethodrJ r r r r r sb � ��(� �� � 8�B
� � � �.�. ��0
�� � � � r r c � � e Zd ZdZd� Zy)� NoOpCallbackz>
This implementation of Callback does exactly nothing
c � � y r r �r �argsr
s r r. zNoOpCallback.call� s � �r N)rL rM rN rO r. r r r rR rR � s � ��r rR c �0 � � e Zd ZdZd� fd� Zd� Zd� Z� xZS )�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 �� || _ t �| � di |�� y )Nr )�chr�superr )r � chr_to_printr
� __class__s �r r zDotPrinterCallback.__init__� s �� � ���
���"�6�"r c � � t d� |d< y)z;Mutate kwargs to add new instance with different print char�.r N)rW r s r r zDotPrinterCallback.branch� s � � /�� 4��z�r c �2 � t | j d�� y)zJust outputs a character� )�endN)�printrY )r r
s r r. zDotPrinterCallback.call� s � �
�d�h�h�B� r )�#)rL rM rN rO r r r. �
__classcell__�r\ s @r rW rW � s �� ��#�5� r rW c �6 � � e Zd ZdZd� fd� Zd� Zd� Zd� Z� xZS )� 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 <https://tqdm.github.io/docs/tqdm/#__init__>`_.
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 � �� ddl m } |j d|� | _ |xs i | _ d | _ t �| � |i |�� y # t $ r}t d� |�d }~ww xY w)Nr )�tqdmz0Using TqdmCallback requires tqdm to be installed�tqdm_cls)ri � ImportErrorr � _tqdm_cls� _tqdm_kwargsrZ r )r � tqdm_kwargsrU r
ri �excer\ s �r r zTqdmCallback.__init__' sj �� � � !� ���J��5��� '� -�2����� �
���$�)�&�)�� � � �B���
�� �s �A � A � A�A c �$ � | j �- | j dd| j i| j ��| _ | j | j _ | j j | j | j j z
� y )N�totalr )ri rl r rm rq r8 r �nrT s r r. zTqdmCallback.call5 sb � � �9�9� �&����L�T�Y�Y�L�$�:K�:K�L�D�I� �)�)�� � �� � � ������d�i�i�k�k�1�2r c �` � | j �"| j j � d | _ y y r )ri r r s r r zTqdmCallback.close; s& � � �9�9� � �I�I�O�O� � �D�I� !r c �" � | j � S r r r s r �__del__zTqdmCallback.__del__@ s � ��z�z�|�r r ) rL rM rN rO r r. r ru rd re s @r rg rg � s �� �7�r *� 3� �
r rg N)� functoolsr r rR rW rg r �_DEFAULT_CALLBACKr r r �<module>rx sL �� �H � H �V�8� � �� �*T �8� T �n (4�~� 5� �$r