3 d @sddlZddlZddlZddlZddlmZmZddlmZddl m Z ddl m Z m Z mZmZddlmZejdZGd d d ZGd d d eZd d gZdS) N)ABCabstractmethod)Lock) TracebackType)AnyOptionalTypeUnion)TimeoutZfilelockc@sReZdZdZdddddZdddd Zeeeeeee dd d d Z dS) AcquireReturnProxyzDA context aware object that will release the lock file when exiting. BaseFileLockN)lockreturncCs ||_dS)N)r)selfrr1/tmp/pip-build-7vycvbft/filelock/filelock/_api.py__init__szAcquireReturnProxy.__init__)rcCs|jS)N)r)rrrr __enter__szAcquireReturnProxy.__enter__)exc_type exc_value tracebackrcCs|jjdS)N)rrelease)rrrrrrr__exit__szAcquireReturnProxy.__exit__) __name__ __module__ __qualname____doc__rrrr BaseExceptionrrrrrrr s r c@seZdZdZd&eedfeddddZeedd d Z eedd d Z e j eeefdd dd Z e ddddZ e ddddZeedddZd'ddeeeeeedddZd(eddddZddddZeeeeeeedd d!d"Zddd#d$ZdS))r z+Abstract base class for a file lock object.r zos.PathLike[Any]N) lock_filetimeoutrcCs*tj||_d|_||_t|_d|_dS)a Create a new lock object. :param lock_file: path to the file :param timeout: default timeout when acquiring the lock. 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. Nr)osfspath _lock_file _lock_file_fdr r _thread_lock _lock_counter)rrr rrrr's zBaseFileLock.__init__)rcCs|jS)z:return: path to the lock file)r#)rrrrrAszBaseFileLock.lock_filecCs|jS)zU :return: the default timeout value .. versionadded:: 2.0.0 )_timeout)rrrrr FszBaseFileLock.timeout)valuercCst||_dS)zX Change the default timeout value. :param value: the new value N)floatr')rr(rrrr OscCstdS)zbIf the file lock could be acquired, self._lock_file_fd holds the file descriptor of the lock file.N)NotImplementedError)rrrr_acquireXszBaseFileLock._acquirecCstdS)z6Releases the lock and sets self._lock_file_fd to None.N)r*)rrrr_release]szBaseFileLock._releasecCs |jdk S)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)r$)rrrr is_lockedbs zBaseFileLock.is_locked皙?)poll_intervall)r poll_intervalr/rcCsT|dkr|j}|dk r.d}tj|tdd|}|j|jd7_WdQRXt|}|j}tj}yx|j"|j st j d|||j WdQRX|j rt j d||Pqhd|kotj|knrt j d ||t |jqhd }t j ||||tj|qhWWn<tk rH|jtd|jd|_WdQRXYnXt|d S) az 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 :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 z#Attempting to acquire lock %s on %szLock %s acquired on %srz"Timeout on acquiring lock %s on %sz2Lock %s not acquired on %s, waiting %s seconds ...)r)r warningswarnDeprecationWarningr%r&idr#timer-_LOGGERdebugr+r sleeprmaxr )rr r0r/msglock_id lock_filename start_timerrracquirens>%  zBaseFileLock.acquireF)forcerc Csr|jb|jrd|jd8_|jdks*|rdt||j}}tjd|||jd|_tjd||WdQRXdS)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 rz#Attempting to release lock %s on %szLock %s released on %sN)r%r-r&r6r#r8r9r,)rrAr=r>rrrrszBaseFileLock.releasecCs |j|S)zE Acquire the lock. :return: the lock object )r@)rrrrrszBaseFileLock.__enter__)rrrrcCs |jdS)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)rrrrrrrrs zBaseFileLock.__exit__cCs|jdddS)z'Called when the lock object is deleted.T)rAN)r)rrrr__del__szBaseFileLock.__del__)rC)Nr.)F)rrrrr strr)rpropertyrr setterrr+r,boolr-rr r@rrrrrrrBrrrrr $s2 E  r )loggingr!r7r3abcrr threadingrtypesrtypingrrrr _errorr getLoggerr8r r __all__rrrrs    H