File: //opt/saltstack/salt/lib/python3.10/site-packages/filelock/__pycache__/_api.cpython-310.pyc
o
;jiW � @ s� U d dl mZ d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl Z d dl
m Z m Z d dl
mZ d dlmZ d dlmZmZmZ d dlmZ dd lmZ d
Zd ed < er�d d
lm Z d dl m Z ddl m Z ddl!m"Z" ej#dkr}d dlm$Z$ nd dl%m$Z$ e�&d�Z'ej(dkr�ej)j*nej)j+Z,G dd� de�Z-e-� Z.G dd� d�Z/eG dd� d��Z0G dd � d e0e�Z1ed d d �Z2G d d!� d!e �Z3G d"d � d ej4e3d#�Z5g d$�Z6dS )%� )� annotationsN)�ABCMeta�abstractmethod)� dataclass)�local)�
TYPE_CHECKING�Any�TypeVar)�WeakValueDictionary� )�Timeout����int�_UNSET_FILE_MODE)�Callable)�
TracebackType)�
ReadWriteLock)�SoftReadWriteLock)� � )�SelfZfilelock�win32c s e Zd Zd� fdd� Z� ZS )�_ThreadLocalRegistry�return�Nonec s t � �� i | _d S �N)�super�__init__�held��self�� __class__� �A/opt/saltstack/salt/lib/python3.10/site-packages/filelock/_api.pyr - s
z _ThreadLocalRegistry.__init__�r r )�__name__�
__module__� __qualname__r �
__classcell__r# r# r! r$ r , s r c @ s. e Zd ZdZddd�Zddd �Zddd�ZdS )�AcquireReturnProxyzDA context-aware object that will release the lock file when exiting.�lock�0BaseFileLock | ReadWriteLock | SoftReadWriteLockr r c C s
|| _ d S r �r+ )r r+ r# r# r$ r ; 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 r0 r2 r4 r# r# r$ �__exit__A s zAcquireReturnProxy.__exit__N)r+ r, r r )r r, �r0 r1 r2 r3 r4 r5 r r )r& r' r( �__doc__r r/ r8 r# r# r# r$ r* 8 s
r* c @ s^ e Zd ZU dZded< ded< ded< ded < ded
< d Zd ed
< d Zded< dZded< d S )�FileLockContextzBA dataclass which holds the context for a ``BaseFileLock`` object.�str� lock_file�float�timeoutr �mode�bool�blocking�
poll_intervalN� float | None�lifetimez
int | None� lock_file_fdr � lock_counter)r& r' r( r: �__annotations__rE rF rG r# r# r# r$ r; J s
r; c @ s e Zd ZdZdS )�ThreadLocalFileContextz8A thread local version of the ``FileLockContext`` class.N)r& r' r( r: r# r# r# r$ rI j s rI �_T� BaseFileLock)�boundc s< e Zd ZU ded< dedfddddd�d � fd d �Z� ZS ) � FileLockMeta�&WeakValueDictionary[str, BaseFileLock]�
_instancesr
TF皙�����?N�rB � is_singletonrC rE �cls�type[_T]r= �str | os.PathLike[str]r? r> r@ r � thread_localrA rB rR rC rE rD �kwargsr r rJ c s |rY| j �t|��}
|
rY||
�� f||
jf||
jjf||
jf||
jf||
j fd�} dd� | �
� D �} | s6|
S d}
|
d7 }
| �
� D ]\}\}}|
d|� d|� d|� d �7 }
q@t |
��|||||||d
�| �}t �
| j�j� � fd d�|�
� D �}t� j|fi |��}
|r�|
| j t|�< |
S ) N)rV r? r@ rB rC rE c S s& i | ]\}\}}||kr|||f�qS r# r# )�.0�name� passed_param� set_paramr# r# r$ �
<dictcomp>� s
�z)FileLockMeta.__call__.<locals>.<dictcomp>zGSingleton lock instances cannot be initialized with differing argumentsz
Non-matching arguments: z
z (existing lock has z but z was passed))r? r@ rV rB rR rC rE c s i | ] \}}|� v r||�qS r# r# )rX �key�value�Zpresent_paramsr# r$ r\ � s )rO �getr< �is_thread_localr? �_contextr@ rB rC rE �items�
ValueError�inspectZ signaturer �
parametersr �__call__)rS r= r? r@ rV rB rR rC rE rW �instanceZparams_to_checkZnon_matching_params�msgZ
param_namerZ r[ �
all_paramsZ init_paramsr! r_ r$ rg t sH
� � �� zFileLockMeta.__call__)rS rT r= rU r? r> r@ r rV rA rB rA rR rA rC r> rE rD rW r r rJ )r& r' r( rH r rg r) r# r# r! r$ rM q s
��rM c s� e Zd ZU dZded< dc� fdd � Zd
ed fd d d
dd�ddd d �Zded d �Ze ded!d"��Z
e dfd$d%��Z e dgd&d'��Z e j
dhd*d'��Z e ded+d,��Zej
did-d,��Ze dgd.d/��Zej
djd0d/��Ze dkd1d2��Zej
dld3d2��Ze dmd4d5��Ze ded6d7��Zdmd8d9�Zdnd:d;�Zednd<d=��Zednd>d?��Ze ded@dA��Ze dmdBdC��ZedodIdJ��Z dpddddK�dqdOdP�Z drdQdR�Z dsdtdTdU�Z dudWdX�Z dvd_d`�Z dndadb�Z!� Z"S )wrK a\
Abstract base class for a file lock object.
Provides a reentrant, cross-process exclusive lock backed by OS-level primitives. Subclasses implement the actual
locking mechanism (:class:`UnixFileLock <filelock.UnixFileLock>`, :class:`WindowsFileLock
<filelock.WindowsFileLock>`, :class:`SoftFileLock <filelock.SoftFileLock>`).
rN rO rW �dict[str, Any]r r c s t � jdi |�� t� | _dS )z'Setup unique state for lock subclasses.Nr# )r �__init_subclass__r
rO )rS rW r! r# r$ rl � s z BaseFileLock.__init_subclass__r
TFrP NrQ r= rU r? r> r@ r rV rA rB rR rC rE rD 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. When not specified, the OS controls permissions via umask and
default ACLs, preserving POSIX default ACL inheritance in shared directories.
: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. When ``True`` (the default), **all fields of the
lock's internal context are per-thread**, including the configuration values ``poll_interval``, ``timeout``,
``blocking``, ``mode``, and ``lifetime``. Setting one of these properties from one thread does not change
the value seen by another thread; threads that did not perform the write continue to see the value supplied
at construction time. If you need configuration values to be visible across threads, construct the lock
with ``thread_local=False``.
:param blocking: whether the lock should be blocking or not
: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.
:param poll_interval: default interval for polling the lock file, in seconds. It will be used as fallback value
in the acquire method, if no poll_interval value (``None``) is given.
:param lifetime: maximum time in seconds a lock can be held before it is considered expired. When set, a waiting
process will break a lock whose file modification time is older than ``lifetime`` seconds. ``None`` (the
default) means locks never expire.
)r= r? r@ rB rC rE Nr# )�_is_thread_local�
_is_singleton�os�fspathrI r; rb )
r r= r? r@ rV rB rR rC rE rW r# r# r$ r � s '� zBaseFileLock.__init__c C r. )z?:returns: a flag indicating if this lock is thread local or not)rm r r# r# r$ ra � s z BaseFileLock.is_thread_localc C r. )zq
:returns: a flag indicating if this lock is singleton or not
.. versionadded:: 3.13.0
)rn r r# r# r$ rR s zBaseFileLock.is_singletonr< c C � | j jS )z :returns: path to the lock file)rb r= r r# r# r$ r= � zBaseFileLock.lock_filec C rq )zc
:returns: the default timeout value, in seconds
.. versionadded:: 2.0.0
)rb r? r r# r# r$ r? � zBaseFileLock.timeoutr^ � float | strc C s t |�| j_dS )ze
Change the default timeout value.
:param value: the new value, in seconds
N)r> rb r? �r r^ r# r# r$ r? s c C rq )ze
:returns: whether the locking is blocking or not
.. versionadded:: 3.14.0
�rb rB r r# r# r$ rB $ rs zBaseFileLock.blockingc C � || j _dS )zb
Change the default blocking value.
:param value: the new value as bool
Nrv ru r# r# r$ rB . � c C rq )zg
:returns: the default polling interval, in seconds
.. versionadded:: 3.24.0
�rb rC r r# r# r$ rC 8 rs zBaseFileLock.poll_intervalc C rw )zh
Change the default polling interval.
:param value: the new value, in seconds
Nry ru r# r# r$ rC B rx c C rq )z�
:returns: the lock lifetime in seconds, or ``None`` if the lock never expires
.. versionadded:: 3.24.0
�rb rE r r# r# r$ rE L rs zBaseFileLock.lifetimec C rw )z
Change the lock lifetime.
:param value: the new value in seconds, or ``None`` to disable expiration
Nrz ru r# r# r$ rE V rx c C � | j jtkrdS | j jS )z/:returns: the file permissions for the lockfilei� �rb r@ r r r# r# r$ r@ ` s zBaseFileLock.modec C s | j jtkS )z::returns: whether the file permissions were explicitly setr| r r# r# r$ �has_explicit_modee s z BaseFileLock.has_explicit_modec C r{ )ue :returns: the mode for os.open() — 0o666 when unset (let umask/ACLs decide), else the explicit modei� r| r r# r# r$ �
_open_modej s zBaseFileLock._open_modec C s� | j j }du r
dS t�t��; t�� t�| j�� � j
|k r( W d � dS | j� dt � � � �}t�| j��
|� t�|��� W d � dS 1 sMw Y dS )zVRemove the lock file if its modification time exceeds the configured :attr:`lifetime`.Nz.break.)rb rE �
contextlib�suppress�OSError�time�pathlib�Pathr= �stat�st_mtimero �getpid�rename�unlink)r rE Z
break_pathr# r# r$ �_try_break_expired_lockn s �"�z$BaseFileLock._try_break_expired_lockc 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$ �_acquirey � zBaseFileLock._acquirec C r� )z>Releases the lock and sets self._context.lock_file_fd to None.r� r r# r# r$ �_release~ r� zBaseFileLock._releasec C s | j jduS )z�
:returns: 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)rb rF r r# r# r$ � is_locked� s
zBaseFileLock.is_lockedc C rq )zQ:returns: The number of times this lock has been acquired (but not yet released).)rb rG r r# r# r$ rG � rr zBaseFileLock.lock_counter�lock_id�
lock_filename� cancel_check�Callable[[], bool] | None�
start_timec C sr |du r
t �d| |� dS |d ur |� r t �d| |� dS d| kr+t�� | k r7n dS t �d| |� dS dS )NFz+Failed to immediately acquire lock %s on %sTz(Cancellation requested for lock %s on %sr z"Timeout on acquiring lock %s on %s)�_LOGGER�debugr� � perf_counter)r� r� rB r� r? r� r# r# r$ �_check_give_up� s
�zBaseFileLock._check_give_up)�poll_intervallrB r� r� � bool | Noner* c
C s` |du r| j j}|du r| j j}|dur d}tj|tdd� |}|dur&|n| j j}| j jd7 _t| �}| j }t
|�} | j jdkoL| j oL|dk oL|}
|
rot j
�| � } duro| |kro| j jd8 _d|� d�}t|��t�� } z | j||||| d � W n ty� td| j jd �| j _| j jdkr�t j
�| d� � w | j jdkr�|t j
| < 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, ``None`` means use the default
:attr:`~poll_interval`
: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.
:param cancel_check: a callable returning ``True`` when the acquisition should be canceled. Checked on each poll
iteration. When triggered, raises :class:`~Timeout` just like an expired timeout.
:returns: a context object that will unlock the file when the context is exited
:raises Timeout: if fails to acquire lock within the timeout period
.. 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 r zDeadlock: lock 'z�' is already held by a different FileLock instance in this thread. Use is_singleton=True to enable reentrant locking across instances.)rB r� r? rC r� r- )rb r? rB �warnings�warn�DeprecationWarningrC rG �idr= �
_canonicalr� � _registryr r` � RuntimeErrorr� r� �_poll_until_acquired�
BaseException�max�popr* )
r r? rC r� rB r� ri r� r� � canonicalZ would_block�existingr� r# r# r$ �acquire� sJ .
�
� �
zBaseFileLock.acquirec C s� t | �}| j} | js| �� t�d||� | �� | jr&t�d||� d S | j||||||d�r5t|��d}t�||||� t �
|� q)NTz#Attempting to acquire lock %s on %szLock %s acquired on %s)rB r� r? r� z2Lock %s not acquired on %s, waiting %s seconds ...) r� r= r� r� r� r� r� r� r r� �sleep) r rB r� r? rC r� r� r� ri r# r# r$ r� s. �
�z!BaseFileLock._poll_until_acquired�forcec C s� | j r<| j jd8 _| jjdks|r>t| �| j}}t�d||� | �� d| j_tj �
t |�d� t�d||� dS dS dS )a1
Release the file lock. The lock is only completely released when the lock counter reaches 0. The lock file
itself may be deleted automatically, the behavior is platform-specific.
: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 %sNzLock %s released on %s) r� rb rG r� r= r� r� r� r� r r� r� )r r� r� r� r# r# r$ r6 ' s �zBaseFileLock.releaser c C s | � � | S )zG
Acquire the lock.
:returns: the lock object
)r� r r# r# r$ r/ ; s zBaseFileLock.__enter__r0 r1 r2 r3 r4 r5 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�r6 r7 r# r# r$ r8 E s zBaseFileLock.__exit__c C s | j dd� dS )z'Called when the lock object is deleted.T)r� Nr� r r# r# r$ �__del__U s zBaseFileLock.__del__)rW rk r r )r= rU r? r> r@ r rV rA rB rA rR rA rC r> rE rD r r )r rA )r r< )r r> )r^ rt r r )r^ rA r r )r^ r> r r )r rD )r^ rD r r )r r r% )r� r r� r< rB rA r� r� r? r> r� r> r rA )NN) r? rD rC rD r� rD rB r� r� r� r r* ) rB rA r� r� r? r> rC r> r� r> r r )F)r� rA r r )r r r9 )#r& r' r( r: rH rl r r ra �propertyrR r= r? �setterrB rC rE r@ r} r~ r� r r� r� r� rG � staticmethodr� r� r� r6 r/ r8 r� r) r# r# r! r$ rK � s|
��
6
��
^
)� metaclass)r r* rK )7�
__future__r r re �loggingro r� �sysr� r� �abcr r Z dataclassesr � threadingr �typingr r r �weakrefr
�_errorr r rH �collections.abcr �typesr Z _read_writer Z_soft_rwr � version_infor Ztyping_extensions� getLoggerr� �platform�path�abspath�realpathr� r r� r* r; rI rJ rM �ContextDecoratorrK �__all__r# r# r# r$ �<module> sN
E '