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
|
# Copyright (c) 2017-2026 Juancarlo AƱez (apalala@gmail.com)
# SPDX-License-Identifier: BSD-4-Clause
from __future__ import annotations
import ast as stdlib_ast
from collections.abc import Callable, Iterable
from contextlib import contextmanager, suppress
from typing import Any
from .. import buffering, tokenizing
from ..ast import AST
from ..buffering import Buffer
from ..collections import BoundedDict
from ..exceptions import (
FailedExpectingEndOfText,
FailedLeftRecursion,
FailedLookahead,
FailedParse,
FailedPattern,
FailedSemantics,
FailedToken,
KeywordError,
OptionSucceeded,
ParseError,
ParseException,
)
from ..infos import Alert, ParseInfo, ParserConfig, RuleInfo
from ..tokenizing import NullTokenizer, Tokenizer
from ..util import regexp, safe_name, trim
from ..util.abctools import is_list, left_assoc, prune_dict, right_assoc
from ..util.deprecate import deprecated
from ..util.safeeval import is_eval_safe, safe_builtins, safe_eval
from ..util.typing import boundcall
from ..util.undefined import Undefined
from .infos import MemoKey, RuleResult, closure
from .state import ParseState, ParseStateStack
from .tracing import EventTracer, EventTracerImpl
__all__: list[str] = ['ParseContext']
class ParseContext:
def __init__(
self,
/,
*,
config: ParserConfig | None = None,
**settings: Any,
) -> None:
super().__init__()
config = ParserConfig.new(config, **settings)
if config.tokenizercls is None:
config = config.override(tokenizercls=Buffer)
self._config: ParserConfig = config
self._active_config: ParserConfig = self._config
self._tokenizer: Tokenizer = NullTokenizer()
self._semantics: type | None = config.semantics
self._initialize_caches()
self._tracer: EventTracer = EventTracer()
self.update_tracer()
def _initialize_caches(self) -> None:
self._states = ParseStateStack()
self._ruleinfo_stack: list[RuleInfo] = []
self.substate: Any = None
self._lookahead: int = 0
self._furthest_exception: FailedParse | None = None
self._clear_memoization_caches()
@property
def config(self):
return self._active_config
@property
def active_config(self) -> ParserConfig:
return self._active_config
@property
def self_config(self) -> ParserConfig:
return self._config
@property
def semantics(self) -> Any:
return self._semantics
@property
def keywords(self) -> set[str]:
return self._keywords
@property
def tracer(self):
return self._tracer
@property
def tokenizer(self) -> Tokenizer:
return self._tokenizer
@property
def tokenizercls(self) -> type[Tokenizer]:
if self.config.tokenizercls is None:
return buffering.Buffer
else:
return self.config.tokenizercls
@property
def last_node(self) -> Any:
return self.states.last_node
@last_node.setter
def last_node(self, value: Any) -> None:
self.states.last_node = value
@property
def pos(self) -> int:
return self._tokenizer.pos
@property
def line(self) -> int:
return self._tokenizer.line
@property
def states(self) -> ParseStateStack:
return self._states
@property
def state(self) -> ParseState:
return self.states.top
@property
def ast(self) -> AST:
return self.state.ast
@ast.setter
def ast(self, value: AST) -> None:
self.state.ast = value
@property
def cst(self) -> Any:
return self.state.cst
@cst.setter
def cst(self, value: Any) -> None:
self.state.cst = value
def update_tracer(self) -> EventTracer:
tracer = EventTracerImpl(
self._tokenizer,
self._ruleinfo_stack,
config=self.config,
)
self._tracer = tracer
return self.tracer
def _reset(self, config: ParserConfig) -> ParserConfig:
self._initialize_caches()
self._keywords: set[str] = set(config.keywords)
self._semantics = config.semantics
if hasattr(self.semantics, 'set_context'):
self.semantics.set_context(self)
return config
def _clear_memoization_caches(self) -> None:
self._memos: BoundedDict[MemoKey, RuleResult | ParseException] = BoundedDict(
self.config.memo_cache_size,
)
self._results: dict[MemoKey, RuleResult | ParseException] = {}
def _set_furthest_exception(self, e: FailedParse) -> None:
if not self._furthest_exception or e.pos > self._furthest_exception.pos:
self._furthest_exception = e
def parse(
self,
text: str | Tokenizer,
/,
*,
config: ParserConfig | None = None,
**settings: Any,
) -> Any:
config = self.config.override_config(config)
config = config.override(**settings)
self._active_config = config
self.update_tracer()
try:
self._reset(config)
if isinstance(text, tokenizing.Tokenizer):
tokenizer = text
elif issubclass(config.tokenizercls, NullTokenizer):
tokenizer = Buffer(text=text, config=config, **settings)
elif text is not None:
cls = self.tokenizercls
tokenizer = cls(text, config=config, **settings)
else:
raise ParseError('No tokenizer or text')
self._tokenizer = tokenizer
if self.config.semantics and hasattr(self.config.semantics, 'set_context'):
self.config.semantics.set_context(self)
start: str = self.config.effective_start_rule_name() or 'start'
rule = self._find_rule(start)
return rule()
except FailedParse as e:
self._set_furthest_exception(e)
if isinstance(self._furthest_exception, Exception):
raise self._furthest_exception from e
raise
finally:
self._clear_memoization_caches()
self._active_config = self._config
self.update_tracer()
if self.config.semantics and hasattr(self.config.semantics, 'set_context'):
self.config.semantics.set_context(None)
def goto(self, pos: int) -> None:
self._tokenizer.goto(pos)
def _next(self) -> Any:
return self._tokenizer.next()
def next_token(self, ruleinfo: RuleInfo | None = None) -> None:
if not (ruleinfo and ruleinfo.is_token_rule()):
self._tokenizer.next_token()
def _define(
self,
keys: Iterable[str],
list_keys: Iterable[str] | None = None,
) -> None:
# NOTE: called by generated parsers
return self.states.define(keys, list_keys)
def setname(self, name: str) -> None:
# NOTE: called by generated parsers
self.states.setname(name)
def addname(self, name: str) -> None:
# NOTE: called by generated parsers
self.states.addname(name)
# bw compatibility
@deprecated(replacement=setname)
def name_last_node(self, name: str): # bw-compat
self.setname(name)
# bw compatibility
@deprecated(replacement=addname)
def add_last_node_to_name(self, name: str): # bw-compat
self.addname(name)
def pushstate(self, ast: Any = None) -> None:
self.states.push(pos=self.pos, ast=ast)
def popstate(self) -> ParseState:
return self.states.pop()
def mergestate(self) -> ParseState:
return self.states.merge(pos=self.pos)
def undostate(self) -> None:
self.states.pop()
self.tokenizer.goto(self.state.pos)
def _cut(self) -> None:
self.states.set_cut_seen()
self.tracer.trace_cut()
def prune(cache: dict[Any, Any], cut_pos: int) -> None:
prune_dict(
cache,
lambda k, v: k[0] < cut_pos and not isinstance(v, FailedLeftRecursion),
)
if self.config.prune_memos_on_cut:
prune(self._memos, self.pos)
def _memoization(self) -> bool:
return self.config.memoization and (
self.config.memoize_lookaheads or self._lookahead == 0
)
def _find_rule(self, name: str) -> Callable[[], Any]:
raise NotImplementedError
def _find_semantic_action(self, name: str) -> Callable[..., Any] | None:
if not self.semantics:
return None
action = getattr(self.semantics, safe_name(name), None)
if not callable(action):
action = getattr(self.semantics, '_default', None)
if not callable(action):
action = None
return action
def newexcept(
self,
item: Any,
exclass: type[FailedParse] = FailedParse,
) -> FailedParse:
if issubclass(exclass, FailedLeftRecursion):
rulestack: list[str] = []
else:
rulestack = [r.name for r in reversed(self._ruleinfo_stack)]
return exclass(self.tokenizer.lineinfo(), rulestack, item)
# bw compatibility
@deprecated(replacement=newexcept)
def _error(
self,
item: Any,
exclass: type[FailedParse] = FailedParse,
) -> FailedParse:
raise self.newexcept(item, exclass)
def _fail(self):
raise self.newexcept('fail')
def _make_parseinfo(self, name: str, pos: int) -> ParseInfo:
endpos = self.pos
return ParseInfo(
tokenizer=self.tokenizer,
rule=name,
pos=pos,
endpos=endpos,
line=self.tokenizer.posline(pos),
endline=self.tokenizer.posline(endpos),
alerts=self.state.alerts,
)
def _set_parseinfo(self, node: Any, name: str, pos: int):
if not self.config.parseinfo:
return
if hasattr(node, 'set_parseinfo'):
parseinfo = self._make_parseinfo(name, pos)
node.set_parseinfo(parseinfo)
elif hasattr(node, 'parseinfo'):
parseinfo = self._make_parseinfo(name, pos)
node.parseinfo = parseinfo
@property
def ruleinfo(self) -> RuleInfo:
return self._ruleinfo_stack[-1]
def memokey(self) -> MemoKey:
return MemoKey(self.pos, self.ruleinfo, self.substate)
def _memoize(
self,
key: MemoKey,
memo: RuleResult | ParseException,
) -> RuleResult | ParseException:
if self._memoization() and key.ruleinfo.is_memoizable:
self._memos[key] = memo
return memo
def _save_result(self, key: MemoKey, result: RuleResult) -> None:
if is_list(result.node):
result = result._replace(node=closure(result.node))
self._results[key] = result
def _set_left_recursion_guard(self, key: MemoKey) -> None:
if not self.config.left_recursion:
return
ex = self.newexcept(key.ruleinfo.name, exclass=FailedLeftRecursion)
self._memoize(key, ex)
def _call(self, ruleinfo: RuleInfo) -> Any:
self._ruleinfo_stack += [ruleinfo]
pos = self.pos
try:
self.tracer.trace_entry()
self.last_node = None
result = self._recursive_call(ruleinfo)
self.goto(result.newpos)
self.substate = result.newstate
self.states.append(result.node)
self.tracer.trace_success()
return result.node
except FailedParse as e:
self.goto(pos)
self._set_furthest_exception(e)
self.tracer.trace_failure(e)
raise
finally:
self._ruleinfo_stack.pop()
def _clear_recursion_errors(self) -> None:
def filter_func(key: MemoKey, value: Any) -> bool:
return isinstance(value, FailedLeftRecursion)
prune_dict(self._memos, filter_func)
def _found_left_recursion(self, ruleinfo: RuleInfo) -> bool:
return any(ri.name == ruleinfo.name for ri in self._ruleinfo_stack)
def _recursive_call(self, ruleinfo: RuleInfo) -> RuleResult:
self.next_token(ruleinfo)
key: MemoKey = self.memokey()
if not ruleinfo.is_leftrec:
return self._rule_call(ruleinfo, key)
elif not self.config.left_recursion:
raise self.newexcept('Left recursion detected', exclass=FailedLeftRecursion)
result: RuleResult | ParseException | None = self._results.get(key)
if isinstance(result, RuleResult):
return result
elif isinstance(result, Exception):
raise result
result = self.newexcept(ruleinfo.name, FailedLeftRecursion)
self._results[key] = result
initial = self.pos
lastpos = -1
while True:
self._clear_recursion_errors()
try:
new_result = self._rule_call(ruleinfo, key)
self.goto(initial)
except FailedParse:
break
if new_result.newpos > lastpos:
self._save_result(key, new_result)
lastpos = new_result.newpos
result = new_result
else:
break
if isinstance(result, Exception):
raise result
return result
def _rule_call(self, ruleinfo: RuleInfo, key: MemoKey) -> RuleResult:
result = self._memos.get(key)
if isinstance(result, Exception):
raise result
if isinstance(result, RuleResult):
return result
self._set_left_recursion_guard(key)
self.pushstate(ast=AST())
try:
self.next_token(ruleinfo)
with self.states.cutscope():
ruleinfo.impl(self)
node = self.state.node
node = self._semantics_call(ruleinfo, node)
self._set_parseinfo(node, ruleinfo.name, key.pos)
result = RuleResult(node, self.pos, self.substate)
self._memoize(key, result)
return result
except FailedSemantics as e:
ex = self.newexcept(str(e))
self._memoize(key, ex)
raise ex from e
except ParseException as e:
self._memoize(key, e)
raise
finally:
self.undostate()
def _semantics_call(self, ruleinfo: RuleInfo, node: Any) -> Any:
if ruleinfo.is_name:
self._check_name(node)
params = ruleinfo.params or ()
kwparams = ruleinfo.kwparams or {}
action = self._find_semantic_action(ruleinfo.name)
if action:
return boundcall(action, {}, node, *params, **kwparams)
else:
return node
def _token(self, token: str) -> str:
self.next_token()
if self.tokenizer.match(token) is None:
self.tracer.trace_match(token, failed=True)
raise self.newexcept(token, exclass=FailedToken)
self.tracer.trace_match(token)
self.states.append(token)
return token
def _constant(self, literal: Any) -> Any:
self.next_token()
self.tracer.trace_match(literal)
if not isinstance(literal, str):
self.states.append(literal)
return literal
literal = str(literal) # for type linters
context: dict[str, Any] = (
safe_builtins()
| getattr(self.semantics, 'safe_context', lambda: {})()
| self.ast
if isinstance(self.ast, AST)
else {}
)
expression = Undefined
result = literal
while result != expression:
expression = result
if not isinstance(expression, str):
break
expression = trim(expression)
with suppress(ValueError, SyntaxError):
result = stdlib_ast.literal_eval(expression.strip())
assert result is not Undefined
continue
try:
fstr_expression = f'''f{expression!r}'''
if is_eval_safe(fstr_expression, context):
result = safe_eval(fstr_expression, context)
if result == expression and is_eval_safe(expression, context):
# NOTE: No f'{xyz}' evaluations occurred
result = safe_eval(expression, context)
except Exception as e:
raise FailedSemantics(
f'Error evaluating constant {literal!r}: {e}',
) from e
self.states.append(result)
return result
def _alert(self, message: str, level: int) -> None:
self.next_token()
self.tracer.trace_match(f'{"^" * level}`{message}`', failed=True)
self.state.alerts.append(Alert(message=message, level=level))
def _pattern(self, pattern: str) -> Any:
token = self.tokenizer.matchre(pattern)
if token is None:
self.tracer.trace_match('', pattern, failed=True)
raise self.newexcept(f'Expecting {regexp(pattern)}', exclass=FailedPattern)
self.tracer.trace_match(token, pattern)
self.states.append(token)
return token
def eof(self) -> bool:
return self.tokenizer.atend()
def eol(self) -> bool:
return self.tokenizer.ateol()
def _check_eof(self) -> None:
self.next_token()
if not self.tokenizer.atend():
raise self.newexcept(
'Expecting end of text',
exclass=FailedExpectingEndOfText,
)
@contextmanager
def _try(self):
s = self.substate
self.pushstate(ast=AST(self.ast))
self.last_node = None
try:
yield
self.mergestate()
except FailedParse:
self.undostate()
self.substate = s
raise
def _no_more_options(self) -> bool:
"""
Used by the Python code generator so there are
no unconditional:
```
raise self.newexception(...)
```
that fool the syntax highlighting of editors
"""
return True
@contextmanager
def _option(self):
self.last_node = None
try:
with self._try():
yield
raise OptionSucceeded()
except FailedParse:
if not self.states.cut_seen():
pass
else:
raise
@contextmanager
def _choice(self):
with suppress(OptionSucceeded), self.states.cutscope():
yield
@contextmanager
def _optional(self):
with self._choice(), self._option(), self.states.cutscope():
yield
@contextmanager
def _group(self):
self.pushstate()
try:
with self.states.cutscope():
yield
self.mergestate()
except ParseException:
self.undostate()
raise
@contextmanager
def _if(self):
s = self.substate
self.pushstate()
self._lookahead += 1
try:
yield
finally:
self.undostate()
self._lookahead -= 1
self.substate = s
@contextmanager
def _ifnot(self):
try:
with self._if():
yield
except ParseException:
pass
else:
raise self.newexcept('', exclass=FailedLookahead)
@contextmanager
def _setname(self, name: str):
yield
self.setname(name)
@contextmanager
def _addname(self, name: str):
yield
self.addname(name)
def _isolate(self, block: Callable[[], Any], drop: bool = False) -> Any:
self.pushstate()
try:
block()
return closure(self.cst) if is_list(self.cst) else self.cst
finally:
ast = self.ast
self.popstate()
self.ast = ast
def _repeat(
self,
block: Callable[[], Any],
prefix: Callable[[], Any] | None = None,
dropprefix: bool = False,
) -> None:
while True:
with self._choice():
with self._option():
p = self.pos
if prefix:
pcst = self._isolate(prefix, drop=dropprefix)
if not dropprefix:
self.states.append(pcst)
self._cut()
cst = self._isolate(block)
self.states.append(cst)
if self.pos == p:
raise self.newexcept('empty closure')
return
def _closure(
self,
block: Callable[[], Any],
sep: Callable[[], Any] | None = None,
omitsep: bool = False,
) -> Any:
self.pushstate()
try:
self.cst = []
with self.states.cutscope():
with self._optional():
block()
self.cst = [self.cst]
self._repeat(block, prefix=sep, dropprefix=omitsep)
self.cst = closure(self.cst)
return self.mergestate().cst
except ParseException:
self.undostate()
raise
def _positive_closure(
self,
block: Callable[[], Any],
sep: Callable[[], Any] | None = None,
omitsep: bool = False,
) -> Any:
self.pushstate()
try:
with self.states.cutscope():
block()
self.cst = [self.cst]
self._repeat(block, prefix=sep, dropprefix=omitsep)
self.cst = closure(self.cst)
return self.mergestate().cst
except ParseException:
self.undostate()
raise
def _empty_closure(self) -> closure:
cst = closure([])
self.states.append(cst)
return cst
def _gather(self, block: Callable[[], Any], sep: Callable[[], Any]) -> Any:
return self._closure(block, sep=sep, omitsep=True)
def _positive_gather(self, block: Callable[[], Any], sep: Callable[[], Any]) -> Any:
return self._positive_closure(block, sep=sep, omitsep=True)
def _join(self, block: Callable[[], Any], sep: Callable[[], Any]) -> Any:
return self._closure(block, sep=sep)
def _positive_join(self, block: Callable[[], Any], sep: Callable[[], Any]) -> Any:
return self._positive_closure(block, sep=sep)
def _left_join(self, block: Callable[[], Any], sep: Callable[[], Any]) -> Any:
self.cst = left_assoc(self._positive_join(block, sep))
self.last_node = self.cst
return self.cst
def _right_join(self, block: Callable[[], Any], sep: Callable[[], Any]) -> Any:
self.cst = right_assoc(self._positive_join(block, sep))
self.last_node = self.cst
return self.cst
def _check_name(self, name: Any) -> None:
name_str = str(name)
if self.config.ignorecase or self.tokenizer.ignorecase:
name_str = name_str.upper()
if name_str in self.keywords:
raise self.newexcept(f'"{name_str}" is a reserved word', KeywordError)
def _void(self) -> None:
self.last_node = None
def _dot(self) -> Any:
c = self._next()
if c is None:
self.tracer.trace_match(c, failed=True)
raise self.newexcept(c, exclass=FailedToken) from None
self.tracer.trace_match(c)
self.states.append(c)
return c
def _skip_to(self, block: Callable[[], Any]) -> None:
while not self.eof():
try:
with self._if():
block()
except FailedParse:
pass
else:
break
pos = self.pos
self.next_token()
if self.pos == pos:
self._next()
block()
|