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
|
import io
import json as jsonlib
import operator
import pathlib
import re
from abc import ABC
from enum import Enum
from functools import reduce
from http.cookies import SimpleCookie
from types import MappingProxyType
from typing import (
Any,
Callable,
ClassVar,
Dict,
List,
Mapping,
Optional,
Pattern as RegexPattern,
Sequence,
Set,
Tuple,
Type,
Union,
)
from unittest.mock import ANY
from urllib.parse import urljoin
import httpx
from respx.utils import MultiItems, decode_data
from .types import (
URL as RawURL,
CookieTypes,
FileTypes,
HeaderTypes,
QueryParamTypes,
RequestFiles,
URLPatternTypes,
)
class Lookup(Enum):
EQUAL = "eq"
REGEX = "regex"
STARTS_WITH = "startswith"
CONTAINS = "contains"
IN = "in"
class Match:
def __init__(self, matches: bool, **context: Any) -> None:
self.matches = matches
self.context = context
def __bool__(self):
return bool(self.matches)
def __invert__(self):
self.matches = not self.matches
return self
def __repr__(self): # pragma: nocover
return f"<Match {self.matches}>"
class Pattern(ABC):
key: ClassVar[str]
lookups: ClassVar[Tuple[Lookup, ...]] = (Lookup.EQUAL,)
lookup: Lookup
base: Optional["Pattern"]
value: Any
# Automatically register all the subclasses in this dict
__registry: ClassVar[Dict[str, Type["Pattern"]]] = {}
registry = MappingProxyType(__registry)
def __init_subclass__(cls) -> None:
if not getattr(cls, "key", None) or ABC in cls.__bases__:
return
if cls.key in cls.__registry:
raise TypeError(
"Subclasses of Pattern must define a unique key. "
f"{cls.key!r} is already defined in {cls.__registry[cls.key]!r}"
)
cls.__registry[cls.key] = cls
def __init__(self, value: Any, lookup: Optional[Lookup] = None) -> None:
if lookup and lookup not in self.lookups:
raise NotImplementedError(
f"{self.key!r} pattern does not support {lookup.value!r} lookup"
)
self.lookup = lookup or self.lookups[0]
self.base = None
self.value = self.clean(value)
def __iter__(self):
yield self
def __bool__(self):
return True
def __and__(self, other: "Pattern") -> "Pattern":
if not bool(other):
return self
elif not bool(self):
return other
return _And((self, other))
def __or__(self, other: "Pattern") -> "Pattern":
if not bool(other):
return self
elif not bool(self):
return other
return _Or((self, other))
def __invert__(self):
if not bool(self):
return self
return _Invert(self)
def __repr__(self): # pragma: nocover
return f"<{self.__class__.__name__} {self.lookup.value} {repr(self.value)}>"
def __hash__(self):
return hash((self.__class__, self.lookup, self.value))
def __eq__(self, other: object) -> bool:
return hash(self) == hash(other)
def clean(self, value: Any) -> Any:
"""
Clean and return pattern value.
"""
return value
def parse(self, request: httpx.Request) -> Any: # pragma: nocover
"""
Parse and return request value to match with pattern value.
"""
raise NotImplementedError()
def strip_base(self, value: Any) -> Any: # pragma: nocover
return value
def match(self, request: httpx.Request) -> Match:
try:
value = self.parse(request)
except Exception:
return Match(False)
# Match and strip base
if self.base:
base_match = self.base._match(value)
if not base_match:
return base_match
value = self.strip_base(value)
return self._match(value)
def _match(self, value: Any) -> Match:
lookup_method = getattr(self, f"_{self.lookup.value}")
return lookup_method(value)
def _eq(self, value: Any) -> Match:
return Match(value == self.value)
def _regex(self, value: str) -> Match:
match = self.value.search(value)
if match is None:
return Match(False)
return Match(True, **match.groupdict())
def _startswith(self, value: str) -> Match:
return Match(value.startswith(self.value))
def _contains(self, value: Any) -> Match: # pragma: nocover
raise NotImplementedError()
def _in(self, value: Any) -> Match:
return Match(value in self.value)
class Noop(Pattern):
def __init__(self) -> None:
super().__init__(None)
def __repr__(self):
return f"<{self.__class__.__name__}>"
def __bool__(self) -> bool:
# Treat this pattern as non-existent, e.g. when filtering or conditioning
return False
def match(self, request: httpx.Request) -> Match:
# If this pattern is part of a combined pattern, always be truthy, i.e. noop
return Match(True)
class PathPattern(Pattern):
path: Optional[str]
def __init__(
self, value: Any, lookup: Optional[Lookup] = None, *, path: Optional[str] = None
) -> None:
self.path = path
super().__init__(value, lookup)
class _And(Pattern):
value: Tuple[Pattern, Pattern]
def __repr__(self): # pragma: nocover
a, b = self.value
return f"{repr(a)} AND {repr(b)}"
def __iter__(self):
a, b = self.value
yield from a
yield from b
def match(self, request: httpx.Request) -> Match:
a, b = self.value
a_match = a.match(request)
if not a_match:
return a_match
b_match = b.match(request)
if not b_match:
return b_match
return Match(True, **{**a_match.context, **b_match.context})
class _Or(Pattern):
value: Tuple[Pattern, Pattern]
def __repr__(self): # pragma: nocover
a, b = self.value
return f"{repr(a)} OR {repr(b)}"
def __iter__(self):
a, b = self.value
yield from a
yield from b
def match(self, request: httpx.Request) -> Match:
a, b = self.value
match = a.match(request)
if not match:
match = b.match(request)
return match
class _Invert(Pattern):
value: Pattern
def __repr__(self): # pragma: nocover
return f"NOT {repr(self.value)}"
def __iter__(self):
yield from self.value
def match(self, request: httpx.Request) -> Match:
return ~self.value.match(request)
class Method(Pattern):
key = "method"
lookups = (Lookup.EQUAL, Lookup.IN)
value: Union[str, Sequence[str]]
def clean(self, value: Union[str, Sequence[str]]) -> Union[str, Sequence[str]]:
if isinstance(value, str):
value = value.upper()
else:
assert isinstance(value, Sequence)
value = tuple(v.upper() for v in value)
return value
def parse(self, request: httpx.Request) -> str:
return request.method
class MultiItemsMixin:
lookup: Lookup
value: Any
def _multi_items(
self, value: Any, *, parse_any: bool = False
) -> Tuple[Tuple[str, Tuple[Any, ...]], ...]:
return tuple(
(
key,
tuple(
ANY if parse_any and v == str(ANY) else v
for v in value.get_list(key)
),
)
for key in sorted(value.keys())
)
def __hash__(self):
return hash((self.__class__, self.lookup, self._multi_items(self.value)))
def _eq(self, value: Any) -> Match:
value_items = self._multi_items(self.value, parse_any=True)
request_items = self._multi_items(value)
return Match(value_items == request_items)
def _contains(self, value: Any) -> Match:
if len(self.value.multi_items()) > len(value.multi_items()):
return Match(False)
value_items = self._multi_items(self.value, parse_any=True)
request_items = self._multi_items(value)
for item in value_items:
if item not in request_items:
return Match(False)
return Match(True)
class Headers(MultiItemsMixin, Pattern):
key = "headers"
lookups = (Lookup.CONTAINS, Lookup.EQUAL)
value: httpx.Headers
def clean(self, value: HeaderTypes) -> httpx.Headers:
return httpx.Headers(value)
def parse(self, request: httpx.Request) -> httpx.Headers:
return request.headers
class Cookies(Pattern):
key = "cookies"
lookups = (Lookup.CONTAINS, Lookup.EQUAL)
value: Set[Tuple[str, str]]
def __hash__(self):
return hash((self.__class__, self.lookup, tuple(sorted(self.value))))
def clean(self, value: CookieTypes) -> Set[Tuple[str, str]]:
if isinstance(value, dict):
return set(value.items())
return set(value)
def parse(self, request: httpx.Request) -> Set[Tuple[str, str]]:
headers = request.headers
cookie_header = headers.get("cookie")
if not cookie_header:
return set()
cookies: SimpleCookie = SimpleCookie()
cookies.load(rawdata=cookie_header)
return {(cookie.key, cookie.value) for cookie in cookies.values()}
def _contains(self, value: Set[Tuple[str, str]]) -> Match:
return Match(bool(self.value & value))
class Scheme(Pattern):
key = "scheme"
lookups = (Lookup.EQUAL, Lookup.IN)
value: Union[str, Sequence[str]]
def clean(self, value: Union[str, Sequence[str]]) -> Union[str, Sequence[str]]:
if isinstance(value, str):
value = value.lower()
else:
assert isinstance(value, Sequence)
value = tuple(v.lower() for v in value)
return value
def parse(self, request: httpx.Request) -> str:
return request.url.scheme
class Host(Pattern):
key = "host"
lookups = (Lookup.EQUAL, Lookup.REGEX, Lookup.IN)
value: Union[str, RegexPattern[str], Sequence[str]]
def clean(
self, value: Union[str, RegexPattern[str]]
) -> Union[str, RegexPattern[str]]:
if self.lookup is Lookup.REGEX and isinstance(value, str):
value = re.compile(value)
return value
def parse(self, request: httpx.Request) -> str:
return request.url.host
class Port(Pattern):
key = "port"
lookups = (Lookup.EQUAL, Lookup.IN)
value: Optional[int]
def parse(self, request: httpx.Request) -> Optional[int]:
scheme = request.url.scheme
port = request.url.port
scheme_port = get_scheme_port(scheme)
return port or scheme_port
class Path(Pattern):
key = "path"
lookups = (Lookup.EQUAL, Lookup.REGEX, Lookup.STARTS_WITH, Lookup.IN)
value: Union[str, Sequence[str], RegexPattern[str]]
def clean(
self, value: Union[str, RegexPattern[str]]
) -> Union[str, RegexPattern[str]]:
if self.lookup in (Lookup.EQUAL, Lookup.STARTS_WITH) and isinstance(value, str):
# Percent encode path, i.e. revert parsed path by httpx.URL.
# Borrowed from HTTPX's "private" quote and percent_encode utilities.
path = "".join(
char
if char
in "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~/"
else "".join(f"%{byte:02x}" for byte in char.encode("utf-8")).upper()
for char in value
)
path = urljoin("/", path) # Ensure leading slash
value = httpx.URL(path).path
elif self.lookup is Lookup.REGEX and isinstance(value, str):
value = re.compile(value)
return value
def parse(self, request: httpx.Request) -> str:
return request.url.path
def strip_base(self, value: str) -> str:
if self.base:
value = value[len(self.base.value) :]
value = "/" + value if not value.startswith("/") else value
return value
class Params(MultiItemsMixin, Pattern):
key = "params"
lookups = (Lookup.CONTAINS, Lookup.EQUAL)
value: httpx.QueryParams
def clean(self, value: QueryParamTypes) -> httpx.QueryParams:
return httpx.QueryParams(value)
def parse(self, request: httpx.Request) -> httpx.QueryParams:
query = request.url.query
return httpx.QueryParams(query)
class URL(Pattern):
key = "url"
lookups = (
Lookup.EQUAL,
Lookup.REGEX,
Lookup.STARTS_WITH,
)
value: Union[str, RegexPattern[str]]
def clean(self, value: URLPatternTypes) -> Union[str, RegexPattern[str]]:
url: Union[str, RegexPattern[str]]
if self.lookup is Lookup.EQUAL and isinstance(value, (str, tuple, httpx.URL)):
_url = parse_url(value)
_url = self._ensure_path(_url)
url = str(_url)
elif self.lookup is Lookup.REGEX and isinstance(value, str):
url = re.compile(value)
elif isinstance(value, (str, RegexPattern)):
url = value
else:
raise ValueError(f"Invalid url: {value!r}")
return url
def parse(self, request: httpx.Request) -> str:
url = request.url
url = self._ensure_path(url)
return str(url)
def _ensure_path(self, url: httpx.URL) -> httpx.URL:
if not url._uri_reference.path:
url = url.copy_with(path="/")
return url
class ContentMixin:
def parse(self, request: httpx.Request) -> Any:
content = request.read()
return content
class Content(ContentMixin, Pattern):
lookups = (Lookup.EQUAL, Lookup.CONTAINS)
key = "content"
value: bytes
def clean(self, value: Union[bytes, str]) -> bytes:
if isinstance(value, str):
return value.encode()
return value
def _contains(self, value: Union[bytes, str]) -> Match:
return Match(self.value in value)
class JSON(ContentMixin, PathPattern):
lookups = (Lookup.EQUAL,)
key = "json"
value: str
def clean(self, value: Union[str, List, Dict]) -> str:
return self.hash(value)
def parse(self, request: httpx.Request) -> str:
content = super().parse(request)
json = jsonlib.loads(content.decode("utf-8"))
if self.path:
value = json
for bit in self.path.split("__"):
key = int(bit) if bit.isdigit() else bit
try:
value = value[key]
except KeyError as e:
raise KeyError(f"{self.path!r} not in {json!r}") from e
except IndexError as e:
raise IndexError(f"{self.path!r} not in {json!r}") from e
else:
value = json
return self.hash(value)
def hash(self, value: Union[str, List, Dict]) -> str:
return jsonlib.dumps(value, sort_keys=True)
class Data(MultiItemsMixin, Pattern):
lookups = (Lookup.EQUAL, Lookup.CONTAINS)
key = "data"
value: MultiItems
def clean(self, value: Dict) -> MultiItems:
return MultiItems(
(key, "" if value is None else str(value)) for key, value in value.items()
)
def parse(self, request: httpx.Request) -> Any:
data, _ = decode_data(request)
return data
class Files(MultiItemsMixin, Pattern):
lookups = (Lookup.CONTAINS, Lookup.EQUAL)
key = "files"
value: MultiItems
def _normalize_file_value(self, value: FileTypes) -> Tuple[Any, Any]:
# Mimic httpx `FileField` to normalize `files` kwarg to shortest tuple style
if isinstance(value, tuple):
filename, fileobj = value[:2]
else:
try:
filename = pathlib.Path(str(getattr(value, "name"))).name # noqa: B009
except AttributeError:
filename = ANY
fileobj = value
# Normalize file-like objects and strings to bytes to allow equality check
if isinstance(fileobj, io.BytesIO):
fileobj = fileobj.read()
elif isinstance(fileobj, str):
fileobj = fileobj.encode()
return filename, fileobj
def clean(self, value: RequestFiles) -> MultiItems:
if isinstance(value, Mapping):
value = list(value.items())
files = MultiItems(
(name, self._normalize_file_value(file_value)) for name, file_value in value
)
return files
def parse(self, request: httpx.Request) -> Any:
_, files = decode_data(request)
return files
def M(*patterns: Pattern, **lookups: Any) -> Pattern:
extras = None
for pattern__lookup, value in lookups.items():
# Handle url pattern
if pattern__lookup == "url":
extras = parse_url_patterns(value)
continue
# Parse pattern key and lookup
pattern_key, __, rest = pattern__lookup.partition("__")
path, __, lookup_name = rest.rpartition("__")
if pattern_key not in Pattern.registry:
raise KeyError(f"{pattern_key!r} is not a valid Pattern")
# Get pattern class
P = Pattern.registry[pattern_key]
pattern: Union[Pattern, PathPattern]
if issubclass(P, PathPattern):
# Make path supported pattern, i.e. JSON
try:
lookup = Lookup(lookup_name) if lookup_name else None
except ValueError:
lookup = None
path = rest
pattern = P(value, lookup=lookup, path=path)
else:
# Make regular pattern
lookup = Lookup(lookup_name) if lookup_name else None
pattern = P(value, lookup=lookup)
# Skip patterns with no value, exept when using equal lookup
if not pattern.value and pattern.lookup is not Lookup.EQUAL:
continue
patterns += (pattern,)
# Combine and merge patterns
combined_pattern = combine(patterns)
if extras:
combined_pattern = merge_patterns(combined_pattern, **extras)
return combined_pattern
def get_scheme_port(scheme: Optional[str]) -> Optional[int]:
return {"http": 80, "https": 443}.get(scheme or "")
def combine(patterns: Sequence[Pattern], op: Callable = operator.and_) -> Pattern:
patterns = tuple(filter(None, patterns))
if not patterns:
return Noop()
return reduce(op, patterns)
def parse_url(value: Union[httpx.URL, str, RawURL]) -> httpx.URL:
url: Union[httpx.URL, str]
if isinstance(value, tuple):
# Handle "raw" httpcore urls. Borrowed from HTTPX prior to #2241
raw_scheme, raw_host, port, raw_path = value
scheme = raw_scheme.decode("ascii")
host = raw_host.decode("ascii")
if host and ":" in host and host[0] != "[":
# it's an IPv6 address, so it should be enclosed in "[" and "]"
# ref: https://tools.ietf.org/html/rfc2732#section-2
# ref: https://tools.ietf.org/html/rfc3986#section-3.2.2
host = f"[{host}]"
port_str = "" if port is None else f":{port}"
path = raw_path.decode("ascii")
url = f"{scheme}://{host}{port_str}{path}"
else:
url = value
return httpx.URL(url)
def parse_url_patterns(
url: Optional[URLPatternTypes], exact: bool = True
) -> Dict[str, Pattern]:
bases: Dict[str, Pattern] = {}
if not url or url == "all":
return bases
if isinstance(url, RegexPattern):
return {"url": URL(url, lookup=Lookup.REGEX)}
url = parse_url(url)
scheme_port = get_scheme_port(url.scheme)
if url.scheme and url.scheme != "all":
bases[Scheme.key] = Scheme(url.scheme)
if url.host:
# NOTE: Host regex patterns borrowed from HTTPX source to support proxy format
if url.host.startswith("*."):
domain = re.escape(url.host[2:])
regex = re.compile(f"^.+\\.{domain}$")
bases[Host.key] = Host(regex, lookup=Lookup.REGEX)
elif url.host.startswith("*"):
domain = re.escape(url.host[1:])
regex = re.compile(f"^(.+\\.)?{domain}$")
bases[Host.key] = Host(regex, lookup=Lookup.REGEX)
else:
bases[Host.key] = Host(url.host)
if url.port and url.port != scheme_port:
bases[Port.key] = Port(url.port)
if url._uri_reference.path: # URL.path always returns "/"
lookup = Lookup.EQUAL if exact else Lookup.STARTS_WITH
bases[Path.key] = Path(url.path, lookup=lookup)
if url.query:
lookup = Lookup.EQUAL if exact else Lookup.CONTAINS
bases[Params.key] = Params(url.query, lookup=lookup)
return bases
def merge_patterns(pattern: Pattern, **bases: Pattern) -> Pattern:
if not bases:
return pattern
# Flatten pattern
patterns: List[Pattern] = list(filter(None, iter(pattern)))
if patterns:
if "host" in (_pattern.key for _pattern in patterns):
# Pattern is "absolute", skip merging
bases = {}
else:
# Traverse pattern and set related base
for _pattern in patterns:
base = bases.pop(_pattern.key, None)
# Skip "exact" base + don't overwrite existing base
if _pattern.base or base and base.lookup is Lookup.EQUAL:
continue
_pattern.base = base
if bases:
# Combine left over base patterns with pattern
base_pattern = combine(list(bases.values()))
if pattern and base_pattern:
pattern = base_pattern & pattern
else:
pattern = base_pattern
return pattern
|