File manager - Edit - /home/newsbmcs.com/public_html/static/img/logo/filelock.tar
Back
_unix.py 0000644 00000004457 15027666670 0006271 0 ustar 00 from __future__ import annotations import os import sys from contextlib import suppress from errno import ENOSYS from pathlib import Path from typing import cast from ._api import BaseFileLock from ._util import ensure_directory_exists #: a flag to indicate if the fcntl API is available has_fcntl = False if sys.platform == "win32": # pragma: win32 cover class UnixFileLock(BaseFileLock): """Uses the :func:`fcntl.flock` to hard lock the lock file on unix systems.""" def _acquire(self) -> None: raise NotImplementedError def _release(self) -> None: raise NotImplementedError else: # pragma: win32 no cover try: import fcntl _ = (fcntl.flock, fcntl.LOCK_EX, fcntl.LOCK_NB, fcntl.LOCK_UN) except (ImportError, AttributeError): pass else: has_fcntl = True class UnixFileLock(BaseFileLock): """Uses the :func:`fcntl.flock` to hard lock the lock file on unix systems.""" def _acquire(self) -> None: ensure_directory_exists(self.lock_file) open_flags = os.O_RDWR | os.O_TRUNC if not Path(self.lock_file).exists(): open_flags |= os.O_CREAT fd = os.open(self.lock_file, open_flags, self._context.mode) with suppress(PermissionError): # This locked is not owned by this UID os.fchmod(fd, self._context.mode) try: fcntl.flock(fd, fcntl.LOCK_EX | fcntl.LOCK_NB) except OSError as exception: os.close(fd) if exception.errno == ENOSYS: # NotImplemented error msg = "FileSystem does not appear to support flock; use SoftFileLock instead" raise NotImplementedError(msg) from exception else: self._context.lock_file_fd = fd def _release(self) -> None: # Do not remove the lockfile: # https://github.com/tox-dev/py-filelock/issues/31 # https://stackoverflow.com/questions/17708885/flock-removing-locked-file-without-race-condition fd = cast("int", self._context.lock_file_fd) self._context.lock_file_fd = None fcntl.flock(fd, fcntl.LOCK_UN) os.close(fd) __all__ = [ "UnixFileLock", "has_fcntl", ] __pycache__/_api.cpython-310.pyc 0000644 00000031111 15027666670 0012401 0 ustar 00 o }h�8 � @ s: d dl mZ d dlZd dlZd dlZd dlZd dlZd dlZd dlm Z m Z d dl m Z d dl mZ d dlmZmZmZ d dlmZ dd lmZ erfd dlZd d lmZ ejd kr`d d lmZ nd d l mZ e� d �Z G dd� d�Z e G dd� d��Z G dd� de e�Z!G dd� de �Z"G dd� dej#e"d�Z$ddgZ%dS )� )� annotationsN)�ABCMeta�abstractmethod)� dataclass)�local)� TYPE_CHECKING�Any�cast)�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 �8/usr/local/lib/python3.10/dist-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 @ sJ e Zd ZU dZded< ded< ded< ded < d Zd ed < d Zded< d S )�FileLockContextzBA dataclass which holds the context for a ``BaseFileLock`` object.�str� lock_file�float�timeout�int�mode�bool�blockingNz int | None� lock_file_fdr � lock_counter)r* r+ r, r- �__annotations__r7 r8 r r r r r. 3 s r. c @ s e Zd ZdZdS )�ThreadLocalFileContextz8A thread local version of the ``FileLockContext`` class.N)r* r+ r, r- r r r r r: M s r: c s. e Zd Z dddd�d� fdd�Z� ZS )� FileLockMeta���� TF�r6 � is_singletonr0 �str | os.PathLike[str]r2 r1 r4 r3 � thread_localr5 r6 r? �kwargsr r r c s |rS| j �t|��}|rS||�� f||jf||jf||jfd�} dd� | �� D �} | s0td|�S d} | d7 } | �� D ]\} \} }| d| � d|� d | � d �7 } q:t | ��|||||d �|�}t � | j �j � � fd d�|�� D �}t� j|fi |��}|r�|| j t|�< td|�S ) N)rA r2 r4 r6 c S s& i | ]\}\}}||kr|||f�qS r r )�.0�name� passed_param� set_paramr r r � <dictcomp>g s �z)FileLockMeta.__call__.<locals>.<dictcomp>r zGSingleton lock instances cannot be initialized with differing argumentsz Non-matching arguments: z z (existing lock has z but z was passed))r2 r4 rA r6 r? c s i | ] \}}|� v r||�qS r r )rC �key�value��present_paramsr r rG � s )� _instances�getr/ �is_thread_localr2 r4 r6 �itemsr � ValueError�inspect� signaturer � parameters�super�__call__)�clsr0 r2 r4 rA r6 r? rB �instance�params_to_check�non_matching_params�msg� param_namerE rF � all_params� init_params�� __class__rJ r rU R s@ �� �� zFileLockMeta.__call__�r< r= T)r0 r@ r2 r1 r4 r3 rA r5 r6 r5 r? r5 rB r r r )r* r+ r, rU � __classcell__r r r^ r r; Q s ��r; c s0 e Zd ZU dZded< dN� fdd � Z dOd d d�dPdd�ZdQdd �ZedQd d ��Z edRd d!��Z edSd"d#��Z e j dTd&d#��Z edQd'd(��Z e j dUd)d(��Z edVd*d+��ZedWd,d-��ZedWd.d/��ZedQd0d1��ZedVd2d3��Z 4 5dXd4d4d6�dYd<d=�ZdZd[d?d@�Zd\dBdC�Zd]dJdK�ZdWdLdM�Z� ZS )^r z+Abstract base class for a file lock object.z&WeakValueDictionary[str, BaseFileLock]rL rB �dict[str, Any]r r c s t � jdi |�� t� | _dS )z'Setup unique state for lock subclasses.Nr )rT �__init_subclass__r rL )rV rB r^ r r rc � s z BaseFileLock.__init_subclass__r< r= TFr> r0 r@ r2 r1 r4 r3 rA r5 r6 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 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. )r0 r2 r4 r6 Nr )�_is_thread_local� _is_singleton�os�fspathr: r. �_context)r r0 r2 r4 rA r6 r? rB r r r r � s � zBaseFileLock.__init__c C r )z>:return: a flag indicating if this lock is thread local or not)rd r r r r rN � s z BaseFileLock.is_thread_localc C r )z;:return: a flag indicating if this lock is singleton or not)re r r r r r? � s zBaseFileLock.is_singletonr/ c C � | j jS )z :return: path to the lock file)rh r0 r r r r r0 � � zBaseFileLock.lock_filec C ri )za :return: the default timeout value, in seconds .. versionadded:: 2.0.0 )rh r2 r r r r r2 � s zBaseFileLock.timeoutrI � float | strc C s t |�| j_dS )ze Change the default timeout value. :param value: the new value, in seconds N)r1 rh r2 �r rI r r r r2 � s c C ri )z/:return: whether the locking is blocking or not�rh r6 r r r r r6 � rj zBaseFileLock.blockingc C s || j _dS )zb Change the default blocking value. :param value: the new value as bool Nrm rl r r r r6 � s c C ri )z.:return: the file permissions for the lockfile)rh r4 r r r r r4 � rj zBaseFileLock.modec 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 rn )z>Releases the lock and sets self._context.lock_file_fd to None.ro r r r r �_release� rr 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)rh r7 r r r r � is_locked� s zBaseFileLock.is_lockedc C ri )zP:return: The number of times this lock has been acquired (but not yet released).)rh r8 r r r r r8 rj zBaseFileLock.lock_counterN皙�����?)�poll_intervallr6 � float | None� poll_intervalrv � bool | Noner c C sD |du r| j j}|du r| j j}|dur d}tj|tdd� |}| j jd7 _t| �}| j}t � � }zV | j sCt � d||� | �� | j rNt � d||� n:|d u r]t � d ||� t|��d | krkt � � | k rxn n t � d ||� t|��d }t � ||||� t �|� q5W 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 )rh r2 r6 �warnings�warn�DeprecationWarningr8 �idr0 �time� perf_counterrt �_LOGGER�debugrq r �sleep� BaseException�maxr ) r r2 rx rv r6 rZ �lock_id� lock_filename� start_timer r r �acquire sH ( � � 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)rt rh r8 r r0 r� r� rs )r r� r� r� r r r r& ^ s �zBaseFileLock.releaser c C s | � � | S )zF Acquire the lock. :return: the lock object )r� r r r r r q 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)r� Nr� r r r r �__del__� s zBaseFileLock.__del__)rB rb r r r` )r0 r@ r2 r1 r4 r3 rA r5 r6 r5 r? r5 r r )r r5 )r r/ )r r1 )rI rk r r )rI r5 r r )r r3 )r r )Nru ) r2 rw rx r1 rv rw r6 ry r r )F)r� r5 r r )r r r) )r* r+ r, r- r9 rc r rN �propertyr? r0 r2 �setterr6 r4 r rq rs rt r8 r� r& r r( r� ra r r r^ r r � sX �� ' �� O r )� metaclass)&� __future__r � contextlibrQ �loggingrf r� r| �abcr r � dataclassesr � threadingr �typingr r r �weakrefr �_errorr �sys�typesr � version_infor �typing_extensions� getLoggerr� r r. r: r; �ContextDecoratorr �__all__r r r r �<module> s> = � __pycache__/asyncio.cpython-310.pyc 0000644 00000027143 15027666670 0013150 0 ustar 00 o }h�0 � @ s� d Z ddlmZ ddlZddlZddlZddlZddlZddlm Z ddl m Z ddl m Z mZmZmZmZ ddlmZmZmZ dd lmZ dd lmZ dd lmZ dd l m Z e r|ddl Z dd l m Z ddl!m"Z" e j#dkrvddl m$Z$ nddl%m$Z$ e�&d�Z'e G dd� de��Z(G dd� de(e �Z)G dd� d�Z*G dd� de�Z+G dd� dee+d �Z,G d d � d ee,�Z-G d d � d ee,�Z.G d!d"� d"e e,�Z/g d#�Z0dS )$z1An asyncio-based implementation of the file lock.� )� annotationsN)� dataclass)�local)� TYPE_CHECKING�Any�Callable�NoReturn�cast� )� BaseFileLock�FileLockContext� FileLockMeta)�Timeout)� SoftFileLock)� UnixFileLock)�WindowsFileLock)�futures)� TracebackType)� � )�Self�filelockc @ s6 e Zd ZU dZdZded< dZded< dZded < dS ) �AsyncFileLockContextzGA dataclass which holds the context for a ``BaseAsyncFileLock`` object.T�bool�run_in_executorN�futures.Executor | None�executor� asyncio.AbstractEventLoop | None�loop)�__name__� __module__� __qualname__�__doc__r �__annotations__r r � r$ r$ �;/usr/local/lib/python3.10/dist-packages/filelock/asyncio.pyr " s r c @ � e Zd ZdZdS )�AsyncThreadLocalFileContextz8A thread local version of the ``FileLockContext`` class.N�r r r! r" r$ r$ r$ r% r' 0 � r' c @ s. e Zd ZdZddd�Zddd �Zddd�ZdS )�AsyncAcquireReturnProxyzDA context-aware object that will release the lock file when exiting.�lock�BaseAsyncFileLock�return�Nonec C s || _ d S �N�r+ )�selfr+ r$ r$ r% �__init__7 s z AsyncAcquireReturnProxy.__init__c � s �| j S r/ r0 �r1 r$ r$ r% � __aenter__: s �z"AsyncAcquireReturnProxy.__aenter__�exc_type�type[BaseException] | None� exc_value�BaseException | None� traceback�TracebackType | Nonec � s �| j �� I d H d S r/ )r+ �release�r1 r5 r7 r9 r$ r$ r% � __aexit__= s �z!AsyncAcquireReturnProxy.__aexit__N)r+ r, r- r. )r- r, �r5 r6 r7 r8 r9 r: r- r. )r r r! r" r2 r4 r= r$ r$ r$ r% r* 4 s r* c s4 e Zd Z ddddddd�d� fdd�Z� ZS ) �AsyncFileLockMeta���� FTN��blocking� is_singletonr r r � lock_file�str | os.PathLike[str]�timeout�float�mode�int� thread_localr rC rD r r r r r r- r, c s< |r |r d} t | ��t� j||||||||| d� } td| �S )Nz:run_in_executor is not supported when thread_local is True) rE rG rI rK rC rD r r r r, )� ValueError�super�__call__r ) �clsrE rG rI rK rC rD r r r �msg�instance�� __class__r$ r% rN G s � zAsyncFileLockMeta.__call__�r@ rA F)rE rF rG rH rI rJ rK r rC r rD r r r r r r r r- r, )r r r! rN � __classcell__r$ r$ rR r% r? F s ��r? c @ s� e Zd ZdZ dBdddddd�dCdd�ZedDdd ��ZedEd d ��ZejdFd d ��ZedGd!d"��Z #dHdd$�dId)d*�Z dJdKd,d-�Z dLd0d1�Z dMd3d4�Z dNd6d7�ZdOd>d?�ZdPd@dA�ZdS )Qr, z'Base class for asynchronous file locks.r@ rA FTNrB rE rF rG rH rI rJ rK r rC rD r r r r r r- r. c C sB || _ || _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 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 loop: The event loop to use. If not specified, the running event loop will be used. :param run_in_executor: If this is set to ``True`` then the lock will be acquired in an executor. :param executor: The executor to use. If not specified, the default executor will be used. )rE rG rI rC r r r Nr$ )�_is_thread_local� _is_singleton�os�fspathr' r �_context) r1 rE rG rI rK rC rD r r r �kwargsr$ r$ r% r2 h s � �zBaseAsyncFileLock.__init__c C � | j jS )z"::return: whether run in executor.)rZ r r3 r$ r$ r% r � � z!BaseAsyncFileLock.run_in_executorc C r\ )z::return: the executor.�rZ r r3 r$ r$ r% r � r] zBaseAsyncFileLock.executor�valuec C s || j _dS )z� Change the executor. :param value: the new executor or ``None`` :type value: futures.Executor | None Nr^ )r1 r_ r$ r$ r% r � s c C r\ )z::return: the event loop.)rZ r r3 r$ r$ r% r � r] zBaseAsyncFileLock.loop皙�����?)rC � float | None� poll_interval� bool | Noner* c � s6 �|du r | j j}|du r| j j}| j jd7 _t| �}| j}t�� }z^ | js9t � d||� | � | j �I dH | jrDt � d||� n=|du rSt � d||� t |��d| krat�� | k rnn n t � d ||� t |��d }t � ||||� t�|�I dH q&W n ty� td| j jd �| j _� w t| d �S ) aW Try to acquire the file lock. :param timeout: maximum wait time for acquiring the lock, ``None`` means use the default :attr:`~BaseFileLock.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 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() Nr 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 ...r0 )rZ rG rC � lock_counter�idrE �time� perf_counter� is_locked�_LOGGER�debug�_run_internal_method�_acquirer �asyncio�sleep� BaseException�maxr* )r1 rG rb rC �lock_id� lock_filename� start_timerP r$ r$ r% �acquire� sB �" � � zBaseAsyncFileLock.acquire�forcec � sz �| j r9| j jd8 _| jjdks|r;t| �| j}}t�d||� | �| j�I dH 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 %sNzLock %s released on %s) rh rZ rd re rE ri rj rk �_release)r1 ru rq rr r$ r$ r% r; � s ��zBaseAsyncFileLock.release�method�Callable[[], Any]c � sR �t �|�r|� I d H d S | jr$| jpt �� }|�| j|�I d H d S |� d S r/ )rm �iscoroutinefunctionr r �get_running_loopr )r1 rw r r$ r$ r% rk s � z&BaseAsyncFileLock._run_internal_methodr c C s d}t |��)z� Replace old __enter__ method to avoid using it. NOTE: DO NOT USE `with` FOR ASYNCIO LOCKS, USE `async with` INSTEAD. :return: none :rtype: NoReturn z>Do not use `with` for asyncio locks, use `async with` instead.)�NotImplementedError)r1 rP r$ r$ r% � __enter__ s zBaseAsyncFileLock.__enter__r c � s �| � � I dH | S )zF Acquire the lock. :return: the lock object N)rt r3 r$ r$ r% r4 s �z BaseAsyncFileLock.__aenter__r5 r6 r7 r8 r9 r: c � s �| � � I dH 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 �zBaseAsyncFileLock.__aexit__c C s| t �t��/ | jp t�� }|�� s|�| jdd�� n|� | jdd�� W d � dS W d � dS 1 s7w Y dS )z'Called when the lock object is deleted.T)ru N) � contextlib�suppress� RuntimeErrorr rm rz � is_running�run_until_completer; � create_task)r1 r r$ r$ r% �__del__: s �"�zBaseAsyncFileLock.__del__rT )rE rF rG rH rI rJ rK r rC r rD r r r r r r r r- r. )r- r )r- r )r_ r r- r. )r- r )Nr` )rG ra rb rH rC rc r- r* )F)ru r r- r. )rw rx r- r. )r- r )r- r r> )r- r. )r r r! r" r2 �propertyr r �setterr rt r; rk r| r4 r= r� r$ r$ r$ r% r, e s> ��2 �� D r, )� metaclassc @ r& )�AsyncSoftFileLockz.Simply watches the existence of the lock file.Nr( r$ r$ r$ r% r� D r) r� c @ r& )�AsyncUnixFileLockzHUses the :func:`fcntl.flock` to hard lock the lock file on unix systems.Nr( r$ r$ r$ r% r� H r) r� c @ r& )�AsyncWindowsFileLockzNUses the :func:`msvcrt.locking` to hard lock the lock file on windows systems.Nr( r$ r$ r$ r% r� L r) r� )r* r� r� r� r, )1r" � __future__r rm r} �loggingrX rf � dataclassesr � threadingr �typingr r r r r �_apir r r �_errorr �_softr �_unixr �_windowsr �sys� concurrentr �typesr � version_infor �typing_extensions� getLoggerri r r' r* r? r, r� r� r� �__all__r$ r$ r$ r% �<module> sD ` __pycache__/version.cpython-310.pyc 0000644 00000001021 15027666670 0013153 0 ustar 00 o }h � @ sx U g d �Z dZer ddlmZ ddlmZ eeeef df ZneZee d< ee d< ee d< ee d < d Z Z d Z Z d S ) )� __version__�__version_tuple__�version� version_tupleF� )�Tuple)�Union.r r r r z3.18.0)� � r N)�__all__� TYPE_CHECKING�typingr r �int�str� VERSION_TUPLE�object�__annotations__r r r r � r r �;/usr/local/lib/python3.10/dist-packages/filelock/version.py�<module> s __pycache__/__init__.cpython-310.pyc 0000644 00000002515 15027666670 0013236 0 ustar 00 o }h� � @ s( U d Z ddlmZ ddlZddlZddlmZ ddlmZm Z ddl m Z ddl m Z dd lmZmZ dd lmZ dd lmZmZmZmZmZ dd lmZ eZd ed< ej dkreeZ ded< eZ ded< n erteZ ded< eZ ded< ne Z eZ edur�ej ddd� er�e Z eZ!ne Z e Z!g d�Z"dS )zw A platform independent file lock that supports the with-statement. .. autodata:: filelock.__version__ :no-value: � )� annotationsN)� TYPE_CHECKING� )�AcquireReturnProxy� BaseFileLock)�Timeout)� SoftFileLock)� UnixFileLock� has_fcntl)�WindowsFileLock)�AsyncAcquireReturnProxy�AsyncSoftFileLock�AsyncUnixFileLock�AsyncWindowsFileLock�BaseAsyncFileLock)�version�str� __version__�win32ztype[BaseFileLock]� _FileLockztype[BaseAsyncFileLock]�_AsyncFileLockz only soft file lock is available� )� stacklevel)r r � AsyncFileLockr r r r r �FileLockr r r r r )#�__doc__� __future__r �sys�warnings�typingr �_apir r �_errorr �_softr �_unixr r �_windowsr �asyncior r r r r r r �__annotations__�platformr r �warnr r �__all__� r* r* �</usr/local/lib/python3.10/dist-packages/filelock/__init__.py�<module> s: __pycache__/_soft.cpython-310.pyc 0000644 00000003003 15027666670 0012602 0 ustar 00 o }h� � @ sz d dl mZ d dlZd dlZd dlmZ d dlmZmZ d dl m Z ddl m Z ddl mZmZ G d d � d e �Zd gZdS ) � )� annotationsN)�suppress)�EACCES�EEXIST)�Path� )� BaseFileLock)�ensure_directory_exists�raise_on_not_writable_filec @ s$ e Zd ZdZd dd�Zd dd�ZdS ) � SoftFileLockz.Simply watches the existence of the lock file.�return�Nonec C s� t | j� t| j� tjtjB tjB tjB }z t�| j|| j j �}W n* t yL } z |j t ks:|j tkr9tjdksA� W Y d }~d S W Y d }~d S d }~ww || j _d S )N�win32)r � lock_filer �os�O_WRONLY�O_CREAT�O_EXCL�O_TRUNC�open�_context�mode�OSError�errnor r �sys�platform� lock_file_fd)�self�flags� file_handler� exception� r! �9/usr/local/lib/python3.10/dist-packages/filelock/_soft.py�_acquire s* ���� ��� zSoftFileLock._acquirec C sb | j jd usJ �t�| j j� d | j _tt�� t| j��� W d � d S 1 s*w Y d S )N) r r r �closer r r r �unlink)r r! r! r" �_release% s "�zSoftFileLock._releaseN)r r )�__name__� __module__� __qualname__�__doc__r# r& r! r! r! r" r s r )� __future__r r r � contextlibr r r r �pathlibr �_apir �_utilr r r �__all__r! r! r! r" �<module> s !� __pycache__/_error.cpython-310.pyc 0000644 00000002625 15027666670 0012771 0 ustar 00 o }h � @ s2 d dl mZ d dlmZ G dd� de�ZdgZdS )� )� annotations)�Anyc sN e Zd ZdZd� fdd� Zdd d �Zdd d �Zdd d�Zeddd��Z � Z S )�Timeoutz@Raised when the lock could not be acquired in *timeout* seconds.� lock_file�str�return�Nonec s t � �� || _d S �N)�super�__init__� _lock_file)�selfr �� __class__� �:/usr/local/lib/python3.10/dist-packages/filelock/_error.pyr s zTimeout.__init__�str | tuple[Any, ...]c C s | j | jffS r )r r �r r r r � __reduce__ � zTimeout.__reduce__c C s d| j � d�S )NzThe file lock 'z' could not be acquired.�r r r r r �__str__ r zTimeout.__str__c C s | j j� d| j�d�S )N�(�))r �__name__r r r r r �__repr__ s zTimeout.__repr__c C s | j S )z#:return: The path of the file lock.r r r r r r s zTimeout.lock_file)r r r r )r r )r r ) r � __module__� __qualname__�__doc__r r r r �propertyr � __classcell__r r r r r s r N)� __future__r �typingr � TimeoutErrorr �__all__r r r r �<module> s � __pycache__/_util.cpython-310.pyc 0000644 00000002720 15027666670 0012611 0 ustar 00 o }h� � @ s` d dl mZ d dlZd dlZd dlZd dlmZmZ d dlm Z dd d �Z dd d �Z d d gZ dS )� )� annotationsN)�EACCES�EISDIR)�Path�filename�str�return�Nonec C s| zt �| �}W n ty Y dS w |jdkr:|jtj@ s#ttd| ��t�|j�r<t j dkr4ttd| ��t t d| ��dS dS )a3 Raise an exception if attempting to open the file for writing would fail. This is done so files that will never be writable can be separated from files that are writable but currently locked. :param filename: file to check :raises OSError: as if the file was opened for writing. Nr zPermission denied�win32zIs a directory) �os�stat�OSError�st_mtime�st_mode�S_IWUSR�PermissionErrorr �S_ISDIR�sys�platform�IsADirectoryErrorr )r � file_stat� r �9/usr/local/lib/python3.10/dist-packages/filelock/_util.py�raise_on_not_writable_file s � �r � Path | strc C s t | �jjddd� dS )zp Ensure the directory containing the file exists (create it if necessary). :param filename: file. T)�parents�exist_okN)r �parent�mkdir)r r r r �ensure_directory_exists' s r )r r r r )r r r r ) � __future__r r r r �errnor r �pathlibr r r �__all__r r r r �<module> s � __pycache__/_unix.cpython-310.pyc 0000644 00000004173 15027666670 0012623 0 ustar 00 o }h/ � @ s� d dl mZ d dlZd dlZd dlmZ d dlmZ d dlm Z d dl m Z ddl m Z dd lmZ d Zejd krBG d d � d e �Zn&zd dlZejejejejfZW n eefy] Y nw dZG dd � d e �Zd dgZdS )� )� annotationsN)�suppress)�ENOSYS)�Path)�cast� )� BaseFileLock)�ensure_directory_existsF�win32c @ �$ e Zd ZdZd dd�Zd dd�ZdS ) � UnixFileLock�HUses the :func:`fcntl.flock` to hard lock the lock file on unix systems.�return�Nonec C � t ��N��NotImplementedError��self� r �9/usr/local/lib/python3.10/dist-packages/filelock/_unix.py�_acquire � �UnixFileLock._acquirec C r r r r r r r �_release r �UnixFileLock._releaseN�r r ��__name__� __module__� __qualname__�__doc__r r r r r r r s r Tc @ r ) r r r r c C s� t | j� tjtjB }t| j��� s|tjO }t�| j|| j j �}t t �� t� || j j � W d � n1 s8w Y z t�|tjtjB � W n$ tym } zt�|� |jtkrbd}t|�|�W Y d }~d S d }~ww || j _d S )NzEFileSystem does not appear to support flock; use SoftFileLock instead)r � lock_file�os�O_RDWR�O_TRUNCr �exists�O_CREAT�open�_context�moder �PermissionError�fchmod�fcntl�flock�LOCK_EX�LOCK_NB�OSError�close�errnor r � lock_file_fd)r � open_flags�fd� exception�msgr r r r ' s& � ��� r c C s2 t d| jj�}d | j_t�|tj� t�|� d S )N�int)r r* r5 r. r/ �LOCK_UNr$ r3 )r r7 r r r r 9 s r Nr r r r r r r $ s � has_fcntl) � __future__r r$ �sys� contextlibr r4 r �pathlibr �typingr �_apir �_utilr r< �platformr r. r/ r0 r1 r; �_� ImportError�AttributeError�__all__r r r r �<module> s. � � __pycache__/_windows.cpython-310.pyc 0000644 00000004007 15027666670 0013326 0 ustar 00 o }h� � @ s� d dl mZ d dlZd dlZd dlmZ d dlmZ d dlm Z d dl m Z ddl m Z dd lmZmZ ejd krFd dlZG d d � d e �ZnG d d � d e �Zd gZdS )� )� annotationsN)�suppress)�EACCES)�Path)�cast� )� BaseFileLock)�ensure_directory_exists�raise_on_not_writable_file�win32c @ �$ e Zd ZdZd dd�Zd dd�ZdS ) �WindowsFileLock�WUses the :func:`msvcrt.locking` function to hard lock the lock file on Windows systems.�return�Nonec C s� t | j� t| j� tjtjB tjB }z t�| j|| jj �}W n t y8 } z |j t kr-� W Y d }~d S d }~ww z t �|t jd� W n t ya } zt�|� |j t krV� W Y d }~d S d }~ww || j_d S )Nr )r � lock_filer �os�O_RDWR�O_CREAT�O_TRUNC�open�_context�mode�OSError�errnor �msvcrt�locking�LK_NBLCK�close� lock_file_fd)�self�flags�fd� exception� r$ �</usr/local/lib/python3.10/dist-packages/filelock/_windows.py�_acquire s4 ��� ��� ��� �WindowsFileLock._acquirec C sl t d| jj�}d | j_t�|tjd� t�|� tt �� t | j �� � W d � d S 1 s/w Y d S )N�intr ) r r r r r �LK_UNLCKr r r r r r �unlink)r r" r$ r$ r% �_release* s "��WindowsFileLock._releaseN�r r ��__name__� __module__� __qualname__�__doc__r& r+ r$ r$ r$ r% r s r c @ r ) r r r r c C � t ��N��NotImplementedError�r r$ r$ r% r& 8 � r' c C r3 r4 r5 r7 r$ r$ r% r+ ; r8 r, Nr- r. r$ r$ r$ r% r 5 s )� __future__r r �sys� contextlibr r r �pathlibr �typingr �_apir �_utilr r �platformr r �__all__r$ r$ r$ r% �<module> s % � _error.py 0000644 00000001423 15027666670 0006425 0 ustar 00 from __future__ import annotations from typing import Any class Timeout(TimeoutError): # noqa: N818 """Raised when the lock could not be acquired in *timeout* seconds.""" def __init__(self, lock_file: str) -> None: super().__init__() self._lock_file = lock_file def __reduce__(self) -> str | tuple[Any, ...]: return self.__class__, (self._lock_file,) # Properly pickle the exception def __str__(self) -> str: return f"The file lock '{self._lock_file}' could not be acquired." def __repr__(self) -> str: return f"{self.__class__.__name__}({self.lock_file!r})" @property def lock_file(self) -> str: """:return: The path of the file lock.""" return self._lock_file __all__ = [ "Timeout", ] _util.py 0000644 00000003263 15027666670 0006255 0 ustar 00 from __future__ import annotations import os import stat import sys from errno import EACCES, EISDIR from pathlib import Path def raise_on_not_writable_file(filename: str) -> None: """ Raise an exception if attempting to open the file for writing would fail. This is done so files that will never be writable can be separated from files that are writable but currently locked. :param filename: file to check :raises OSError: as if the file was opened for writing. """ try: # use stat to do exists + can write to check without race condition file_stat = os.stat(filename) # noqa: PTH116 except OSError: return # swallow does not exist or other errors if file_stat.st_mtime != 0: # if os.stat returns but modification is zero that's an invalid os.stat - ignore it if not (file_stat.st_mode & stat.S_IWUSR): raise PermissionError(EACCES, "Permission denied", filename) if stat.S_ISDIR(file_stat.st_mode): if sys.platform == "win32": # pragma: win32 cover # On Windows, this is PermissionError raise PermissionError(EACCES, "Permission denied", filename) else: # pragma: win32 no cover # noqa: RET506 # On linux / macOS, this is IsADirectoryError raise IsADirectoryError(EISDIR, "Is a directory", filename) def ensure_directory_exists(filename: Path | str) -> None: """ Ensure the directory containing the file exists (create it if necessary). :param filename: file. """ Path(filename).parent.mkdir(parents=True, exist_ok=True) __all__ = [ "ensure_directory_exists", "raise_on_not_writable_file", ] py.typed 0000644 00000000000 15027666670 0006250 0 ustar 00 _windows.py 0000644 00000004203 15027666670 0006765 0 ustar 00 from __future__ import annotations import os import sys from contextlib import suppress from errno import EACCES from pathlib import Path from typing import cast from ._api import BaseFileLock from ._util import ensure_directory_exists, raise_on_not_writable_file if sys.platform == "win32": # pragma: win32 cover import msvcrt class WindowsFileLock(BaseFileLock): """Uses the :func:`msvcrt.locking` function to hard lock the lock file on Windows systems.""" def _acquire(self) -> None: raise_on_not_writable_file(self.lock_file) ensure_directory_exists(self.lock_file) flags = ( os.O_RDWR # open for read and write | os.O_CREAT # create file if not exists | os.O_TRUNC # truncate file if not empty ) try: fd = os.open(self.lock_file, flags, self._context.mode) except OSError as exception: if exception.errno != EACCES: # has no access to this lock raise else: try: msvcrt.locking(fd, msvcrt.LK_NBLCK, 1) except OSError as exception: os.close(fd) # close file first if exception.errno != EACCES: # file is already locked raise else: self._context.lock_file_fd = fd def _release(self) -> None: fd = cast("int", self._context.lock_file_fd) self._context.lock_file_fd = None msvcrt.locking(fd, msvcrt.LK_UNLCK, 1) os.close(fd) with suppress(OSError): # Probably another instance of the application hat acquired the file lock. Path(self.lock_file).unlink() else: # pragma: win32 no cover class WindowsFileLock(BaseFileLock): """Uses the :func:`msvcrt.locking` function to hard lock the lock file on Windows systems.""" def _acquire(self) -> None: raise NotImplementedError def _release(self) -> None: raise NotImplementedError __all__ = [ "WindowsFileLock", ] _soft.py 0000644 00000003257 15027666670 0006256 0 ustar 00 from __future__ import annotations import os import sys from contextlib import suppress from errno import EACCES, EEXIST from pathlib import Path from ._api import BaseFileLock from ._util import ensure_directory_exists, raise_on_not_writable_file class SoftFileLock(BaseFileLock): """Simply watches the existence of the lock file.""" def _acquire(self) -> None: raise_on_not_writable_file(self.lock_file) ensure_directory_exists(self.lock_file) # first check for exists and read-only mode as the open will mask this case as EEXIST flags = ( os.O_WRONLY # open for writing only | os.O_CREAT | os.O_EXCL # together with above raise EEXIST if the file specified by filename exists | os.O_TRUNC # truncate the file to zero byte ) try: file_handler = os.open(self.lock_file, flags, self._context.mode) except OSError as exception: # re-raise unless expected exception if not ( exception.errno == EEXIST # lock already exist or (exception.errno == EACCES and sys.platform == "win32") # has no access to this lock ): # pragma: win32 no cover raise else: self._context.lock_file_fd = file_handler def _release(self) -> None: assert self._context.lock_file_fd is not None # noqa: S101 os.close(self._context.lock_file_fd) # the lock file is definitely not None self._context.lock_file_fd = None with suppress(OSError): # the file is already deleted and that's what we want Path(self.lock_file).unlink() __all__ = [ "SoftFileLock", ] version.py 0000644 00000001001 15027666670 0006612 0 ustar 00 # file generated by setuptools-scm # don't change, don't track in version control __all__ = ["__version__", "__version_tuple__", "version", "version_tuple"] TYPE_CHECKING = False if TYPE_CHECKING: from typing import Tuple from typing import Union VERSION_TUPLE = Tuple[Union[int, str], ...] else: VERSION_TUPLE = object version: str __version__: str __version_tuple__: VERSION_TUPLE version_tuple: VERSION_TUPLE __version__ = version = '3.18.0' __version_tuple__ = version_tuple = (3, 18, 0) _api.py 0000644 00000034321 15027666670 0006050 0 ustar 00 from __future__ import annotations import contextlib import inspect import logging import os import time import warnings from abc import ABCMeta, abstractmethod from dataclasses import dataclass from threading import local from typing import TYPE_CHECKING, Any, cast from weakref import WeakValueDictionary from ._error import Timeout if TYPE_CHECKING: import sys from types import TracebackType if sys.version_info >= (3, 11): # pragma: no cover (py311+) from typing import Self else: # pragma: no cover (<py311) from typing_extensions import Self _LOGGER = logging.getLogger("filelock") # This is a helper class which is returned by :meth:`BaseFileLock.acquire` and wraps the lock to make sure __enter__ # is not called twice when entering the with statement. If we would simply return *self*, the lock would be acquired # again in the *__enter__* method of the BaseFileLock, but not released again automatically. issue #37 (memory leak) class AcquireReturnProxy: """A context-aware object that will release the lock file when exiting.""" def __init__(self, lock: BaseFileLock) -> None: self.lock = lock def __enter__(self) -> BaseFileLock: return self.lock def __exit__( self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None, ) -> None: self.lock.release() @dataclass class FileLockContext: """A dataclass which holds the context for a ``BaseFileLock`` object.""" # The context is held in a separate class to allow optional use of thread local storage via the # ThreadLocalFileContext class. #: The path to the lock file. lock_file: str #: The default timeout value. timeout: float #: The mode for the lock files mode: int #: Whether the lock should be blocking or not blocking: bool #: The file descriptor for the *_lock_file* as it is returned by the os.open() function, not None when lock held lock_file_fd: int | None = None #: The lock counter is used for implementing the nested locking mechanism. lock_counter: int = 0 # When the lock is acquired is increased and the lock is only released, when this value is 0 class ThreadLocalFileContext(FileLockContext, local): """A thread local version of the ``FileLockContext`` class.""" class FileLockMeta(ABCMeta): def __call__( # noqa: PLR0913 cls, lock_file: str | os.PathLike[str], timeout: float = -1, mode: int = 0o644, thread_local: bool = True, # noqa: FBT001, FBT002 *, blocking: bool = True, is_singleton: bool = False, **kwargs: Any, # capture remaining kwargs for subclasses # noqa: ANN401 ) -> BaseFileLock: if is_singleton: instance = cls._instances.get(str(lock_file)) # type: ignore[attr-defined] if instance: params_to_check = { "thread_local": (thread_local, instance.is_thread_local()), "timeout": (timeout, instance.timeout), "mode": (mode, instance.mode), "blocking": (blocking, instance.blocking), } non_matching_params = { name: (passed_param, set_param) for name, (passed_param, set_param) in params_to_check.items() if passed_param != set_param } if not non_matching_params: return cast("BaseFileLock", instance) # parameters do not match; raise error msg = "Singleton lock instances cannot be initialized with differing arguments" msg += "\nNon-matching arguments: " for param_name, (passed_param, set_param) in non_matching_params.items(): msg += f"\n\t{param_name} (existing lock has {set_param} but {passed_param} was passed)" raise ValueError(msg) # Workaround to make `__init__`'s params optional in subclasses # E.g. virtualenv changes the signature of the `__init__` method in the `BaseFileLock` class descendant # (https://github.com/tox-dev/filelock/pull/340) all_params = { "timeout": timeout, "mode": mode, "thread_local": thread_local, "blocking": blocking, "is_singleton": is_singleton, **kwargs, } present_params = inspect.signature(cls.__init__).parameters # type: ignore[misc] init_params = {key: value for key, value in all_params.items() if key in present_params} instance = super().__call__(lock_file, **init_params) if is_singleton: cls._instances[str(lock_file)] = instance # type: ignore[attr-defined] return cast("BaseFileLock", instance) class BaseFileLock(contextlib.ContextDecorator, metaclass=FileLockMeta): """Abstract base class for a file lock object.""" _instances: WeakValueDictionary[str, BaseFileLock] def __init_subclass__(cls, **kwargs: dict[str, Any]) -> None: """Setup unique state for lock subclasses.""" super().__init_subclass__(**kwargs) cls._instances = WeakValueDictionary() def __init__( # noqa: PLR0913 self, lock_file: str | os.PathLike[str], timeout: float = -1, mode: int = 0o644, thread_local: bool = True, # noqa: FBT001, FBT002 *, blocking: bool = True, is_singleton: bool = False, ) -> None: """ 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 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. """ self._is_thread_local = thread_local self._is_singleton = is_singleton # Create the context. Note that external code should not work with the context directly and should instead use # properties of this class. kwargs: dict[str, Any] = { "lock_file": os.fspath(lock_file), "timeout": timeout, "mode": mode, "blocking": blocking, } self._context: FileLockContext = (ThreadLocalFileContext if thread_local else FileLockContext)(**kwargs) def is_thread_local(self) -> bool: """:return: a flag indicating if this lock is thread local or not""" return self._is_thread_local @property def is_singleton(self) -> bool: """:return: a flag indicating if this lock is singleton or not""" return self._is_singleton @property def lock_file(self) -> str: """:return: path to the lock file""" return self._context.lock_file @property def timeout(self) -> float: """ :return: the default timeout value, in seconds .. versionadded:: 2.0.0 """ return self._context.timeout @timeout.setter def timeout(self, value: float | str) -> None: """ Change the default timeout value. :param value: the new value, in seconds """ self._context.timeout = float(value) @property def blocking(self) -> bool: """:return: whether the locking is blocking or not""" return self._context.blocking @blocking.setter def blocking(self, value: bool) -> None: """ Change the default blocking value. :param value: the new value as bool """ self._context.blocking = value @property def mode(self) -> int: """:return: the file permissions for the lockfile""" return self._context.mode @abstractmethod def _acquire(self) -> None: """If the file lock could be acquired, self._context.lock_file_fd holds the file descriptor of the lock file.""" raise NotImplementedError @abstractmethod def _release(self) -> None: """Releases the lock and sets self._context.lock_file_fd to None.""" raise NotImplementedError @property def is_locked(self) -> bool: """ :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. """ return self._context.lock_file_fd is not None @property def lock_counter(self) -> int: """:return: The number of times this lock has been acquired (but not yet released).""" return self._context.lock_counter def acquire( self, timeout: float | None = None, poll_interval: float = 0.05, *, poll_intervall: float | None = None, blocking: bool | None = None, ) -> AcquireReturnProxy: """ 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. """ # Use the default timeout, if no timeout is provided. if timeout is None: timeout = self._context.timeout if blocking is None: blocking = self._context.blocking if poll_intervall is not None: msg = "use poll_interval instead of poll_intervall" warnings.warn(msg, DeprecationWarning, stacklevel=2) poll_interval = poll_intervall # Increment the number right at the beginning. We can still undo it, if something fails. self._context.lock_counter += 1 lock_id = id(self) lock_filename = self.lock_file start_time = time.perf_counter() try: while True: if not self.is_locked: _LOGGER.debug("Attempting to acquire lock %s on %s", lock_id, lock_filename) self._acquire() if self.is_locked: _LOGGER.debug("Lock %s acquired on %s", lock_id, lock_filename) break if blocking is False: _LOGGER.debug("Failed to immediately acquire lock %s on %s", lock_id, lock_filename) raise Timeout(lock_filename) # noqa: TRY301 if 0 <= timeout < time.perf_counter() - start_time: _LOGGER.debug("Timeout on acquiring lock %s on %s", lock_id, lock_filename) raise Timeout(lock_filename) # noqa: TRY301 msg = "Lock %s not acquired on %s, waiting %s seconds ..." _LOGGER.debug(msg, lock_id, lock_filename, poll_interval) time.sleep(poll_interval) except BaseException: # Something did go wrong, so decrement the counter. self._context.lock_counter = max(0, self._context.lock_counter - 1) raise return AcquireReturnProxy(lock=self) def release(self, force: bool = False) -> None: # noqa: FBT001, FBT002 """ 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/ """ if self.is_locked: self._context.lock_counter -= 1 if self._context.lock_counter == 0 or force: lock_id, lock_filename = id(self), self.lock_file _LOGGER.debug("Attempting to release lock %s on %s", lock_id, lock_filename) self._release() self._context.lock_counter = 0 _LOGGER.debug("Lock %s released on %s", lock_id, lock_filename) def __enter__(self) -> Self: """ Acquire the lock. :return: the lock object """ self.acquire() return self def __exit__( self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None, ) -> None: """ 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 """ self.release() def __del__(self) -> None: """Called when the lock object is deleted.""" self.release(force=True) __all__ = [ "AcquireReturnProxy", "BaseFileLock", ] asyncio.py 0000644 00000030243 15027666670 0006604 0 ustar 00 """An asyncio-based implementation of the file lock.""" from __future__ import annotations import asyncio import contextlib import logging import os import time from dataclasses import dataclass from threading import local from typing import TYPE_CHECKING, Any, Callable, NoReturn, cast from ._api import BaseFileLock, FileLockContext, FileLockMeta from ._error import Timeout from ._soft import SoftFileLock from ._unix import UnixFileLock from ._windows import WindowsFileLock if TYPE_CHECKING: import sys from concurrent import futures from types import TracebackType if sys.version_info >= (3, 11): # pragma: no cover (py311+) from typing import Self else: # pragma: no cover (<py311) from typing_extensions import Self _LOGGER = logging.getLogger("filelock") @dataclass class AsyncFileLockContext(FileLockContext): """A dataclass which holds the context for a ``BaseAsyncFileLock`` object.""" #: Whether run in executor run_in_executor: bool = True #: The executor executor: futures.Executor | None = None #: The loop loop: asyncio.AbstractEventLoop | None = None class AsyncThreadLocalFileContext(AsyncFileLockContext, local): """A thread local version of the ``FileLockContext`` class.""" class AsyncAcquireReturnProxy: """A context-aware object that will release the lock file when exiting.""" def __init__(self, lock: BaseAsyncFileLock) -> None: # noqa: D107 self.lock = lock async def __aenter__(self) -> BaseAsyncFileLock: # noqa: D105 return self.lock async def __aexit__( # noqa: D105 self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None, ) -> None: await self.lock.release() class AsyncFileLockMeta(FileLockMeta): def __call__( # type: ignore[override] # noqa: PLR0913 cls, # noqa: N805 lock_file: str | os.PathLike[str], timeout: float = -1, mode: int = 0o644, thread_local: bool = False, # noqa: FBT001, FBT002 *, blocking: bool = True, is_singleton: bool = False, loop: asyncio.AbstractEventLoop | None = None, run_in_executor: bool = True, executor: futures.Executor | None = None, ) -> BaseAsyncFileLock: if thread_local and run_in_executor: msg = "run_in_executor is not supported when thread_local is True" raise ValueError(msg) instance = super().__call__( lock_file=lock_file, timeout=timeout, mode=mode, thread_local=thread_local, blocking=blocking, is_singleton=is_singleton, loop=loop, run_in_executor=run_in_executor, executor=executor, ) return cast("BaseAsyncFileLock", instance) class BaseAsyncFileLock(BaseFileLock, metaclass=AsyncFileLockMeta): """Base class for asynchronous file locks.""" def __init__( # noqa: PLR0913 self, lock_file: str | os.PathLike[str], timeout: float = -1, mode: int = 0o644, thread_local: bool = False, # noqa: FBT001, FBT002 *, blocking: bool = True, is_singleton: bool = False, loop: asyncio.AbstractEventLoop | None = None, run_in_executor: bool = True, executor: futures.Executor | None = None, ) -> None: """ 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 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 loop: The event loop to use. If not specified, the running event loop will be used. :param run_in_executor: If this is set to ``True`` then the lock will be acquired in an executor. :param executor: The executor to use. If not specified, the default executor will be used. """ self._is_thread_local = thread_local self._is_singleton = is_singleton # Create the context. Note that external code should not work with the context directly and should instead use # properties of this class. kwargs: dict[str, Any] = { "lock_file": os.fspath(lock_file), "timeout": timeout, "mode": mode, "blocking": blocking, "loop": loop, "run_in_executor": run_in_executor, "executor": executor, } self._context: AsyncFileLockContext = (AsyncThreadLocalFileContext if thread_local else AsyncFileLockContext)( **kwargs ) @property def run_in_executor(self) -> bool: """::return: whether run in executor.""" return self._context.run_in_executor @property def executor(self) -> futures.Executor | None: """::return: the executor.""" return self._context.executor @executor.setter def executor(self, value: futures.Executor | None) -> None: # pragma: no cover """ Change the executor. :param value: the new executor or ``None`` :type value: futures.Executor | None """ self._context.executor = value @property def loop(self) -> asyncio.AbstractEventLoop | None: """::return: the event loop.""" return self._context.loop async def acquire( # type: ignore[override] self, timeout: float | None = None, poll_interval: float = 0.05, *, blocking: bool | None = None, ) -> AsyncAcquireReturnProxy: """ Try to acquire the file lock. :param timeout: maximum wait time for acquiring the lock, ``None`` means use the default :attr:`~BaseFileLock.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 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() """ # Use the default timeout, if no timeout is provided. if timeout is None: timeout = self._context.timeout if blocking is None: blocking = self._context.blocking # Increment the number right at the beginning. We can still undo it, if something fails. self._context.lock_counter += 1 lock_id = id(self) lock_filename = self.lock_file start_time = time.perf_counter() try: while True: if not self.is_locked: _LOGGER.debug("Attempting to acquire lock %s on %s", lock_id, lock_filename) await self._run_internal_method(self._acquire) if self.is_locked: _LOGGER.debug("Lock %s acquired on %s", lock_id, lock_filename) break if blocking is False: _LOGGER.debug("Failed to immediately acquire lock %s on %s", lock_id, lock_filename) raise Timeout(lock_filename) # noqa: TRY301 if 0 <= timeout < time.perf_counter() - start_time: _LOGGER.debug("Timeout on acquiring lock %s on %s", lock_id, lock_filename) raise Timeout(lock_filename) # noqa: TRY301 msg = "Lock %s not acquired on %s, waiting %s seconds ..." _LOGGER.debug(msg, lock_id, lock_filename, poll_interval) await asyncio.sleep(poll_interval) except BaseException: # Something did go wrong, so decrement the counter. self._context.lock_counter = max(0, self._context.lock_counter - 1) raise return AsyncAcquireReturnProxy(lock=self) async def release(self, force: bool = False) -> None: # type: ignore[override] # noqa: FBT001, FBT002 """ 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/ """ if self.is_locked: self._context.lock_counter -= 1 if self._context.lock_counter == 0 or force: lock_id, lock_filename = id(self), self.lock_file _LOGGER.debug("Attempting to release lock %s on %s", lock_id, lock_filename) await self._run_internal_method(self._release) self._context.lock_counter = 0 _LOGGER.debug("Lock %s released on %s", lock_id, lock_filename) async def _run_internal_method(self, method: Callable[[], Any]) -> None: if asyncio.iscoroutinefunction(method): await method() elif self.run_in_executor: loop = self.loop or asyncio.get_running_loop() await loop.run_in_executor(self.executor, method) else: method() def __enter__(self) -> NoReturn: """ Replace old __enter__ method to avoid using it. NOTE: DO NOT USE `with` FOR ASYNCIO LOCKS, USE `async with` INSTEAD. :return: none :rtype: NoReturn """ msg = "Do not use `with` for asyncio locks, use `async with` instead." raise NotImplementedError(msg) async def __aenter__(self) -> Self: """ Acquire the lock. :return: the lock object """ await self.acquire() return self async def __aexit__( self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None, ) -> None: """ 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 """ await self.release() def __del__(self) -> None: """Called when the lock object is deleted.""" with contextlib.suppress(RuntimeError): loop = self.loop or asyncio.get_running_loop() if not loop.is_running(): # pragma: no cover loop.run_until_complete(self.release(force=True)) else: loop.create_task(self.release(force=True)) class AsyncSoftFileLock(SoftFileLock, BaseAsyncFileLock): """Simply watches the existence of the lock file.""" class AsyncUnixFileLock(UnixFileLock, BaseAsyncFileLock): """Uses the :func:`fcntl.flock` to hard lock the lock file on unix systems.""" class AsyncWindowsFileLock(WindowsFileLock, BaseAsyncFileLock): """Uses the :func:`msvcrt.locking` to hard lock the lock file on windows systems.""" __all__ = [ "AsyncAcquireReturnProxy", "AsyncSoftFileLock", "AsyncUnixFileLock", "AsyncWindowsFileLock", "BaseAsyncFileLock", ] __init__.py 0000644 00000003351 15027666670 0006676 0 ustar 00 """ A platform independent file lock that supports the with-statement. .. autodata:: filelock.__version__ :no-value: """ from __future__ import annotations import sys import warnings from typing import TYPE_CHECKING from ._api import AcquireReturnProxy, BaseFileLock from ._error import Timeout from ._soft import SoftFileLock from ._unix import UnixFileLock, has_fcntl from ._windows import WindowsFileLock from .asyncio import ( AsyncAcquireReturnProxy, AsyncSoftFileLock, AsyncUnixFileLock, AsyncWindowsFileLock, BaseAsyncFileLock, ) from .version import version #: version of the project as a string __version__: str = version if sys.platform == "win32": # pragma: win32 cover _FileLock: type[BaseFileLock] = WindowsFileLock _AsyncFileLock: type[BaseAsyncFileLock] = AsyncWindowsFileLock else: # pragma: win32 no cover # noqa: PLR5501 if has_fcntl: _FileLock: type[BaseFileLock] = UnixFileLock _AsyncFileLock: type[BaseAsyncFileLock] = AsyncUnixFileLock else: _FileLock = SoftFileLock _AsyncFileLock = AsyncSoftFileLock if warnings is not None: warnings.warn("only soft file lock is available", stacklevel=2) if TYPE_CHECKING: FileLock = SoftFileLock AsyncFileLock = AsyncSoftFileLock else: #: Alias for the lock, which should be used for the current platform. FileLock = _FileLock AsyncFileLock = _AsyncFileLock __all__ = [ "AcquireReturnProxy", "AsyncAcquireReturnProxy", "AsyncFileLock", "AsyncSoftFileLock", "AsyncUnixFileLock", "AsyncWindowsFileLock", "BaseAsyncFileLock", "BaseFileLock", "FileLock", "SoftFileLock", "Timeout", "UnixFileLock", "WindowsFileLock", "__version__", ]
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.02 |
proxy
|
phpinfo
|
Settings