From 768091ddd89acb41f6661e9e476adc4e39aae50d Mon Sep 17 00:00:00 2001 From: Patrick Ferber <39368483+PatrickFerber@users.noreply.github.com> Date: Thu, 18 Jan 2024 15:08:29 +0100 Subject: [PATCH] [issue1030] translator: Improve PDDL error reporting. We have substantially extended the PDDL syntax checks in the translator. Many PDDL errors are now diagnosed much better and lead to a meaningful error message and exit code where previously they would trigger failed assertions or be silently accepted with unclear semantics. --- src/translate/pddl/tasks.py | 19 +- src/translate/pddl_parser/__init__.py | 1 + src/translate/pddl_parser/lisp_parser.py | 19 +- src/translate/pddl_parser/parse_error.py | 2 + .../pddl_parser/parsing_functions.py | 977 ++++++++++++------ src/translate/pddl_parser/pddl_file.py | 7 +- src/translate/translate.py | 4 + 7 files changed, 683 insertions(+), 346 deletions(-) create mode 100644 src/translate/pddl_parser/parse_error.py diff --git a/src/translate/pddl/tasks.py b/src/translate/pddl/tasks.py index 6663a95afc..0e28115eee 100644 --- a/src/translate/pddl/tasks.py +++ b/src/translate/pddl/tasks.py @@ -68,15 +68,22 @@ def dump(self): for axiom in self.axioms: axiom.dump() + +REQUIREMENT_LABELS = [ + ":strips", ":adl", ":typing", ":negation", ":equality", + ":negative-preconditions", ":disjunctive-preconditions", + ":existential-preconditions", ":universal-preconditions", + ":quantified-preconditions", ":conditional-effects", + ":derived-predicates", ":action-costs" +] + + class Requirements: def __init__(self, requirements: List[str]): self.requirements = requirements for req in requirements: - assert req in ( - ":strips", ":adl", ":typing", ":negation", ":equality", - ":negative-preconditions", ":disjunctive-preconditions", - ":existential-preconditions", ":universal-preconditions", - ":quantified-preconditions", ":conditional-effects", - ":derived-predicates", ":action-costs"), req + if req not in REQUIREMENT_LABELS: + raise ValueError(f"Invalid requirement. Got: {req}\n" + f"Expected: {', '.join(REQUIREMENT_LABELS)}") def __str__(self): return ", ".join(self.requirements) diff --git a/src/translate/pddl_parser/__init__.py b/src/translate/pddl_parser/__init__.py index 32f5186587..c6290588b9 100644 --- a/src/translate/pddl_parser/__init__.py +++ b/src/translate/pddl_parser/__init__.py @@ -1 +1,2 @@ +from .parse_error import ParseError from .pddl_file import open diff --git a/src/translate/pddl_parser/lisp_parser.py b/src/translate/pddl_parser/lisp_parser.py index 271cb646bf..872b29784d 100644 --- a/src/translate/pddl_parser/lisp_parser.py +++ b/src/translate/pddl_parser/lisp_parser.py @@ -1,20 +1,18 @@ -__all__ = ["ParseError", "parse_nested_list"] +__all__ = ["parse_nested_list"] -class ParseError(Exception): - def __init__(self, value): - self.value = value - def __str__(self): - return self.value +from .parse_error import ParseError # Basic functions for parsing PDDL (Lisp) files. def parse_nested_list(input_file): tokens = tokenize(input_file) next_token = next(tokens) if next_token != "(": - raise ParseError("Expected '(', got %s." % next_token) + raise ParseError(f"Expected '(', got '{next_token}'.") result = list(parse_list_aux(tokens)) - for tok in tokens: # Check that generator is exhausted. - raise ParseError("Unexpected token: %s." % tok) + remaining_tokens = list(tokens) + if remaining_tokens: + raise ParseError(f"Tokens remaining after parsing: " + f"{' '.join(remaining_tokens)}") return result def tokenize(input): @@ -23,8 +21,7 @@ def tokenize(input): try: line.encode("ascii") except UnicodeEncodeError: - raise ParseError("Non-ASCII character outside comment: %s" % - line[0:-1]) + raise ParseError(f"Non-ASCII character outside comment: {line[0:-1]}") line = line.replace("(", " ( ").replace(")", " ) ").replace("?", " ?") for token in line.split(): yield token.lower() diff --git a/src/translate/pddl_parser/parse_error.py b/src/translate/pddl_parser/parse_error.py new file mode 100644 index 0000000000..831cca9f04 --- /dev/null +++ b/src/translate/pddl_parser/parse_error.py @@ -0,0 +1,2 @@ +class ParseError(Exception): + pass diff --git a/src/translate/pddl_parser/parsing_functions.py b/src/translate/pddl_parser/parsing_functions.py index fdc0b9dc80..33cbb00c4f 100644 --- a/src/translate/pddl_parser/parsing_functions.py +++ b/src/translate/pddl_parser/parsing_functions.py @@ -1,31 +1,142 @@ +import contextlib import sys import graph import pddl +from .parse_error import ParseError +TYPED_LIST_SEPARATOR = "-" -def parse_typed_list(alist, only_variables=False, - constructor=pddl.TypedObject, +SYNTAX_LITERAL = "(PREDICATE ARGUMENTS*)" +SYNTAX_LITERAL_NEGATED = "(not (PREDICATE ARGUMENTS*))" +SYNTAX_LITERAL_POSSIBLY_NEGATED = f"{SYNTAX_LITERAL} or {SYNTAX_LITERAL_NEGATED}" + +SYNTAX_PREDICATE = "(PREDICATE_NAME [VARIABLE [- TYPE]?]*)" +SYNTAX_PREDICATES = f"(:predicates {SYNTAX_PREDICATE}*)" +SYNTAX_FUNCTION = "(FUNCTION_NAME [VARIABLE [- TYPE]?]*)" +SYNTAX_ACTION = "(:action NAME [:parameters PARAMETERS]? " \ + "[:precondition PRECONDITION]? :effect EFFECT)" +SYNTAX_AXIOM = "(:derived PREDICATE CONDITION)" +SYNTAX_GOAL = "(:goal GOAL)" + +SYNTAX_CONDITION_AND = "(and CONDITION*)" +SYNTAX_CONDITION_OR = "(or CONDITION*)" +SYNTAX_CONDITION_IMPLY = "(imply CONDITION CONDITION)" +SYNTAX_CONDITION_NOT = "(not CONDITION)" +SYNTAX_CONDITION_FORALL_EXISTS = "({forall, exists} VARIABLES CONDITION)" + +SYNTAX_EFFECT_FORALL = "(forall VARIABLES EFFECT)" +SYNTAX_EFFECT_WHEN = "(when CONDITION EFFECT)" +SYNTAX_EFFECT_INCREASE = "(increase (total-cost) ASSIGNMENT)" + +SYNTAX_EXPRESSION = "POSITIVE_NUMBER or (FUNCTION VARIABLES*)" +SYNTAX_ASSIGNMENT = "({=,increase} EXPRESSION EXPRESSION)" + +SYNTAX_DOMAIN_DOMAIN_NAME = "(domain NAME)" +SYNTAX_TASK_PROBLEM_NAME = "(problem NAME)" +SYNTAX_TASK_DOMAIN_NAME = "(:domain NAME)" +SYNTAX_METRIC = "(:metric minimize (total-cost))" + + +CONDITION_TAG_TO_SYNTAX = { + "and": SYNTAX_CONDITION_AND, + "or": SYNTAX_CONDITION_OR, + "imply": SYNTAX_CONDITION_IMPLY, + "not": SYNTAX_CONDITION_NOT, + "forall": SYNTAX_CONDITION_FORALL_EXISTS, +} + + +class Context: + def __init__(self): + self._traceback = [] + + def __str__(self) -> str: + return "\n\t->".join(self._traceback) + + def error(self, message, item=None, syntax=None): + error_msg = f"{self}\n{message}" + if syntax: + error_msg += f"\nSyntax: {syntax}" + if item: + error_msg += f"\nGot: {item}" + raise ParseError(error_msg) + + def expected_word_error(self, name, *args, **kwargs): + self.error(f"{name} is expected to be a word.", *args, **kwargs) + + def expected_list_error(self, name, *args, **kwargs): + self.error(f"{name} is expected to be a block.", *args, **kwargs) + + def expected_named_block_error(self, alist, expected, *args, **kwargs): + self.error(f"Expected a non-empty block starting with any of the " + f"following words: {', '.join(expected)}", + item=alist, *args, **kwargs) + + @contextlib.contextmanager + def layer(self, message: str): + self._traceback.append(message) + yield + assert self._traceback.pop() == message + + +def check_named_block(alist, names): + return isinstance(alist, list) and alist and alist[0] in names + +def assert_named_block(context, alist, names): + if not check_named_block(alist, names): + context.expected_named_block_error(alist, names) + +def construct_typed_object(context, name, _type): + with context.layer("Parsing typed object"): + if not isinstance(name, str): + context.expected_word_error("Name of typed object", name) + return pddl.TypedObject(name, _type) + + +def construct_type(context, curr_type, base_type): + with context.layer("Parsing PDDL type"): + if not isinstance(curr_type, str): + context.expected_word_error("PDDL type", curr_type) + if not isinstance(base_type, str): + context.expected_word_error("Base type", base_type) + return pddl.Type(curr_type, base_type) + + +def parse_typed_list(context, alist, only_variables=False, + constructor=construct_typed_object, default_type="object"): - result = [] - while alist: - try: - separator_position = alist.index("-") - except ValueError: - items = alist - _type = default_type - alist = [] - else: - items = alist[:separator_position] - _type = alist[separator_position + 1] - alist = alist[separator_position + 2:] - for item in items: - assert not only_variables or item.startswith("?"), \ - "Expected item to be a variable: %s in (%s)" % ( - item, " ".join(items)) - entry = constructor(item, _type) - result.append(entry) - return result + with context.layer("Parsing typed list"): + result = [] + group_number = 1 + while alist: + with context.layer(f"Parsing {group_number}. group of typed list"): + try: + separator_position = alist.index(TYPED_LIST_SEPARATOR) + except ValueError: + items = alist + _type = default_type + alist = [] + else: + if separator_position == len(alist) - 1: + context.error( + f"Type missing after '{TYPED_LIST_SEPARATOR}'.", + alist) + items = alist[:separator_position] + _type = alist[separator_position + 1] + alist = alist[separator_position + 2:] + if not (isinstance(_type, str) or + (_type and _type[0] == "either" and + all(isinstance(_sub_type, str) for _sub_type in _type[1:]))): + context.error("Type value is expected to be a single word " + "or '(either WORD*)") + for item in items: + if only_variables and not item.startswith("?"): + context.error("Expected item to be a variable", item) + entry = constructor(context, item, _type) + result.append(entry) + group_number += 1 + return result def set_supertypes(type_list): @@ -42,49 +153,111 @@ def set_supertypes(type_list): type_name_to_type[desc_name].supertype_names.append(anc_name) -def parse_predicate(alist): - name = alist[0] - arguments = parse_typed_list(alist[1:], only_variables=True) +def parse_requirements(context, alist): + with context.layer("Parsing requirements"): + for item in alist: + if not isinstance(item, str): + context.expected_word_error("Requirement label", item) + try: + return pddl.Requirements(alist) + except ValueError as e: + context.error(f"Error in requirements.\n" + f"Reason: {e}") + + +def parse_predicate(context, alist): + with context.layer("Parsing predicate name"): + if not alist: + context.error("Predicate name missing", syntax=SYNTAX_PREDICATE) + name = alist[0] + if not isinstance(name, str): + context.expected_word_error("Predicate name", name) + with context.layer(f"Parsing arguments of predicate '{name}'"): + arguments = parse_typed_list(context, alist[1:], only_variables=True) return pddl.Predicate(name, arguments) -def parse_function(alist, type_name): - name = alist[0] - arguments = parse_typed_list(alist[1:]) +def parse_predicates(context, alist): + with context.layer("Parsing predicates"): + the_predicates = [] + for no, entry in enumerate(alist): + with context.layer(f"Parsing {no}. predicate"): + if not isinstance(entry, list): + context.error("Invalid predicate definition.", + syntax=SYNTAX_PREDICATE) + the_predicates.append(parse_predicate(context, entry)) + return the_predicates + + +def parse_function(context, alist, type_name): + with context.layer("Parsing function name"): + if not isinstance(alist, list) or len(alist) == 0: + context.error("Invalid definition of function.", + syntax=SYNTAX_FUNCTION) + name = alist[0] + if not isinstance(name, str): + context.expected_word_error("Function name", name) + with context.layer(f"Parsing function '{name}'"): + arguments = parse_typed_list(context, alist[1:]) + if not isinstance(type_name, str): + context.expected_word_error("Function type", type_name) return pddl.Function(name, arguments, type_name) -def parse_condition(alist, type_dict, predicate_dict): - condition = parse_condition_aux(alist, False, type_dict, predicate_dict) - return condition.uniquify_variables({}).simplified() +def parse_condition(context, alist, type_dict, predicate_dict): + with context.layer("Parsing condition"): + condition = parse_condition_aux( + context, alist, False, type_dict, predicate_dict) + return condition.uniquify_variables({}).simplified() -def parse_condition_aux(alist, negated, type_dict, predicate_dict): +def parse_condition_aux(context, alist, negated, type_dict, predicate_dict): """Parse a PDDL condition. The condition is translated into NNF on the fly.""" + if not alist: + context.error("Expected a non-empty block as condition.") tag = alist[0] if tag in ("and", "or", "not", "imply"): args = alist[1:] if tag == "imply": - assert len(args) == 2 + if len(args) != 2: + context.error("'imply' expects exactly two arguments.", + syntax=SYNTAX_CONDITION_IMPLY) if tag == "not": - assert len(args) == 1 - return parse_condition_aux( - args[0], not negated, type_dict, predicate_dict) + if len(args) != 1: + context.error("'not' expects exactly one argument.", + syntax=SYNTAX_CONDITION_NOT) + negated = not negated elif tag in ("forall", "exists"): - parameters = parse_typed_list(alist[1]) - args = alist[2:] - assert len(args) == 1 + if len(alist) != 3: + context.error("'forall' and 'exists' expect exactly two arguments.", + syntax=SYNTAX_CONDITION_FORALL_EXISTS) + if not isinstance(alist[1], list) or not alist[1]: + context.error( + "The first argument (VARIABLES) of 'forall' and 'exists' is " + "expected to be a non-empty block.", + syntax=SYNTAX_CONDITION_FORALL_EXISTS + ) + parameters = parse_typed_list(context, alist[1]) + args = [alist[2]] + elif tag in predicate_dict: + return parse_literal(context, alist, type_dict, predicate_dict, negated=negated) else: - return parse_literal(alist, type_dict, predicate_dict, negated=negated) + context.error("Expected logical operator or predicate name", tag) + + for nb_arg, arg in enumerate(args, start=1): + if not isinstance(arg, list) or not arg: + context.error( + f"'{tag}' expects as {nb_arg}. argument a non-empty block.", + item=arg, syntax=CONDITION_TAG_TO_SYNTAX[tag]) if tag == "imply": parts = [parse_condition_aux( - args[0], not negated, type_dict, predicate_dict), + context, args[0], not negated, type_dict, predicate_dict), parse_condition_aux( - args[1], negated, type_dict, predicate_dict)] + context, args[1], negated, type_dict, predicate_dict)] tag = "or" else: - parts = [parse_condition_aux(part, negated, type_dict, predicate_dict) + parts = [parse_condition_aux(context, part, negated, type_dict, predicate_dict) for part in args] if tag == "and" and not negated or tag == "or" and negated: @@ -95,36 +268,52 @@ def parse_condition_aux(alist, negated, type_dict, predicate_dict): return pddl.UniversalCondition(parameters, parts) elif tag == "exists" and not negated or tag == "forall" and negated: return pddl.ExistentialCondition(parameters, parts) - - -def parse_literal(alist, type_dict, predicate_dict, negated=False): - if alist[0] == "not": - assert len(alist) == 2 - alist = alist[1] - negated = not negated - - pred_id, arity = _get_predicate_id_and_arity( - alist[0], type_dict, predicate_dict) - - if arity != len(alist) - 1: - raise SystemExit("predicate used with wrong arity: (%s)" - % " ".join(alist)) - - if negated: - return pddl.NegatedAtom(pred_id, alist[1:]) - else: - return pddl.Atom(pred_id, alist[1:]) + elif tag == "not": + return parts[0] + + +def parse_literal(context, alist, type_dict, predicate_dict, negated=False): + with context.layer("Parsing literal"): + if not alist: + context.error("Literal definition has to be a non-empty block.", + alist, syntax=SYNTAX_LITERAL_POSSIBLY_NEGATED) + if alist[0] == "not": + if len(alist) != 2: + context.error( + "Negated literal definition has to have exactly one block as argument.", + alist, syntax=SYNTAX_LITERAL_NEGATED) + alist = alist[1] + if not isinstance(alist, list) or not alist: + context.error( + "Definition of negated literal has to be a non-empty block.", + alist, syntax=SYNTAX_LITERAL) + negated = not negated + + predicate_name = alist[0] + if not isinstance(predicate_name, str): + context.expected_word_error("Predicate name", predicate_name) + pred_id, arity = _get_predicate_id_and_arity( + context, predicate_name, type_dict, predicate_dict) + + if arity != len(alist) - 1: + context.error(f"Predicate '{predicate_name}' of arity {arity} used" + f" with {len(alist) -1} arguments.", alist) + + if negated: + return pddl.NegatedAtom(pred_id, alist[1:]) + else: + return pddl.Atom(pred_id, alist[1:]) SEEN_WARNING_TYPE_PREDICATE_NAME_CLASH = False -def _get_predicate_id_and_arity(text, type_dict, predicate_dict): +def _get_predicate_id_and_arity(context, text, type_dict, predicate_dict): global SEEN_WARNING_TYPE_PREDICATE_NAME_CLASH the_type = type_dict.get(text) the_predicate = predicate_dict.get(text) if the_type is None and the_predicate is None: - raise SystemExit("Undeclared predicate: %s" % text) + context.error("Undeclared predicate", text) elif the_predicate is not None: if the_type is not None and not SEEN_WARNING_TYPE_PREDICATE_NAME_CLASH: msg = ("Warning: name clash between type and predicate %r.\n" @@ -137,16 +326,18 @@ def _get_predicate_id_and_arity(text, type_dict, predicate_dict): return the_type.get_predicate_name(), 1 -def parse_effects(alist, result, type_dict, predicate_dict): +def parse_effects(context, alist, result, type_dict, predicate_dict): """Parse a PDDL effect (any combination of simple, conjunctive, conditional, and universal).""" - tmp_effect = parse_effect(alist, type_dict, predicate_dict) - normalized = tmp_effect.normalize() - cost_eff, rest_effect = normalized.extract_cost() - add_effect(rest_effect, result) - if cost_eff: - return cost_eff.effect - else: - return None + with context.layer("Parsing effect"): + tmp_effect = parse_effect(context, alist, type_dict, predicate_dict) + normalized = tmp_effect.normalize() + cost_eff, rest_effect = normalized.extract_cost() + add_effect(rest_effect, result) + if cost_eff: + return cost_eff.effect + else: + return None + def add_effect(tmp_effect, result): """tmp_effect has the following structure: @@ -188,93 +379,153 @@ def add_effect(tmp_effect, result): result.remove(contradiction) result.append(new_effect) -def parse_effect(alist, type_dict, predicate_dict): + +def parse_effect(context, alist, type_dict, predicate_dict): + if not alist: + context.error("All (sub-)effects have to be a non-empty blocks.", alist) tag = alist[0] if tag == "and": - return pddl.ConjunctiveEffect( - [parse_effect(eff, type_dict, predicate_dict) for eff in alist[1:]]) + effects = [] + for eff in alist[1:]: + if not isinstance(eff, list): + context.error("All sub-effects of a conjunction have to be blocks.", + eff) + effects.append(parse_effect(context, eff, type_dict, predicate_dict)) + return pddl.ConjunctiveEffect(effects) elif tag == "forall": - assert len(alist) == 3 - parameters = parse_typed_list(alist[1]) - effect = parse_effect(alist[2], type_dict, predicate_dict) + if len(alist) != 3: + context.error("'forall' effect expects exactly two arguments.", + syntax=SYNTAX_EFFECT_FORALL) + if not isinstance(alist[1], list): + context.expected_list_error( + "First argument (VARIABLES) of 'forall'", + alist[1], syntax=SYNTAX_EFFECT_FORALL) + parameters = parse_typed_list(context, alist[1]) + if not isinstance(alist[2], list): + context.expected_list_error( + "Second argument (EFFECT) of 'forall'", + alist[2], syntax=SYNTAX_EFFECT_FORALL) + effect = parse_effect(context, alist[2], type_dict, predicate_dict) return pddl.UniversalEffect(parameters, effect) elif tag == "when": - assert len(alist) == 3 - condition = parse_condition( - alist[1], type_dict, predicate_dict) - effect = parse_effect(alist[2], type_dict, predicate_dict) + if len(alist) != 3: + context.error("'when' effect expects exactly two arguments.", + syntax=SYNTAX_EFFECT_WHEN) + if not isinstance(alist[1], list): + context.error( + "First argument (CONDITION) of 'when' is expected to be a block", + alist[1], syntax=SYNTAX_EFFECT_WHEN) + condition = parse_condition(context, alist[1], type_dict, predicate_dict) + if not isinstance(alist[2], list): + context.expected_list_error( + "Second argument (EFFECT) of 'when'", + alist[2], syntax=SYNTAX_EFFECT_WHEN) + effect = parse_effect(context, alist[2], type_dict, predicate_dict) return pddl.ConditionalEffect(condition, effect) elif tag == "increase": - assert len(alist) == 3 - assert alist[1] == ['total-cost'] - assignment = parse_assignment(alist) + if len(alist) != 3 or alist[1] != ["total-cost"]: + context.error("'increase' expects two arguments", + alist, syntax=SYNTAX_EFFECT_INCREASE) + assignment = parse_assignment(context, alist) return pddl.CostEffect(assignment) else: # We pass in {} instead of type_dict here because types must # be static predicates, so cannot be the target of an effect. - return pddl.SimpleEffect(parse_literal(alist, {}, predicate_dict)) - - -def parse_expression(exp): - if isinstance(exp, list): - functionsymbol = exp[0] - return pddl.PrimitiveNumericExpression(functionsymbol, exp[1:]) - elif exp.replace(".", "").isdigit(): - return pddl.NumericConstant(float(exp)) - elif exp[0] == "-": - raise ValueError("Negative numbers are not supported") - else: - return pddl.PrimitiveNumericExpression(exp, []) - -def parse_assignment(alist): - assert len(alist) == 3 - op = alist[0] - head = parse_expression(alist[1]) - exp = parse_expression(alist[2]) - if op == "=": - return pddl.Assign(head, exp) - elif op == "increase": - return pddl.Increase(head, exp) - else: - assert False, "Assignment operator not supported." - - -def parse_action(alist, type_dict, predicate_dict): - iterator = iter(alist) - action_tag = next(iterator) - assert action_tag == ":action" - name = next(iterator) - parameters_tag_opt = next(iterator) - if parameters_tag_opt == ":parameters": - parameters = parse_typed_list(next(iterator), - only_variables=True) - precondition_tag_opt = next(iterator) - else: - parameters = [] - precondition_tag_opt = parameters_tag_opt - if precondition_tag_opt == ":precondition": - precondition_list = next(iterator) - if not precondition_list: - # Note that :precondition () is allowed in PDDL. - precondition = pddl.Conjunction([]) + return pddl.SimpleEffect(parse_literal(context, alist, {}, predicate_dict)) + + +def parse_expression(context, exp): + with context.layer("Parsing expression"): + if isinstance(exp, list): + if len(exp) < 1: + context.error("Expression cannot be an empty block.", + syntax=SYNTAX_EXPRESSION) + functionsymbol = exp[0] + return pddl.PrimitiveNumericExpression(functionsymbol, exp[1:]) + elif exp.replace(".", "").isdigit() and exp.count(".") <= 1: + return pddl.NumericConstant(float(exp)) + elif exp[0] == "-": + context.error("Expression cannot be a negative number", + syntax=SYNTAX_EXPRESSION) else: - precondition = parse_condition( - precondition_list, type_dict, predicate_dict) - effect_tag = next(iterator) - else: - precondition = pddl.Conjunction([]) - effect_tag = precondition_tag_opt - assert effect_tag == ":effect" - effect_list = next(iterator) - eff = [] - if effect_list: + return pddl.PrimitiveNumericExpression(exp, []) + + +def parse_assignment(context, alist): + with context.layer("Parsing Assignment"): + if len(alist) != 3: + context.error("Assignment expects two arguments", + syntax=SYNTAX_ASSIGNMENT) + op = alist[0] + head = parse_expression(context, alist[1]) + exp = parse_expression(context, alist[2]) + if op == "=": + return pddl.Assign(head, exp) + elif op == "increase": + return pddl.Increase(head, exp) + else: + context.error(f"Unsupported assignment operator '{op}'." + f" Use '=' or 'increase'.") + + +def parse_action(context, alist, type_dict, predicate_dict): + with context.layer("Parsing action name"): + if len(alist) < 4: + context.error("Expecting block with at least 3 arguments for an action.", + syntax=SYNTAX_ACTION) + iterator = iter(alist) + action_tag = next(iterator) + assert action_tag == ":action" + name = next(iterator) + if not isinstance(name, str): + context.expected_word_error("Action name", name, syntax=SYNTAX_ACTION) + with context.layer(f"Parsing action '{name}'"): try: - cost = parse_effects( - effect_list, eff, type_dict, predicate_dict) - except ValueError as e: - raise SystemExit("Error in Action %s\nReason: %s." % (name, e)) - for rest in iterator: - assert False, rest + with context.layer("Parsing parameters"): + parameters_tag_opt = next(iterator) + if parameters_tag_opt == ":parameters": + parameters_list = next(iterator) + if not isinstance(parameters_list, list): + context.expected_list_error( + "Parameters", parameters_list, syntax=SYNTAX_ACTION) + parameters = parse_typed_list( + context, parameters_list, only_variables=True) + precondition_tag_opt = next(iterator) + else: + parameters = [] + precondition_tag_opt = parameters_tag_opt + with context.layer("Parsing precondition"): + if precondition_tag_opt == ":precondition": + precondition_list = next(iterator) + if not isinstance(precondition_list, list): + context.expected_list_error( + "Precondition", precondition_list, syntax=SYNTAX_ACTION) + if not precondition_list: + # Note that :precondition () is allowed in PDDL. + precondition = pddl.Conjunction([]) + else: + precondition = parse_condition( + context, precondition_list, type_dict, predicate_dict) + effect_tag = next(iterator) + else: + precondition = pddl.Conjunction([]) + effect_tag = precondition_tag_opt + with context.layer("Parsing effect"): + if effect_tag != ":effect": + context.error( + "Effect tag is expected to be ':effect'", effect_tag, + syntax=SYNTAX_ACTION) + effect_list = next(iterator) + if not isinstance(effect_list, list): + context.expected_list_error("Effect", effect_list, syntax=SYNTAX_ACTION) + eff = [] + if effect_list: + cost = parse_effects( + context, effect_list, eff, type_dict, predicate_dict) + except StopIteration: + context.error(f"Missing fields. Expecting {SYNTAX_ACTION}.") + for _ in iterator: + context.error(f"Too many fields. Expecting {SYNTAX_ACTION}") if eff: return pddl.Action(name, parameters, len(parameters), precondition, eff, cost) @@ -282,27 +533,117 @@ def parse_action(alist, type_dict, predicate_dict): return None -def parse_axiom(alist, type_dict, predicate_dict): - assert len(alist) == 3 - assert alist[0] == ":derived" - predicate = parse_predicate(alist[1]) - condition = parse_condition( - alist[2], type_dict, predicate_dict) - return pddl.Axiom(predicate.name, predicate.arguments, - len(predicate.arguments), condition) +def parse_axiom(context, alist, type_dict, predicate_dict): + with context.layer("Parsing derived predicate"): + if len(alist) != 3: + context.error("Expecting block with exactly three elements", + syntax=SYNTAX_AXIOM) + assert alist[0] == ":derived" + if not isinstance(alist[1], list): + context.expected_list_error("The first argument (PREDICATE)", + syntax=SYNTAX_AXIOM) + predicate = parse_predicate(context, alist[1]) + with context.layer(f"Parsing condition for derived predicate '{predicate}'"): + if not isinstance(alist[2], list): + context.error("The second argument (CONDITION) is expected to be a block.", + syntax=SYNTAX_AXIOM) + condition = parse_condition( + context, alist[2], type_dict, predicate_dict) + return pddl.Axiom(predicate.name, predicate.arguments, + len(predicate.arguments), condition) -def parse_task(domain_pddl, task_pddl): - domain_name, domain_requirements, types, type_dict, constants, predicates, predicate_dict, functions, actions, axioms \ - = parse_domain_pddl(domain_pddl) - task_name, task_domain_name, task_requirements, objects, init, goal, use_metric = parse_task_pddl(task_pddl, type_dict, predicate_dict) +def parse_axioms_and_actions(context, entries, type_dict, predicate_dict): + the_axioms = [] + the_actions = [] + for no, entry in enumerate(entries, start=1): + with context.layer(f"Parsing {no}. axiom/action entry"): + assert_named_block(context, entry, [":derived", ":action"]) + if entry[0] == ":derived": + with context.layer(f"Parsing {len(the_axioms) + 1}. axiom"): + the_axioms.append(parse_axiom( + context, entry, type_dict, predicate_dict)) + else: + assert entry[0] == ":action" + with context.layer(f"Parsing {len(the_actions) + 1}. action"): + action = parse_action(context, entry, type_dict, predicate_dict) + if action is not None: + the_actions.append(action) + return the_axioms, the_actions + +def parse_init(context, alist): + initial = [] + initial_true = set() + initial_false = set() + initial_assignments = dict() + for no, fact in enumerate(alist[1:], start=1): + with context.layer(f"Parsing {no}. element in init block"): + if not isinstance(fact, list) or not fact: + context.error( + "Invalid fact.", + syntax=f"{SYNTAX_LITERAL_POSSIBLY_NEGATED} or {SYNTAX_ASSIGNMENT}") + if fact[0] == "=": + try: + assignment = parse_assignment(context, fact) + except ValueError as e: + context.error(f"Error in initial state specification\n" + f"Reason: {e}.") + if not isinstance(assignment.expression, + pddl.NumericConstant): + context.error("Illegal assignment in initial state specification.", + assignment) + if assignment.fluent in initial_assignments: + prev = initial_assignments[assignment.fluent] + if assignment.expression == prev.expression: + print(f"Warning: {assignment} is specified twice " + f"in initial state specification") + else: + context.error("Error in initial state specification\n" + "Reason: conflicting assignment for " + f"{assignment.fluent}.") + else: + initial_assignments[assignment.fluent] = assignment + initial.append(assignment) + elif fact[0] == "not": + if len(fact) != 2: + context.error(f"Expecting {SYNTAX_LITERAL_NEGATED} for negated atoms.") + fact = fact[1] + if not isinstance(fact, list) or not fact: + context.error("Invalid negated fact.", syntax=SYNTAX_LITERAL_NEGATED) + atom = pddl.Atom(fact[0], fact[1:]) + check_atom_consistency(context, atom, initial_false, initial_true, False) + initial_false.add(atom) + else: + if len(fact) < 1: + context.error(f"Expecting {SYNTAX_LITERAL} for atoms.") + atom = pddl.Atom(fact[0], fact[1:]) + check_atom_consistency(context, atom, initial_true, initial_false) + initial_true.add(atom) + initial.extend(initial_true) + return initial - assert domain_name == task_domain_name + +def parse_task(domain_pddl, task_pddl): + context = Context() + if not isinstance(domain_pddl, list): + context.error("Invalid definition of a PDDL domain.") + domain_name, domain_requirements, types, type_dict, constants, predicates, \ + predicate_dict, functions, actions, axioms = parse_domain_pddl(context, domain_pddl) + if not isinstance(task_pddl, list): + context.error("Invalid definition of a PDDL task.") + task_name, task_domain_name, task_requirements, objects, init, goal, \ + use_metric = parse_task_pddl(context, task_pddl, type_dict, predicate_dict) + + if domain_name != task_domain_name: + context.error(f"The domain name specified by the task " + f"({task_domain_name}) does not match the name specified " + f"by the domain file ({domain_name}).") requirements = pddl.Requirements(sorted(set( domain_requirements.requirements + task_requirements.requirements))) objects = constants + objects check_for_duplicates( + context, [o.name for o in objects], errmsg="error: duplicate object %r", finalmsg="please check :constants and :objects definitions") @@ -313,180 +654,164 @@ def parse_task(domain_pddl, task_pddl): predicates, functions, init, goal, actions, axioms, use_metric) -def parse_domain_pddl(domain_pddl): +def parse_domain_pddl(context, domain_pddl): iterator = iter(domain_pddl) - - define_tag = next(iterator) - assert define_tag == "define" - domain_line = next(iterator) - assert domain_line[0] == "domain" and len(domain_line) == 2 - yield domain_line[1] - - ## We allow an arbitrary order of the requirement, types, constants, - ## predicates and functions specification. The PDDL BNF is more strict on - ## this, so we print a warning if it is violated. - requirements = pddl.Requirements([":strips"]) - the_types = [pddl.Type("object")] - constants, the_predicates, the_functions = [], [], [] - correct_order = [":requirements", ":types", ":constants", ":predicates", - ":functions"] - seen_fields = [] - first_action = None - for opt in iterator: - field = opt[0] - if field not in correct_order: - first_action = opt - break - if field in seen_fields: - raise SystemExit("Error in domain specification\n" + - "Reason: two '%s' specifications." % field) - if (seen_fields and - correct_order.index(seen_fields[-1]) > correct_order.index(field)): - msg = "\nWarning: %s specification not allowed here (cf. PDDL BNF)" % field - print(msg, file=sys.stderr) - seen_fields.append(field) - if field == ":requirements": - requirements = pddl.Requirements(opt[1:]) - elif field == ":types": - the_types.extend(parse_typed_list( - opt[1:], constructor=pddl.Type)) - elif field == ":constants": - constants = parse_typed_list(opt[1:]) - elif field == ":predicates": - the_predicates = [parse_predicate(entry) - for entry in opt[1:]] - the_predicates += [pddl.Predicate("=", [ - pddl.TypedObject("?x", "object"), - pddl.TypedObject("?y", "object")])] - elif field == ":functions": - the_functions = parse_typed_list( - opt[1:], - constructor=parse_function, - default_type="number") - set_supertypes(the_types) - yield requirements - yield the_types - type_dict = {type.name: type for type in the_types} - yield type_dict - yield constants - yield the_predicates - predicate_dict = {pred.name: pred for pred in the_predicates} - yield predicate_dict - yield the_functions - - entries = [] - if first_action is not None: - entries.append(first_action) - entries.extend(iterator) - - the_axioms = [] - the_actions = [] - for entry in entries: - if entry[0] == ":derived": - axiom = parse_axiom(entry, type_dict, predicate_dict) - the_axioms.append(axiom) - else: - action = parse_action(entry, type_dict, predicate_dict) - if action is not None: - the_actions.append(action) - yield the_actions - yield the_axioms - -def parse_task_pddl(task_pddl, type_dict, predicate_dict): + with context.layer("Parsing domain"): + define_tag = next(iterator) + if define_tag != "define": + context.error(f"Domain definition expected to start with '(define '. Got '({define_tag}'") + + with context.layer("Parsing domain name"): + domain_line = next(iterator) + if (not check_named_block(domain_line, ["domain"]) or + len(domain_line) != 2 or not isinstance(domain_line[1], str)): + context.error("Invalid definition of domain name.", + syntax=SYNTAX_DOMAIN_DOMAIN_NAME) + yield domain_line[1] + + ## We allow an arbitrary order of the requirement, types, constants, + ## predicates and functions specification. The PDDL BNF is more strict on + ## this, so we print a warning if it is violated. + requirements = pddl.Requirements([":strips"]) + the_types = [pddl.Type("object")] + constants, the_predicates, the_functions = [], [], [] + correct_order = [":requirements", ":types", ":constants", ":predicates", + ":functions"] + action_or_axiom_block = [":derived", ":action"] + seen_fields = [] + first_action = None + for opt in iterator: + assert_named_block(context, opt, correct_order + action_or_axiom_block) + field = opt[0] + if field not in correct_order: + first_action = opt + break + if field in seen_fields: + context.error(f"Error in domain specification\n" + f"Reason: two '{field}' specifications.") + if (seen_fields and + correct_order.index(seen_fields[-1]) > correct_order.index(field)): + msg = f"\nWarning: {field} specification not allowed here (cf. PDDL BNF)" + print(msg, file=sys.stderr) + seen_fields.append(field) + if field == ":requirements": + requirements = parse_requirements(context, opt[1:]) + elif field == ":types": + with context.layer("Parsing types"): + the_types.extend(parse_typed_list( + context, opt[1:], constructor=construct_type)) + elif field == ":constants": + with context.layer("Parsing constants"): + constants = parse_typed_list(context, opt[1:]) + elif field == ":predicates": + the_predicates = parse_predicates(context, opt[1:]) + the_predicates += [pddl.Predicate("=", [ + pddl.TypedObject("?x", "object"), + pddl.TypedObject("?y", "object")])] + elif field == ":functions": + with context.layer("Parsing functions"): + the_functions = parse_typed_list( + context, opt[1:], + constructor=parse_function, + default_type="number") + set_supertypes(the_types) + yield requirements + yield the_types + type_dict = {type.name: type for type in the_types} + yield type_dict + yield constants + yield the_predicates + predicate_dict = {pred.name: pred for pred in the_predicates} + yield predicate_dict + yield the_functions + + entries = [] + if first_action is not None: + entries.append(first_action) + entries.extend(iterator) + + the_axioms, the_actions = parse_axioms_and_actions( + context, entries, type_dict, predicate_dict) + + yield the_actions + yield the_axioms + +def parse_task_pddl(context, task_pddl, type_dict, predicate_dict): iterator = iter(task_pddl) - - define_tag = next(iterator) - assert define_tag == "define" - problem_line = next(iterator) - assert problem_line[0] == "problem" and len(problem_line) == 2 - yield problem_line[1] - domain_line = next(iterator) - assert domain_line[0] == ":domain" and len(domain_line) == 2 - yield domain_line[1] - - requirements_opt = next(iterator) - if requirements_opt[0] == ":requirements": - requirements = requirements_opt[1:] - objects_opt = next(iterator) - else: - requirements = [] - objects_opt = requirements_opt - yield pddl.Requirements(requirements) - - if objects_opt[0] == ":objects": - yield parse_typed_list(objects_opt[1:]) - init = next(iterator) - else: - yield [] - init = objects_opt - - assert init[0] == ":init" - initial = [] - initial_true = set() - initial_false = set() - initial_assignments = dict() - for fact in init[1:]: - if fact[0] == "=": - try: - assignment = parse_assignment(fact) - except ValueError as e: - raise SystemExit("Error in initial state specification\n" + - "Reason: %s." % e) - if not isinstance(assignment.expression, - pddl.NumericConstant): - raise SystemExit("Illegal assignment in initial state " + - "specification:\n%s" % assignment) - if assignment.fluent in initial_assignments: - prev = initial_assignments[assignment.fluent] - if assignment.expression == prev.expression: - print("Warning: %s is specified twice" % assignment, - "in initial state specification") - else: - raise SystemExit("Error in initial state specification\n" + - "Reason: conflicting assignment for " + - "%s." % assignment.fluent) - else: - initial_assignments[assignment.fluent] = assignment - initial.append(assignment) - elif fact[0] == "not": - atom = pddl.Atom(fact[1][0], fact[1][1:]) - check_atom_consistency(atom, initial_false, initial_true, False) - initial_false.add(atom) + with context.layer("Parsing task"): + define_tag = next(iterator) + if define_tag != "define": + context.error("Task definition expected to start with '(define ") + + with context.layer("Parsing problem name"): + problem_line = next(iterator) + if (not check_named_block(problem_line, ["problem"]) or + len(problem_line) != 2 or not isinstance(problem_line[1], str)): + context.error("Invalid problem name definition", problem_line, + syntax=SYNTAX_TASK_PROBLEM_NAME) + yield problem_line[1] + + with context.layer("Parsing domain name"): + domain_line = next(iterator) + if (not check_named_block(domain_line, [":domain"]) or + len(domain_line) != 2 or not isinstance(domain_line[1], str)): + context.error("Invalid domain name definition", domain_line, + syntax=SYNTAX_TASK_DOMAIN_NAME) + yield domain_line[1] + + requirements_opt = next(iterator) + assert_named_block(context, requirements_opt, [":requirements", ":objects", ":init"]) + if requirements_opt[0] == ":requirements": + requirements = requirements_opt[1:] + objects_opt = next(iterator) else: - atom = pddl.Atom(fact[0], fact[1:]) - check_atom_consistency(atom, initial_true, initial_false) - initial_true.add(atom) - initial.extend(initial_true) - yield initial - - goal = next(iterator) - assert goal[0] == ":goal" and len(goal) == 2 - yield parse_condition(goal[1], type_dict, predicate_dict) - - use_metric = False - for entry in iterator: - if entry[0] == ":metric": - if entry[1] == "minimize" and entry[2][0] == "total-cost": - use_metric = True - else: - assert False, "Unknown metric." - yield use_metric - - for entry in iterator: - assert False, entry - - -def check_atom_consistency(atom, same_truth_value, other_truth_value, atom_is_true=True): + requirements = [] + objects_opt = requirements_opt + yield parse_requirements(context, requirements) + + assert_named_block(context, objects_opt, [":objects", ":init"]) + if objects_opt[0] == ":objects": + with context.layer("Parsing objects"): + yield parse_typed_list(context, objects_opt[1:]) + init = next(iterator) + else: + yield [] + init = objects_opt + + assert_named_block(context, init, [":init"]) + yield parse_init(context, init) + + goal = next(iterator) + with context.layer("Parsing goal"): + if (not check_named_block(goal, [":goal"]) or + len(goal) != 2 or not isinstance(goal[1], list) or + not goal[1]): + context.error("Expected non-empty goal.", syntax=SYNTAX_GOAL) + yield parse_condition(context, goal[1], type_dict, predicate_dict) + + use_metric = False + for entry in iterator: + if isinstance(entry, list) and entry[0] == ":metric": + with context.layer("Parsing metric"): + if len(entry) != 3 or not isinstance(entry[2], list) or len(entry[2]) != 1 or entry[1] != "minimize" or entry[2][0] != "total-cost": + context.error("Invalid metric definition.", entry, syntax=SYNTAX_METRIC) + use_metric = True + yield use_metric + + for _ in iterator: + assert False, "This line should be unreachable" + + +def check_atom_consistency(context, atom, same_truth_value, other_truth_value, atom_is_true=True): if atom in other_truth_value: - raise SystemExit("Error in initial state specification\n" + - "Reason: %s is true and false." % atom) + context.error(f"Error in initial state specification\n" + f"Reason: {atom} is true and false.") if atom in same_truth_value: if not atom_is_true: atom = atom.negate() - print("Warning: %s is specified twice in initial state specification" % atom) - + print(f"Warning: {atom} is specified twice in initial state specification") -def check_for_duplicates(elements, errmsg, finalmsg): +def check_for_duplicates(context, elements, errmsg, finalmsg): seen = set() errors = [] for element in elements: @@ -495,4 +820,4 @@ def check_for_duplicates(elements, errmsg, finalmsg): else: seen.add(element) if errors: - raise SystemExit("\n".join(errors) + "\n" + finalmsg) + context.error("\n".join(errors) + "\n" + finalmsg) diff --git a/src/translate/pddl_parser/pddl_file.py b/src/translate/pddl_parser/pddl_file.py index 58850e4023..9e8fc01f35 100644 --- a/src/translate/pddl_parser/pddl_file.py +++ b/src/translate/pddl_parser/pddl_file.py @@ -1,4 +1,5 @@ from . import lisp_parser +from . import parse_error from . import parsing_functions file_open = open @@ -14,10 +15,10 @@ def parse_pddl_file(type, filename): return lisp_parser.parse_nested_list(file_open(filename, encoding='ISO-8859-1')) except OSError as e: - raise SystemExit("Error: Could not read file: %s\nReason: %s." % + raise SystemExit("Error: Could not read file: %s\nReason: %s" % (e.filename, e)) - except lisp_parser.ParseError as e: - raise SystemExit("Error: Could not parse %s file: %s\nReason: %s." % + except parse_error.ParseError as e: + raise parse_error.ParseError("Error: Could not parse %s file: %s\nReason: %s" % (type, filename, e)) diff --git a/src/translate/translate.py b/src/translate/translate.py index f4c0e47d42..d2652f0fe6 100755 --- a/src/translate/translate.py +++ b/src/translate/translate.py @@ -50,6 +50,7 @@ def python_version_supported(): ## we only list codes that are used by the translator component of the planner. TRANSLATE_OUT_OF_MEMORY = 20 TRANSLATE_OUT_OF_TIME = 21 +TRANSLATE_INPUT_ERROR = 31 simplified_effect_condition_counter = 0 added_implied_precondition_counter = 0 @@ -753,3 +754,6 @@ def handle_sigxcpu(signum, stackframe): traceback.print_exc(file=sys.stdout) print("=" * 79) sys.exit(TRANSLATE_OUT_OF_MEMORY) + except pddl_parser.ParseError as e: + print(e) + sys.exit(TRANSLATE_INPUT_ERROR)