U
��UV�$ �
@ s� d Z ddlmZ ddlZddlZddlZddlZddlZeed�sJej e_
eej d�sbej j ej _
dddd d
d d d
dddddg
ZG dd� de�ZG dd� de�ZG dd� de�ZG dd � d e�ZG dd
� d
e�ZG dd � d e�ZG dd � d e�ZG dd
� d
e�ZG dd � d e�ZG d d� de�Zd d � Zd d� Z d!d� Z d"d� Z d(d#d�Z eed$��rjd%d&l m!Z" e"j#Z$nd%d'l m%Z& e&j'Z$e$Z(dS ))a
lockfile.py - Platform-independent advisory file locks.
Requires Python 2.5 unless you apply 2.4.diff
Locking is done on a per-thread basis instead of a per-process basis.
Usage:
>>> lock = LockFile('somefile')
>>> try:
... lock.acquire()
... except AlreadyLocked:
... print 'somefile', 'is locked already.'
... except LockFailed:
... print 'somefile', 'can\'t be locked.'
... else:
... print 'got lock'
got lock
>>> print lock.is_locked()
True
>>> lock.release()
>>> lock = LockFile('somefile')
>>> print lock.is_locked()
False
>>> with lock:
... print lock.is_locked()
True
>>> print lock.is_locked()
False
>>> lock = LockFile('somefile')
>>> # It is okay to lock twice from the same thread...
>>> with lock:
... lock.acquire()
...
>>> # Though no counter is kept, so you can't unlock multiple times...
>>> print lock.is_locked()
False
Exceptions:
Error - base class for other exceptions
LockError - base class for all locking exceptions
AlreadyLocked - Another thread or process already holds the lock
LockFailed - Lock failed for some other reason
UnlockError - base class for all unlocking exceptions
AlreadyUnlocked - File was not locked.
NotMyLock - File was locked but not by the current thread/process
� )�absolute_importN�current_thread�get_name�Error� LockError� LockTimeout�
AlreadyLocked�
LockFailed� UnlockError� NotLocked� NotMyLock� LinkFileLock�
MkdirFileLock�SQLiteFileLock�LockBase�lockedc @ s e Zd ZdZdS )r zw
Base class for other exceptions.
>>> try:
... raise Error
... except Exception:
... pass
N��__name__�
__module__� __qualname__�__doc__� r r � /__init__.pyr J s c @ s e Zd ZdZdS )r z�
Base class for error arising from attempts to acquire the lock.
>>> try:
... raise LockError
... except Error:
... pass
Nr r r r r r V s c @ s e Zd ZdZdS )r z�Raised when lock creation fails within a user-defined period of time.
>>> try:
... raise LockTimeout
... except LockError:
... pass
Nr r r r r r b s c @ s e Zd ZdZdS )r z�Some other thread/process is locking the file.
>>> try:
... raise AlreadyLocked
... except LockError:
... pass
Nr r r r r r m s c @ s e Zd ZdZdS )r z�Lock file creation failed for some other reason.
>>> try:
... raise LockFailed
... except LockError:
... pass
Nr r r r r r x s c @ s e Zd ZdZdS )r
z�
Base class for errors arising from attempts to release the lock.
>>> try:
... raise UnlockError
... except Error:
... pass
Nr r r r r r
� s c @ s e Zd ZdZdS )r z�Raised when an attempt is made to unlock an unlocked file.
>>> try:
... raise NotLocked
... except UnlockError:
... pass
Nr r r r r r � s c @ s e Zd ZdZdS )r z�Raised when an attempt is made to unlock a file someone else locked.
>>> try:
... raise NotMyLock
... except UnlockError:
... pass
Nr r r r r r � s c @ s> e Zd Zdd� Zddd�Zdd� Zdd � Zd
d � Zd d
� ZdS )� _SharedBasec C s
|| _ d S )N)�path)�selfr r r r �__init__� s z_SharedBase.__init__Nc C s t d��dS )a�
Acquire the lock.
* If timeout is omitted (or None), wait forever trying to lock the
file.
* If timeout > 0, try to acquire the lock for that many seconds. If
the lock period expires and the file is still locked, raise
LockTimeout.
* If timeout <= 0, raise AlreadyLocked immediately if the file is
already locked.
�implement in subclassN��NotImplemented)r �timeoutr r r �acquire� s z_SharedBase.acquirec C s t d��dS )zX
Release the lock.
If the file is not locked, raise NotLocked.
r Nr �r r r r �release� s z_SharedBase.releasec C s | � � | S )�*
Context manager support.
)r! r" r r r � __enter__� s z_SharedBase.__enter__c G s | � � dS )r$ N)r# )r Z_excr r r �__exit__� s z_SharedBase.__exit__c C s d| j j| jf S )Nz<%s: %r>)� __class__r r r" r r r �__repr__� s z_SharedBase.__repr__)N) r r r r r! r# r% r& r( r r r r r � s
r c sB e Zd ZdZd� fdd� Zdd� Zdd � Zd
d � Zd d
� Z� Z S )r z.Base class for platform-specific lock classes.TNc s� t t| ��|� tj�|�d | _t�� | _ t�
� | _ |rbt �
� }t|dt|��}d|d@ | _nd| _tj�| j�}tj�|d| j | j| j t| j�f �| _|| _dS )zi
>>> lock = LockBase('somefile')
>>> lock = LockBase('somefile', threaded=False)
z.lock�identz-%xl �� � z %s%s.%s%sN)�superr r �osr �abspathZ lock_file�socketZ gethostnameZhostname�getpid�pid� threadingr �getattr�hashZtname�dirname�join� unique_namer )r r �threadedr �tr) r4 �r' r r r � s$
��zLockBase.__init__c C s t d��dS )z9
Tell whether or not the file is locked.
r Nr r" r r r � is_locked� s zLockBase.is_lockedc C s t d��dS )zA
Return True if this object is locking the file.
r Nr r" r r r � i_am_locking� s zLockBase.i_am_lockingc C s t d��dS )zN
Remove a lock. Useful if a locking thread failed to unlock.
r Nr r" r r r �
break_lock s zLockBase.break_lockc C s d| j j| j| jf S )Nz<%s: %r -- %r>)r' r r6 r r" r r r r( s �zLockBase.__repr__)TN)
r r r r r r: r; r< r( �
__classcell__r r r9 r r � s !c O sP t jd| tdd� t|d t�s.|dd � }t|�dkrF|sFd|d< | ||�S )Nz1Import from %s module instead of lockfile package� )�
stacklevelr � Tr7 )�warnings�warn�DeprecationWarning�
isinstance�str�len)�cls�mod�args�kwdsr r r �
_fl_helper s
� rK c O s ddl m} t|jdf| �|�S )z�Factory function provided for backwards compatibility.
Do not use in new code. Instead, import LinkLockFile from the
lockfile.linklockfile module.
r@ �� linklockfilezlockfile.linklockfile)r* rM rK � LinkLockFile)rI rJ rM r r r r
s
��c O s ddl m} t|jdf| �|�S )z�Factory function provided for backwards compatibility.
Do not use in new code. Instead, import MkdirLockFile from the
lockfile.mkdirlockfile module.
r@ ��
mkdirlockfilezlockfile.mkdirlockfile)r* rP rK �
MkdirLockFile)rI rJ rP r r r r % s
��c O s ddl m} t|jdf| �|�S )z�Factory function provided for backwards compatibility.
Do not use in new code. Instead, import SQLiteLockFile from the
lockfile.mkdirlockfile module.
r@ )�sqlitelockfilezlockfile.sqlitelockfile)r* rR rK ZSQLiteLockFile)rI rJ rR r r r r 0 s
��c s � �fdd�}|S )a Decorator which enables locks for decorated function.
Arguments:
- path: path for lockfile.
- timeout (optional): Timeout for acquiring lock.
Usage:
@locked('/var/run/myname', timeout=0)
def myname(...):
...
c s t �� �� ��fdd��}|S )Nc s2 t ��d�}|�� z� | |�W �S |�� X d S )N)r )�FileLockr! r# )rI �kwargs�lock)�funcr r r r �wrapperH s
z&locked.<locals>.decor.<locals>.wrapper)� functools�wraps)rV rW �r r )rV r �decorG s zlocked.<locals>.decorr )r r r[ r rZ r r ; s
�linkr@ rL rO )N))r Z
__future__r rX r, r. r1 rA �hasattrZ
currentThreadr ZThreadZgetNamer �__all__� Exceptionr r r r r r
r r �objectr r rK r
r r r r* rM Z_llfrN ZLockFilerP Z_mlfrQ rS r r r r �<module> sT 3
� -: