add R4=I40 to all relations

Author: JuliusFiedler

.gitignore

@@ -12,3 +12,4 @@ dist
 build
 .aider*
 .env*
+/graph_site/*

src/pyirk/builtin_entities.py

@@ -304,20 +304,43 @@ def instance_of(
     R2,
     "specifies that for each subject there is at most one 'R30-Statement' for a given language tag (e.g. en)",
 )
+R18 = create_builtin_relation(
+    "R18", R1="has usage hint", R2="specifies a hint (str) on how this relation should be used"
+)
 
 R22 = create_builtin_relation(
     key_str="R22",
     R1="is functional",
     R2="specifies that the subject entity is a relation which has at most one value per item",
 )
 
+I40 = create_builtin_item(
+    key_str="I40",
+    R1__has_label="general relation",
+    R2__has_description="proxy item for a relation",
+    R18__has_usage_hint=(
+        "This item (which is in no direct relation to I1__general_item) can be used as a placeholder for any relation. "
+        "In other words: this can be interpreted as the common superclass for all relations"
+    ),
+)
+
 R22["is functional"].set_relation(R22["is functional"], True)
 R32["is functional for each language"].set_relation(R22["is functional"], True)
 
 # Note that R1, R22, and R32 are used extensively to control the behavior in pyirk.core
 
 R3 = create_builtin_relation("R3", R1="is subclass of", R22__is_functional=True)
 R4 = create_builtin_relation("R4", R1="is instance of", R22__is_functional=True)
+
+# update type of relations before automatic was possible (in create_relation())
+R32.set_relation(R4["is instance of"], I40["general relation"])
+R1.set_relation(R4["is instance of"], I40["general relation"])
+R2.set_relation(R4["is instance of"], I40["general relation"])
+R18.set_relation(R4["is instance of"], I40["general relation"])
+R22.set_relation(R4["is instance of"], I40["general relation"])
+R3.set_relation(R4["is instance of"], I40["general relation"])
+R4.set_relation(R4["is instance of"], I40["general relation"])
+
 R5 = create_builtin_relation("R5", R1="is part of")
 R6 = create_builtin_relation("R6", R1="has defining mathematical relation", R22__is_functional=True)
 R7 = create_builtin_relation("R7", R1="has arity", R22__is_functional=True)
@@ -351,9 +374,7 @@ def instance_of(
 R17 = create_builtin_relation(
     key_str="R17", R1="is subproperty of", R2="specifies that arg1 (subj) is a subproperty of arg2 (obj)"
 )
-R18 = create_builtin_relation(
-    "R18", R1="has usage hint", R2="specifies a hint (str) on how this relation should be used"
-)
+
 
 R16.set_relation(
     R18["has usage hint"], "this relation should be used on concrete instances, not on generic types"
@@ -370,15 +391,6 @@ def instance_of(
 )
 
 
-I40 = create_builtin_item(
-    key_str="I40",
-    R1__has_label="general relation",
-    R2__has_description="proxy item for a relation",
-    R18__has_usage_hint=(
-        "This item (which is in no direct relation to I1__general_item) can be used as a placeholder for any relation. "
-        "In other words: this can be interpreted as the common superclass for all relations"
-    ),
-)
 
 
 R68 = create_builtin_relation(

src/pyirk/core.py

@@ -2209,6 +2209,12 @@ def create_relation(key_str: str = "", **kwargs) -> Relation:
     }
 
     new_kwargs, lang_related_kwargs = process_kwargs_for_entity_creation(rel_key, kwargs)
+    if "R4" not in new_kwargs.keys() and "irk:/builtins#R4" in ds.relations.keys():
+        try:
+            new_kwargs["R4"] = ds.items["irk:/builtins#I40"]
+        except KeyError:
+            pass
+
 
     rel = Relation(mod_uri, rel_key, **new_kwargs)
     if rel.uri in ds.relations:

src/pyirk/visualization.py

@@ -445,6 +445,7 @@ def create_complete_graph(
         url_template="",
         limit: Optional[int] = None,
         skip_auto_items: bool = False,
+        vis_relations: bool = False,
     ) -> nx.DiGraph:
         """
         :param url_template:    template to insert links based on uris
@@ -466,8 +467,14 @@ def create_complete_graph(
                 # this is the case for some statements which are subject of a qualifier relation
                 assert item_uri in p.ds.statement_uri_map
                 continue
-            if not isinstance(item, p.Item) or item.short_key in ["I000"]:
+            if item.short_key in ["I000"]:
                 continue
+            if vis_relations:
+                if (not isinstance(item, p.Item) and not isinstance(item, p.Relation)):
+                    continue # what possible type could item have to get here?
+            else:
+                if not isinstance(item, p.Item):
+                    continue
             if skip_auto_items and "Ia" in item.short_key:
                 continue
             # count only items
@@ -643,7 +650,7 @@ def svg_replace(self, raw_svg_data: str, REPLACEMENTS: dict) -> str:
         return svg_data1
 
 
-    def visualize_entity(self, uri: str, url_template="", write_tmp_files: Union[bool, str] = False, radius=1, graph=None) -> str:
+    def visualize_entity(self, uri: str, url_template="", write_tmp_files: Union[bool, str] = False, radius=1, graph=None, vis_relations=False) -> str:
         """
 
         :param uri:             entity uri (like "irk:/my/module#I0123")
@@ -653,7 +660,7 @@ def visualize_entity(self, uri: str, url_template="", write_tmp_files: Union[boo
         :return:                svg_data as string
         """
         if graph is None:
-            big_G = self.create_complete_graph(url_template)
+            big_G = self.create_complete_graph(url_template, vis_relations=vis_relations)
         else:
             big_G = graph
         try:
@@ -696,7 +703,7 @@ def visualize_entity(self, uri: str, url_template="", write_tmp_files: Union[boo
         # for interactive graph, we need hyperlinks. these mess up the svg with <> inside attributes -> remove
         svg_data1 = re.sub(r'(?<=xlink:title=").+?(?=" target=)', "", svg_data1)
 
-        if 1:
+        if 0:
             # add legend
             svg_data1 = self.add_legend(svg_data1, relation_color_map, list_of_relations)
 
@@ -778,7 +785,7 @@ def get_label(self, entity):
         return res
 
 
-    def visualize_all_entities(self, url_template="", write_tmp_files: Union[bool, str] = False, skip_auto_items: bool = False) -> str:
+    def visualize_all_entities(self, url_template="", write_tmp_files: Union[bool, str] = False, skip_auto_items: bool = False, vis_relations=False) -> str:
         """visualize all entities loaded in datastore. output svg graph.
 
         Args:
@@ -789,7 +796,7 @@ def visualize_all_entities(self, url_template="", write_tmp_files: Union[bool, s
         Returns:
             str: svg graph
         """
-        G = self.create_complete_graph(url_template, skip_auto_items=skip_auto_items)
+        G = self.create_complete_graph(url_template, skip_auto_items=skip_auto_items, vis_relations=vis_relations)
 
         print(f"Visualizing {len(G.nodes)} nodes and {len(G.edges)} edges.")
         ecm = self.build_edge_color_map(G)
@@ -883,10 +890,10 @@ def render_label(self, label: str):
 
         return res.format(**REPLACEMENTS)
 
-    def create_interactive_graph(self, url_template="", output_dir="graph_site", radius=1, skip_auto_items=True, skip_existing=False):
+    def create_interactive_graph(self, url_template="", output_dir="graph_site", radius=1, skip_auto_items=True, skip_existing=False, vis_relations=False):
         os.makedirs(output_dir, exist_ok=True)
 
-        G = self.create_complete_graph(url_template, skip_auto_items=skip_auto_items)
+        G = self.create_complete_graph(url_template, skip_auto_items=skip_auto_items, vis_relations=vis_relations)
         print(f"Visualizing {len(G.nodes)} nodes and {len(G.edges)} edges.")
 
         for node in G.nodes:
@@ -914,9 +921,17 @@ def create_interactive_graph(self, url_template="", output_dir="graph_site", rad
             # to trick graphviz to render rect and then replace href and title to create tooltip
             image_map = re.sub(r'(?<=shape="rect")(.+?)(href=")(.+?)(" title=")(.+?)(?=")', lambda mo: mo.group(1)+mo.group(2)+""+mo.group(4)+mo.group(3), image_map)
 
-            desc = p.ds.items[node.uri].R2.value if p.ds.items[node.uri].R2 else ""
+            if node_name.startswith("I"):
+                item = p.ds.items[node.uri]
+            else:
+                item = p.ds.relations[node.uri]
+
+            desc = item.R2.value if item.R2 else ""
+            # add usage hint, sometimes more expressive than R2
+            desc += "<br>" + " ".join(item.R18) if item.R18 else ""
+
             context = {
-                "title": node_name + " " + p.ds.items[node.uri].R1.value,
+                "title": node_name + " " + item.R1.value,
                 "img_source": f"{node_name}.svg",
                 "map": image_map,
                 "desc": desc
@@ -927,7 +942,7 @@ def create_interactive_graph(self, url_template="", output_dir="graph_site", rad
 
         # Index page
         dot_path = os.path.join(output_dir, "index.dot")
-        self.visualize_all_entities(write_tmp_files=dot_path, skip_auto_items=skip_auto_items)
+        self.visualize_all_entities(write_tmp_files=dot_path, skip_auto_items=skip_auto_items, vis_relations=vis_relations)
 
         # create map
         cmapx_path = os.path.join(output_dir, f"index.map")
@@ -961,6 +976,6 @@ def create_interactive_graph(self, url_template="", output_dir="graph_site", rad
 
 if __name__ == "__main__":
     # visualize_all_entities(write_tmp_files=True, skip_auto_items=True)
-    vm.create_interactive_graph()
+    vm.create_interactive_graph(vis_relations=True)
     # nl = p.irkloader.load_mod_from_path("output.py", "nl", "nonlinear")
     # visualize_entity("irk:/builtins#I31", write_tmp_files=True, radius=1)