File size: 97,553 Bytes
a1af790 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 | from __future__ import annotations
import contextlib
import inspect
import logging
import math
import os
import secrets
import stat
import sys
import time
import warnings
from abc import ABCMeta, abstractmethod
from collections.abc import Callable, Hashable
from contextlib import contextmanager
from dataclasses import dataclass, fields
from decimal import Decimal
from itertools import count, starmap
from numbers import Real
from threading import TIMEOUT_MAX, Condition, RLock, Thread, current_thread, get_ident, local
from typing import TYPE_CHECKING, Final, Generic, Literal, NoReturn, TypedDict, TypeVar, cast
from weakref import WeakKeyDictionary, WeakValueDictionary
from ._error import SoftFileLockLifetimeWarning, Timeout
from ._util import break_lock_file
#: No explicit file permission mode was passed. Lock files then open with 0o666 so umask and default ACLs pick
#: the final permissions, and fchmod is skipped to preserve POSIX default ACL inheritance.
_UNSET_FILE_MODE: Final[int] = -1
_PERMISSION_BITS: Final[int] = stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO
#: Ceiling on the retry counter used as a power of two, so a long contended wait cannot overflow the backoff multiply.
_MAX_BACKOFF_EXPONENT: Final[int] = 20
#: How a context manager reconciles a body failure with a release failure on exit (see the property of this name).
ContextErrorPolicy = Literal["chain", "group"]
_CONTEXT_ERROR_POLICIES: Final[frozenset[str]] = frozenset({"chain", "group"})
#: What a descriptor-owning backend does with an ``os.close`` failure after relinquishing ownership (see the property).
CloseErrorPolicy = Literal["default", "raise", "suppress"]
_CLOSE_ERROR_POLICIES: Final[frozenset[str]] = frozenset({"default", "raise", "suppress"})
if TYPE_CHECKING:
from collections.abc import Generator, Mapping
from types import FrameType, TracebackType
from typing import Protocol
from _typeshed import Unused
from ._lease import _LeaseClaim
from ._read_write import ReadWriteLock
from ._soft_rw import SoftReadWriteLock
class _ForkResettable(Protocol):
def _reset_after_fork_in_child(self) -> None: ...
class _ForkDescriptorOwner(Protocol):
def _descriptors_for_fork(self) -> tuple[tuple[int, tuple[int, int] | None], ...]: ...
# Matched against the class object itself rather than `type[...]` of it. A metaclass supplies this method to the
# class while leaving instances without it, so a `type[_ForkResettableClass]` bound rejects `ReadWriteLock`.
class _ForkResettableClass(Protocol):
def _reset_class_after_fork(self) -> None: ...
class _RegisterAtFork(Protocol):
def __call__(
self,
*,
before: Callable[[], None] | None = None,
after_in_parent: Callable[[], None] | None = None,
after_in_child: Callable[[], None] | None = None,
) -> None: ...
from typing import Self
_LOGGER: Final[logging.Logger] = logging.getLogger("filelock")
_REGISTER_AT_FORK: Final[_RegisterAtFork | None] = cast("_RegisterAtFork | None", getattr(os, "register_at_fork", None))
_HAS_REGISTER_AT_FORK: Final[bool] = _REGISTER_AT_FORK is not None
_ExtraValue = TypeVar("_ExtraValue")
_MarkerValue = TypeVar("_MarkerValue")
_SubclassValue = TypeVar("_SubclassValue")
_LockInitValue = float | int | bool | str | None | Callable[[int], None]
class LockOptions(TypedDict, total=False):
"""Every option the metaclass forwards, so a subclass adding its own can still type what it passes through."""
timeout: float
mode: int
thread_local: bool
blocking: bool
is_singleton: bool
poll_interval: float
lifetime: float | None
context_error_policy: ContextErrorPolicy
close_error_policy: CloseErrorPolicy
fallback_to_soft: bool
preserve_lock_file: bool
on_acquired: Callable[[int], None] | None
def _is_exception_group(error: BaseException) -> bool:
return isinstance(error, BaseExceptionGroup)
def _raise_grouped_errors(
message: str,
first_error: BaseException,
second_error: BaseException,
*additional_errors: BaseException,
marker: tuple[str, _MarkerValue] | None = None,
) -> NoReturn:
errors = (first_error, second_error, *additional_errors)
_detach_grouped_contexts(errors)
group: Final = BaseExceptionGroup(message, errors)
if marker is not None:
setattr(group, marker[0], marker[1])
raise group from None
def _detach_grouped_contexts(errors: tuple[BaseException, ...]) -> None:
seen: set[int] = set()
pending = list(errors)
while pending:
error = pending.pop()
if id(error) in seen:
continue
seen.add(id(error))
if (context := error.__context__) is not None and (
context is error
or _same_exception_tree(error, context)
or any(context is root or _contains_exception(root, context) for root in errors)
):
error.__context__ = None
elif context is not None:
pending.append(context)
if error.__cause__ is not None:
pending.append(error.__cause__)
if _is_exception_group(error):
pending.extend(cast("_ExceptionGroupProtocol", error).exceptions)
def _same_exception_tree(first: BaseException, second: BaseException) -> bool:
pending = [(first, second)]
seen: set[tuple[int, int]] = set()
while pending:
first_error, second_error = pending.pop()
if first_error is second_error:
continue
if (pair := (id(first_error), id(second_error))) in seen:
continue
seen.add(pair)
if (
type(first_error) is not type(second_error)
or not _is_exception_group(first_error)
or not _is_exception_group(second_error)
):
return False
first_group = cast("_ExceptionGroupProtocol", first_error)
second_group = cast("_ExceptionGroupProtocol", second_error)
if first_group.message != second_group.message or len(first_group.exceptions) != len(second_group.exceptions):
return False
pending.extend(zip(first_group.exceptions, second_group.exceptions, strict=True))
return True
def _contains_exception(error: BaseException, target: BaseException | None) -> bool:
if target is None or not _is_exception_group(error):
return False
pending = list(cast("_ExceptionGroupProtocol", error).exceptions)
seen: set[int] = set()
while pending:
child = pending.pop()
if child is target:
return True
if id(child) in seen:
continue
seen.add(id(child))
if _is_exception_group(child):
pending.extend(cast("_ExceptionGroupProtocol", child).exceptions)
return False
def _append_exception_context(error: BaseException, context: BaseException) -> None:
if _exception_graph_contains(error, context) or _exception_graph_contains(context, error):
return
if error.__context__ is None:
error.__context__ = context
return
tail = error
seen: set[int] = set()
while id(tail) not in seen:
seen.add(id(tail))
if (next_error := tail.__cause__ if tail.__cause__ is not None else tail.__context__) is None:
tail.__context__ = context
return
tail = next_error
def _exception_graph_contains(error: BaseException, target: BaseException) -> bool:
pending = [error]
seen: set[int] = set()
while pending:
current = pending.pop()
if current is target:
return True
if id(current) in seen: # pragma: no cover - arbitrary caller exceptions can contain cycles
continue
seen.add(id(current))
if current.__cause__ is not None:
pending.append(current.__cause__)
if current.__context__ is not None:
pending.append(current.__context__)
if _is_exception_group(current):
pending.extend(cast("_ExceptionGroupProtocol", current).exceptions)
return False
def _grouped_errors(
error: BaseException, message: str, marker: tuple[str, _MarkerValue]
) -> tuple[BaseException, ...] | None:
if not _is_exception_group(error):
return None
group = cast("_ExceptionGroupProtocol", error)
return group.exceptions if group.message == message and getattr(group, marker[0], None) is marker[1] else None
if TYPE_CHECKING:
class _ExceptionGroupProtocol(Protocol):
@property
def message(self) -> str: ...
@property
def exceptions(self) -> tuple[BaseException, ...]: ...
def _raise_chained_errors(first_error: BaseException, second_error: BaseException | None = None) -> NoReturn:
if second_error is None:
first_context = first_error.__context__
try:
raise first_error # ruff:ignore[raise-within-try] # the handler restores caller-supplied context before propagation
except BaseException:
first_error.__context__ = first_context
raise
if (second_context := second_error.__context__) is not None and second_context is not first_error:
_detach_exception_context(second_context, first_error)
_append_exception_context(first_error, second_context)
first_context = first_error.__context__
try:
raise first_error # ruff:ignore[raise-within-try] # the second raise needs this error as implicit context
except BaseException: # ruff:ignore[blind-except] # first_error may be a control-flow exception
first_error.__context__ = first_context
try:
raise second_error # ruff:ignore[raise-within-try] # the handler makes the chain interpreter-independent
except BaseException:
second_error.__context__ = first_error
first_error.__context__ = first_context
raise
def _detach_exception_context(error: BaseException, target: BaseException) -> None:
pending = [error]
seen: set[int] = set()
while pending:
current = pending.pop()
if id(current) in seen:
continue
seen.add(id(current))
if current.__context__ is target:
current.__context__ = None
elif current.__context__ is not None:
pending.append(current.__context__)
if current.__cause__ is not None:
pending.append(current.__cause__)
if _is_exception_group(current):
pending.extend(cast("_ExceptionGroupProtocol", current).exceptions)
def _raise_body_and_release(body_error: BaseException, release_error: BaseException) -> NoReturn:
# Group mode: surface the body failure and the release failure as sibling leaves instead of letting one hide in the
# other's __context__. BaseExceptionGroup returns a plain ExceptionGroup when both leaves subclass Exception, so
# ``except*`` and ``except Exception`` still catch them; a BaseException leaf (KeyboardInterrupt, CancelledError)
# keeps the group outside ordinary handlers. ``from None`` stops the group itself gaining a redundant __context__.
_raise_grouped_errors("lock body and release both failed", body_error, release_error)
def _raise_cleanup_errors(
message: str,
primary_error: BaseException,
*cleanup_errors: BaseException | None,
) -> NoReturn:
_raise_grouped_errors(
message,
primary_error,
*(error for error in cleanup_errors if error is not None),
)
# On Windows os.path.realpath calls CreateFileW with share_mode=0, which blocks concurrent DeleteFileW and causes
# livelocks under threaded contention with SoftFileLock. os.path.abspath is purely string-based and avoids this.
_resolve_dir: Final[Callable[[str], str]] = os.path.abspath if sys.platform == "win32" else os.path.realpath
def _canonical(path: str | os.PathLike[str]) -> str:
"""
Return one stable key for *path*, collapsing equivalent spellings without following a final symlink.
Relative, absolute, and ``./`` spellings of one lock file must map to a single singleton instance, deadlock-registry
entry, and removal key. Resolving the whole path with ``realpath`` would follow a final symlink and alias a lock
target the backend deliberately rejects, so the registry identity would differ from the backend's. Resolving only
the parent directory and re-appending the literal final component collapses the equivalent spellings while keeping a
final symlink a distinct key. On Windows the parent is resolved with ``abspath`` so junctions and reparse points are
not followed either.
"""
parent, name = os.path.split(os.fspath(path))
return os.path.join(_resolve_dir(parent or os.curdir), name) # ruff:ignore[os-path-join] # string join matches abspath/realpath
class _ThreadLocalRegistry(local):
def __init__(self) -> None:
super().__init__()
self.held: dict[Hashable, int] = {}
_registry: Final[_ThreadLocalRegistry] = _ThreadLocalRegistry()
_T = TypeVar("_T", bound="BaseFileLock")
_LockT = TypeVar("_LockT", bound="BaseFileLock | ReadWriteLock | SoftReadWriteLock")
class FileLockMeta(ABCMeta):
_instances: WeakValueDictionary[str, BaseFileLock]
_instances_lock: RLock
_instances_under_construction: set[str]
def __call__( # ruff:ignore[too-many-arguments] # forwards the public constructor's documented parameters
cls: type[_T],
lock_file: str | os.PathLike[str],
timeout: float = -1,
mode: int = _UNSET_FILE_MODE,
thread_local: bool = True, # ruff:ignore[boolean-type-hint-positional-argument, boolean-default-value-positional-argument] # public API: positional bool kept for backwards compatibility
*,
blocking: bool = True,
is_singleton: bool = False,
poll_interval: float = 0.05,
lifetime: float | None = None,
context_error_policy: ContextErrorPolicy = "chain",
close_error_policy: CloseErrorPolicy = "default",
fallback_to_soft: bool = True,
preserve_lock_file: bool = False,
on_acquired: Callable[[int], None] | None = None,
**kwargs: _ExtraValue,
) -> _T:
_ensure_current_process()
lifetime = _resolve_lifetime(lifetime, cls, stacklevel=cls._constructor_lifetime_warning_stacklevel)
poll_interval = _resolve_poll_interval(poll_interval)
# Validate before building the instance: a raise inside __init__ would leave a half-constructed object whose
# __del__ then trips over the missing context.
_check_blocking(blocking)
# nan is left to acquire, which knows whether the call blocks; a non-blocking call ignores the timeout.
timeout = _seconds("timeout", timeout)
_check_mode(mode, cls.__name__)
context_error_policy = _resolve_context_error_policy(context_error_policy)
close_error_policy = _resolve_close_error_policy(close_error_policy)
preserve_lock_file = _resolve_preserve_lock_file(
preserve=preserve_lock_file, supported=cls._preserve_lock_file_supported, cls_name=cls.__name__
)
on_acquired = _resolve_on_acquired(on_acquired, supported=cls._on_acquired_supported, cls_name=cls.__name__)
# Checked before the singleton lookup so a cache hit rejects a misspelled option just like a fresh build does.
params: Final = _supported_init_params(
cls,
{
"timeout": timeout,
"mode": mode,
"thread_local": thread_local,
"blocking": blocking,
"is_singleton": is_singleton,
"poll_interval": poll_interval,
"lifetime": lifetime,
"context_error_policy": context_error_policy,
"close_error_policy": close_error_policy,
"fallback_to_soft": fallback_to_soft,
"preserve_lock_file": preserve_lock_file,
"on_acquired": on_acquired,
**kwargs,
},
)
if not is_singleton:
return super().__call__(lock_file, **params)
# Look up, build and store under one lock. Without it two threads racing the first construction for a
# path both miss the cache and each build their own instance, so callers relying on is_singleton for
# reentrant locking across instances end up with two "singletons" and acquire()'s deadlock check then
# rejects a legitimate reentrant acquire; the unguarded writes to the WeakValueDictionary are a data
# race besides. ReadWriteLock and SoftReadWriteLock already guard their singleton caches this way.
# Key the cache on the canonical form so equivalent spellings of one path share a singleton, and it matches the
# deadlock-registry key acquire() uses.
singleton_key = _canonical(lock_file)
with cls._instances_lock:
if (instance := cls._instances.get(singleton_key)) is None:
if singleton_key in cls._instances_under_construction: # pragma: needs fork
msg = f"Singleton lock construction is already active for {lock_file!s}"
raise RuntimeError(msg)
construction_registry = cls._instances_under_construction
construction_pid = os.getpid()
construction_registry.add(singleton_key)
try:
instance = super().__call__(lock_file, **params)
finally:
construction_registry.discard(singleton_key)
if os.getpid() != construction_pid: # pragma: needs fork
msg = "Lock construction cannot continue after fork; construct a new lock in the child"
raise RuntimeError(msg)
cls._instances[singleton_key] = instance
return instance
non_matching_params = {
name: (str(passed_param), str(set_param))
for name, (passed_param, set_param) in {
"thread_local": (thread_local, instance.is_thread_local()),
# Compare the wait, not the value: nan never equals itself, and -1, -5 and inf all mean no limit.
"timeout": (
_timeout_behavior(timeout, any_negative=True),
_timeout_behavior(instance.timeout, any_negative=True),
),
"mode": (mode, instance._context.mode), # ruff:ignore[private-member-access] # compares against the managed instance's own context
"blocking": (blocking, instance.blocking),
"poll_interval": (poll_interval, instance.poll_interval),
"lifetime": (lifetime, instance.lifetime),
"context_error_policy": (context_error_policy, instance.context_error_policy),
"close_error_policy": (close_error_policy, instance.close_error_policy),
"fallback_to_soft": (fallback_to_soft, instance.fallback_to_soft),
"preserve_lock_file": (preserve_lock_file, instance.preserve_lock_file),
}.items()
if passed_param != set_param
}
# The metaclass owns the instance it returns, so reading the subclass hook stays inside this module's contract.
non_matching_params.update(instance._singleton_extra_mismatches(kwargs)) # ruff:ignore[private-member-access]
# Callables compare by identity, not equality: two equal callables can close over different state, so a
# singleton must reject a different hook object even if it compares equal. Keep it out of the scalar dict above.
hook_mismatch = on_acquired is not instance.on_acquired
if not non_matching_params and not hook_mismatch:
return instance # ty: ignore[invalid-return-type] # https://github.com/astral-sh/ty/issues/3231
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)"
if hook_mismatch:
msg += f"\n\ton_acquired (existing lock has {instance.on_acquired} but {on_acquired} was passed)"
raise ValueError(msg)
def _resolve_lifetime(lifetime: float | None, cls: type[BaseFileLock], *, stacklevel: int) -> float | None:
"""
Validate ``lifetime`` and drop a value the backend cannot honor.
``lifetime`` is a deliberate age-based lease: a lock file older than ``lifetime`` is broken even while its holder is
still alive. Existence locks (:class:`SoftFileLock`) implement that behavior by unlinking a reclaimable pathname,
which can overlap a live holder. A native OS lock lives on the inode, so unlinking the pathname by age cannot revoke
the kernel lock; a contender would lock a fresh inode and overlap the live holder (#590). Ignore the request with a
warning rather than accept a setting that breaks mutual exclusion.
"""
if lifetime is None:
return None
# An int stays exact: no float holds every int 4.0.12 accepted here.
if isinstance(lifetime, bool) or not isinstance(lifetime, int):
lifetime = _seconds("lifetime", lifetime)
if lifetime < 0 or (isinstance(lifetime, float) and not math.isfinite(lifetime)):
msg = f"lifetime must be finite and non-negative, not {lifetime!r}"
raise ValueError(msg)
if not cls._lifetime_supported:
warnings.warn(
f"lifetime is ignored for {cls.__name__}: {cls._lifetime_unsupported_reason}; "
f"only SoftFileLock supports lifetime-based expiry",
stacklevel=stacklevel,
)
return None
if cls._lifetime_replacements is not None:
strict_lock, lease = cls._lifetime_replacements
warnings.warn(
f"{cls.__name__}(lifetime=...) uses age-based expiry and can overlap a live holder; "
f"use {lease} for expiry or {strict_lock} for fail-closed locking",
SoftFileLockLifetimeWarning,
stacklevel=stacklevel,
)
return lifetime
def _resolve_poll_interval(poll_interval: float) -> float:
"""Validate ``poll_interval`` used for ``time.sleep`` / ``asyncio.sleep`` retries."""
if (poll_interval := _seconds("poll_interval", poll_interval)) < 0 or not math.isfinite(poll_interval):
msg = f"poll_interval must be finite and non-negative, not {poll_interval!r}"
raise ValueError(msg)
_check_timeout_max("poll_interval", poll_interval)
return poll_interval
def _check_blocking(blocking: bool) -> None: # ruff:ignore[boolean-type-hint-positional-argument] # validates the option's own value
if not isinstance(blocking, bool):
msg = f"blocking must be a bool, not {type(blocking).__name__}"
raise TypeError(msg)
def _seconds(name: str, value: float) -> float:
# 4.0.12 accepted Decimal and Fraction; a bool is a typo, and a string would only fail later.
if isinstance(value, bool) or not isinstance(value, (Real, Decimal)):
msg = f"{name} must be a number of seconds, not {type(value).__name__}"
raise TypeError(msg)
# float() refuses a signaling NaN, which means no number of seconds just as a quiet one does.
if isinstance(value, Decimal) and value.is_snan():
return math.nan
try:
seconds: Final = float(value)
except OverflowError:
msg = f"{name} is too large to be a number of seconds: {value!r}"
raise ValueError(msg) from None
# float() rounds a tiny negative to -0.0, which compares as zero, yet timeout and lifetime checks read the sign.
return -math.ulp(0.0) if seconds == 0 and value < 0 else seconds
def _check_mode(mode: int, cls_name: str) -> None:
if mode == _UNSET_FILE_MODE:
return
if isinstance(mode, bool) or not isinstance(mode, int):
msg = f"mode must be an int, not {type(mode).__name__}"
raise TypeError(msg)
# A lock file is never executed, so setuid, setgid and sticky have no meaning on it and only widen its permissions.
if not 0 <= mode <= _PERMISSION_BITS:
msg = f"mode={mode:#o} must be within 0o000-0o777 for {cls_name}"
raise ValueError(msg)
# A lock reopens, reads, or deletes the files it creates, so a mode that denies the owner read or write fails later
# and for good.
if ~mode & (stat.S_IRUSR | stat.S_IWUSR):
msg = f"mode={mode:#o} must grant the owner read and write for {cls_name}"
raise ValueError(msg)
def _resolve_context_error_policy(policy: str) -> ContextErrorPolicy:
if policy not in _CONTEXT_ERROR_POLICIES:
msg = f"context_error_policy must be 'chain' or 'group', got {policy!r}"
raise ValueError(msg)
return cast("ContextErrorPolicy", policy)
def _resolve_close_error_policy(policy: str) -> CloseErrorPolicy:
if policy not in _CLOSE_ERROR_POLICIES:
msg = f"close_error_policy must be 'default', 'raise', or 'suppress', got {policy!r}"
raise ValueError(msg)
return cast("CloseErrorPolicy", policy)
def _resolve_preserve_lock_file(*, preserve: bool, supported: bool, cls_name: str) -> bool:
# An existence lock unlinks its marker to release, so preserving the pathname would defeat unlocking. Reject the
# request rather than silently ignore it, since a caller asking for a stable identity must know it cannot be kept.
if preserve and not supported:
msg = f"preserve_lock_file=True is not supported by {cls_name}: unlinking its marker is how it releases"
raise ValueError(msg)
return preserve
def _resolve_on_acquired(
on_acquired: Callable[[int], None] | None, *, supported: bool, cls_name: str
) -> Callable[[int], None] | None:
if on_acquired is None:
return None
# An existence lock stores protocol state in its marker, so a caller writing through the descriptor would corrupt
# stale detection and ownership metadata; only native locks lend out the descriptor.
if not supported:
msg = f"on_acquired is not supported by {cls_name}: only native locks expose the lock descriptor"
raise ValueError(msg)
return on_acquired
def _supported_init_params(
cls: type[BaseFileLock], params: dict[str, _LockInitValue | _ExtraValue]
) -> dict[str, _LockInitValue | _ExtraValue]:
if (model := _init_parameter_model(cls)).accepts_kwargs:
return params
if unsupported := sorted(
name
for name, value in params.items()
if name not in model.accepted_params
and ((parameter := model.default_params.get(name)) is None or value != parameter.default)
):
msg = f"{cls.__name__} does not support non-default lock options: {', '.join(unsupported)}"
raise TypeError(msg)
# virtualenv narrows a BaseFileLock descendant's signature; omit base defaults it does not accept (#340).
return {name: value for name, value in params.items() if name in model.accepted_params}
def _timeout_behavior(timeout: float, *, any_negative: bool) -> float | str:
# inf, and for a BaseFileLock any negative value, wait without a limit like -1.
if math.isnan(timeout):
return "nan"
return -1.0 if timeout == math.inf or (any_negative and timeout < 0) else timeout
def _check_timeout_max(name: str, value: float) -> None:
# Lock.acquire, Event.wait and time.sleep raise OverflowError past this bound, which is only ~49.7 days on Windows.
if value > TIMEOUT_MAX:
msg = f"{name} must not exceed threading.TIMEOUT_MAX ({TIMEOUT_MAX}), got {value!r}"
raise ValueError(msg)
_INIT_PARAMETER_MODELS: Final[WeakKeyDictionary[type[BaseFileLock], _InitParameterModel]] = WeakKeyDictionary()
def _init_parameter_model(cls: type[BaseFileLock]) -> _InitParameterModel:
# A strong cache would keep dynamically created subclasses alive for the process lifetime.
with _fork_transition(), _FORK_STATE.parameter_models_lock:
if (model := _INIT_PARAMETER_MODELS.get(cls)) is None:
parameters = inspect.signature(cls.__init__).parameters.values()
model = _InitParameterModel(
accepted_params=frozenset(
parameter.name
for parameter in parameters
if parameter.kind in {inspect.Parameter.POSITIONAL_OR_KEYWORD, inspect.Parameter.KEYWORD_ONLY}
),
accepts_kwargs=any(parameter.kind is inspect.Parameter.VAR_KEYWORD for parameter in parameters),
default_params={
name: parameter
for name, parameter in inspect.signature(type(cls).__call__).parameters.items()
if parameter.default is not inspect.Parameter.empty
},
)
_INIT_PARAMETER_MODELS[cls] = model
return model
@dataclass(frozen=True)
class _InitParameterModel:
accepted_params: frozenset[str]
accepts_kwargs: bool
default_params: dict[str, inspect.Parameter]
class BaseFileLock(contextlib.ContextDecorator, metaclass=FileLockMeta): # ruff:ignore[too-many-public-methods] # public config properties
"""
Abstract base class for a file lock object.
Provides the common reentrant API and state management. Subclasses implement the locking mechanism
(:class:`UnixFileLock <filelock.UnixFileLock>`, :class:`WindowsFileLock <filelock.WindowsFileLock>`,
:class:`SoftFileLock <filelock.SoftFileLock>`).
"""
_instances: WeakValueDictionary[str, BaseFileLock]
_instances_lock: RLock
_instances_under_construction: set[str]
#: How the cross-instance deadlock message names the conflicting holder; the async subclass says "task".
_deadlock_holder_desc: str = "FileLock instance in this thread"
#: Whether an age-based :attr:`lifetime` lease may break this lock. Only existence locks set it (they reclaim by
#: unlinking a pathname); native OS locks leave it ``False`` since a kernel lock cannot be revoked by file age.
_lifetime_supported: bool = False
#: Strict-lock and lease replacements for a backend with legacy age-based expiry.
_lifetime_replacements: tuple[str, str] | None = None
#: Why a backend that refuses ``lifetime`` cannot honor it, named in the warning that drops the value.
_lifetime_unsupported_reason: str = "a native OS lock cannot be broken safely by file age"
#: Async construction adds one metaclass frame before lifetime validation.
_constructor_lifetime_warning_stacklevel: int = 3
#: Whether :attr:`preserve_lock_file` may be ``True``. Native locks keep the pathname on release, so they support
#: it; existence locks unlink their marker to release and reject it.
_preserve_lock_file_supported: bool = True
#: Whether an :attr:`on_acquired` hook may be set. Native locks lend the descriptor out; existence locks keep
#: protocol state in the marker and reject it.
_on_acquired_supported: bool = True
#: Ceiling in seconds on the jittered backoff between contended acquisition retries. ``0`` keeps the fixed
#: poll cadence; a multi-file backend sets it so contending processes desynchronize instead of livelocking.
_poll_backoff_cap: float = 0.0
def __init_subclass__(cls, **kwargs: _SubclassValue) -> None:
"""Give each lock subclass its own singleton registry and lock."""
super().__init_subclass__(**kwargs)
cls._instances = WeakValueDictionary()
cls._instances_lock = RLock()
cls._instances_under_construction = set()
_register_fork_class(cls)
@classmethod
def _reset_class_after_fork(cls) -> None: # pragma: forked child
cls._instances = WeakValueDictionary()
cls._instances_lock = RLock()
cls._instances_under_construction = set()
def __init__( # ruff:ignore[too-many-arguments] # public constructor: one parameter per documented lock option
self,
lock_file: str | os.PathLike[str],
timeout: float = -1,
mode: int = _UNSET_FILE_MODE,
thread_local: bool = True, # ruff:ignore[boolean-type-hint-positional-argument, boolean-default-value-positional-argument] # public API: positional bool kept for backwards compatibility
*,
blocking: bool = True,
is_singleton: bool = False,
poll_interval: float = 0.05,
lifetime: float | None = None,
context_error_policy: ContextErrorPolicy = "chain",
close_error_policy: CloseErrorPolicy = "default",
fallback_to_soft: bool = True,
preserve_lock_file: bool = False,
on_acquired: Callable[[int], None] | 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 or ``inf``. 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. Construction raises
:class:`ValueError` unless it grants the owner read and write, which the lock needs for its own files.
: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. ``mode`` has no setter, so construction is the only place it is ever set. 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: for :class:`SoftFileLock`, the age in seconds after which a waiting process may delete the
marker, even while its holder remains alive. This legacy expiry mode does not provide strict mutual
exclusion. ``None`` (the default) disables age-based expiry. Native OS locks (:class:`FileLock`) cannot be
revoked by file age and ignore a non-``None`` ``lifetime`` with a warning.
:param context_error_policy: how a context manager reconciles a failure in its body with a failure while
releasing on exit. ``"chain"`` (the default) keeps Python's behavior: the release error propagates with the
body error in its ``__context__``. ``"group"`` raises a :class:`BaseExceptionGroup` holding the body error
first and the release error second, so neither hides the other.
:param close_error_policy: what to do with an ``os.close`` failure after relinquishing descriptor ownership.
``"default"`` keeps each backend's historical behavior (Unix native locks drop a FUSE/Docker ``EIO``;
Windows native locks and :class:`SoftFileLock` propagate); ``"raise"`` always propagates the ``OSError``;
``"suppress"`` always ignores it. Held state is released either way. It does not affect unlock failures or
lock-file deletion.
:param fallback_to_soft: for :class:`UnixFileLock`, whether to switch to :class:`SoftFileLock` when the
filesystem's ``flock`` returns ``ENOSYS``. ``True`` (the default) keeps the historical fallback;
``False`` fails closed, letting the ``ENOSYS`` propagate so a caller that needs kernel-enforced
locking is never silently downgraded. It has no effect on Windows or :class:`SoftFileLock`.
:param preserve_lock_file: for native locks (:class:`FileLock`), whether filelock promises not to unlink the
lock pathname on release. ``False`` (the default) keeps each backend's cleanup: Windows removes the lock
file, Unix already leaves it. ``True`` keeps a stable file identity for ACLs, auditing, and holder metadata:
Windows skips its post-release unlink and Unix refuses to enter the ``ENOSYS`` soft fallback (which releases
by unlinking). :class:`SoftFileLock` rejects ``True``. The promise covers filelock's own release path only;
it cannot stop another process or the filesystem from removing the pathname.
:param on_acquired: for native locks (:class:`FileLock`), a callable invoked with the borrowed lock descriptor
once per physical acquisition, after filelock holds the native lock and finished backend initialization but
before :meth:`~BaseFileLock.acquire` returns. Recursive acquisitions do not call it again. The callback may
read, write, seek, truncate, or set metadata through ``os`` on the descriptor, but must not close, unlock,
or take ownership of it, and filelock does not fsync its writes. If it raises, filelock releases the lock
and re-raises. :class:`SoftFileLock` rejects the hook.
:raises TypeError: if *timeout* or *poll_interval* is a :class:`bool` or not a real number, *blocking* is not a
:class:`bool`, or *mode* is not an :class:`int`
:raises ValueError: if *poll_interval* is negative, not finite, or above :data:`threading.TIMEOUT_MAX`, if
*timeout* is too large to convert to :class:`float`, or if *mode* falls outside ``0o000``-``0o777`` or
denies the owner read and write
"""
self._creator_pid = os.getpid()
self._transition_lock = RLock()
self._is_thread_local = thread_local
self._is_singleton = is_singleton
self._context_error_policy = context_error_policy # already validated by the metaclass
self._close_error_policy = close_error_policy # already validated by the metaclass
self._fallback_to_soft = fallback_to_soft
self._preserve_lock_file = preserve_lock_file # already validated by the metaclass
self._on_acquired = on_acquired # already validated by the metaclass
self._context: FileLockContext = (ThreadLocalFileContext if thread_local else FileLockContext)(
lock_file=os.fspath(lock_file),
timeout=timeout,
mode=mode,
blocking=blocking,
poll_interval=poll_interval,
lifetime=lifetime,
)
#: Each thread's committed hold on a thread-local lock, so another thread can release it.
self._thread_holds: dict[int, tuple[FileLockContext, Thread]] = {}
#: Each thread's uncommitted acquisition, so a backend can finish it for an exited thread.
self._thread_pending: dict[int, tuple[FileLockContext, Thread]] = {}
_register_fork_object(self)
def _singleton_extra_mismatches( # ruff:ignore[no-self-use] # the base class adds no options of its own
self, _kwargs: Mapping[str, _ExtraValue], /
) -> dict[str, tuple[str, str]]:
# A subclass's own options reach the metaclass only as kwargs, and only the subclass knows their defaults and
# how __init__ resolves them, so each override compares its options and merges what super() reports.
return {}
def is_thread_local(self) -> bool:
""":returns: a flag indicating if this lock is thread local or not"""
return self._is_thread_local
@property
def is_singleton(self) -> bool:
"""
A flag indicating if this lock is singleton or not.
.. versionadded:: 3.13.0
"""
return self._is_singleton
@property
def context_error_policy(self) -> ContextErrorPolicy:
"""
How a context manager reconciles a body failure with a release failure on exit.
.. versionadded:: 3.30.0
"""
return self._context_error_policy
@property
def close_error_policy(self) -> CloseErrorPolicy:
"""
What a lock does with an ``os.close`` failure after relinquishing descriptor ownership.
.. versionadded:: 3.30.0
"""
return self._close_error_policy
def _close_released_fd(self, fd: int, *, default_suppresses: bool) -> None:
# CPython never retries close() after EINTR because the descriptor number may already be reused, so neither does
# this. close_error_policy decides the error's fate after the backend relinquishes descriptor ownership.
try:
os.close(fd)
except OSError:
if not self._suppresses_close_error(default_suppresses=default_suppresses):
raise
def _suppresses_close_error(self, *, default_suppresses: bool) -> bool:
return self._close_error_policy == "suppress" or (self._close_error_policy == "default" and default_suppresses)
@property
def fallback_to_soft(self) -> bool:
"""
Whether a :class:`FileLock` falls back to :class:`SoftFileLock` when the filesystem lacks ``flock``.
Only :class:`UnixFileLock` acts on it: when ``False`` an ``ENOSYS`` from ``flock`` propagates instead of
switching to existence-lock semantics.
.. versionadded:: 3.30.0
"""
return self._fallback_to_soft
@property
def preserve_lock_file(self) -> bool:
"""
Whether filelock promises not to unlink the lock pathname on release.
When ``True``, Windows skips its post-release unlink and Unix refuses the ``ENOSYS`` soft fallback.
:class:`SoftFileLock` rejects ``True`` because unlinking its marker is how it releases.
.. versionadded:: 3.30.0
"""
return self._preserve_lock_file
@property
def on_acquired(self) -> Callable[[int], None] | None:
"""
The callback run with the borrowed lock descriptor once per physical acquisition, or ``None``.
Native locks only. It runs after the native lock is held and backend initialization finished, before
:meth:`~BaseFileLock.acquire` returns; a raise rolls back the acquisition. :class:`SoftFileLock` rejects it.
.. versionadded:: 3.30.0
"""
return self._on_acquired
@property
def lock_file(self) -> str:
"""Path to the lock file."""
return self._context.lock_file
@property
def timeout(self) -> float:
"""
The default timeout value, in seconds.
.. versionadded:: 2.0.0
"""
return self._context.timeout
@timeout.setter
def timeout(self, value: float | str | bytes | bytearray) -> None:
"""
Change the default timeout value.
:param value: the new value, in seconds; a negative value or ``inf`` waits without a limit
:raises TypeError: if *value* is a :class:`bool` or not a real number
:raises ValueError: if *value* is too large to convert to :class:`float`
.. deprecated:: 4.0.13
Passing a numeric string; pass the number instead.
"""
if isinstance(value, (str, bytes, bytearray)):
warnings.warn(
"setting timeout from a string is deprecated and will be removed; pass a number",
DeprecationWarning,
stacklevel=2,
)
value = float(value)
self._context.timeout = _seconds("timeout", value)
@property
def blocking(self) -> bool:
"""
Whether the locking is blocking or not.
.. versionadded:: 3.14.0
"""
return self._context.blocking
@blocking.setter
def blocking(self, value: bool) -> None:
"""
Change the default blocking value.
:param value: the new value as bool
:raises TypeError: if *value* is not a bool
"""
_check_blocking(value)
self._context.blocking = value
@property
def poll_interval(self) -> float:
"""
The default polling interval, in seconds.
.. versionadded:: 3.24.0
"""
return self._context.poll_interval
@poll_interval.setter
def poll_interval(self, value: float) -> None:
"""
Change the default polling interval.
:param value: the new value, in seconds
:raises ValueError: if *value* is negative, not finite, or above :data:`threading.TIMEOUT_MAX`
:raises TypeError: if *value* is a :class:`bool` or not a real number
"""
self._context.poll_interval = _resolve_poll_interval(value)
@property
def lifetime(self) -> float | None:
"""
The soft marker age in seconds that permits expiry, or ``None`` to disable age-based expiry.
A non-``None`` value permits a waiter to enter while the previous holder remains active, so it does not provide
strict mutual exclusion. Native locks ignore the value with a warning.
.. versionadded:: 3.24.0
"""
return self._context.lifetime
@lifetime.setter
def lifetime(self, value: float | None) -> None:
"""
Change the legacy age-based expiry threshold.
:param value: the new value in seconds, or ``None`` to disable expiration
:raises ValueError: if *value* is negative or not finite
:raises TypeError: if *value* is not ``None`` and not a real number
"""
self._context.lifetime = _resolve_lifetime(value, type(self), stacklevel=3)
@property
def mode(self) -> int:
"""
The file permissions requested for the lock file.
Without an explicit ``mode`` this reports ``0o644`` for backwards compatibility, but the file is created with
``0o666`` filtered through the umask and default ACLs, so with a ``002`` umask it ends up ``0o664``. Check
:attr:`has_explicit_mode` before relying on the value, or ``os.stat`` the file for its actual permissions.
"""
return 0o644 if self._context.mode == _UNSET_FILE_MODE else self._context.mode
@property
def has_explicit_mode(self) -> bool:
"""Whether the file permissions were explicitly set."""
return self._context.mode != _UNSET_FILE_MODE
def _open_mode(self) -> int:
"""Mode for ``os.open``: 0o666 when unset so umask and ACLs decide, otherwise the explicit mode."""
return 0o666 if self._context.mode == _UNSET_FILE_MODE else self._context.mode
@property
def is_locked(self) -> bool:
"""
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.
"""
_ensure_current_process()
return self._context.lock_file_fd is not None
@property
def lock_counter(self) -> int:
"""The number of times this lock has been acquired (but not yet released)."""
_ensure_current_process()
return self._context.lock_counter
def __enter__(self) -> Self:
"""
Acquire the lock.
:returns: 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, reconciling a release failure with any body failure per :attr:`context_error_policy`."""
self._release_in_context(exc_value)
def _release_in_context(self, body_error: BaseException | None) -> None:
# Release from a context-manager exit. "chain" lets a release failure propagate with the body error already in
# its __context__ (Python's default); "group" raises both as sibling leaves so neither one hides the other.
try:
self.release()
except BaseException as release_error:
if body_error is None or self._context_error_policy == "chain":
raise
_raise_body_and_release(body_error, release_error)
def __del__(self) -> None:
"""Force-release so a dropped reference never leaks a held lock, including every thread's hold."""
if vars(self).get("_creator_pid") != os.getpid():
return # pragma: forked child
# A finalizer must not raise. A release error during garbage collection would otherwise surface as an
# unraisable-exception warning, attributed to whichever code triggered collection. The dropped lock still gets
# best-effort cleanup; an explicit release() reports the same error to a caller who can act on it.
with contextlib.suppress(Exception):
self.release(force=True)
# Nothing references the lock any more, so no thread can still be inside it through this instance.
with contextlib.suppress(Exception):
self._release_thread_holds(exited_only=False)
def acquire(
self,
timeout: float | None = None,
poll_interval: float | None = None,
*,
poll_intervall: float | None = None,
blocking: bool | None = None,
cancel_check: Callable[[], bool] | None = None,
) -> AcquireReturnProxy[Self]:
"""
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: whether to retry until this call holds the lock or the timeout expires, ``None`` means use
the default :attr:`~blocking`. ``False`` makes one attempt and raises :class:`~Timeout` on failure.
: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
:raises ValueError: if a blocking call gets a ``nan`` timeout, or *poll_interval* exceeds
:data:`threading.TIMEOUT_MAX`
.. 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.
"""
self._raise_if_inherited()
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
poll_interval = poll_interval if poll_interval is not None else self._context.poll_interval
poll_interval = _resolve_poll_interval(poll_interval)
timeout = _resolve_timeout(timeout, blocking=blocking)
start_time = time.perf_counter()
# Wait for admission before touching any state: a caller refused entry must leave the counter, the registry and
# the descriptor exactly as it found them.
with self._transition_admission(
blocking=blocking,
cancel_check=cancel_check,
timeout=timeout,
poll_interval=poll_interval,
start_time=start_time,
):
# The interrupted acquire cannot run until the handler returns, so a second one here would wait on it
# forever or take the lock out from under it. Once the lock is held, as in an on_acquired hook, it nests.
if not self.is_locked and _on_this_stack(self._context.acquiring):
msg = f"Deadlock: lock '{self.lock_file}' is acquired again while this thread's acquire of it waits"
raise RuntimeError(msg)
# Bump the counter up front; _undo_acquire rolls it back if acquisition fails.
self._context.lock_counter += 1
canonical = _canonical(self.lock_file)
self._raise_if_would_deadlock(canonical, timeout=timeout, blocking=blocking)
try:
self._poll_until_acquired(
blocking=blocking,
cancel_check=cancel_check,
timeout=timeout,
poll_interval=poll_interval,
start_time=start_time,
)
except BaseException:
self._reconcile_failed_acquire(canonical)
raise
self._commit_acquire(canonical)
return AcquireReturnProxy(lock=self)
@contextlib.contextmanager
def _transition_admission(
self,
*,
blocking: bool,
cancel_check: Callable[[], bool] | None,
timeout: float,
poll_interval: float,
start_time: float,
) -> Generator[None]:
# One thread at a time drives the physical transition of a shared instance: its counter, descriptor and claim
# state are plain attributes every thread reads and writes, so an unserialized loser clears the winner's
# descriptor or double-closes it. Waiting in slices keeps cancel_check and the timeout live. A thread-local
# context is never shared, so it skips the gate.
if self._is_thread_local:
yield
return
deadline: Final = None if timeout < 0 else start_time + timeout
wait: Final = poll_interval if blocking else 0.0
# wait leads the min() so a non-blocking call, whose nan timeout goes unchecked, waits 0 rather than nan.
while not self._transition_lock.acquire(
timeout=wait if deadline is None else min(wait, max(deadline - time.perf_counter(), 0.0))
):
if not blocking or (cancel_check is not None and cancel_check()):
raise Timeout(self.lock_file)
if deadline is not None and time.perf_counter() >= deadline:
raise Timeout(self.lock_file)
try:
yield
finally:
self._transition_lock.release()
def release(self, force: bool = False) -> None: # ruff:ignore[boolean-type-hint-positional-argument, boolean-default-value-positional-argument] # public API: positional bool kept for backwards compatibility
"""
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. On a thread-local
lock it also releases the holds of threads that exited without releasing; a hold of a thread still running
stays with that thread. Dropping the last reference to the lock releases every thread's hold.
"""
self._release_current(force=force)
if force:
self._release_thread_holds(exited_only=True)
def _release_current(self, *, force: bool) -> None:
# A shared instance releases under the same gate its acquisition ran through, so a thread entering the lock
# never observes a partially torn-down owner. Only an acquirer that found the lock free holds the gate for
# long, so an unheld lock returns without waiting behind it.
if self._context.lock_file_fd is None:
# Only a committed hold registers, so an entry without a descriptor is a release a signal handler stopped
# after the unlock; left alone it refuses every other instance on this path in this thread.
if self._context.lock_file_registry is not None:
self._finish_interrupted_release()
return
with contextlib.nullcontext() if self._is_thread_local else self._transition_lock:
state: Final = self._hold_state()
# A signal handler can land between the backend's unlock and its clearing of the descriptor, where a second
# release would close the number twice, maybe hitting a file that reused it. The flag holds the releasing
# frame, so only a release still on this stack stops it, and a flag a cut-short frame left set does not.
if self._creator_pid != os.getpid() or state.lock_file_fd is None or _on_this_stack(state.releasing):
return
if not force and state.lock_counter > 1:
state.lock_counter -= 1
return
state.releasing = inspect.currentframe()
try:
_LOGGER.debug("Attempting to release lock %s on %s", id(self), self.lock_file)
self._release_with_fork_tracking()
finally:
# A failure after the OS unlock (during close or unlink) still released the lock: the backend cleared
# its descriptor, so commit the counter and registry to released even as the cleanup error propagates.
# A failure that left the lock held keeps the counter so a later release can retry the OS unlock.
if state.lock_file_fd is None: # pragma: no branch # a release that returns cleared the descriptor
self._commit_release()
state.releasing = None
_LOGGER.debug("Lock %s released on %s", id(self), self.lock_file)
def _finish_interrupted_release(self) -> None:
# An unheld lock never waits behind an acquirer, whose own commit takes the entry over anyway.
if not self._transition_lock.acquire(blocking=False):
return # pragma: no cover # only a concurrent acquire of a shared instance holds the gate
try:
if self._context.lock_file_fd is None: # pragma: no branch # only a racing acquire fills it
self._commit_release()
finally:
self._transition_lock.release()
def _hold_state(self) -> FileLockContext:
return self._context.current if isinstance(self._context, ThreadLocalFileContext) else self._context
def _release_thread_holds(self, *, exited_only: bool) -> None:
if not isinstance(context := self._context, ThreadLocalFileContext):
return
# Serialized, or two threads would both close an exited thread's descriptor; copy() is atomic free-threaded.
with self._transition_lock:
own: Final = context.current
for held, thread in self._thread_holds.copy().values():
if exited_only and thread.is_alive():
continue
context.current = held
try:
self._release_current(force=True)
finally:
context.current = own
def _raise_if_inherited(self) -> None:
if self._creator_pid != os.getpid(): # pragma: forked child
msg = f"{type(self).__name__} on {self.lock_file} was inherited across fork; construct a new instance"
raise RuntimeError(msg)
def _mark_descriptor_owned(self, fd: int, identity: tuple[int, int] | None = None) -> None:
state: Final = self._hold_state()
state.pending_lock_file_fd = None
state.pending_lock_file_fd_identity = None
state.lock_file_fd = fd
state.lock_file_fd_identity = identity
if isinstance(self._context, ThreadLocalFileContext):
self._thread_pending.pop(id(state), None)
self._thread_holds[id(state)] = state, current_thread()
def _mark_descriptor_pending(self, fd: int, identity: tuple[int, int] | None = None) -> None:
state: Final = self._hold_state()
state.pending_lock_file_fd = fd
state.pending_lock_file_fd_identity = identity
if isinstance(self._context, ThreadLocalFileContext):
self._thread_pending[id(state)] = state, current_thread()
def _mark_descriptor_released(self) -> None:
state: Final = self._hold_state()
state.pending_lock_file_fd = None
state.pending_lock_file_fd_identity = None
state.lock_file_fd = None
state.lock_file_fd_identity = None
if isinstance(self._context, ThreadLocalFileContext):
self._thread_pending.pop(id(state), None)
self._thread_holds.pop(id(state), None)
def _reset_after_fork_in_child(self) -> None: # pragma: forked child
# fork copies the lock in whatever state the parent's threads left it, so give the child an unheld one.
self._transition_lock = RLock()
if isinstance(self._context, ThreadLocalFileContext):
self._thread_holds.clear()
self._thread_pending.clear()
self._context.owner_claim_paths = ()
self._context.claim_root = None
self._context.lock_file_fd = None
self._context.lock_file_fd_token = None
self._context.lock_file_fd_identity = None
self._context.pending_lock_file_fd = None
self._context.pending_lock_file_fd_identity = None
self._context.lock_counter = 0
self._context.releasing = None
self._context.acquiring = None
self._context.lock_file_key = None
self._context.lock_file_registry = None
def _descriptors_for_fork(self) -> tuple[tuple[int, tuple[int, int] | None], ...]: # pragma: needs fork
descriptors: list[tuple[int, tuple[int, int] | None]] = []
if self._context.lock_file_fd is not None and self._context.lock_file_fd_token is None:
descriptors.append((self._context.lock_file_fd, self._context.lock_file_fd_identity))
if self._context.pending_lock_file_fd is not None:
descriptors.append((self._context.pending_lock_file_fd, self._context.pending_lock_file_fd_identity))
return tuple(descriptors)
def _raise_if_would_deadlock(self, canonical: str, *, timeout: float, blocking: bool) -> None:
"""
Fail fast when a *different* live instance already holds this path in the current deadlock scope.
Only the first, indefinitely-blocking acquire can self-deadlock this way: waiting in the OS primitive would
block on a lock this flow already owns. A finite timeout or ``blocking=False`` keeps the normal Timeout path.
"""
would_block = self._context.lock_counter == 1 and not self.is_locked and timeout < 0 and blocking
if would_block and _registry.held.get(self._registry_key(canonical)) not in {None, id(self)}:
self._context.lock_counter -= 1
msg = (
f"Deadlock: lock '{self.lock_file}' is already held by a different {self._deadlock_holder_desc}. "
f"Use is_singleton=True to enable reentrant locking across instances."
)
raise RuntimeError(msg)
def _registry_key(self, canonical: str) -> Hashable:
return canonical if (scope := self._deadlock_scope()) is None else (scope, canonical)
@staticmethod
def _deadlock_scope() -> Hashable | None:
"""
Execution unit whose own hold would deadlock a new acquire.
``None`` scopes holders to the thread, which the thread-local registry already separates. Async locks
override it with the running task, since one event loop thread runs many tasks and only a reacquire from
the *same* task can self-deadlock.
"""
return None
def _poll_until_acquired(
self,
*,
blocking: bool,
cancel_check: Callable[[], bool] | None,
timeout: float,
poll_interval: float,
start_time: float,
) -> None:
lock_id = id(self)
lock_filename = self.lock_file
attempt = 0
self._context.acquiring = inspect.currentframe()
try:
while True:
self._raise_if_inherited()
if not self.is_locked:
self._try_break_expired_lock()
_LOGGER.debug("Attempting to acquire lock %s on %s", lock_id, lock_filename)
self._acquire_with_fork_tracking()
self._raise_if_inherited()
if self.is_locked:
_LOGGER.debug("Lock %s acquired on %s", lock_id, lock_filename)
return
if self._check_give_up(
blocking=blocking,
cancel_check=cancel_check,
timeout=timeout,
start_time=start_time,
):
raise Timeout(lock_filename, self._unprobeable_holder())
attempt += 1
delay = self._poll_delay(poll_interval, attempt)
if timeout >= 0:
delay = min(delay, max(start_time + timeout - time.perf_counter(), 0.0))
msg = "Lock %s not acquired on %s, waiting %s seconds ..."
_LOGGER.debug(msg, lock_id, lock_filename, delay)
time.sleep(delay)
finally:
self._context.acquiring = None
def _poll_delay(self, poll_interval: float, attempt: int) -> float:
# A single-file lock retries on a fixed cadence. A backend that publishes several files per acquisition sets a
# cap, and then contending processes back off across a jittered, exponentially widening window instead of
# colliding on every poll; poll_interval stays the floor so a lone waiter is still responsive.
if not self._poll_backoff_cap:
return poll_interval
# Cap the exponent before doubling: under heavy contention attempt reaches the thousands, and 2**attempt would
# overflow the float multiply long before the window itself stops growing past the cap.
window = min(
self._poll_backoff_cap, poll_interval * 2 ** min(attempt, _MAX_BACKOFF_EXPONENT)
) # pragma: needs hard-link
return max(poll_interval, secrets.randbelow(int(window * 1_000_000) + 1) / 1_000_000) # pragma: needs hard-link
def _reconcile_failed_acquire(self, canonical: str) -> None:
# An acquire that raised while still holding the native lock (a hook that failed and whose rollback could not
# release) must keep the registry entry so a later release can retry the OS unlock; otherwise roll the counter
# back. is_locked was already reconciled by whichever release ran.
if self.is_locked:
self._commit_acquire(canonical)
else:
self._undo_acquire()
def _invoke_on_acquired(self) -> None:
# The wrapper runs in the backend executor for async locks, preserving the callback's documented thread.
if self._on_acquired is None or self._context.lock_counter != 1:
return
try:
self._on_acquired(cast("int", self._context.lock_file_fd))
except BaseException as callback_error: # arbitrary caller code; roll back on any failure
callback_context = callback_error.__context__
try:
self._release_with_fork_tracking()
except BaseException as release_error: # ruff:ignore[blind-except] # both errors surface via the group below
_raise_body_and_release(callback_error, release_error)
callback_error.__context__ = callback_context
raise
def _acquire_with_fork_tracking(self) -> None:
with _fork_transition(self):
try:
self._acquire()
except BaseException as acquisition_error:
self._rollback_failed_acquire(acquisition_error)
raise
try:
self._register_context_descriptor()
except BaseException as registration_error: # pragma: needs fork
self._rollback_failed_registration(registration_error)
raise
if self.is_locked:
self._invoke_on_acquired()
def _rollback_failed_acquire(self, acquisition_error: BaseException) -> None:
if not self.is_locked:
return
registration_error: BaseException | None = None
tracking_error: BaseException | None = None
try:
self._register_context_descriptor()
except BaseException as error: # ruff:ignore[blind-except] # preserve registration and acquisition failures
registration_error = error
try:
# Rollback may fail too; retain the fd so a child can close it without another identity probe.
self._register_unverified_context_descriptor()
except BaseException as error: # ruff:ignore[blind-except] # pragma: no cover - allocation/control-flow during fallback
tracking_error = error
try:
self._release_with_fork_tracking()
except BaseException as rollback_error: # ruff:ignore[blind-except] # preserve rollback and acquisition failures
_raise_cleanup_errors(
"lock acquisition cleanup failed",
acquisition_error,
registration_error,
tracking_error,
rollback_error,
)
if registration_error is not None: # pragma: needs fork
_raise_cleanup_errors(
"lock acquisition cleanup failed", acquisition_error, registration_error, tracking_error
)
def _rollback_failed_registration(self, registration_error: BaseException) -> None: # pragma: needs fork
tracking_error: BaseException | None = None
try:
# Rollback may fail too; retain the fd so a child can close it without another identity probe.
self._register_unverified_context_descriptor()
except BaseException as error: # ruff:ignore[blind-except] # pragma: no cover - allocation/control-flow during fallback
tracking_error = error
try:
self._release_with_fork_tracking()
except BaseException as rollback_error: # ruff:ignore[blind-except] # preserve rollback and registration failures
_raise_cleanup_errors(
"descriptor registration cleanup failed", registration_error, tracking_error, rollback_error
)
if tracking_error is not None: # pragma: no cover - requires failed in-memory fallback
_raise_cleanup_errors("descriptor registration cleanup failed", registration_error, tracking_error)
def _release_with_fork_tracking(self) -> None:
with _fork_transition(self):
try:
self._release()
finally:
self._unregister_released_descriptor()
def _register_context_descriptor(self) -> None:
if self._context.lock_file_fd is not None and self._context.lock_file_fd_token is None:
self._context.lock_file_fd_token = _register_owned_descriptor(
self._context.lock_file_fd,
self._context.lock_file_fd_identity,
)
def _register_unverified_context_descriptor(self) -> None:
# The rollback only reaches here still holding a descriptor it never managed to register.
if self._context.lock_file_fd is not None and self._context.lock_file_fd_token is None: # pragma: no branch
self._context.lock_file_fd_token = _register_unverified_owned_descriptor(self._context.lock_file_fd)
def _unregister_released_descriptor(self) -> None:
if self._context.lock_file_fd is None:
if (token := self._context.lock_file_fd_token) is not None: # pragma: needs fork
_unregister_owned_descriptor(token)
self._context.lock_file_fd_token = None
self._context.lock_file_fd_identity = None
def _undo_acquire(self) -> None:
"""Roll back the counter after a failed acquire, dropping the registry entry once nothing holds the path."""
self._context.lock_counter = max(0, self._context.lock_counter - 1)
if self._context.lock_counter == 0:
self._drop_registry_entry()
def _commit_acquire(self, canonical: str) -> None:
"""Record this instance as the holder once the first acquire succeeds, so peers can detect the deadlock."""
# Keyed on the registry rather than the counter: an on_acquired hook that acquires again bumps the counter
# past 1 before this first commit runs, and must not leave the hold unregistered.
if self._context.lock_file_registry is None:
key = self._registry_key(canonical)
# The holder scope is resolved once at commit so a later release from another flow drops the right entry.
self._context.lock_file_key = key
# A shared instance may be released from another thread, which must clear the entry in the acquirer's
# registry: the releaser's own thread-local registry never held it.
self._context.lock_file_registry = _registry.held
_registry.held[key] = id(self)
def _drop_registry_entry(self) -> None:
"""Forget the key owned by this hold without resolving a mutable path again."""
# Ordered so a run an interrupt cuts short repeats safely: the entry goes only while it is still ours, and the
# key outlives the registry it indexes, so a later commit sees no registry and records the hold afresh.
key, registry = self._context.lock_file_key, self._context.lock_file_registry
if registry is not None and registry.get(key) == id(self):
del registry[key]
self._context.lock_file_registry = None
self._context.lock_file_key = None
def _commit_release(self) -> None:
"""Record the lock as fully released: reset the recursion counter and drop the deadlock-registry entry."""
self._context.lock_counter = 0
self._drop_registry_entry()
def _try_break_expired_lock(self) -> None:
"""Remove the lock file if its modification time exceeds the configured :attr:`lifetime`."""
if (lifetime := self._context.lifetime) is None:
return
with contextlib.suppress(OSError):
# lstat, not stat: an attacker with write access to the lock directory can replace a held
# lock file with a symlink pointing at an old file, making stat() report the target's stale
# mtime so a waiter breaks a live lock and two processes hold it at once. lstat reads the
# symlink's own mtime, matching the O_NOFOLLOW reads elsewhere.
st = os.lstat(self.lock_file)
if time.time() - st.st_mtime < lifetime:
return
break_lock_file(self.lock_file, st.st_mtime, st.st_ino)
def _check_give_up(
self,
*,
blocking: bool,
cancel_check: Callable[[], bool] | None,
timeout: float,
start_time: float,
) -> bool:
lock_id, lock_filename = id(self), self.lock_file
if blocking is False:
_LOGGER.debug("Failed to immediately acquire lock %s on %s", lock_id, lock_filename)
return True
if cancel_check is not None and cancel_check():
_LOGGER.debug("Cancellation requested for lock %s on %s", lock_id, lock_filename)
return True
if 0 <= timeout < time.perf_counter() - start_time:
_LOGGER.debug("Timeout on acquiring lock %s on %s", lock_id, lock_filename)
return True
return False
def _unprobeable_holder(self) -> str | None: # ruff:ignore[no-self-use] # existence locks override it
return None
@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
def _resolve_read_write_timeout(timeout: float, *, blocking: bool) -> float:
"""Validate a read-write lock's acquire ``timeout``: ``-1`` or a non-negative number, ``inf`` meaning ``-1``."""
if (timeout := _resolve_timeout(timeout, blocking=blocking)) < 0 and timeout != -1 and blocking:
msg = f"timeout must be a non-negative number or -1, not {timeout!r}"
raise ValueError(msg)
return timeout
def _resolve_timeout(timeout: float, *, blocking: bool) -> float:
"""Validate an acquire ``timeout``; every negative value waits without a limit."""
if math.isnan(timeout := _seconds("timeout", timeout)) and blocking:
msg = "timeout must be a number of seconds, not nan"
raise ValueError(msg)
# The fail-fast deadlock check only sees a negative timeout as unlimited, so spell inf that way.
return -1 if timeout == math.inf else timeout
def _on_this_stack(frame: FrameType | None) -> bool:
if frame is None:
return False
caller = inspect.currentframe()
while caller is not None and caller is not frame:
caller = caller.f_back
return caller is not None
# acquire() returns this wrapper instead of self so entering the with-statement does not call __enter__ a second
# time; returning self would re-acquire the lock in BaseFileLock.__enter__ without a matching release (issue #37).
class AcquireReturnProxy(Generic[_LockT]):
"""A context-aware object that will release the lock file when exiting."""
def __init__(self, lock: _LockT) -> None:
self.lock: _LockT = lock
def __enter__(self) -> _LockT:
return self.lock
def __exit__(
self,
exc_type: type[BaseException] | None,
exc_value: BaseException | None,
traceback: TracebackType | None,
) -> None:
# Widen to the bound: ty narrows the else branch to the type variable minus BaseFileLock, not to the union rest.
lock: Final = cast("BaseFileLock | ReadWriteLock | SoftReadWriteLock", self.lock)
if isinstance(lock, BaseFileLock):
lock._release_in_context(exc_value) # ruff:ignore[private-member-access] # forwards __exit__ to the owned lock's context release
else: # a reader/writer lock does not carry a context_error_policy
lock.release()
@dataclass
class FileLockContext:
"""Holds the context for a ``BaseFileLock`` object."""
# A separate class so ThreadLocalFileContext can make the whole context thread-local.
lock_file: str
timeout: float
mode: int
blocking: bool
poll_interval: float
#: The lock lifetime in seconds; ``None`` means the lock never expires.
lifetime: float | None = None
#: File descriptor from os.open for the lock file; not None while the lock is held.
lock_file_fd: int | None = None
#: Registry token for the descriptor owned by this thread's context.
lock_file_fd_token: int | None = None
#: Identity captured by a backend that already inspected the descriptor.
lock_file_fd_identity: tuple[int, int] | None = None
#: Descriptor opened by a backend but not yet committed as the held lock.
pending_lock_file_fd: int | None = None
#: Identity captured for a descriptor whose acquisition has not committed.
pending_lock_file_fd_identity: tuple[int, int] | None = None
#: Depth of nested acquisitions; the lock is released only when it returns to 0.
lock_counter: int = 0
#: Canonical registry key captured when the first physical acquisition commits.
lock_file_key: Hashable | None = None
#: The acquiring thread's deadlock registry holding :attr:`lock_file_key`.
lock_file_registry: dict[Hashable, int] | None = None
#: Claim pathnames this owner published, removed by name on release so no holder ever unlinks a peer's claim.
owner_claim_paths: tuple[str, ...] = ()
#: The frame of the :meth:`BaseFileLock.release` tearing this hold down, so a re-entrant call from a signal handler
#: on the same thread returns instead of closing the descriptor a second time.
releasing: FrameType | None = None
#: The frame of an acquire still polling for this hold, so one a signal handler starts on this thread fails fast.
acquiring: FrameType | None = None
#: Canonical lock path resolved when an acquisition starts. A waiter polling a relative path must keep publishing
#: into the directory it started in, even when another thread changes the working directory mid-wait.
claim_root: str | None = None
#: The lease claim of this hold, kept with it so a cross-thread release stops the right heartbeat.
lease_claim: _LeaseClaim | None = None
class ThreadLocalFileContext(FileLockContext, local):
"""
A thread local version of the ``FileLockContext`` class.
Each thread's state lives in an ordinary :class:`FileLockContext` at :attr:`current`, which the lock also keeps, so
``release(force=True)`` and the finalizer can unlock a hold whose thread exited.
"""
current: FileLockContext
# threading.local runs __init__ again with these arguments the first time each thread touches the context.
def __init__( # ruff:ignore[too-many-arguments] # mirrors the FileLockContext fields set at construction
self,
*,
lock_file: str,
timeout: float,
mode: int,
blocking: bool,
poll_interval: float,
lifetime: float | None = None,
) -> None:
self.current = FileLockContext(
lock_file=lock_file,
timeout=timeout,
mode=mode,
blocking=blocking,
poll_interval=poll_interval,
lifetime=lifetime,
)
def _delegate_to_current(name: str) -> property:
return property(
lambda context: getattr(context.current, name),
lambda context, value: setattr(context.current, name, value),
)
for _field in fields(FileLockContext):
setattr(ThreadLocalFileContext, _field.name, _delegate_to_current(_field.name))
@dataclass(frozen=True)
class _OwnedDescriptor:
fd: int
creator_pid: int
device: int | None
inode: int | None
class _ForkState:
def __init__(self) -> None:
self.gate = Condition(RLock())
self.registry_lock = RLock()
self.parameter_models_lock = RLock()
self.transitions: dict[int, dict[int, _ForkDescriptorOwner | None]] = {}
self.active_transitions = 0
self.admission_closed = False
self.fork_owner_depths: dict[int, int] = {}
self.pinned_objects: dict[int, list[tuple[_ForkResettable, ...]]] = {}
self.pinned_classes: dict[int, list[tuple[_ForkResettableClass, ...]]] = {}
self.provisional_descriptor_tokens: dict[int, list[tuple[int, ...]]] = {}
self.pid = os.getpid()
def reset_synchronization(self) -> None: # pragma: forked child
self.gate = Condition(RLock())
self.registry_lock = RLock()
self.parameter_models_lock = RLock()
self.transitions = {}
self.active_transitions = 0
self.admission_closed = False
self.fork_owner_depths = {}
self.pinned_objects = {}
self.pinned_classes = {}
self.provisional_descriptor_tokens = {}
_FORK_OBJECTS: Final[WeakValueDictionary[int, _ForkResettable]] = WeakValueDictionary()
_FORK_CLASSES: Final[WeakValueDictionary[int, _ForkResettableClass]] = WeakValueDictionary()
_OWNED_DESCRIPTORS: Final[dict[int, _OwnedDescriptor]] = {}
_DESCRIPTOR_TOKENS: Final[count[int]] = count()
_TRANSITION_TOKENS: Final[count[int]] = count()
_FORK_STATE: Final = _ForkState()
_FORK_AUDIT_EVENTS: Final[frozenset[str]] = frozenset({"os.fork", "os.forkpty"})
# CPython before 3.12 guards sys.settrace with one process-wide flag that stays set while audit hooks run, so a thread
# switch inside a Python hook makes a concurrent settrace raise. Coverage and debuggers call it on every thread start.
_SETTRACE_SURVIVES_AUDIT_HOOKS: Final[bool] = sys.implementation.name != "cpython" or sys.version_info >= (3, 12)
def _register_fork_hooks() -> None:
if _REGISTER_AT_FORK is None:
return # pragma: lacks fork
if _SETTRACE_SURVIVES_AUDIT_HOOKS: # pragma: needs fork # pragma: needs settrace-safe-audit-hooks
sys.addaudithook(_audit_fork_safety)
_REGISTER_AT_FORK( # pragma: needs fork
before=_pin_fork_objects,
after_in_parent=_resume_parent_after_fork,
after_in_child=_reset_child_after_fork,
)
@contextmanager
def _fork_transition(descriptor_owner: _ForkDescriptorOwner | None = None) -> Generator[None]:
# No fork follows exit, and a daemon thread stopped inside this bookkeeping holds its lock forever.
if not _HAS_REGISTER_AT_FORK or sys.is_finalizing():
yield # pragma: lacks fork
return # pragma: lacks fork
_ensure_current_process() # pragma: needs fork
creator_pid = os.getpid() # pragma: needs fork
# A generator holding this transition can be finalized on another thread, which must close the entering thread's.
thread_id: Final = get_ident() # pragma: needs fork
token: Final = _enter_fork_transition(descriptor_owner, thread_id) # pragma: needs fork
try: # pragma: needs fork
yield
finally:
if os.getpid() == creator_pid: # pragma: needs fork
_leave_fork_transition(token, thread_id)
def _register_fork_object(instance: _ForkResettable) -> None:
if not _HAS_REGISTER_AT_FORK:
return # pragma: lacks fork
with _fork_transition(), _FORK_STATE.registry_lock: # pragma: needs fork
_FORK_OBJECTS[id(instance)] = instance
_refresh_owner_pins()
def _register_fork_class(cls: _ForkResettableClass) -> None:
if not _HAS_REGISTER_AT_FORK:
return # pragma: lacks fork
with _fork_transition(), _FORK_STATE.registry_lock: # pragma: needs fork
_FORK_CLASSES[id(cls)] = cls
_refresh_owner_pins()
def _register_owned_descriptor(fd: int, identity: tuple[int, int] | None = None) -> int | None:
if not _HAS_REGISTER_AT_FORK:
return None # pragma: lacks fork
with _fork_transition(): # pragma: needs fork
if identity is None:
stat_result = os.fstat(fd)
identity = stat_result.st_dev, stat_result.st_ino
return _record_owned_descriptor(fd, identity)
def _register_unverified_owned_descriptor(fd: int) -> int | None:
if not _HAS_REGISTER_AT_FORK:
return None # pragma: lacks fork
with _fork_transition(): # pragma: needs fork
return _record_owned_descriptor(fd, None)
def _record_owned_descriptor(fd: int, identity: tuple[int, int] | None) -> int: # pragma: needs fork
with _FORK_STATE.registry_lock:
token = next(_DESCRIPTOR_TOKENS)
_OWNED_DESCRIPTORS[token] = _OwnedDescriptor(
fd=fd,
creator_pid=os.getpid(),
device=None if identity is None else identity[0],
inode=None if identity is None else identity[1],
)
return token
def _unregister_owned_descriptor(token: int) -> None: # pragma: needs fork
# No fork follows exit, and a daemon thread stopped inside this bookkeeping holds its lock forever.
if sys.is_finalizing(): # pragma: no cover # only exit reaches it, after coverage stops measuring
return
with _fork_transition(), _FORK_STATE.registry_lock:
_OWNED_DESCRIPTORS.pop(token, None)
def _pin_fork_objects() -> None: # pragma: needs fork
_ensure_current_process()
thread_id = get_ident()
with _FORK_STATE.gate:
_FORK_STATE.fork_owner_depths[thread_id] = _FORK_STATE.fork_owner_depths.get(thread_id, 0) + 1
_FORK_STATE.admission_closed = True
while _FORK_STATE.active_transitions > len(_FORK_STATE.transitions.get(thread_id, ())):
_FORK_STATE.gate.wait()
transition_owners = tuple(_FORK_STATE.transitions.get(thread_id, {}).values())
_verify_unverified_descriptors()
owners = {id(owner): owner for owner in transition_owners if owner is not None}
provisional_descriptor_tokens = tuple(
starmap(
_snapshot_descriptor_for_fork,
(descriptor for owner in owners.values() for descriptor in owner._descriptors_for_fork()), # ruff:ignore[private-member-access] # snapshots each owner's own fork descriptors
)
)
with _FORK_STATE.registry_lock:
_FORK_STATE.provisional_descriptor_tokens.setdefault(thread_id, []).append(provisional_descriptor_tokens)
_FORK_STATE.pinned_objects.setdefault(thread_id, []).append(tuple(_FORK_OBJECTS.values()))
_FORK_STATE.pinned_classes.setdefault(thread_id, []).append(tuple(_FORK_CLASSES.values()))
def _resume_parent_after_fork() -> None: # pragma: needs fork
thread_id = get_ident()
with _FORK_STATE.registry_lock:
for token in _FORK_STATE.provisional_descriptor_tokens[thread_id].pop():
_OWNED_DESCRIPTORS.pop(token, None)
_FORK_STATE.pinned_objects[thread_id].pop()
_FORK_STATE.pinned_classes[thread_id].pop()
if not _FORK_STATE.provisional_descriptor_tokens[thread_id]: # pragma: needs fork
del _FORK_STATE.provisional_descriptor_tokens[thread_id]
del _FORK_STATE.pinned_objects[thread_id]
del _FORK_STATE.pinned_classes[thread_id]
with _FORK_STATE.gate:
if _FORK_STATE.fork_owner_depths[thread_id] == 1:
del _FORK_STATE.fork_owner_depths[thread_id]
else: # pragma: no cover - earlier at-fork callbacks may deadlock first
_FORK_STATE.fork_owner_depths[thread_id] -= 1
_FORK_STATE.admission_closed = bool(_FORK_STATE.fork_owner_depths)
_FORK_STATE.gate.notify_all()
def _ensure_current_process() -> None:
_reset_child_after_fork()
def _reset_child_after_fork() -> None: # pragma: forked child
if (pid := os.getpid()) == _FORK_STATE.pid:
return
thread_id = get_ident()
pinned_objects = _FORK_STATE.pinned_objects.get(thread_id, [()])[-1]
pinned_classes = _FORK_STATE.pinned_classes.get(thread_id, [()])[-1]
descriptors: list[_OwnedDescriptor] = []
for token, descriptor in tuple(_OWNED_DESCRIPTORS.items()):
if descriptor.creator_pid != pid:
descriptors.append(_OWNED_DESCRIPTORS.pop(token))
_FORK_STATE.reset_synchronization()
_FORK_STATE.pid = pid
_INIT_PARAMETER_MODELS.clear()
_detach_child_state(descriptors, pinned_objects, pinned_classes)
def _enter_fork_transition(descriptor_owner: _ForkDescriptorOwner | None, thread_id: int) -> int: # pragma: needs fork
with _FORK_STATE.gate:
while (
_FORK_STATE.admission_closed
and thread_id not in _FORK_STATE.fork_owner_depths
and thread_id not in _FORK_STATE.transitions
):
_FORK_STATE.gate.wait() # pragma: no cover - exercised in isolated interpreter
token = next(_TRANSITION_TOKENS)
_FORK_STATE.transitions.setdefault(thread_id, {})[token] = descriptor_owner
_FORK_STATE.active_transitions += 1
return token
def _leave_fork_transition(token: int, thread_id: int) -> None: # pragma: needs fork
with _FORK_STATE.gate:
owned: Final = _FORK_STATE.transitions[thread_id]
del owned[token]
if not owned:
del _FORK_STATE.transitions[thread_id]
_FORK_STATE.active_transitions -= 1
_FORK_STATE.gate.notify_all()
def _verify_unverified_descriptors() -> None: # pragma: needs fork
with _FORK_STATE.registry_lock:
for token, descriptor in tuple(_OWNED_DESCRIPTORS.items()):
if descriptor.creator_pid != os.getpid() or descriptor.device is not None:
continue
try:
stat_result = os.fstat(descriptor.fd)
except OSError:
continue
_OWNED_DESCRIPTORS[token] = _OwnedDescriptor(
fd=descriptor.fd,
creator_pid=descriptor.creator_pid,
device=stat_result.st_dev,
inode=stat_result.st_ino,
)
def _snapshot_descriptor_for_fork(fd: int, identity: tuple[int, int] | None) -> int: # pragma: needs fork
if identity is None: # pragma: needs fork
try:
stat_result = os.fstat(fd)
except OSError:
pass
else:
identity = stat_result.st_dev, stat_result.st_ino
return _record_owned_descriptor(fd, identity)
def _detach_child_state( # pragma: forked child
descriptors: list[_OwnedDescriptor],
pinned_objects: tuple[_ForkResettable, ...],
pinned_classes: tuple[_ForkResettableClass, ...],
) -> None:
for descriptor in descriptors:
if descriptor.device is None:
continue
try:
stat_result = os.fstat(descriptor.fd)
except OSError:
continue
if (stat_result.st_dev, stat_result.st_ino) != (descriptor.device, descriptor.inode):
continue
with contextlib.suppress(OSError):
os.close(descriptor.fd)
for instance in pinned_objects:
instance._reset_after_fork_in_child() # ruff:ignore[private-member-access] # resets each pinned instance in the fork child
for cls in pinned_classes:
cls._reset_class_after_fork()
_registry.held.clear()
def _refresh_owner_pins() -> None: # pragma: needs fork
with _FORK_STATE.gate:
fork_owner_thread_ids = tuple(_FORK_STATE.fork_owner_depths)
if get_ident() not in fork_owner_thread_ids: # pragma: no cover - at-fork callbacks disable tracing
return
objects = tuple(_FORK_OBJECTS.values())
classes = tuple(_FORK_CLASSES.values())
for thread_id in fork_owner_thread_ids:
if object_snapshots := _FORK_STATE.pinned_objects.get(thread_id): # pragma: needs fork
object_snapshots[:] = [objects] * len(object_snapshots)
_FORK_STATE.pinned_classes[thread_id][:] = [classes] * len(object_snapshots)
# The defaults capture the module globals: the hook outlives them at interpreter shutdown, where CPython wipes the
# module dict to None before the final audit events fire.
def _audit_fork_safety( # pragma: no cover - CPython disables tracing while Python audit hooks run
event: str,
_args: Unused,
*,
_fork_events: frozenset[str] = _FORK_AUDIT_EVENTS,
_state: _ForkState = _FORK_STATE,
_get_ident: Callable[[], int] = get_ident,
) -> None:
if event in _fork_events:
if _get_ident() in _state.transitions or _state.fork_owner_depths:
msg = f"{event} is unsafe while filelock is changing descriptor ownership"
raise RuntimeError(msg)
elif event == "_posixsubprocess.fork_exec" and _get_ident() in _state.transitions:
msg = "fork_exec is unsafe while filelock is changing descriptor ownership"
raise RuntimeError(msg)
_register_fork_hooks()
__all__ = [
"_UNSET_FILE_MODE",
"AcquireReturnProxy",
"BaseFileLock",
"CloseErrorPolicy",
"ContextErrorPolicy",
"FileLockContext",
"FileLockMeta",
"LockOptions",
"ThreadLocalFileContext",
"_append_exception_context",
"_canonical",
"_check_timeout_max",
"_delegate_to_current",
"_ensure_current_process",
"_fork_transition",
"_grouped_errors",
"_raise_body_and_release",
"_raise_chained_errors",
"_raise_cleanup_errors",
"_raise_grouped_errors",
"_register_fork_class",
"_register_fork_object",
"_register_owned_descriptor",
"_resolve_poll_interval",
"_resolve_read_write_timeout",
"_resolve_timeout",
"_seconds",
"_timeout_behavior",
"_unregister_owned_descriptor",
]
|