codekingpro/portable-devtools
115k
1�
2 �jcS � � � % S SK Jr S SKrS SKrS SKrS SKrS SKrS SKrS SKrS SK r S SK3J r J r S SK
Jr S SKJr S SKJrJrJr S SKJr SS KJr S4rS \S ' \( a5 S S
KJ r S SK J r SSK J r SSK!J"r" \RF S:� a S SKJ$r$ OS SK%J$r$ \RL " S5 r'\RP S:X a \RR RT O\RR RV r, " S S\5 r-\-" 5 r. " S S5 r/\ " S S5 5 r0 " S S \0\5 r1\" S S S 9r2 " S S!\ 5 r3 " S" S \Rh \3S#9r5/ S$Qr6g)%� )� annotationsN)�ABCMeta�abstractmethod)� dataclass)�local)�
TYPE_CHECKING�Any�TypeVar)�WeakValueDictionary� )�Timeout������int�_UNSET_FILE_MODE)�Callable)�
TracebackType)�
ReadWriteLock)�SoftReadWriteLock)� � )�Self�filelock�win32c �, ^ � \ rS rSrSU 4S jjrSrU =r$ )�_ThreadLocalRegistry�, c �0 >� [ TU ] 5 0 U l g �N)�super�__init__�held)�self� __class__s ��SD:\code\apps\devtools\python\user_packages\Python313\site-packages\filelock/_api.pyr � _ThreadLocalRegistry.__init__- s �� �
����$&�� � )r! ��return�None)�__name__�5__module__� __qualname__�__firstlineno__r �__static_attributes__�
__classcell__�r# s @r$ r r , s
�� �'� 'r& r c �F � \ rS rSrSrSS jrS S jr S6S jrSrg) �AcquireReturnProxy�8 zDA context-aware object that will release the lock file when exiting.c � � Xl g r ��lock)r" r6 s r$ r �AcquireReturnProxy.__init__; s � �FJ� r& c � � U R $ r r5 �r" s r$ � __enter__� AcquireReturnProxy.__enter__> s � ��y�y�r& c �8 � U R R 5 g r )r6 �release�r" �exc_type� exc_value� tracebacks r$ �__exit__�AcquireReturnProxy.__exit__A s � �
� � ���r& r5 N)r6 �0BaseFileLock | ReadWriteLock | SoftReadWriteLockr( r) )r( rD �r? ztype[BaseException] | Noner@ zBaseException | NonerA zTracebackType | Noner( r) ) r* r+ r, r- �__doc__r r: rB r. � r& r$ r2 r2 8 s; � �N�K�� �,� � (� � (� �7 8� r& r2 c �v � \ rS rSr% SrS\S' S\S' S\S' S \S9' S\S ' S rS
\S' S rS\S' SrS\S' Sr g )�FileLockContext�J zBA dataclass which holds the context for a ``BaseFileLock`` object.�str� lock_file�float�timeoutr �mode�bool�blocking�
poll_intervalN� float | None�lifetimez10int | None� lock_file_fdr � lock_counterrG )11r* r+ r, r- rF �__annotations__rT rU rV r. rG r& r$ rI rI J sM � �L� �N� �N� �I� �N� �� "�H�l�!� $�L�*�#� �L�#�r& rI c � � \ rS rSrSrSrg)�ThreadLocalFileContext�j z8A thread local version of the ``FileLockContext`` class.rG N)r* r+ r, r- rF r. rG r& r$ rY rY j s � �Br& rY �_T� BaseFileLock)�boundc �z ^ � \ rS rSr% S\S' S\S4SSSSS . S U 4S12 jjjjrS rU =r$ )
� FileLockMeta�q �&WeakValueDictionary[str, BaseFileLock]�13_instancesr TF皙�����?N�rQ � is_singletonrR rT c �N >� U( a� U R R [ U5 5 n14U15( a� XJR 5 4X*R 4X:R16 R 4XZR 4XzR 4X�R 4S.n U R 5 V V
Vs0 s H u n u p�X�:w d M X�U4_M nn
n nU( d U17$ SnUS-
nUR 5 H u nu p�USU SU SU
S3-
nM [ U5 eUUUUUUUS.U En[ R " U R 5 R nUR 5 VVs0 s H u nnUU; d M UU_M nnn[ TU ]D " U40 UD6n18U( a X�R [ U5 ' U19$ s snn
n f s snnf ) N)� thread_localrN rO rQ rR rT zGSingleton lock instances cannot be initialized with differing argumentsz20Non-matching arguments: z21 z (existing lock has z but z was passed))rN rO rg rQ re rR rT )rb �getrK �is_thread_localrN �_contextrO rQ rR rT �items�22ValueError�inspect� signaturer �23parametersr �__call__)�clsrL rN rO rg rQ re rR rT �kwargs�instance�params_to_check�name� passed_param� set_param�non_matching_params�msg�24param_name�25all_params�present_params�key�value� init_paramsr# s �r$ rp �FileLockMeta.__call__t s� �� � ��~�~�)�)�#�i�.�9�H��%1�3K�3K�3M�$N� '�)9�)9� :� !�#4�#4�#9�#9� :�!)�+<�+<� =�&3�5K�5K�%L�!)�+<�+<� =�
#�� <K�;P�;P�;R�'�;R�7�� 7�|�#�0� 4�D��3�3�;R� $� '�26 +�#�O� `���3�3��=P�=V�=V�=X�9�J� 9� ��T�*� �-A�)��E�R^�Q_�_k�l�l�C� >Y� ��o�%� �� (� � (� *� � 27� � 28�29� !�*�*�3�<�<�8�C�C��4>�4D�4D�4F�`�4F�j�c�5�#�Q_�J_�z�s�E�z�4F� �`��7�#�I�=��=�� �-5�N�N�3�y�>� *����M'��> as �!F�3F�
F!� F!rG )rq ztype[_T]rL �str | os.PathLike[str]rN rM rO r rg rP rQ rP re rP rR rM rT rS rr r r( r[ ) r* r+ r, r- rW r rp r. r/ r0 s @r$ r_ r_ q s� �� �6�6�30 �$� !� ?� � "� #�!%�?�
�?�)�?� �?� � ?�31 � ?� �?� �?� �?� �?� �?� 32 �?� ?r& r_ c �� ^ � \ rS rSr% SrS\S' S(U 4S jjrS\S4SSS S33S . S)S jjjrS*S
jr \34S*S j5 r \35S+S j5 r \36S,S j5 r
\
R S-S j5 r
\37S*S j5 r\R S.S j5 r\38S,S j5 r\R S/S j5 r\39S0S j5 r\R S1S j5 r\40S2S j5 r\41S*S j5 rS2S jrS3S jr\S3S j5 r\S3S j5 r\42S*S j5 r\43S2S j5 r\ S4S j5 r S5S44S45S46S!. S6S" jjjr S7S8S# jjr S9S$ jr S:S% jr S3S& jr!S'r"U =r#$ );r\ � aH 47Abstract base class for a file lock object.48 49Provides a reentrant, cross-process exclusive lock backed by OS-level primitives. Subclasses implement the actual50locking mechanism (:class:`UnixFileLock <filelock.UnixFileLock>`, :class:`WindowsFileLock51<filelock.WindowsFileLock>`, :class:`SoftFileLock <filelock.SoftFileLock>`).52 53ra rb c �D >� [ TU ] " S0 UD6 [ 5 U l g)z'Setup unique state for lock subclasses.NrG )r �__init_subclass__r rb )rq rr r# s �r$ r� � BaseFileLock.__init_subclass__� s �� �
��!�+�F�+�,�.��r& r TFrc Nrd c � � X@l X`l [ R " U5 UUUUUS.n U( a [ O[54 " S0 U D6U l g)a� 55Create a new lock object.56 57:param lock_file: path to the file58:param timeout: default timeout when acquiring the lock, in seconds. It will be used as fallback value in the59 acquire method, if no timeout value (``None``) is given. If you want to disable the timeout, set it to a60 negative value. A timeout of 0 means that there is exactly one attempt to acquire the file lock.61:param mode: file permissions for the lockfile. When not specified, the OS controls permissions via umask and62 default ACLs, preserving POSIX default ACL inheritance in shared directories.63:param thread_local: Whether this object's internal context should be thread local or not. If this is set to64 ``False`` then the lock will be reentrant across threads.65:param blocking: whether the lock should be blocking or not66:param is_singleton: If this is set to ``True`` then only one instance of this class will be created per lock67 file. This is useful if you want to use the lock object for reentrant locking without needing to pass the68 same object around.69:param poll_interval: default interval for polling the lock file, in seconds. It will be used as fallback value70 in the acquire method, if no poll_interval value (``None``) is given.71:param lifetime: maximum time in seconds a lock can be held before it is considered expired. When set, a waiting72 process will break a lock whose file modification time is older than ``lifetime`` seconds. ``None`` (the73 default) means locks never expire.74 75)rL rN rO rQ rR rT NrG )�_is_thread_local�
_is_singleton�os�fspathrY rI rj )76r" rL rN rO rg rQ re rR rT rr s77 r$ r �BaseFileLock.__init__� sR � �D !-� � )��78 ���9�-� �� � *� �
"79�� EQ�*@�Ve�*e�)p�io�)p��
r& c � � U R $ )z?:returns: a flag indicating if this lock is thread local or not)r� r9 s r$ ri � BaseFileLock.is_thread_local� s � ��$�$�$r& c � � U R $ )zY80:returns: a flag indicating if this lock is singleton or not81 82.. versionadded:: 3.13.083 84)r� r9 s r$ re �BaseFileLock.is_singleton� s � � �!�!�!r& c �. � U R R $ )z :returns: path to the lock file)rj rL r9 s r$ rL �BaseFileLock.lock_file s � � �}�}�&�&�&r& c �. � U R R $ )zK85:returns: the default timeout value, in seconds86 87.. versionadded:: 2.0.088 89)rj rN r9 s r$ rN �BaseFileLock.timeout s � � �}�}�$�$�$r& c �8 � [ U5 U R l g)zM90Change the default timeout value.91 92:param value: the new value, in seconds93 94N)rM rj rN �r" r~ s r$ rN r� s � � !&�e� ��
�
� r& c �. � U R R $ )zM95:returns: whether the locking is blocking or not96 97.. versionadded:: 3.14.098 99�rj rQ r9 s r$ rQ �BaseFileLock.blocking � � � �}�}�%�%�%r& c �$ � XR l g)zJ100Change the default blocking value.101 102:param value: the new value as bool103 104Nr� r� s r$ rQ r� ) � � � "'�
�
� r& c �. � U R R $ )zO105:returns: the default polling interval, in seconds106 107.. versionadded:: 3.24.0108 109�rj rR r9 s r$ rR �BaseFileLock.poll_interval3 s � � �}�}�*�*�*r& c �$ � XR l g)zP110Change the default polling interval.111 112:param value: the new value, in seconds113 114Nr� r� s r$ rR r� = s � � ',�
�
�#r& c �. � U R R $ )zj115:returns: the lock lifetime in seconds, or ``None`` if the lock never expires116 117.. versionadded:: 3.24.0118 119�rj rT r9 s r$ rT �BaseFileLock.lifetimeG r� r& c �$ � XR l g)zg120Change the lock lifetime.121 122:param value: the new value in seconds, or ``None`` to disable expiration123 124Nr� r� s r$ rT r� Q r� r& c �n � U R R [ :X a S$ U R R $ )z/:returns: the file permissions for the lockfilei� �rj rO r r9 s r$ rO �BaseFileLock.mode[ s+ � � �
�
�*�*�.>�>�u�V�D�M�M�DV�DV�Vr& c �< � U R R [ :g $ )z::returns: whether the file permissions were explicitly setr� r9 s r$ �has_explicit_mode� BaseFileLock.has_explicit_mode` s � � �}�}�!�!�%5�5�5r& c �n � U R R [ :X a S$ U R R $ )ue :returns: the mode for os.open() — 0o666 when unset (let umask/ACLs decide), else the explicit modei� r� r9 s r$ �125_open_mode�BaseFileLock._open_modee s) � � �
�
�*�*�.>�>�u�V�D�M�M�DV�DV�Vr& c �F � U R R =nc g[ R " [ 5 [126 R127 " 5 [ R " U R 5 R 5 R -128 U: a129 SSS5 gU R S[ R " 5 3n[ R " U R 5 R U5 [ R " U5 R 5 SSS5 g! , ( d f g= f)zVRemove the lock file if its modification time exceeds the configured :attr:`lifetime`.Nz.break.)rj rT �130contextlib�suppress�OSError�time�pathlib�PathrL �stat�st_mtimer� �getpid�rename�unlink)r" rT �131break_paths r$ �_try_break_expired_lock�$BaseFileLock._try_break_expired_locki s� � � �
�
�.�.� .�H� 7� �
�
�
��
)��y�y�{�W�\�\�$�.�.� 9� >� >� @� I� I�I�H�T�� *�
)� !�N�N�+�7�2�9�9�;�-�@�J� �L�L�� � � (� /� /�132� ;� �L�L�� $� +� +� -� *�
)�
)�s �AD�A7D�133D c � � [ e)zjIf the file lock could be acquired, self._context.lock_file_fd holds the file descriptor of the lock file.��NotImplementedErrorr9 s r$ �_acquire�BaseFileLock._acquiret �134 � � "�!r& c � � [ e)z>Releases the lock and sets self._context.lock_file_fd to None.r� r9 s r$ �_release�BaseFileLock._releasey r� r& c �2 � U R R SL$ )z�135:returns: A boolean indicating if the lock file is holding the lock currently.136 137.. versionchanged:: 2.0.0138 139 This was previously a method and is now a property.140 141N)rj rU r9 s r$ � is_locked�BaseFileLock.is_locked~ s � � �}�}�)�)��5�5r& c �. � U R R $ )zQ:returns: The number of times this lock has been acquired (but not yet released).)rj rV r9 s r$ rV �BaseFileLock.lock_counter� s � � �}�}�)�)�)r& c � � USL a [ R SX5 gUb# U" 5 ( a [ R SX5 gSUs=:: a [ R " 5 U-142 : a O g[ R SX5 gg)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)�lock_id�
lock_filenamerQ � cancel_checkrN �143start_times r$ �_check_give_up�BaseFileLock._check_give_up� ss � � �u� � �M�M�G�� `�� � #� ��� �M�M�D�g� ]�� �� :�$�+�+�-�144�:� :� �
�M�M�>�� W��r& )�poll_intervallrQ r� c � � Uc U R R nUc U R R nUb Sn[ R " U[145 SS9 UnUb UOU R R nU R =R S-
sl [ U 5 nU R n[ U5 n U R R S:H =( a& U R ( + =( a US: =( a Un146U147( aW [ R R U 5 =n b5 X�:w a0 U R =R S- sl SU S3n[ U5 e[ R" " 5 n U R ( d6 U R% 5 [& R) S Xx5 U R+ 5 U R ( a [& R) S148Xx5 OTU R- UUUUUU S 9( a [/ U5 eS n[& R) XgX�5 [ R0 " U5 M� U R R S:X a U[ R U ' [9 U S
9$ ! [2 an [5 SU R R S-149 5 U R l U R R S:X a [ R R7 U S5 e f = f)a� 150Try to acquire the file lock.151 152:param timeout: maximum wait time for acquiring the lock, ``None`` means use the default :attr:`~timeout` is and153 if ``timeout < 0``, there is no timeout and this method will block until the lock could be acquired154:param poll_interval: interval of trying to acquire the lock file, ``None`` means use the default155 :attr:`~poll_interval`156:param poll_intervall: deprecated, kept for backwards compatibility, use ``poll_interval`` instead157:param blocking: defaults to True. If False, function will return immediately if it cannot obtain a lock on the158 first attempt. Otherwise, this method will block until the timeout expires or the lock is acquired.159:param cancel_check: a callable returning ``True`` when the acquisition should be canceled. Checked on each poll160 iteration. When triggered, raises :class:`~Timeout` just like an expired timeout.161 162:returns: a context object that will unlock the file when the context is exited163 164:raises Timeout: if fails to acquire lock within the timeout period165 166.. code-block:: python167 168 # You can use this method in the context manager (recommended)169 with lock.acquire():170 pass171 172 # Or use an equivalent try-finally construct:173 lock.acquire()174 try:175 pass176 finally:177 lock.release()178 179.. versionchanged:: 2.0.0180 181 This method returns now a *proxy* object instead of *self*, so that it can be used in a with statement182 without side effects.183 184Nz+use poll_interval instead of poll_intervall� )�185stacklevelr 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.z#Attempting to acquire lock %s on %szLock %s acquired on %s)rQ r� rN r� z2Lock %s not acquired on %s, waiting %s seconds ...r5 ) rj rN rQ �warnings�warn�DeprecationWarningrR rV �idrL �186_canonicalr� � _registryr! rh � RuntimeErrorr� r� r� r� r� r� r� r
�sleep�
BaseException�max�popr2 )
r" rN rR r� rQ r� ry r� r� � canonical� would_block�existingr� s
r$ �acquire�BaseFileLock.acquire� s] � �\ �?��m�m�+�+�G� � ��}�}�-�-�H� � %�?�C� �M�M�#� 1�a� @� *�M�)6�)B�
��
�
�Hc�Hc�
�
�
�
�"�"�a�'�"��T�(�� ���
� �}�-� ��m�m�0�0�A�5�i�d�n�n�:L�i�QX�[\�Q\�i�ai� � � ���(:�(:�9�(E� E�H�R�W_�Wj� �M�M� &� &�!� +� &�"�=�/� 2=� >�
�187 �s�#� #��&�&�(�188� ���~�~��0�0�2��M�M�"G��`��M�M�O��>�>��M�M�":�G�S���&�&��!� %�!-� #� )�
'� � "�-�0�0�J���
�
�c�M�I��189�190�=�)�' �2 �=�=� %� %�� *�(/�I�N�N�9� %�!�t�,�,�� � �),�Q��
�
�0J�0J�Q�0N�)O�D�M�M� &��}�}�)�)�Q�.����"�"�9�d�3� � �s �*A/I$ �AI$ �$A8K c �� � U R ( a� U R =R S- sl U R R S:X d U( a� [ U 5 U R p2[191 R
SX#5 U R 5 SU R l [ R R [ U5 S5 [192 R
SX#5 ggg)z�193Release the file lock. The lock is only completely released when the lock counter reaches 0. The lock file194itself is not automatically deleted.195 196:param force: If true, the lock counter is ignored and the lock is released in every case.197 198r r z#Attempting to release lock %s on %sNzLock %s released on %s) r� rj rV r� rL r� r� r� r� r! r� r� )r" �forcer� r� s r$ r= �BaseFileLock.release s� � � �>�>� �M�M� &� &�!� +� &��}�}�)�)�Q�.�%�)+�D��4�>�>� ��
�
� C�W�\��
�
��-.��
�
�*����"�"�:�m�#<�d�C��
�
� 6��O� 38� r& c �& � U R 5 U $ )z/199Acquire the lock.200 201:returns: the lock object202 203)r� r9 s r$ r: �BaseFileLock.__enter__# s � �
� � ��� r& c �$ � U R 5 g)z�204Release the lock.205 206:param exc_type: the exception type if raised207:param exc_value: the exception value if raised208:param traceback: the exception traceback if raised209 210N�r= r> s r$ rB �BaseFileLock.__exit__- s
� �
� � �r& c �" � U R SS9 g)z'Called when the lock object is deleted.T)r� Nr� r9 s r$ �__del__�BaseFileLock.__del__= s � � � � �4� � r& )rj r� r� )rr zdict[str, Any]r( r) )rL r� rN rM rO r rg rP rQ rP re rP rR rM rT rS r( r) )r( rP )r( rK )r( rM )r~ z float | strr( r) )r~ rP r( r) )r~ rM r( r) )r( rS )r~ rS r( r) )r( r r' )r� r r� rK rQ rP r� �Callable[[], bool] | NonerN rM r� rM r( rP )NN) rN rS rR rS r� rS rQ z bool | Noner� r� r( r2 )F)r� rP r( r) )r( r rE )$r* r+ r, r- rF rW r� r r ri �propertyre rL rN �setterrQ rR rT rO r� r� r� r r� r� r� rV � staticmethodr� r� r= r: rB r� r. r/ r0 s @r$ r\ r\ � s� �� �� 7�6�/� �$� !� /q� � "� #�!%�/q�)�/q� �/q� � /q�211 � /q� �/q� �/q� �/q� �/q� 212�/q�b%� �"� �"� �'� �'� �%� �%�
�^�^�-� �-� �&� �&� �_�_�'� �'� �+� �+� ���,� �,� �&� �&� �_�_�'� �'� �W� �W� �6� �6�W� .� �"� �"� �"� �"� � 6� � 6� �*� �*� ������ � �213 0� � �
� �� 214�� ��, !%�&*�i-�215 (,� $�26�i-� �i-� $�i-�216 %� i-� �
i-� 0�i-� 217 �i-�VP�(��,�� (�� (� �218 219� � !� !r& )� metaclass)r r2 r\ )7�220__future__r r� rm �loggingr� r� �sysr� r� �abcr r � dataclassesr � threadingr �typingr r r221 �weakrefr �_errorr
r rW �collections.abcr �typesr � _read_writer �_soft_rwr � version_infor �typing_extensions� getLoggerr� �platform�path�abspath�realpathr� r r� r2 rI rY r[ r_ �ContextDecoratorr\ �__all__rG r& r$ �<module>r s! �� "� � � � � � 222� � � '� !� � .� .� '� �223 � �#� ��(�#�*�+�224���7�"� �*� �225�226�J�227'�� !$� � �� 7�R�W�W�_�_�R�W�W�=M�=M�228�'�5� '�
!� "� � � �$ � � � � �>C�_�e� C�
�T� �(��B�7� B�JI!�:�.�.�,� I!�X �r&