File: //home/arjun/projects/env/lib/python3.10/site-packages/filelock/__pycache__/_api.cpython-310.pyc
o
!weT. � @ s d dl mZ d dlZd dlZd dlZd dlZd dlZd dlmZm Z d dl
m Z d dl m
Z
d dlmZmZmZ d dlmZ dd lmZ erbd dlZd d
lmZ ejd kr\d d lmZ nd d lmZ e� d
�Z G dd� d�Z e G dd� d��Z G dd� de e
�Z G dd� deej!�Z"ddgZ#dS )� )� annotationsN)�ABC�abstractmethod)� dataclass)�local)�
TYPE_CHECKING�Any�ClassVar)�WeakValueDictionary� )�Timeout)�
TracebackType)� � )�Self�filelockc @ s. e Zd ZdZddd�Zddd �Zddd�ZdS )�AcquireReturnProxyzDA context aware object that will release the lock file when exiting.�lock� BaseFileLock�return�Nonec C s
|| _ d S �N�r )�selfr � r �F/home/arjun/projects/env/lib/python3.10/site-packages/filelock/_api.py�__init__# s
zAcquireReturnProxy.__init__c C � | j S r r �r r r r � __enter__& s z AcquireReturnProxy.__enter__�exc_type�type[BaseException] | None� exc_value�BaseException | None� traceback�TracebackType | Nonec C s | j �� d S r )r �release�r r r" r$ r r r �__exit__) s zAcquireReturnProxy.__exit__N)r r r r )r r �r r! r" r# r$ r% r r )�__name__�
__module__� __qualname__�__doc__r r r( r r r r r s
r c @ sB e Zd ZU dZded< ded< ded< dZd ed
< d Zded < dS )
�FileLockContextzBA dataclass which holds the context for a ``BaseFileLock`` object.�str� lock_file�float�timeout�int�modeNz
int | None� lock_file_fdr � lock_counter)r* r+ r, r- �__annotations__r5 r6 r r r r r. 2 s
r. c @ s e Zd ZdZdS )�ThreadLocalFileContextz8A thread local version of the ``FileLockContext`` class.N)r* r+ r, r- r r r r r8 I s r8 c s e Zd ZU dZe� Zded< dHdd�dI� fdd�Z dHdd�dJdd�ZdKdd �Z e
dKd d ��Z e
dLd d!��Z e
dMd"d#��Z
e
jdNd&d#��Z
edOd'd(��ZedOd)d*��Ze
dKd+d,��Ze
dPd-d.��Z / 0dQd/dd1�dRd7d8�ZdSdTd:d;�ZdUd<d=�ZdVdDdE�ZdOdFdG�Z� ZS )Wr z+Abstract base class for a file lock object.z0ClassVar[WeakValueDictionary[str, BaseFileLock]]�
_instances���� TF)� is_singletonr0 �str | os.PathLike[str]r2 r1 r4 r3 � thread_local�boolr< �kwargs�dict[str, Any]r r c sB |st � �| �S | j�t|��}|s t � �| �}|| jt|�< |S )zYCreate a new lock object or if specified return the singleton instance for the lock file.)�super�__new__r9 �getr/ )�clsr0 r2 r4 r> r< r@ �instance�� __class__r r rC R s zBaseFileLock.__new__r c C s: || _ || _t�|�||d�}|rtntdi |��| _dS )a�
Create a new lock object.
:param lock_file: path to the file
:param timeout: default timeout when acquiring the lock, in seconds. It will be used as fallback value in the acquire method, if no timeout value (``None``) is given. If you want to disable the timeout, set it to a negative value. A timeout of 0 means, that there is exactly one attempt to acquire the file lock.
:param mode: file permissions for the lockfile
:param thread_local: Whether this object's internal context should be thread local or not. If this is set to ``False`` then the lock will be reentrant across threads.
:param is_singleton: If this is set to ``True`` then only one instance of this class will be created per lock file. This is useful if you want to use the lock object for reentrant locking without needing to pass the same object around.
)r0 r2 r4 Nr )�_is_thread_local�
_is_singleton�os�fspathr8 r. �_context)r r0 r2 r4 r> r< r@ r r r r g s � zBaseFileLock.__init__c C r )z>:return: a flag indicating if this lock is thread local or not)rI r r r r �is_thread_local� s z BaseFileLock.is_thread_localc C r )z;:return: a flag indicating if this lock is singleton or not)rJ r r r r r< � s zBaseFileLock.is_singletonr/ c C � | j jS )z :return: path to the lock file)rM r0 r r r r r0 � � zBaseFileLock.lock_filec C rO )za
:return: the default timeout value, in seconds
.. versionadded:: 2.0.0
)rM r2 r r r r r2 � s zBaseFileLock.timeout�value� float | strc C s t |�| j_dS )zd
Change the default timeout value.
:param value: the new value, in seconds
N)r1 rM r2 )r rQ r r r r2 � s c C � t �)zjIf the file lock could be acquired, self._context.lock_file_fd holds the file descriptor of the lock file.��NotImplementedErrorr r r r �_acquire� � zBaseFileLock._acquirec C rS )z>Releases the lock and sets self._context.lock_file_fd to None.rT r r r r �_release� rW zBaseFileLock._releasec C s | j jduS )z�
:return: A boolean indicating if the lock file is holding the lock currently.
.. versionchanged:: 2.0.0
This was previously a method and is now a property.
N)rM r5 r r r r � is_locked� s
zBaseFileLock.is_lockedc C rO )zP:return: The number of times this lock has been acquired (but not yet released).)rM r6 r r r r r6 � rP zBaseFileLock.lock_counterN皙�����?)�poll_intervall�blocking� float | None�
poll_intervalr[ r\ r c C s4 |du r| j j}|durd}tj|tdd� |}| j jd7 _t| �}| j}t� � }zV | j
s;t � d||� | �
� | j
rFt � d||� n:|d u rUt � d
||� t|��d | krct� � | k rpn n t � d ||� t|��d
}t � ||||� t�|� q-W n ty� td | j jd �| j _� w t| d�S )a_
Try to acquire the file lock.
:param timeout: maximum wait time for acquiring the lock, ``None`` means use the default :attr:`~timeout` is and
if ``timeout < 0``, there is no timeout and this method will block until the lock could be acquired
:param poll_interval: interval of trying to acquire the lock file
:param poll_intervall: deprecated, kept for backwards compatibility, use ``poll_interval`` instead
:param blocking: defaults to True. If False, function will return immediately if it cannot obtain a lock on the
first attempt. Otherwise, this method will block until the timeout expires or the lock is acquired.
:raises Timeout: if fails to acquire lock within the timeout period
:return: a context object that will unlock the file when the context is exited
.. code-block:: python
# You can use this method in the context manager (recommended)
with lock.acquire():
pass
# Or use an equivalent try-finally construct:
lock.acquire()
try:
pass
finally:
lock.release()
.. versionchanged:: 2.0.0
This method returns now a *proxy* object instead of *self*,
so that it can be used in a with statement without side effects.
Nz+use poll_interval instead of poll_intervall� )�
stacklevelr Tz#Attempting to acquire lock %s on %szLock %s acquired on %sFz+Failed to immediately acquire lock %s on %sr z"Timeout on acquiring lock %s on %sz2Lock %s not acquired on %s, waiting %s seconds ...r )rM r2 �warnings�warn�DeprecationWarningr6 �idr0 �time� perf_counterrY �_LOGGER�debugrV r �sleep�
BaseException�maxr ) r r2 r^ r[ r\ �msg�lock_id�
lock_filename�
start_timer r r �acquire� sD (
�
�
zBaseFileLock.acquire�forcec C sn | j r3| j jd8 _| jjdks|r5t| �| j}}t�d||� | �� d| j_t�d||� dS dS dS )a*
Releases the file lock. Please note, that the lock is only completely released, if the lock counter is 0. Also
note, that the lock file itself is not automatically deleted.
:param force: If true, the lock counter is ignored and the lock is released in every case/
r r z#Attempting to release lock %s on %szLock %s released on %sN)rY rM r6 rd r0 rg rh rX )r rq rm rn r r r r& s �zBaseFileLock.releasec C s | � � | S )zE
Acquire the lock.
:return: the lock object
)rp r r r r r # s zBaseFileLock.__enter__r r! r" r# r$ r% c C s | � � dS )z�
Release the lock.
:param exc_type: the exception type if raised
:param exc_value: the exception value if raised
:param traceback: the exception traceback if raised
N�r& r' r r r r( , s
zBaseFileLock.__exit__c C s | j dd� dS )z'Called when the lock object is deleted.T)rq Nrr r r r r �__del__; s zBaseFileLock.__del__)r: r; T)r0 r= r2 r1 r4 r3 r> r? r< r? r@ rA r r ) r0 r= r2 r1 r4 r3 r> r? r< r? r r )r r? )r r/ )r r1 )rQ rR r r )r r )r r3 )NrZ )
r2 r] r^ r1 r[ r] r\ r? r r )F)rq r? r r )r r r) )r* r+ r, r- r
r9 r7 rC r rN �propertyr< r0 r2 �setterr rV rX rY r6 rp r& r r( rs �
__classcell__r r rG r r M sT
����
# �� L
r )$�
__future__r �
contextlib�loggingrK re ra �abcr r � dataclassesr � threadingr �typingr r r �weakrefr
�_errorr �sys�typesr
� version_infor �typing_extensions� getLoggerrg r r. r8 �ContextDecoratorr �__all__r r r r �<module> s8
u�