You've already forked pgbackrest
mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2026-10-23 21:28:56 +03:00
59bd2cd96c
The build tool in src/build becomes build/build.py with its library in build/lib, and the C part of the documentation tool in doc/src becomes doc/doc.py with its library in doc/lib. They migrate together because doc/src was built on src/build, linking its config and help parsing along with its extensions to the core types. doc.pl runs doc.py rather than building and running a C binary, and meson runs build.py for the code it generates as it builds. The three libraries form the hierarchy the C include path did: build/lib is the base, doc/lib sits on it, and test/lib sits on both. They are implicit namespace packages so a package spans them, and a module lives in exactly one library and holds the union of what the tools need from it, since Python resolves a module name to a single file and cannot extend one the way the C included a core module and added to it. define.yaml declares which libraries each tool may import and the test runner puts only those on the path, so a test of the build library cannot reach the doc or test library any more than the build tool can. The declarations move with the code. config.yaml, error.yaml, and postgres.yaml are now at the root of build, and help.xml becomes doc/xml/reference.xml since it is documentation that the help happens to be generated from, so the generator is told where it is rather than knowing. dist.sh moves to build as well. The documentation tool's own option declarations are gone because they existed only to generate the option parser for the C binary and doc.py parses its command line directly. Three modules in src/build/common were never build tool code. exec, regExp, and string extend the core types for the test harness and the unit tests, which were their only users, so they move to test/src/harness. The json and xml extensions had no users outside the two tools and are removed with them, and the tests for both are trimmed to the core functions that remain. The help unit test built its fixture by calling the generator's C functions directly, which was the last thing outside the tools that depended on them. It now runs build.py help-data to write the packed help and loads that, so it still runs against the current declarations without needing the generated C, which may not have been written when the test runs. The manual page wrapping is a port of the wrapper the binary uses for its own help, so the manual page and pgbackrest help break lines the same way, including where a word longer than a line is left unbroken. libyaml is no longer needed to build pgBackRest since the only thing that read yaml was the C generator. It is dropped from the development container and from every CI platform, and meson no longer looks for it. Code generation needs nothing compiled first either, so a test run no longer builds a generator before it can select the tests. The common source list is merged into the pgbackrest source list since it existed only so the generator could be built from the same files, and the entries that were out of alphabetical order are put in order while the list is being rewritten anyway. Every file the generator writes is byte identical to what the C wrote, for the project declarations and for the documentation's own. The documentation is checked the same way: the HTML rendered on this branch is byte identical to the HTML rendered on integration, every file of it, which exercises the whole pipeline on the real content rather than only the four files the tool writes. Every module in both libraries is declared in define.yaml and has full line and branch coverage. The coverage list is keyed by file rather than by module name, since the same name in two languages is two files and one of them would have silently lost its requirement while both existed. TestError becomes ToolError, since it is the error type for three tools now rather than for the harness alone.
116 lines
4.4 KiB
Python
116 lines
4.4 KiB
Python
"""Expression Evaluation.
|
|
|
|
Evaluates the expression an if attribute holds, which decides whether the node it is on stays in the document. Variables are replaced
|
|
before the expression gets here, so it works on values rather than on names.
|
|
|
|
The grammar is only what the documentation needs: or, and, parentheses, negation, string equality, and numeric comparison. Or binds
|
|
loosest and is split first, so "a || b && c" is "a || (b && c)"."""
|
|
|
|
####################################################################################################################################
|
|
from common.error import ToolError
|
|
|
|
# Numeric comparisons, longest operator first so that >= is not read as > followed by =
|
|
_COMPARE_LIST = (
|
|
(" >= ", lambda left, right: left >= right),
|
|
(" <= ", lambda left, right: left <= right),
|
|
(" > ", lambda left, right: left > right),
|
|
(" < ", lambda left, right: left < right),
|
|
)
|
|
|
|
|
|
####################################################################################################################################
|
|
def _find_op(expression, op):
|
|
"""Find an operator that is not inside parentheses, since one that is belongs to the expression they hold."""
|
|
|
|
depth = 0
|
|
|
|
for idx in range(len(expression)):
|
|
if expression[idx] == "(":
|
|
depth += 1
|
|
elif expression[idx] == ")":
|
|
depth -= 1
|
|
elif depth == 0 and expression.startswith(op, idx):
|
|
return idx
|
|
|
|
return -1
|
|
|
|
|
|
####################################################################################################################################
|
|
def _quoted(value, side, op, expression):
|
|
"""The value a quoted string holds, since a comparison is between what was written rather than how it was written."""
|
|
|
|
if len(value) < 2 or value[0] != "'" or value[-1] != "'":
|
|
raise ToolError("expected quoted string on %s side of '%s': '%s'" % (side, op, expression))
|
|
|
|
return value[1:-1]
|
|
|
|
|
|
####################################################################################################################################
|
|
def _number(value, expression):
|
|
"""The number a value holds."""
|
|
|
|
try:
|
|
return int(value.strip())
|
|
except ValueError:
|
|
raise ToolError("expected number in '%s'" % expression)
|
|
|
|
|
|
####################################################################################################################################
|
|
def _eval_one(expression):
|
|
"""Evaluate an expression that has no or/and in it."""
|
|
|
|
trimmed = expression.strip()
|
|
|
|
# An expression in parentheses is evaluated on its own
|
|
if trimmed.startswith("("):
|
|
if not trimmed.endswith(")"):
|
|
raise ToolError("unmatched parenthesis in '%s'" % expression)
|
|
|
|
return eval_expression(trimmed[1:-1])
|
|
|
|
if trimmed.startswith("!"):
|
|
return not _eval_one(trimmed[1:])
|
|
|
|
# String comparison
|
|
for op in ("eq", "ne"):
|
|
idx = trimmed.find(" %s " % op)
|
|
|
|
if idx != -1:
|
|
left = _quoted(trimmed[:idx].strip(), "left", op, expression)
|
|
right = _quoted(trimmed[idx + len(op) + 2 :].strip(), "right", op, expression)
|
|
|
|
return left == right if op == "eq" else left != right
|
|
|
|
# Numeric comparison
|
|
for op, compare in _COMPARE_LIST:
|
|
idx = trimmed.find(op)
|
|
|
|
if idx != -1:
|
|
return compare(_number(trimmed[:idx], expression), _number(trimmed[idx + len(op) :], expression))
|
|
|
|
raise ToolError("unable to evaluate '%s'" % expression)
|
|
|
|
|
|
####################################################################################################################################
|
|
def eval_expression(expression):
|
|
"""Evaluate an expression, which must have had its variables replaced already."""
|
|
|
|
if "{[" in expression:
|
|
raise ToolError("unreplaced variable in expression '%s'" % expression)
|
|
|
|
# Or binds loosest so it is split first, which leaves and to bind tighter than it. Each side is evaluated only when it is needed,
|
|
# so an expression that is decided by its left side is not held to what is on its right.
|
|
for op in (" || ", " && "):
|
|
idx = _find_op(expression, op)
|
|
|
|
if idx != -1:
|
|
left = expression[:idx].strip()
|
|
right = expression[idx + len(op) :].strip()
|
|
|
|
if op == " || ":
|
|
return eval_expression(left) or eval_expression(right)
|
|
|
|
return eval_expression(left) and eval_expression(right)
|
|
|
|
return _eval_one(expression)
|