File size: 38,541 Bytes
9c6594c |
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 |
import enum
import functools
import reprlib
import sys
from array import array
from collections.abc import (
ItemsView,
Iterable,
Iterator,
KeysView,
Mapping,
ValuesView,
)
from dataclasses import dataclass
from typing import (
TYPE_CHECKING,
Any,
ClassVar,
Generic,
NoReturn,
Optional,
TypeVar,
Union,
cast,
overload,
)
from ._abc import MDArg, MultiMapping, MutableMultiMapping, SupportsKeys
if sys.version_info >= (3, 11):
from typing import Self
else:
from typing_extensions import Self
class istr(str):
"""Case insensitive str."""
__is_istr__ = True
__istr_identity__: Optional[str] = None
_V = TypeVar("_V")
_T = TypeVar("_T")
_SENTINEL = enum.Enum("_SENTINEL", "sentinel")
sentinel = _SENTINEL.sentinel
_version = array("Q", [0])
class _Iter(Generic[_T]):
__slots__ = ("_size", "_iter")
def __init__(self, size: int, iterator: Iterator[_T]):
self._size = size
self._iter = iterator
def __iter__(self) -> Self:
return self
def __next__(self) -> _T:
return next(self._iter)
def __length_hint__(self) -> int:
return self._size
class _ViewBase(Generic[_V]):
def __init__(
self,
md: "MultiDict[_V]",
):
self._md = md
def __len__(self) -> int:
return len(self._md)
class _ItemsView(_ViewBase[_V], ItemsView[str, _V]):
def __contains__(self, item: object) -> bool:
if not isinstance(item, (tuple, list)) or len(item) != 2:
return False
key, value = item
try:
identity = self._md._identity(key)
except TypeError:
return False
hash_ = hash(identity)
for slot, idx, e in self._md._keys.iter_hash(hash_):
if e.identity == identity and value == e.value:
return True
return False
def __iter__(self) -> _Iter[tuple[str, _V]]:
return _Iter(len(self), self._iter(self._md._version))
def _iter(self, version: int) -> Iterator[tuple[str, _V]]:
for e in self._md._keys.iter_entries():
if version != self._md._version:
raise RuntimeError("Dictionary changed during iteration")
yield self._md._key(e.key), e.value
@reprlib.recursive_repr()
def __repr__(self) -> str:
lst = []
for e in self._md._keys.iter_entries():
lst.append(f"'{e.key}': {e.value!r}")
body = ", ".join(lst)
return f"<{self.__class__.__name__}({body})>"
def _parse_item(
self, arg: Union[tuple[str, _V], _T]
) -> Optional[tuple[int, str, str, _V]]:
if not isinstance(arg, tuple):
return None
if len(arg) != 2:
return None
try:
identity = self._md._identity(arg[0])
return (hash(identity), identity, arg[0], arg[1])
except TypeError:
return None
def _tmp_set(self, it: Iterable[_T]) -> set[tuple[str, _V]]:
tmp = set()
for arg in it:
item = self._parse_item(arg)
if item is None:
continue
else:
tmp.add((item[1], item[3]))
return tmp
def __and__(self, other: Iterable[Any]) -> set[tuple[str, _V]]:
ret = set()
try:
it = iter(other)
except TypeError:
return NotImplemented
for arg in it:
item = self._parse_item(arg)
if item is None:
continue
hash_, identity, key, value = item
for slot, idx, e in self._md._keys.iter_hash(hash_):
e.hash = -1
if e.identity == identity and e.value == value:
ret.add((e.key, e.value))
self._md._keys.restore_hash(hash_)
return ret
def __rand__(self, other: Iterable[_T]) -> set[_T]:
ret = set()
try:
it = iter(other)
except TypeError:
return NotImplemented
for arg in it:
item = self._parse_item(arg)
if item is None:
continue
hash_, identity, key, value = item
for slot, idx, e in self._md._keys.iter_hash(hash_):
if e.identity == identity and e.value == value:
ret.add(arg)
break
return ret
def __or__(self, other: Iterable[_T]) -> set[Union[tuple[str, _V], _T]]:
ret: set[Union[tuple[str, _V], _T]] = set(self)
try:
it = iter(other)
except TypeError:
return NotImplemented
for arg in it:
item: Optional[tuple[int, str, str, _V]] = self._parse_item(arg)
if item is None:
ret.add(arg)
continue
hash_, identity, key, value = item
for slot, idx, e in self._md._keys.iter_hash(hash_):
if e.identity == identity and e.value == value: # pragma: no branch
break
else:
ret.add(arg)
return ret
def __ror__(self, other: Iterable[_T]) -> set[Union[tuple[str, _V], _T]]:
try:
ret: set[Union[tuple[str, _V], _T]] = set(other)
except TypeError:
return NotImplemented
tmp = self._tmp_set(ret)
for e in self._md._keys.iter_entries():
if (e.identity, e.value) not in tmp:
ret.add((e.key, e.value))
return ret
def __sub__(self, other: Iterable[_T]) -> set[Union[tuple[str, _V], _T]]:
ret: set[Union[tuple[str, _V], _T]] = set()
try:
it = iter(other)
except TypeError:
return NotImplemented
tmp = self._tmp_set(it)
for e in self._md._keys.iter_entries():
if (e.identity, e.value) not in tmp:
ret.add((e.key, e.value))
return ret
def __rsub__(self, other: Iterable[_T]) -> set[_T]:
ret: set[_T] = set()
try:
it = iter(other)
except TypeError:
return NotImplemented
for arg in it:
item = self._parse_item(arg)
if item is None:
ret.add(arg)
continue
hash_, identity, key, value = item
for slot, idx, e in self._md._keys.iter_hash(hash_):
if e.identity == identity and e.value == value: # pragma: no branch
break
else:
ret.add(arg)
return ret
def __xor__(self, other: Iterable[_T]) -> set[Union[tuple[str, _V], _T]]:
try:
rgt = set(other)
except TypeError:
return NotImplemented
ret: set[Union[tuple[str, _V], _T]] = self - rgt
ret |= rgt - self
return ret
__rxor__ = __xor__
def isdisjoint(self, other: Iterable[tuple[str, _V]]) -> bool:
for arg in other:
item = self._parse_item(arg)
if item is None:
continue
hash_, identity, key, value = item
for slot, idx, e in self._md._keys.iter_hash(hash_):
if e.identity == identity and e.value == value: # pragma: no branch
return False
return True
class _ValuesView(_ViewBase[_V], ValuesView[_V]):
def __contains__(self, value: object) -> bool:
for e in self._md._keys.iter_entries():
if e.value == value:
return True
return False
def __iter__(self) -> _Iter[_V]:
return _Iter(len(self), self._iter(self._md._version))
def _iter(self, version: int) -> Iterator[_V]:
for e in self._md._keys.iter_entries():
if version != self._md._version:
raise RuntimeError("Dictionary changed during iteration")
yield e.value
@reprlib.recursive_repr()
def __repr__(self) -> str:
lst = []
for e in self._md._keys.iter_entries():
lst.append(repr(e.value))
body = ", ".join(lst)
return f"<{self.__class__.__name__}({body})>"
class _KeysView(_ViewBase[_V], KeysView[str]):
def __contains__(self, key: object) -> bool:
if not isinstance(key, str):
return False
identity = self._md._identity(key)
hash_ = hash(identity)
for slot, idx, e in self._md._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
return True
return False
def __iter__(self) -> _Iter[str]:
return _Iter(len(self), self._iter(self._md._version))
def _iter(self, version: int) -> Iterator[str]:
for e in self._md._keys.iter_entries():
if version != self._md._version:
raise RuntimeError("Dictionary changed during iteration")
yield self._md._key(e.key)
def __repr__(self) -> str:
lst = []
for e in self._md._keys.iter_entries():
lst.append(f"'{e.key}'")
body = ", ".join(lst)
return f"<{self.__class__.__name__}({body})>"
def __and__(self, other: Iterable[object]) -> set[str]:
ret = set()
try:
it = iter(other)
except TypeError:
return NotImplemented
for key in it:
if not isinstance(key, str):
continue
identity = self._md._identity(key)
hash_ = hash(identity)
for slot, idx, e in self._md._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
ret.add(e.key)
break
return ret
def __rand__(self, other: Iterable[_T]) -> set[_T]:
ret = set()
try:
it = iter(other)
except TypeError:
return NotImplemented
for key in it:
if not isinstance(key, str):
continue
if key in self._md:
ret.add(key)
return cast(set[_T], ret)
def __or__(self, other: Iterable[_T]) -> set[Union[str, _T]]:
ret: set[Union[str, _T]] = set(self)
try:
it = iter(other)
except TypeError:
return NotImplemented
for key in it:
if not isinstance(key, str):
ret.add(key)
continue
if key not in self._md:
ret.add(key)
return ret
def __ror__(self, other: Iterable[_T]) -> set[Union[str, _T]]:
try:
ret: set[Union[str, _T]] = set(other)
except TypeError:
return NotImplemented
tmp = set()
for key in ret:
if not isinstance(key, str):
continue
identity = self._md._identity(key)
tmp.add(identity)
for e in self._md._keys.iter_entries():
if e.identity not in tmp:
ret.add(e.key)
return ret
def __sub__(self, other: Iterable[object]) -> set[str]:
ret = set(self)
try:
it = iter(other)
except TypeError:
return NotImplemented
for key in it:
if not isinstance(key, str):
continue
identity = self._md._identity(key)
hash_ = hash(identity)
for slot, idx, e in self._md._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
ret.discard(e.key)
break
return ret
def __rsub__(self, other: Iterable[_T]) -> set[_T]:
try:
ret: set[_T] = set(other)
except TypeError:
return NotImplemented
for key in other:
if not isinstance(key, str):
continue
if key in self._md:
ret.discard(key) # type: ignore[arg-type]
return ret
def __xor__(self, other: Iterable[_T]) -> set[Union[str, _T]]:
try:
rgt = set(other)
except TypeError:
return NotImplemented
ret: set[Union[str, _T]] = self - rgt # type: ignore[assignment]
ret |= rgt - self
return ret
__rxor__ = __xor__
def isdisjoint(self, other: Iterable[object]) -> bool:
for key in other:
if not isinstance(key, str):
continue
if key in self._md:
return False
return True
class _CSMixin:
_ci: ClassVar[bool] = False
def _key(self, key: str) -> str:
return key
def _identity(self, key: str) -> str:
if isinstance(key, str):
return key
else:
raise TypeError("MultiDict keys should be either str or subclasses of str")
class _CIMixin:
_ci: ClassVar[bool] = True
def _key(self, key: str) -> str:
if type(key) is istr:
return key
else:
return istr(key)
def _identity(self, key: str) -> str:
if isinstance(key, istr):
ret = key.__istr_identity__
if ret is None:
ret = key.title()
key.__istr_identity__ = ret
return ret
if isinstance(key, str):
return key.title()
else:
raise TypeError("MultiDict keys should be either str or subclasses of str")
def estimate_log2_keysize(n: int) -> int:
# 7 == HT_MINSIZE - 1
return (((n * 3 + 1) // 2) | 7).bit_length()
@dataclass
class _Entry(Generic[_V]):
hash: int
identity: str
key: str
value: _V
@dataclass
class _HtKeys(Generic[_V]): # type: ignore[misc]
LOG_MINSIZE: ClassVar[int] = 3
MINSIZE: ClassVar[int] = 8
PREALLOCATED_INDICES: ClassVar[dict[int, array]] = { # type: ignore[type-arg]
log2_size: array(
"b" if log2_size < 8 else "h", (-1 for i in range(1 << log2_size))
)
for log2_size in range(3, 10)
}
log2_size: int
usable: int
indices: array # type: ignore[type-arg] # in py3.9 array is not generic
entries: list[Optional[_Entry[_V]]]
@functools.cached_property
def nslots(self) -> int:
return 1 << self.log2_size
@functools.cached_property
def mask(self) -> int:
return self.nslots - 1
if sys.implementation.name != "pypy":
def __sizeof__(self) -> int:
return (
object.__sizeof__(self)
+ sys.getsizeof(self.indices)
+ sys.getsizeof(self.entries)
)
@classmethod
def new(cls, log2_size: int, entries: list[Optional[_Entry[_V]]]) -> Self:
size = 1 << log2_size
usable = (size << 1) // 3
if log2_size < 10:
indices = cls.PREALLOCATED_INDICES[log2_size].__copy__()
elif log2_size < 16:
indices = array("h", (-1 for i in range(size)))
elif log2_size < 32:
indices = array("l", (-1 for i in range(size)))
else: # pragma: no cover # don't test huge multidicts
indices = array("q", (-1 for i in range(size)))
ret = cls(
log2_size=log2_size,
usable=usable,
indices=indices,
entries=entries,
)
return ret
def clone(self) -> "_HtKeys[_V]":
entries = [
_Entry(e.hash, e.identity, e.key, e.value) if e is not None else None
for e in self.entries
]
return _HtKeys(
log2_size=self.log2_size,
usable=self.usable,
indices=self.indices.__copy__(),
entries=entries,
)
def build_indices(self, update: bool) -> None:
mask = self.mask
indices = self.indices
for idx, e in enumerate(self.entries):
assert e is not None
hash_ = e.hash
if update:
if hash_ == -1:
hash_ = hash(e.identity)
else:
assert hash_ != -1
i = hash_ & mask
perturb = hash_ & sys.maxsize
while indices[i] != -1:
perturb >>= 5
i = mask & (i * 5 + perturb + 1)
indices[i] = idx
def find_empty_slot(self, hash_: int) -> int:
mask = self.mask
indices = self.indices
i = hash_ & mask
perturb = hash_ & sys.maxsize
ix = indices[i]
while ix != -1:
perturb >>= 5
i = (i * 5 + perturb + 1) & mask
ix = indices[i]
return i
def iter_hash(self, hash_: int) -> Iterator[tuple[int, int, _Entry[_V]]]:
mask = self.mask
indices = self.indices
entries = self.entries
i = hash_ & mask
perturb = hash_ & sys.maxsize
ix = indices[i]
while ix != -1:
if ix != -2:
e = entries[ix]
if e.hash == hash_:
yield i, ix, e
perturb >>= 5
i = (i * 5 + perturb + 1) & mask
ix = indices[i]
def del_idx(self, hash_: int, idx: int) -> None:
mask = self.mask
indices = self.indices
i = hash_ & mask
perturb = hash_ & sys.maxsize
ix = indices[i]
while ix != idx:
perturb >>= 5
i = (i * 5 + perturb + 1) & mask
ix = indices[i]
indices[i] = -2
def iter_entries(self) -> Iterator[_Entry[_V]]:
return filter(None, self.entries)
def restore_hash(self, hash_: int) -> None:
mask = self.mask
indices = self.indices
entries = self.entries
i = hash_ & mask
perturb = hash_ & sys.maxsize
ix = indices[i]
while ix != -1:
if ix != -2:
entry = entries[ix]
if entry.hash == -1:
entry.hash = hash_
perturb >>= 5
i = (i * 5 + perturb + 1) & mask
ix = indices[i]
class MultiDict(_CSMixin, MutableMultiMapping[_V]):
"""Dictionary with the support for duplicate keys."""
__slots__ = ("_keys", "_used", "_version")
def __init__(self, arg: MDArg[_V] = None, /, **kwargs: _V):
self._used = 0
v = _version
v[0] += 1
self._version = v[0]
if not kwargs:
md = None
if isinstance(arg, MultiDictProxy):
md = arg._md
elif isinstance(arg, MultiDict):
md = arg
if md is not None and md._ci is self._ci:
self._from_md(md)
return
items = self._parse_args(arg, kwargs)
log2_size = estimate_log2_keysize(len(items))
if log2_size > 17: # pragma: no cover
# Don't overallocate really huge keys space in init
log2_size = 17
self._keys: _HtKeys[_V] = _HtKeys.new(log2_size, [])
self._extend_items(items)
def _from_md(self, md: "MultiDict[_V]") -> None:
# Copy everything as-is without compacting the new multidict,
# otherwise it requires reindexing
self._keys = md._keys.clone()
self._used = md._used
@overload
def getall(self, key: str) -> list[_V]: ...
@overload
def getall(self, key: str, default: _T) -> Union[list[_V], _T]: ...
def getall(
self, key: str, default: Union[_T, _SENTINEL] = sentinel
) -> Union[list[_V], _T]:
"""Return a list of all values matching the key."""
identity = self._identity(key)
hash_ = hash(identity)
res = []
for slot, idx, e in self._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
res.append(e.value)
e.hash = -1
self._keys.restore_hash(hash_)
if res:
return res
if not res and default is not sentinel:
return default
raise KeyError("Key not found: %r" % key)
@overload
def getone(self, key: str) -> _V: ...
@overload
def getone(self, key: str, default: _T) -> Union[_V, _T]: ...
def getone(
self, key: str, default: Union[_T, _SENTINEL] = sentinel
) -> Union[_V, _T]:
"""Get first value matching the key.
Raises KeyError if the key is not found and no default is provided.
"""
identity = self._identity(key)
hash_ = hash(identity)
for slot, idx, e in self._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
return e.value
if default is not sentinel:
return default
raise KeyError("Key not found: %r" % key)
# Mapping interface #
def __getitem__(self, key: str) -> _V:
return self.getone(key)
@overload
def get(self, key: str, /) -> Union[_V, None]: ...
@overload
def get(self, key: str, /, default: _T) -> Union[_V, _T]: ...
def get(self, key: str, default: Union[_T, None] = None) -> Union[_V, _T, None]:
"""Get first value matching the key.
If the key is not found, returns the default (or None if no default is provided)
"""
return self.getone(key, default)
def __iter__(self) -> Iterator[str]:
return iter(self.keys())
def __len__(self) -> int:
return self._used
def keys(self) -> KeysView[str]:
"""Return a new view of the dictionary's keys."""
return _KeysView(self)
def items(self) -> ItemsView[str, _V]:
"""Return a new view of the dictionary's items *(key, value) pairs)."""
return _ItemsView(self)
def values(self) -> _ValuesView[_V]:
"""Return a new view of the dictionary's values."""
return _ValuesView(self)
def __eq__(self, other: object) -> bool:
if not isinstance(other, Mapping):
return NotImplemented
if isinstance(other, MultiDictProxy):
return self == other._md
if isinstance(other, MultiDict):
lft = self._keys
rht = other._keys
if self._used != other._used:
return False
for e1, e2 in zip(lft.iter_entries(), rht.iter_entries()):
if e1.identity != e2.identity or e1.value != e2.value:
return False
return True
if self._used != len(other):
return False
for k, v in self.items():
nv = other.get(k, sentinel)
if v != nv:
return False
return True
def __contains__(self, key: object) -> bool:
if not isinstance(key, str):
return False
identity = self._identity(key)
hash_ = hash(identity)
for slot, idx, e in self._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
return True
return False
@reprlib.recursive_repr()
def __repr__(self) -> str:
body = ", ".join(f"'{e.key}': {e.value!r}" for e in self._keys.iter_entries())
return f"<{self.__class__.__name__}({body})>"
if sys.implementation.name != "pypy":
def __sizeof__(self) -> int:
return object.__sizeof__(self) + sys.getsizeof(self._keys)
def __reduce__(self) -> tuple[type[Self], tuple[list[tuple[str, _V]]]]:
return (self.__class__, (list(self.items()),))
def add(self, key: str, value: _V) -> None:
identity = self._identity(key)
hash_ = hash(identity)
self._add_with_hash(_Entry(hash_, identity, key, value))
self._incr_version()
def copy(self) -> Self:
"""Return a copy of itself."""
cls = self.__class__
return cls(self)
__copy__ = copy
def extend(self, arg: MDArg[_V] = None, /, **kwargs: _V) -> None:
"""Extend current MultiDict with more values.
This method must be used instead of update.
"""
items = self._parse_args(arg, kwargs)
newsize = self._used + len(items)
self._resize(estimate_log2_keysize(newsize), False)
self._extend_items(items)
def _parse_args(
self,
arg: MDArg[_V],
kwargs: Mapping[str, _V],
) -> list[_Entry[_V]]:
identity_func = self._identity
if arg:
if isinstance(arg, MultiDictProxy):
arg = arg._md
if isinstance(arg, MultiDict):
if self._ci is not arg._ci:
items = []
for e in arg._keys.iter_entries():
identity = identity_func(e.key)
items.append(_Entry(hash(identity), identity, e.key, e.value))
else:
items = [
_Entry(e.hash, e.identity, e.key, e.value)
for e in arg._keys.iter_entries()
]
if kwargs:
for key, value in kwargs.items():
identity = identity_func(key)
items.append(_Entry(hash(identity), identity, key, value))
else:
if hasattr(arg, "keys"):
arg = cast(SupportsKeys[_V], arg)
arg = [(k, arg[k]) for k in arg.keys()]
if kwargs:
arg = list(arg)
arg.extend(list(kwargs.items()))
items = []
for pos, item in enumerate(arg):
if not len(item) == 2:
raise ValueError(
f"multidict update sequence element #{pos}"
f"has length {len(item)}; 2 is required"
)
identity = identity_func(item[0])
items.append(_Entry(hash(identity), identity, item[0], item[1]))
else:
items = []
for key, value in kwargs.items():
identity = identity_func(key)
items.append(_Entry(hash(identity), identity, key, value))
return items
def _extend_items(self, items: Iterable[_Entry[_V]]) -> None:
for e in items:
self._add_with_hash(e)
self._incr_version()
def clear(self) -> None:
"""Remove all items from MultiDict."""
self._used = 0
self._keys = _HtKeys.new(_HtKeys.LOG_MINSIZE, [])
self._incr_version()
# Mapping interface #
def __setitem__(self, key: str, value: _V) -> None:
identity = self._identity(key)
hash_ = hash(identity)
found = False
for slot, idx, e in self._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
if not found:
e.key = key
e.value = value
e.hash = -1
found = True
self._incr_version()
elif e.hash != -1: # pragma: no branch
self._del_at(slot, idx)
if not found:
self._add_with_hash(_Entry(hash_, identity, key, value))
else:
self._keys.restore_hash(hash_)
def __delitem__(self, key: str) -> None:
found = False
identity = self._identity(key)
hash_ = hash(identity)
for slot, idx, e in self._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
self._del_at(slot, idx)
found = True
if not found:
raise KeyError(key)
else:
self._incr_version()
@overload
def setdefault(
self: "MultiDict[Union[_T, None]]", key: str, default: None = None
) -> Union[_T, None]: ...
@overload
def setdefault(self, key: str, default: _V) -> _V: ...
def setdefault(self, key: str, default: Union[_V, None] = None) -> Union[_V, None]: # type: ignore[misc]
"""Return value for key, set value to default if key is not present."""
identity = self._identity(key)
hash_ = hash(identity)
for slot, idx, e in self._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
return e.value
self.add(key, default) # type: ignore[arg-type]
return default
@overload
def popone(self, key: str) -> _V: ...
@overload
def popone(self, key: str, default: _T) -> Union[_V, _T]: ...
def popone(
self, key: str, default: Union[_T, _SENTINEL] = sentinel
) -> Union[_V, _T]:
"""Remove specified key and return the corresponding value.
If key is not found, d is returned if given, otherwise
KeyError is raised.
"""
identity = self._identity(key)
hash_ = hash(identity)
for slot, idx, e in self._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
value = e.value
self._del_at(slot, idx)
self._incr_version()
return value
if default is sentinel:
raise KeyError(key)
else:
return default
# Type checking will inherit signature for pop() if we don't confuse it here.
if not TYPE_CHECKING:
pop = popone
@overload
def popall(self, key: str) -> list[_V]: ...
@overload
def popall(self, key: str, default: _T) -> Union[list[_V], _T]: ...
def popall(
self, key: str, default: Union[_T, _SENTINEL] = sentinel
) -> Union[list[_V], _T]:
"""Remove all occurrences of key and return the list of corresponding
values.
If key is not found, default is returned if given, otherwise
KeyError is raised.
"""
found = False
identity = self._identity(key)
hash_ = hash(identity)
ret = []
for slot, idx, e in self._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
found = True
ret.append(e.value)
self._del_at(slot, idx)
self._incr_version()
if not found:
if default is sentinel:
raise KeyError(key)
else:
return default
else:
return ret
def popitem(self) -> tuple[str, _V]:
"""Remove and return an arbitrary (key, value) pair."""
if self._used <= 0:
raise KeyError("empty multidict")
pos = len(self._keys.entries) - 1
entry = self._keys.entries.pop()
while entry is None:
pos -= 1
entry = self._keys.entries.pop()
ret = self._key(entry.key), entry.value
self._keys.del_idx(entry.hash, pos)
self._used -= 1
self._incr_version()
return ret
def update(self, arg: MDArg[_V] = None, /, **kwargs: _V) -> None:
"""Update the dictionary from *other*, overwriting existing keys."""
items = self._parse_args(arg, kwargs)
newsize = self._used + len(items)
log2_size = estimate_log2_keysize(newsize)
if log2_size > 17: # pragma: no cover
# Don't overallocate really huge keys space in update,
# duplicate keys could reduce the resulting anount of entries
log2_size = 17
if log2_size > self._keys.log2_size:
self._resize(log2_size, False)
self._update_items(items)
def _update_items(self, items: list[_Entry[_V]]) -> None:
if not items:
return
for entry in items:
found = False
hash_ = entry.hash
identity = entry.identity
for slot, idx, e in self._keys.iter_hash(hash_):
if e.identity == identity: # pragma: no branch
if not found:
found = True
e.key = entry.key
e.value = entry.value
e.hash = -1
else:
self._del_at_for_upd(e)
if not found:
self._add_with_hash_for_upd(entry)
keys = self._keys
indices = keys.indices
entries = keys.entries
for slot in range(keys.nslots):
idx = indices[slot]
if idx >= 0:
e2 = entries[idx]
assert e2 is not None
if e2.key is None:
entries[idx] = None # type: ignore[unreachable]
indices[slot] = -2
self._used -= 1
if e2.hash == -1:
e2.hash = hash(e2.identity)
self._incr_version()
def _incr_version(self) -> None:
v = _version
v[0] += 1
self._version = v[0]
def _resize(self, log2_newsize: int, update: bool) -> None:
oldkeys = self._keys
newentries = self._used
if len(oldkeys.entries) == newentries:
entries = oldkeys.entries
else:
entries = [e for e in oldkeys.entries if e is not None]
newkeys: _HtKeys[_V] = _HtKeys.new(log2_newsize, entries)
newkeys.usable -= newentries
newkeys.build_indices(update)
self._keys = newkeys
def _add_with_hash(self, entry: _Entry[_V]) -> None:
if self._keys.usable <= 0:
self._resize((self._used * 3 | _HtKeys.MINSIZE - 1).bit_length(), False)
keys = self._keys
slot = keys.find_empty_slot(entry.hash)
keys.indices[slot] = len(keys.entries)
keys.entries.append(entry)
self._incr_version()
self._used += 1
keys.usable -= 1
def _add_with_hash_for_upd(self, entry: _Entry[_V]) -> None:
if self._keys.usable <= 0:
self._resize((self._used * 3 | _HtKeys.MINSIZE - 1).bit_length(), True)
keys = self._keys
slot = keys.find_empty_slot(entry.hash)
keys.indices[slot] = len(keys.entries)
entry.hash = -1
keys.entries.append(entry)
self._incr_version()
self._used += 1
keys.usable -= 1
def _del_at(self, slot: int, idx: int) -> None:
self._keys.entries[idx] = None
self._keys.indices[slot] = -2
self._used -= 1
def _del_at_for_upd(self, entry: _Entry[_V]) -> None:
entry.key = None # type: ignore[assignment]
entry.value = None # type: ignore[assignment]
class CIMultiDict(_CIMixin, MultiDict[_V]):
"""Dictionary with the support for duplicate case-insensitive keys."""
class MultiDictProxy(_CSMixin, MultiMapping[_V]):
"""Read-only proxy for MultiDict instance."""
__slots__ = ("_md",)
_md: MultiDict[_V]
def __init__(self, arg: Union[MultiDict[_V], "MultiDictProxy[_V]"]):
if not isinstance(arg, (MultiDict, MultiDictProxy)):
raise TypeError(
"ctor requires MultiDict or MultiDictProxy instance"
f", not {type(arg)}"
)
if isinstance(arg, MultiDictProxy):
self._md = arg._md
else:
self._md = arg
def __reduce__(self) -> NoReturn:
raise TypeError(f"can't pickle {self.__class__.__name__} objects")
@overload
def getall(self, key: str) -> list[_V]: ...
@overload
def getall(self, key: str, default: _T) -> Union[list[_V], _T]: ...
def getall(
self, key: str, default: Union[_T, _SENTINEL] = sentinel
) -> Union[list[_V], _T]:
"""Return a list of all values matching the key."""
if default is not sentinel:
return self._md.getall(key, default)
else:
return self._md.getall(key)
@overload
def getone(self, key: str) -> _V: ...
@overload
def getone(self, key: str, default: _T) -> Union[_V, _T]: ...
def getone(
self, key: str, default: Union[_T, _SENTINEL] = sentinel
) -> Union[_V, _T]:
"""Get first value matching the key.
Raises KeyError if the key is not found and no default is provided.
"""
if default is not sentinel:
return self._md.getone(key, default)
else:
return self._md.getone(key)
# Mapping interface #
def __getitem__(self, key: str) -> _V:
return self.getone(key)
@overload
def get(self, key: str, /) -> Union[_V, None]: ...
@overload
def get(self, key: str, /, default: _T) -> Union[_V, _T]: ...
def get(self, key: str, default: Union[_T, None] = None) -> Union[_V, _T, None]:
"""Get first value matching the key.
If the key is not found, returns the default (or None if no default is provided)
"""
return self._md.getone(key, default)
def __iter__(self) -> Iterator[str]:
return iter(self._md.keys())
def __len__(self) -> int:
return len(self._md)
def keys(self) -> KeysView[str]:
"""Return a new view of the dictionary's keys."""
return self._md.keys()
def items(self) -> ItemsView[str, _V]:
"""Return a new view of the dictionary's items *(key, value) pairs)."""
return self._md.items()
def values(self) -> _ValuesView[_V]:
"""Return a new view of the dictionary's values."""
return self._md.values()
def __eq__(self, other: object) -> bool:
return self._md == other
def __contains__(self, key: object) -> bool:
return key in self._md
@reprlib.recursive_repr()
def __repr__(self) -> str:
body = ", ".join(f"'{k}': {v!r}" for k, v in self.items())
return f"<{self.__class__.__name__}({body})>"
def copy(self) -> MultiDict[_V]:
"""Return a copy of itself."""
return MultiDict(self._md)
class CIMultiDictProxy(_CIMixin, MultiDictProxy[_V]):
"""Read-only proxy for CIMultiDict instance."""
def __init__(self, arg: Union[MultiDict[_V], MultiDictProxy[_V]]):
if not isinstance(arg, (CIMultiDict, CIMultiDictProxy)):
raise TypeError(
"ctor requires CIMultiDict or CIMultiDictProxy instance"
f", not {type(arg)}"
)
super().__init__(arg)
def copy(self) -> CIMultiDict[_V]:
"""Return a copy of itself."""
return CIMultiDict(self._md)
def getversion(md: Union[MultiDict[object], MultiDictProxy[object]]) -> int:
if isinstance(md, MultiDictProxy):
md = md._md
elif not isinstance(md, MultiDict):
raise TypeError("Parameter should be multidict or proxy")
return md._version
|