Update verbalizers

esgen/verbalizer.py

@@ -1,15 +1,72 @@
-def comment_verbaliser(prop_label, freq):
-    comment = f" # {prop_label}, {freq * 100:.2f}%"
+def init_comment_verbaliser(prop_label, freq):
+    comment = f"{prop_label}, {freq * 100:.2f}%"
     return comment
 
 
 def chatbot_verbaliser(prop_label, freq, examples):
     message = f"{freq * 100:.2f}% instances within the class use the property '{prop_label}'. Here are examples:\n"
     # verbalise examples
-    example_lines = [f"{example['subjectLabel']} ({example['subject']}), " \
-                     f"{example['propertyLabel']} ({example['property']}), " \
-                     f"{example['objectLabel']} ({example['object']})" for example in examples]
+    # TODO: remove IDs and change strings to links
+    # example_lines = [f"{example['subjectLabel']} [https://www.wikidata.org/wiki/{example['subject']}], "
+    #                  f"{example['propertyLabel']} [https://www.wikidata.org/wiki/Property:{example['property']}], "
+    #                  f"{example['objectLabel']} [https://www.wikidata.org/wiki/{example['object']}]"
+    #                  for example in examples]
+    example_lines = [f"{example['subjectLabel']} ({example['subject']}), "
+                     f"{example['propertyLabel']} ({example['property']}), "
+                     f"{example['objectLabel']} ({example['object']})"
+                     for example in examples]
     examples_verbalised = '\n'.join([f"- {line}" for line in example_lines])
     message += examples_verbalised
-    message += "\nDo you think the property is properly used for all instances within the class?"
+    # TODO: remove indent
+    message += "\n\nDo you think the property is properly used for all instances within the class?"
     return message
+
+
+def prefix_verbaliser(abbr, url):
+    """
+
+    :param abbr:
+    :param url:
+    :return:
+    """
+    return f"PREFIX {abbr}: <{url}>\n"
+
+
+def triple_constraint_verbaliser(constraint):
+    """ single line constraint verbaliser
+
+    :param constraint:
+    :return:
+    """
+    if constraint.constraint_type == "value_shape":
+        output = f"\t {constraint.prop} @<{constraint.value}> {constraint.cardinality} ;"
+    elif isinstance(constraint.value, list):  # value sets
+        output = f"\t {constraint.prop} [ {' '.join(constraint.value)} ] {constraint.cardinality} ;"
+    else:
+        output = f"\t {constraint.prop} {constraint.value} {constraint.cardinality} ;"
+    if constraint.comment:
+        output += f"  # {constraint.comment} \n"
+    else:
+        output += "\n"
+    return output
+
+
+def value_shape_verbaliser(name: str, constraints: list, extra: bool):
+    """
+    assumptions:
+      the first property in constraints is wdt:P31 or wdt:P279
+
+    :param name:
+    :param constraints:
+    :param extra:
+    :return:
+    """
+    output = "".join(triple_constraint_verbaliser(constraint) for constraint in constraints)
+    # if extra:
+    #     nested_constraints = f"<{name}> EXTRA {{\n{output}}}\n"
+    # else:
+    #     nested_constraints = f"<{name}> {{\n{output}}}\n"
+    # print(constraints)
+    # nested_constraints = f"<{name}> EXTRA {constraints[0].prop} {{\n{output}}}\n"
+    nested_constraints = f"<{name}> {{\n{output}}}\n"
+    return nested_constraints