Fix #4072. IDS reports now include filename.

2026-08-13 10:57:49 +00:00 · 2023-12-04 17:26:57 +11:00
parent 31e912cf12
commit b9f33e06bd
5 changed files with 39 additions and 19 deletions
@@ -55,6 +55,10 @@ class Ids:
        purpose=None,
        milestone=None,
    ):
+        # Not part of the IDS spec, but very useful in practice
+        self.filepath = None
+        self.filename = None
+
        self.specifications = []
        self.info = {}
        self.info["title"] = title or "Untitled"
@@ -112,7 +116,12 @@ class Ids:
        ET.ElementTree(get_schema().encode(self.asdict())).write(filepath, encoding="utf-8", xml_declaration=True)
        return get_schema().is_valid(filepath)

-    def validate(self, ifc_file, filter_version=False):
+    def validate(self, ifc_file, filter_version=False, filepath=None):
+        if filepath:
+            self.filepath = filepath
+            self.filename = os.path.basename(filepath)
+        else:
+            self.filepath = self.filename = None
        get_pset.cache_clear()
        get_psets.cache_clear()
        for specification in self.specifications:
@@ -175,8 +184,12 @@ class Specification:
        self.minOccurs = ids_dict["@minOccurs"]
        self.maxOccurs = ids_dict["@maxOccurs"]
        self.ifcVersion = ids_dict["@ifcVersion"]
-        self.applicability = self.parse_clause(ids_dict["applicability"]) if ids_dict.get("applicability") is not None else []
-        self.requirements = self.parse_clause(ids_dict["requirements"]) if ids_dict.get("requirements") is not None else []
+        self.applicability = (
+            self.parse_clause(ids_dict["applicability"]) if ids_dict.get("applicability") is not None else []
+        )
+        self.requirements = (
+            self.parse_clause(ids_dict["requirements"]) if ids_dict.get("requirements") is not None else []
+        )
        return self

    def parse_clause(self, clause):
@@ -205,7 +218,7 @@ class Specification:
            return

        elements = None
-        
+
        # This is a broadphase filter of applicability. We almost never want to
        # test every single class in an IFC model.
        for i, facet in enumerate(self.applicability):
@@ -225,7 +238,7 @@ class Specification:
            for facet in self.requirements:
                result = facet(element)
                if self.maxOccurs == 0:
-                    prohibited = bool(result)                    
+                    prohibited = bool(result)
                else:
                    prohibited = not bool(result)
                if prohibited:
@@ -249,7 +262,7 @@ class Specification:
                    facet.status = False
            elif self.failed_entities:
                self.status = False
-        elif self.minOccurs == 0 and self.maxOccurs != 0: 
+        elif self.minOccurs == 0 and self.maxOccurs != 0:
            if self.failed_entities:
                self.status = False
        elif self.maxOccurs == 0:
@@ -163,6 +163,8 @@ class Json(Reporter):
    def report(self):
        self.results["title"] = self.ids.info.get("title", "Untitled IDS")
        self.results["date"] = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+        self.results["filepath"] = self.ids.filepath
+        self.results["filename"] = self.ids.filename
        total_specifications = 0
        total_specifications_pass = 0
        total_requirements = 0
@@ -71,7 +71,7 @@
 <body>
    <header>
        <h1>{{title}}</h1>
-        <p><strong>{{date}}</strong></p>
+        <p><strong>{{#filename}}{{filename}}<br />{{/filename}}{{date}}</strong></p>
    </header>
    <h2>Summary</h2>
    <div class="container">