src/rdflib/plugins/sparql/pyparsing_compat.py
1"""
2Compatibility helpers for supporting pyparsing v2 and v3 APIs.
3"""
4
5from __future__ import annotations
6
7from typing import Callable, Dict, Type, cast
8
9import pyparsing
10
11ParseResults = pyparsing.ParseResults
12ParserElement = pyparsing.ParserElement
13
14
15_RAW_VERSION = getattr(pyparsing, "__version__", "0")
16try:
17 PYPARSING_MAJOR_VERSION = int(_RAW_VERSION.split(".", 1)[0])
18except (TypeError, ValueError):
19 PYPARSING_MAJOR_VERSION = 0
20
21PYPARSING_V3 = PYPARSING_MAJOR_VERSION >= 3
22
23_ParserFactory = Callable[..., ParserElement]
24_ParserTransform = Callable[..., ParserElement]
25
26DelimitedList: _ParserFactory
27original_text_for: _ParserTransform
28rest_of_line: ParserElement
29
30if PYPARSING_V3:
31 DelimitedList = pyparsing.DelimitedList
32 original_text_for = pyparsing.original_text_for
33 rest_of_line = pyparsing.rest_of_line
34else:
35 DelimitedList = pyparsing.delimitedList
36 original_text_for = pyparsing.originalTextFor
37 rest_of_line = pyparsing.restOfLine
38
39
40def _alias_instance_method(klass: Type[object], new_name: str, old_name: str) -> None:
41 if hasattr(klass, new_name) or not hasattr(klass, old_name):
42 return
43
44 def _method(self: object, *args: object, **kwargs: object) -> object:
45 # Resolve old_name on self so subclass overrides are preserved.
46 method = cast(Callable[..., object], getattr(self, old_name))
47 return method(*args, **kwargs)
48
49 setattr(klass, new_name, _method)
50
51
52def _alias_static_method(klass: Type[object], new_name: str, old_name: str) -> None:
53 if hasattr(klass, new_name) or not hasattr(klass, old_name):
54 return
55
56 old_method = cast(Callable[..., object], getattr(klass, old_name))
57
58 def _method(*args: object, **kwargs: object) -> object:
59 return old_method(*args, **kwargs)
60
61 setattr(klass, new_name, staticmethod(_method))
62
63
64_alias_instance_method(ParserElement, "set_parse_action", "setParseAction")
65_alias_instance_method(ParserElement, "add_parse_action", "addParseAction")
66_alias_instance_method(ParserElement, "leave_whitespace", "leaveWhitespace")
67_alias_instance_method(ParserElement, "set_name", "setName")
68_alias_instance_method(ParserElement, "set_results_name", "setResultsName")
69_alias_instance_method(ParserElement, "parse_with_tabs", "parseWithTabs")
70_alias_instance_method(ParserElement, "search_string", "searchString")
71_alias_static_method(
72 ParserElement,
73 "set_default_whitespace_chars",
74 "setDefaultWhitespaceChars",
75)
76
77if not hasattr(ParserElement, "parse_string"):
78
79 def _parse_string(
80 self: ParserElement,
81 instring: str,
82 parse_all: bool = False,
83 *,
84 parseAll: bool = False,
85 ) -> ParseResults:
86 if parseAll:
87 parse_all = parseAll
88 parser = cast(Callable[..., ParseResults], getattr(self, "parseString"))
89 return parser(instring, parseAll=parse_all)
90
91 setattr(ParserElement, "parse_string", _parse_string)
92
93
94_alias_instance_method(ParseResults, "as_list", "asList")
95
96
97def combine_join_kwargs(value: str) -> Dict[str, str]:
98 if PYPARSING_V3:
99 return {"join_string": value}
100 return {"joinString": value}