Semantic Graph Synthesis

.github/workflows/ci.yml

@@ -42,7 +42,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11']
     steps:
       - name: checkout
         uses: actions/checkout@v4

buildingmotif/api/views/library.py

@@ -4,9 +4,9 @@
 from flask import Blueprint, current_app, jsonify
 from flask_api import status
 from rdflib import URIRef
-from sqlalchemy.orm.exc import NoResultFound
 
 from buildingmotif.api.serializers.library import serialize
+from buildingmotif.database.errors import LibraryNotFound
 from buildingmotif.dataclasses.shape_collection import ShapeCollection
 
 blueprint = Blueprint("libraries", __name__)
@@ -81,7 +81,7 @@ def get_library(library_id: int) -> flask.Response:
     """
     try:
         db_lib = current_app.building_motif.table_connection.get_db_library(library_id)
-    except NoResultFound:
+    except LibraryNotFound:
         return {
             "message": f"No library with id {library_id}"
         }, status.HTTP_404_NOT_FOUND

buildingmotif/api/views/model.py

@@ -7,6 +7,7 @@
 
 from buildingmotif.api.serializers.model import serialize
 from buildingmotif.dataclasses import Library, Model, ShapeCollection
+from buildingmotif import get_building_motif
 
 blueprint = Blueprint("models", __name__)
 
@@ -164,10 +165,13 @@ def validate_model(models_id: int) -> flask.Response:
         return {"message": f"No model with id {models_id}"}, status.HTTP_404_NOT_FOUND
 
     shape_collections = []
+    shacl_engine = None
 
     # no body provided -- default to model manifest and default SHACL engine
+    # TODO: take the shacl engine as a parameter
     if request.content_length is None:
         shape_collections = [model.get_manifest()]
+        shacl_engine = "pyshacl"
     else:
         # get body
         if request.content_type != "application/json":
@@ -198,7 +202,12 @@ def validate_model(models_id: int) -> flask.Response:
 
     # if shape_collections is empty, model.validate will default
     # to the model's manifest
-    vaildation_context = model.validate(shape_collections)
+    bm = get_building_motif()
+    old_shacl_engine = bm.shacl_engine
+    bm.shacl_engine = shacl_engine
+    vaildation_context = model.validate(shape_collections, error_on_missing_imports=False)
+    bm.shacl_engine = old_shacl_engine
+
 
     return {
         "message": vaildation_context.report_string,

buildingmotif/api/views/template.py

@@ -7,6 +7,7 @@
 from rdflib import Literal, URIRef
 from rdflib.term import Node
 from sqlalchemy.orm.exc import NoResultFound
+from buildingmotif.database.errors import TemplateNotFound
 
 from buildingmotif.api.serializers.template import serialize
 from buildingmotif.dataclasses import Model, Template
@@ -42,7 +43,7 @@ def get_template(templates_id: int) -> flask.Response:
         template = current_app.building_motif.table_connection.get_db_template(
             templates_id
         )
-    except NoResultFound:
+    except TemplateNotFound:
         return {
             "message": f"No template with id {templates_id}"
         }, status.HTTP_404_NOT_FOUND
@@ -55,7 +56,7 @@ def evaluate_ingress(template_id: int) -> flask.Response:
     # get template
     try:
         template = Template.load(template_id)
-    except NoResultFound:
+    except TemplateNotFound:
         return {
             "message": f"No template with id {template_id}"
         }, status.HTTP_404_NOT_FOUND
@@ -107,7 +108,7 @@ def evaluate_bindings(template_id: int) -> flask.Response:
     """
     try:
         template = Template.load(template_id)
-    except NoResultFound:
+    except TemplateNotFound:
         return {
             "message": f"No template with id {template_id}"
         }, status.HTTP_404_NOT_FOUND
@@ -141,6 +142,25 @@ def evaluate_bindings(template_id: int) -> flask.Response:
     return graph.serialize(format="ttl"), status.HTTP_200_OK
 
 
+@blueprint.route("/<template_id>/body", methods=(["GET"]))
+def get_template_body(template_id: int) -> flask.Response:
+    """Get template body.
+
+    :param template_id: template id
+    :type template_id: int
+    :return: template body
+    :rtype: flask.Response
+    """
+    try:
+        template: Template = Template.load(template_id)
+    except TemplateNotFound:
+        return {
+            "message": f"No template with id {template_id}"
+        }, status.HTTP_404_NOT_FOUND
+
+    return template.body.serialize(format="ttl"), status.HTTP_200_OK
+
+
 def get_bindings(binding_dict) -> Dict[str, Node]:
     """type binding_dict values to nodes
 

buildingmotif/database/errors.py

@@ -0,0 +1,22 @@
+from typing import Optional
+
+
+class LibraryNotFound(Exception):
+    def __init__(self, name: Optional[str] = None, idnum: Optional[int] = None):
+        self.lib_name = name
+        self.lib_id = idnum
+
+    def __str__(self):
+        if self.lib_name:
+            return f"Library with name '{self.lib_name}' not found"
+        return f"Library with id '{self.lib_id}' not found"
+
+class TemplateNotFound(Exception):
+    def __init__(self, name: Optional[str] = None, idnum: Optional[int] = None):
+        self.template_name = name
+        self.template_id = idnum
+
+    def __str__(self):
+        if self.template_name:
+            return f"Template with name '{self.template_name}' not found"
+        return f"Template with id '{self.template_id}' not found"

buildingmotif/database/table_connection.py

@@ -13,6 +13,7 @@
     DBTemplate,
     DepsAssociation,
 )
+from buildingmotif.database.errors import LibraryNotFound, TemplateNotFound
 
 
 class TableConnection:
@@ -216,7 +217,10 @@ def get_db_library(self, id: int) -> DBLibrary:
         :return: DBLibrary
         :rtype: DBLibrary
         """
-        db_library = self.bm.session.query(DBLibrary).filter(DBLibrary.id == id).one()
+        try:
+            db_library = self.bm.session.query(DBLibrary).filter(DBLibrary.id == id).one()
+        except NoResultFound:
+            raise LibraryNotFound(f"Library with id {id} not found")
         return db_library
 
     def get_db_library_by_name(self, name: str) -> DBLibrary:
@@ -227,7 +231,10 @@ def get_db_library_by_name(self, name: str) -> DBLibrary:
         :return: DBLibrary
         :rtype: DBLibrary
         """
-        return self.bm.session.query(DBLibrary).filter(DBLibrary.name == name).one()
+        try:
+            return self.bm.session.query(DBLibrary).filter(DBLibrary.name == name).one()
+        except NoResultFound:
+            raise LibraryNotFound(name=name)
 
     def update_db_library_name(self, id: int, name: str) -> None:
         """Update database library name.
@@ -298,9 +305,12 @@ def get_db_template(self, id: int) -> DBTemplate:
         :return: DBTemplate
         :rtype: DBTemplate
         """
-        db_template = (
-            self.bm.session.query(DBTemplate).filter(DBTemplate.id == id).one()
-        )
+        try:
+            db_template = (
+                self.bm.session.query(DBTemplate).filter(DBTemplate.id == id).one()
+            )
+        except NoResultFound:
+            raise TemplateNotFound(idnum=id)
         return db_template
 
     def get_db_template_by_name(self, name: str) -> DBTemplate:
@@ -316,7 +326,7 @@ def get_db_template_by_name(self, name: str) -> DBTemplate:
                 self.bm.session.query(DBTemplate).filter(DBTemplate.name == name).one()
             )
         except NoResultFound:
-            raise NoResultFound(f"No template found with name {name}")
+            raise TemplateNotFound(name=name)
         return db_template
 
     def get_library_defining_db_template(self, id: int) -> DBLibrary:

buildingmotif/database/tables.py

@@ -1,6 +1,7 @@
 from typing import Dict, List
 
-from sqlalchemy import Column, ForeignKey, Integer, String, Text, UniqueConstraint
+from sqlalchemy import Column, ForeignKey, Integer, String, Text, UniqueConstraint, event
+from sqlalchemy.engine import Engine
 from sqlalchemy.orm import Mapped, declarative_base, relationship
 
 # from sqlalchemy.dialects.postgresql import JSON
@@ -9,6 +10,13 @@
 Base = declarative_base()
 
 
+# https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#foreign-key-support
+@event.listens_for(Engine, "connect")
+def set_sqlite_pragma(dbapi_connection, connection_record):
+    cursor = dbapi_connection.cursor()
+    cursor.execute("PRAGMA foreign_keys=ON")
+    cursor.close()
+
 class DBModel(Base):
     """A Model is a metadata model of all or part of a building."""
 
@@ -18,12 +26,13 @@ class DBModel(Base):
     description: Mapped[str] = Column(Text(), default="", nullable=False)
     graph_id: Mapped[str] = Column(String())
     manifest_id: Mapped[int] = Column(
-        Integer, ForeignKey("shape_collection.id"), nullable=False
+        Integer, ForeignKey("shape_collection.id", ondelete="CASCADE"), nullable=False
     )
     manifest: "DBShapeCollection" = relationship(
         "DBShapeCollection",
         uselist=False,
-        cascade="all,delete",
+        cascade="all",
+        passive_deletes=True,
     )
 
 
@@ -45,16 +54,17 @@ class DBLibrary(Base):
     name: Mapped[str] = Column(String(), nullable=False, unique=True)
 
     templates: Mapped[List["DBTemplate"]] = relationship(
-        "DBTemplate", back_populates="library", cascade="all,delete"
+        "DBTemplate", back_populates="library", cascade="all", passive_deletes=True
     )
 
     shape_collection_id = Column(
-        Integer, ForeignKey("shape_collection.id"), nullable=False
+        Integer, ForeignKey("shape_collection.id", ondelete="CASCADE"), nullable=False
     )
     shape_collection: DBShapeCollection = relationship(
         "DBShapeCollection",
         uselist=False,
-        cascade="all,delete",
+        cascade="all",
+        passive_deletes=True,
     )
 
 
@@ -64,8 +74,8 @@ class DepsAssociation(Base):
     __tablename__ = "deps_association_table"
 
     id: Mapped[int] = Column(Integer, primary_key=True)
-    dependant_id: Mapped[int] = Column(ForeignKey("template.id"))
-    dependee_id: Mapped[int] = Column(ForeignKey("template.id"))
+    dependant_id: Mapped[int] = Column(ForeignKey("template.id", ondelete="CASCADE"))
+    dependee_id: Mapped[int] = Column(ForeignKey("template.id", ondelete="CASCADE"))
     # args are a mapping of dependee args to dependant args
     args: Mapped[Dict[str, str]] = Column(JSONType)  # type: ignore
 
@@ -89,21 +99,25 @@ class DBTemplate(Base):
     body_id: Mapped[str] = Column(String())
     optional_args: Mapped[List[str]] = Column(JSONType)  # type: ignore
 
-    library_id: Mapped[int] = Column(Integer, ForeignKey("library.id"), nullable=False)
+    library_id: Mapped[int] = Column(Integer, ForeignKey("library.id", ondelete="CASCADE"), nullable=False)
     library: Mapped[DBLibrary] = relationship("DBLibrary", back_populates="templates")
     dependencies: Mapped[List["DBTemplate"]] = relationship(
         "DBTemplate",
         secondary="deps_association_table",
         primaryjoin=id == DepsAssociation.dependant_id,
         secondaryjoin=id == DepsAssociation.dependee_id,
         back_populates="dependants",
+        cascade="all",
+        passive_deletes=True,
     )
     dependants: Mapped[List["DBTemplate"]] = relationship(
         "DBTemplate",
         secondary="deps_association_table",
         primaryjoin=id == DepsAssociation.dependee_id,
         secondaryjoin=id == DepsAssociation.dependant_id,
         back_populates="dependencies",
+        cascade="all",
+        passive_deletes=True,
     )
 
     __table_args__ = (