Merge branch 'v0.7.0' into linked_aggregate_operator_from_panel

src/blenderbim/blenderbim/bim/export_ifc.py

@@ -16,6 +16,7 @@
 # You should have received a copy of the GNU General Public License
 # along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
 
+from __future__ import annotations
 import os
 import bpy
 import json
@@ -36,6 +37,7 @@ import blenderbim.core.style
 from blenderbim.bim.ifc import IfcStore
 from mathutils import Vector
 from typing import Union
+from logging import Logger
 
 
 class IfcExporter:
@@ -163,10 +165,10 @@ class IfcExporter:
                 bpy.ops.bim.update_representation(obj=obj.name)
         tool.Geometry.record_object_position(obj)
 
-    def get_application_name(self):
+    def get_application_name(self) -> str:
         return "BlenderBIM"
 
-    def get_application_version(self):
+    def get_application_version(self) -> str:
         version = ".".join(
             [
                 str(x)
@@ -184,11 +186,13 @@ class IfcExporter:
 
 class IfcExportSettings:
     def __init__(self):
-        self.logger = None
-        self.output_file = None
+        self.logger: Logger = None
+        self.output_file: str = None
+        self.json_version: str = None
+        self.json_compact: bool = None
 
     @staticmethod
-    def factory(context, output_file, logger):
+    def factory(context: bpy.types.Context, output_file: str, logger: Logger) -> IfcExportSettings:
         settings = IfcExportSettings()
         settings.output_file = output_file
         settings.logger = logger

src/blenderbim/blenderbim/bim/import_ifc.py

@@ -299,6 +299,7 @@ class IfcImporter:
         if self.ifc_import_settings.should_setup_viewport_camera:
             self.setup_viewport_camera()
         self.setup_arrays()
+        self.profile_code("Setup arrays")
         self.update_progress(100)
         bpy.context.window_manager.progress_end()
 
@@ -602,6 +603,9 @@ class IfcImporter:
         return products
 
     def predict_dense_mesh(self):
+        if self.ifc_import_settings.should_use_native_meshes:
+            return
+
         threshold = 10000  # Just from experience.
 
         faces = [len(e.CfsFaces) for e in self.file.by_type("IfcClosedShell")]
@@ -1494,7 +1498,11 @@ class IfcImporter:
             # Occurs when reloading a project
             pass
         project_collection = bpy.context.view_layer.layer_collection.children[self.project["blender"].name]
-        project_collection.children[self.type_collection.name].hide_viewport = True
+        types_collection = project_collection.children[self.type_collection.name]
+        types_collection.hide_viewport = False
+        for obj in types_collection.collection.objects: #turn off all objects inside Types collection.
+            obj.hide_set(True)
+
 
     def clean_mesh(self):
         obj = None
@@ -2041,7 +2049,7 @@ class IfcImporter:
 
 class IfcImportSettings:
     def __init__(self):
-        self.logger = None
+        self.logger: logging.Logger = None
         self.input_file = None
         self.diff_file = None
         self.should_use_cpu_multiprocessing = True

src/blenderbim/blenderbim/bim/module/classification/operator.py

@@ -209,6 +209,10 @@ class DisableEditingClassification(bpy.types.Operator):
 class RemoveClassification(bpy.types.Operator, tool.Ifc.Operator):
     bl_idname = "bim.remove_classification"
     bl_label = "Remove Classification"
+    bl_description = (
+        "The classification and all of its relationships, children references, "
+        "and relationships between objects and child references will be completely removed from a project"
+    )
     bl_options = {"REGISTER", "UNDO"}
     classification: bpy.props.IntProperty()
 

src/blenderbim/blenderbim/bim/module/context/operator.py

@@ -53,6 +53,10 @@ class AddContext(bpy.types.Operator, Operator):
 class RemoveContext(bpy.types.Operator, Operator):
     bl_idname = "bim.remove_context"
     bl_label = "Remove Context"
+    bl_description = (
+        "Remove representation context. Any representation geometry that is assigned to the context is also removed. "
+        "If a context is removed, then any subcontexts are also removed"
+    )
     bl_options = {"REGISTER", "UNDO"}
     context: bpy.props.IntProperty()
 

src/blenderbim/blenderbim/bim/module/csv/operator.py

@@ -246,6 +246,7 @@ class ExportIfcCsv(bpy.types.Operator):
         if props.format != "csv" and props.should_generate_svg:
             schedule_creator = scheduler.Scheduler()
             schedule_creator.schedule(self.filepath, tool.Drawing.get_path_with_ext(self.filepath, "svg"))
+        self.report({"INFO"}, f"Data is exported to {props.format.upper()}.")
         return {"FINISHED"}
 
 
@@ -285,6 +286,7 @@ class ImportIfcCsv(bpy.types.Operator):
         if not props.should_load_from_memory:
             ifc_file.write(props.csv_ifc_file)
         refresh_ui_data()
+        self.report({"INFO"}, "Data is imported to IFC.")
         return {"FINISHED"}
 
 

src/blenderbim/blenderbim/bim/module/debug/__init__.py

@@ -35,7 +35,6 @@ classes = (
     operator.PrintUnusedElementStats,
     operator.ProfileImportIFC,
     operator.PurgeHdf5Cache,
-    operator.PurgeIfcLinks,
     operator.PurgeUnusedElementsByClass,
     operator.RewindInspector,
     operator.SelectExpressFile,

src/blenderbim/blenderbim/bim/module/debug/operator.py

@@ -104,10 +104,11 @@ class PrintIfcFile(bpy.types.Operator):
         return {"FINISHED"}
 
 
-class PurgeIfcLinks(bpy.types.Operator):
-    bl_idname = "bim.purge_ifc_links"
-    bl_label = "Purge IFC Links"
-    bl_description = "Purge all definitions and references from the file.\nWarning : Cannot be undone."
+class ConvertToBlender(bpy.types.Operator):
+    bl_idname = "bim.convert_to_blender"
+    bl_label = "Convert To Blender File"
+    bl_description = "Removes all IFC data and revert to basic Blender objects.\nWarning : Cannot be undone."
+    bl_options = {"REGISTER", "UNDO"}
 
     def execute(self, context):
         for obj in bpy.data.objects:
@@ -124,26 +125,6 @@ class PurgeIfcLinks(bpy.types.Operator):
         return {"FINISHED"}
 
 
-class ConvertToBlender(bpy.types.Operator):
-    bl_idname = "bim.convert_to_blender"
-    bl_label = "Convert To Blender File"
-    bl_description = "Removes all IFC data, and converts the file to a simple Blender file."
-    bl_options = {"REGISTER", "UNDO"}
-
-    def execute(self, context):
-        for o in bpy.data.objects:
-            if o.type in {"MESH", "EMPTY"}:
-                o.BIMObjectProperties.ifc_definition_id = 0
-                if o.data:
-                    o.data.BIMMeshProperties.ifc_definition_id = 0
-        for m in bpy.data.materials:
-            m.BIMMaterialProperties.ifc_style_id = False
-        bpy.context.scene.BIMProperties.ifc_file = ""
-        IfcStore.purge()
-        blenderbim.bim.handler.refresh_ui_data()
-        return {"FINISHED"}
-
-
 class ValidateIfcFile(bpy.types.Operator):
     bl_idname = "bim.validate_ifc_file"
     bl_label = "Validate IFC File"

src/blenderbim/blenderbim/bim/module/debug/ui.py

@@ -60,9 +60,6 @@ class BIM_PT_debug(Panel):
         row = layout.row()
         row.operator("bim.purge_hdf5_cache")
 
-        row = layout.row()
-        row.operator("bim.purge_ifc_links")
-
         row = layout.row()
         row.operator("bim.update_representation", text="Manually Save Representation")
 

src/blenderbim/blenderbim/bim/module/drawing/operator.py

@@ -29,6 +29,7 @@ import subprocess
 import numpy as np
 import multiprocessing
 import ifcopenshell
+import ifcopenshell.ifcopenshell_wrapper
 import ifcopenshell.geom
 import ifcopenshell.util.selector
 import ifcopenshell.util.representation
@@ -219,11 +220,12 @@ class CreateDrawing(bpy.types.Operator):
     def execute(self, context):
         self.props = context.scene.DocProperties
 
+        active_drawing_id = context.scene.camera.BIMObjectProperties.ifc_definition_id
         if self.print_all:
-            original_drawing_id = self.props.active_drawing_id
+            original_drawing_id = active_drawing_id
             drawings_to_print = [d.ifc_definition_id for d in self.props.drawings if d.is_selected and d.is_drawing]
         else:
-            drawings_to_print = [self.props.active_drawing_id]
+            drawings_to_print = [active_drawing_id]
 
         for drawing_i, drawing_id in enumerate(drawings_to_print):
             self.drawing_index = drawing_i
@@ -1451,13 +1453,19 @@ class ActivateModel(bpy.types.Operator):
 
         CutDecorator.uninstall()
 
+        # save current visibility statuses for Views and Types collections
+        visibility_status: dict[bpy.types.Object, bool] = {}
+        for col in bpy.data.collections["Views"].children:
+            for obj in col.objects:
+                visibility_status[obj] = obj.hide_get()
+        for obj in bpy.data.collections["Types"].objects:
+            visibility_status[obj] = obj.hide_get()
+
         if not bpy.app.background:
             with context.temp_override(**tool.Blender.get_viewport_context()):
                 bpy.ops.object.hide_view_clear()
                 bpy.ops.bim.activate_status_filters()
 
-        subcontext = ifcopenshell.util.representation.get_context(tool.Ifc.get(), "Model", "Body", "MODEL_VIEW")
-
         for obj in context.visible_objects:
             element = tool.Ifc.get_entity(obj)
             if not element:
@@ -1475,6 +1483,11 @@ class ActivateModel(bpy.types.Operator):
                         is_global=True,
                         should_sync_changes_first=True,
                     )
+
+        # restore visibility after hide_view_clear()
+        for obj, hide_status in visibility_status.items():
+            obj.hide_set(hide_status)
+
         tool.Blender.update_viewport()
         return {"FINISHED"}
 

src/blenderbim/blenderbim/bim/module/drawing/svgwriter.py

@@ -719,7 +719,7 @@ class SvgWriter:
             self.svg.text(sheet_id, insert=(text_position[0], text_position[1] + 2.5), class_="ELEVATION", **text_style)
         )
 
-    def get_reference_and_sheet_id_from_annotation(self, element):
+    def get_reference_and_sheet_id_from_annotation(self, element: ifcopenshell.entity_instance) -> tuple[str, str]:
         reference_id = "-"
         sheet_id = "-"
         drawing = tool.Drawing.get_annotation_element(element)

src/blenderbim/blenderbim/bim/module/geometry/data.py

@@ -17,6 +17,7 @@
 # along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
 
 import bpy
+import ifcopenshell.util.element
 import blenderbim.tool as tool
 import ifcopenshell.util.placement
 from mathutils import Vector
@@ -222,7 +223,7 @@ class ConnectionsData:
     @classmethod
     def is_connection_realization(cls):
         element = tool.Ifc.get_entity(bpy.context.active_object)
-        connections = element.IsConnectionRealization
+        connections = getattr(element, "IsConnectionRealization", None)
         if not connections:
             return
 

src/blenderbim/blenderbim/bim/module/geometry/operator.py

@@ -215,6 +215,13 @@ class SwitchRepresentation(bpy.types.Operator, Operator):
     disable_opening_subtractions: bpy.props.BoolProperty()
     should_switch_all_meshes: bpy.props.BoolProperty()
 
+    @classmethod
+    def poll(cls, context):
+        if context.active_object.mode == "OBJECT":
+            return True
+        cls.poll_message_set("Only available in OBJECT mode - Press TAB in the viewport")
+        return False
+
     def _execute(self, context):
         target_representation = tool.Ifc.get().by_id(self.ifc_definition_id)
         target = target_representation.ContextOfItems
@@ -223,6 +230,8 @@ class SwitchRepresentation(bpy.types.Operator, Operator):
             element = tool.Ifc.get_entity(obj)
             if not element:
                 continue
+            if not obj.mode == "OBJECT":
+                continue
             if obj == context.active_object:
                 representation = target_representation
             else:
@@ -538,6 +547,8 @@ class OverrideDelete(bpy.types.Operator):
         row.prop(self, "is_batch", text="Enable Faster Deletion")
 
     def _execute(self, context):
+        start_time = time()
+
         if self.is_batch:
             ifcopenshell.util.element.batch_remove_deep2(tool.Ifc.get())
 
@@ -562,6 +573,11 @@ class OverrideDelete(bpy.types.Operator):
             IfcStore.add_transaction_operation(self)
         # Required otherwise gizmos are still visible
         context.view_layer.objects.active = None
+
+        operator_time = time() - start_time
+        if operator_time > 10:
+            self.report({"INFO"}, "IFC Delete was finished in {:.2f} seconds".format(operator_time))
+
         return {"FINISHED"}
 
     def rollback(self, data):
@@ -902,7 +918,7 @@ class OverrideDuplicateMove(bpy.types.Operator):
             if pset:
                 pset = tool.Ifc.get().by_id(pset["id"])
                 ifcopenshell.api.run("pset.remove_pset", tool.Ifc.get(), pset=pset)
-                
+
             if new[0].is_a("IfcElementAssembly"):
                 linked_aggregate_group = [
                     r.RelatingGroup
@@ -910,7 +926,7 @@ class OverrideDuplicateMove(bpy.types.Operator):
                     if r.is_a("IfcRelAssignsToGroup")
                     if "BBIM_Linked_Aggregate" in r.RelatingGroup.Name
                 ]
-                tool.Ifc.run("group.unassign_group", group=linked_aggregate_group[0], product=new[0])
+                tool.Ifc.run("group.unassign_group", group=linked_aggregate_group[0], products=[new[0]])
 
 
 class OverrideDuplicateMoveLinkedMacro(bpy.types.Macro):
@@ -980,7 +996,7 @@ class DuplicateMoveLinkedAggregate(bpy.types.Operator):
                     else:
                         index = add_linked_aggregate_pset(part, index)
                         # index += 1
-                        
+
                     obj = tool.Ifc.get_object(part)
                     obj.select_set(True)
 
@@ -1014,9 +1030,7 @@ class DuplicateMoveLinkedAggregate(bpy.types.Operator):
                 return
 
             linked_aggregate_group = ifcopenshell.api.run("group.add_group", tool.Ifc.get(), Name=self.group_name)
-            ifcopenshell.api.run(
-                "group.assign_group", tool.Ifc.get(), products=[element], group=linked_aggregate_group
-            )
+            ifcopenshell.api.run("group.assign_group", tool.Ifc.get(), products=[element], group=linked_aggregate_group)
 
         def custom_incremental_naming_for_element_assembly(old_to_new):
             for new in old_to_new.values():
@@ -1040,10 +1054,10 @@ class DuplicateMoveLinkedAggregate(bpy.types.Operator):
                     if re.findall(pattern2, new_obj.name):
                         split_name = new_obj.name.split(".")
                         new_obj.name = split_name[0] + "_" + number
-                        
+
         def get_max_index(parts):
             psets = [ifcopenshell.util.element.get_pset(p, "BBIM_Linked_Aggregate") for p in parts]
-            index = [i['Index'] for i in psets if i]
+            index = [i["Index"] for i in psets if i]
             if len(index) > 0:
                 index = max(index)
                 return index
@@ -1057,14 +1071,14 @@ class DuplicateMoveLinkedAggregate(bpy.types.Operator):
                     new_pset = ifcopenshell.api.run(
                         "pset.add_pset", tool.Ifc.get(), product=new[0], name=self.pset_name
                     )
-            
+
                     ifcopenshell.api.run(
                         "pset.edit_pset",
                         tool.Ifc.get(),
                         pset=new_pset,
                         properties={"Index": pset["Index"]},
                     )
-                
+
                 if new[0].is_a("IfcElementAssembly"):
                     linked_aggregate_group = [
                         r.RelatingGroup
@@ -1083,6 +1097,7 @@ class DuplicateMoveLinkedAggregate(bpy.types.Operator):
                 location_diff = new_obj.location - base_obj_location
                 new_obj.location = context.scene.cursor.location + location_diff
 
+
         if len(context.selected_objects) != 1:
             return {"FINISHED"}
 
@@ -1102,7 +1117,7 @@ class DuplicateMoveLinkedAggregate(bpy.types.Operator):
         select_objects_and_add_data(selected_element)
 
         old_to_new = OverrideDuplicateMove.execute_ifc_duplicate_operator(self, context, linked=True)
-        
+
         tool.Root.recreate_aggregate(old_to_new)
 
         copy_linked_aggregate_data(old_to_new)
@@ -1269,9 +1284,9 @@ class RefreshLinkedAggregate(bpy.types.Operator):
             selected_matrix = selected_obj.matrix_world
             object_duplicate = tool.Ifc.get_object(element)
             duplicate_matrix = object_duplicate.matrix_world.decompose()
-            
+
             return selected_matrix, duplicate_matrix
-            
+
         def set_new_matrix(selected_matrix, duplicate_matrix, old_to_new):
             for old, new in old_to_new.items():
                 new_obj = tool.Ifc.get_object(new[0])
@@ -1279,7 +1294,6 @@ class RefreshLinkedAggregate(bpy.types.Operator):
                 matrix_diff = Matrix.inverted(selected_matrix) @ new_obj.matrix_world
                 new_obj_matrix = new_base_matrix @ matrix_diff
                 new_obj.matrix_world = new_obj_matrix
-        
 
         active_element = tool.Ifc.get_entity(context.active_object)
         if not active_element:
@@ -1465,14 +1479,13 @@ class OverridePasteBuffer(bpy.types.Operator):
 
     def execute(self, context):
         bpy.ops.view3d.pastebuffer()
-        if IfcStore.get_file():
-            for obj in context.selected_objects:
-                # Pasted objects may come from another Blender session, or even
-                # from the same session where the original object has since
-                # been deleted. As the source element may not exist, paste will
-                # always unlink the element. If you want to duplicate an
-                # element, use the duplicate commands.
-                tool.Root.unlink_object(obj)
+        for obj in context.selected_objects:
+            # Pasted objects may come from another Blender session, or even
+            # from the same session where the original object has since
+            # been deleted. As the source element may not exist, paste will
+            # always unlink the element. If you want to duplicate an
+            # element, use the duplicate commands.
+            tool.Root.unlink_object(obj)
         return {"FINISHED"}
 
 

src/blenderbim/blenderbim/bim/module/material/data.py

@@ -19,6 +19,7 @@
 import os
 import bpy
 import ifcopenshell
+import ifcopenshell.util.element
 import ifcopenshell.util.doc
 import ifcopenshell.util.schema
 import blenderbim.tool as tool
@@ -166,6 +167,9 @@ class ObjectMaterialData:
         cls.data["type_material"] = cls.type_material()
         cls.data["material_type"] = cls.material_type()
         cls.data["active_material_constituents"] = cls.active_material_constituents()
+        # after material_name and type_material
+        cls.data["is_type_material_overridden"] = cls.is_type_material_overridden()
+
         cls.is_loaded = True
 
     @classmethod
@@ -294,8 +298,7 @@ class ObjectMaterialData:
 
     @classmethod
     def material_name(cls):
-        element = tool.Ifc.get_entity(bpy.context.active_object)
-        material = ifcopenshell.util.element.get_material(element)
+        material = cls.material
         if material:
             return getattr(material, "Name", None) or "Unnamed"
 
@@ -339,3 +342,18 @@ class ObjectMaterialData:
         if not cls.material or not material.is_a("IfcMaterialConstituentSet"):
             return []
         return [m.Name for m in material.MaterialConstituents if m.Name]
+
+    @classmethod
+    def is_type_material_overridden(cls) -> bool:
+        if not cls.data["type_material"]:
+            return False
+
+        # try to avoid accessing ifc
+        if cls.data["material_name"] != cls.data["type_material"]:
+            return True
+
+        # in theory material can be overridden by the same material
+        # so we check occurrence material explicitly
+        element = tool.Ifc.get_entity(bpy.context.active_object)
+        occurrence_material = ifcopenshell.util.element.get_material(element, should_inherit=False)
+        return bool(occurrence_material)

src/blenderbim/blenderbim/bim/module/material/ui.py

@@ -177,7 +177,13 @@ class BIM_PT_object_material(Panel):
 
         if ObjectMaterialData.data["type_material"]:
             row = self.layout.row(align=True)
-            row.label(text="Inherited Material: " + ObjectMaterialData.data["type_material"], icon="CON_CHILDOF")
+            if ObjectMaterialData.data["is_type_material_overridden"]:
+                row.label(
+                    text=f"Inherited Material Is Occurrence Overridden",
+                    icon="CON_CHILDOF",
+                )
+            else:
+                row.label(text="Inherited Material: " + ObjectMaterialData.data["type_material"], icon="CON_CHILDOF")
 
         if ObjectMaterialData.data["material_class"]:
             return self.draw_material_ui()

src/blenderbim/blenderbim/bim/module/model/product.py

@@ -39,6 +39,7 @@ from mathutils import Vector, Matrix
 from bpy_extras.object_utils import AddObjectHelper
 from . import prop
 import json
+from typing import Any, Union
 
 
 class EnableAddType(bpy.types.Operator, tool.Ifc.Operator):
@@ -511,7 +512,7 @@ def regenerate_profile_usage(usecase_path, ifc_file, settings):
             )
 
 
-def ensure_material_assigned(usecase_path, ifc_file, settings):
+def ensure_material_assigned(usecase_path: str, ifc_file: ifcopenshell.file, settings: dict[str, Any]) -> None:
     if usecase_path == "material.assign_material":
         if not settings.get("material", None):
             return
@@ -524,53 +525,76 @@ def ensure_material_assigned(usecase_path, ifc_file, settings):
             ]:
                 elements.extend(rel.RelatedObjects)
 
-    for element in elements:
-        obj = IfcStore.get_element(element.GlobalId)
-        if not obj or not obj.data:
-            continue
-
-        element_material = ifcopenshell.util.element.get_material(element)
-        material = [m for m in ifc_file.traverse(element_material) if m.is_a("IfcMaterial")]
-
-        object_material_ids = [
-            om.BIMObjectProperties.ifc_definition_id
-            for om in obj.data.materials
-            if om is not None and om.BIMObjectProperties.ifc_definition_id
-        ]
-
-        if material and material[0].id() in object_material_ids:
-            continue
-
-        if len(obj.data.materials) == 1:
-            obj.data.materials.clear()
-
-        if not material:
-            continue
-
-        obj.data.materials.append(IfcStore.get_element(material[0].id()))
+    update_blender_ifc_materials(elements)
 
 
-def ensure_material_unassigned(usecase_path, ifc_file, settings):
+def ensure_material_unassigned(usecase_path: str, ifc_file: ifcopenshell.file, settings: dict[str, Any]) -> None:
     elements = settings["products"]
     if elements[0].is_a("IfcElementType"):
         elements.extend(ifcopenshell.util.element.get_types(elements[0]))
+    update_blender_ifc_materials(elements)
+
+
+def update_blender_ifc_materials(elements: list[ifcopenshell.entity_instance]) -> None:
+    """update mesh blender materials that have ifc material connected to them
+    by replacing them with `blender_material`"""
+    # since different elements can share meshes (e.g. occurrecnes without openings)
+    # we need to make sure not to affect them accidentally
+    meshes_users: dict[bpy.types.Mesh, set[bpy.types.Object]] = dict()
+    for obj in bpy.data.objects:
+        if not obj.data:
+            continue
+        meshes_users.setdefault(obj.data, set()).add(obj)
+
+    objects: set[bpy.types.Object] = set()
     for element in elements:
-        obj = tool.Ifc.get_object(element)
+        obj: bpy.types.Object = tool.Ifc.get_object(element)
         if not obj or not obj.data:
             continue
-        element_material = ifcopenshell.util.element.get_material(element)
-        if element_material:
+        objects.add(obj)
+
+    meshes: set[bpy.types.Mesh] = {obj.data for obj in objects}
+
+    for mesh in meshes:
+        mesh_users = meshes_users[mesh]
+        if not mesh_users.issubset(objects):
             continue
-        to_remove = []
-        for i, slot in enumerate(obj.material_slots):
-            if not slot.material:
+
+        # NOTE: we need `obj` as removing materials and appending them to `mesh.materials`
+        # will mess up mesh faces material indices
+
+        # NOTE: we make an assumption here that all mesh users
+        # have the same material - they either inherit it from the type
+        # or type doesn't have a material.
+        #
+        # If we add option to UI to add materials overriding type materials
+        # then this assumption won't be safe anymore
+
+        obj = next(iter(mesh_users))
+        element = tool.Ifc.get_entity(obj)
+        current_material = ifcopenshell.util.element.get_material(element)
+        if current_material:
+            current_material = tool.Ifc.get_object(current_material)
+
+        material_replaced = False
+
+        for material_slot in obj.material_slots:
+            material = material_slot.material
+            if material is None:
                 continue
-            material = tool.Ifc.get_entity(slot.material)
-            if material:
-                to_remove.append(i)
-        total_removed = 0
-        for i in to_remove:
-            obj.active_material_index = i - total_removed
-            with bpy.context.temp_override(object=obj):
-                bpy.ops.object.material_slot_remove()
-            total_removed += 1
+            ifc_material = tool.Ifc.get_entity(material)
+            # it's blender material for style, so ignore it
+            if not ifc_material:
+                continue
+            if ifc_material == current_material:
+                continue
+            material_slot.material = current_material
+            material_replaced = True
+
+        if not material_replaced and current_material:
+            mesh.materials.append(current_material)
+
+        # clear empty slots
+        for i, material in reversed(list(enumerate(mesh.materials[:]))):
+            if material is None:
+                mesh.materials.pop(index=i)

src/blenderbim/blenderbim/bim/module/model/ui.py

@@ -56,8 +56,11 @@ class LaunchTypeManager(bpy.types.Operator):
             ifc_class = props.ifc_class or AuthoringData.data["ifc_element_type"]
         else:
             ifc_class = AuthoringData.data["ifc_element_type"]
-        props.type_class = ifc_class
-        bpy.ops.bim.load_type_thumbnails(ifc_class=ifc_class, offset=0, limit=9)
+
+        # will be None if project has no types
+        if ifc_class is not None:
+            props.type_class = ifc_class
+            bpy.ops.bim.load_type_thumbnails(ifc_class=ifc_class, offset=0, limit=9)
         return context.window_manager.invoke_popup(self, width=550)
 
     def draw(self, context):

src/blenderbim/blenderbim/bim/module/model/workspace.py

@@ -378,6 +378,7 @@ class BimToolUI:
             op.depth = cls.props.extrusion_depth
 
             add_layout_hotkey_operator(cls.layout, "Extend", "S_E", "")
+            add_layout_hotkey_operator(cls.layout, "Flip", "S_F", bpy.ops.bim.flip_object.__doc__)
 
             if AuthoringData.data["active_class"] in (
                 "IfcCableCarrierSegment",
@@ -385,8 +386,8 @@ class BimToolUI:
                 "IfcDuctSegment",
                 "IfcPipeSegment",
             ):
-                add_layout_hotkey_operator(cls.layout, "Add Fitting", "S_F", "")
 
+                add_layout_hotkey_operator(cls.layout, "Add Fitting", "S_Y", "")
                 if context.region.type != "TOOL_HEADER":
                     cls.layout.operator("bim.mep_add_bend")
                     cls.layout.operator("bim.mep_add_transition")
@@ -394,7 +395,6 @@ class BimToolUI:
 
             else:
                 add_layout_hotkey_operator(cls.layout, "Edit Axis", "A_E", "")
-                add_layout_hotkey_operator(cls.layout, "Flip", "S_F", bpy.ops.bim.flip_object.__doc__)
                 add_layout_hotkey_operator(cls.layout, "Butt", "S_T", "")
                 add_layout_hotkey_operator(cls.layout, "Mitre", "S_Y", "")
                 add_layout_hotkey_operator(cls.layout, "Rotate 90", "S_R", bpy.ops.bim.rotate_90.__doc__)
@@ -719,10 +719,9 @@ class Hotkey(bpy.types.Operator, tool.Ifc.Operator):
             bpy.ops.bim.flip_wall()
         elif self.active_class in ("IfcWindow", "IfcWindowStandardCase", "IfcDoor", "IfcDoorStandardCase"):
             bpy.ops.bim.flip_fill()
-        elif self.active_class in ("IfcBeam", "IfcColumn"):
+        elif self.active_material_usage == "PROFILE":
             bpy.ops.bim.flip_object(flip_local_axes="XZ")
-        elif self.active_class in ("IfcDuctSegment", "IfcPipeSegment", "IfcCableCarrierSegment", "IfcCableSegment"):
-            bpy.ops.bim.fit_flow_segments()
+
 
     def hotkey_S_G(self):
         obj = bpy.context.active_object
@@ -808,9 +807,12 @@ class Hotkey(bpy.types.Operator, tool.Ifc.Operator):
             return
         if self.active_material_usage == "LAYER2":
             bpy.ops.bim.join_wall(join_type="V")
+        elif self.active_class in ("IfcDuctSegment", "IfcPipeSegment", "IfcCableCarrierSegment", "IfcCableSegment"):
+            bpy.ops.bim.fit_flow_segments()
         elif self.active_material_usage == "PROFILE":
             bpy.ops.bim.extend_profile(join_type="V")
 
+
     def hotkey_S_B(self):
         bpy.ops.bim.add_boundary()
 

src/blenderbim/blenderbim/bim/module/project/operator.py

@@ -47,6 +47,7 @@ from mathutils import Vector, Matrix
 from bpy.app.handlers import persistent
 from blenderbim.bim.module.project.data import LinksData
 from blenderbim.bim.module.project.decorator import ProjectDecorator, ClippingPlaneDecorator
+from typing import Union
 
 
 class NewProject(bpy.types.Operator):
@@ -301,7 +302,7 @@ class AssignLibraryDeclaration(bpy.types.Operator):
         ifcopenshell.api.run(
             "project.assign_declaration",
             self.file,
-            definition=self.file.by_id(self.definition),
+            definitions=[self.file.by_id(self.definition)],
             relating_context=self.file.by_type("IfcProjectLibrary")[0],
         )
         element_name = self.props.active_library_element
@@ -337,7 +338,7 @@ class UnassignLibraryDeclaration(bpy.types.Operator):
         ifcopenshell.api.run(
             "project.unassign_declaration",
             self.file,
-            definition=self.file.by_id(self.definition),
+            definitions=[self.file.by_id(self.definition)],
             relating_context=self.file.by_type("IfcProjectLibrary")[0],
         )
         element_name = self.props.active_library_element
@@ -867,7 +868,16 @@ class LinkIfc(bpy.types.Operator):
                 except:
                     pass  # Perhaps on another drive or something
             new.name = filepath
-            bpy.ops.bim.load_link(filepath=filepath, false_origin=self.false_origin)
+            status = bpy.ops.bim.load_link(filepath=filepath, false_origin=self.false_origin)
+            if status == {"CANCELLED"}:
+                error_msg = (
+                    f'Error processing IFC file "{self.filepath}" '
+                    "was critical and blend file either wasn't saved or wasn't updated. "
+                    "See logs above in system console for details."
+                )
+                print(error_msg)
+                self.report({"ERROR"}, error_msg)
+                return {"FINISHED"}
         print(f"Finished linking {len(files)} IFCs", time.time() - start)
         return {"FINISHED"}
 
@@ -946,10 +956,12 @@ class LoadLink(bpy.types.Operator):
         if self.filepath.lower().endswith(".blend"):
             self.link_blend(filepath)
         elif self.filepath.lower().endswith(".ifc"):
-            self.link_ifc()
+            status = self.link_ifc()
+            if status:
+                return status
         return {"FINISHED"}
 
-    def link_blend(self, filepath):
+    def link_blend(self, filepath: str) -> None:
         with bpy.data.libraries.load(filepath, link=True) as (data_from, data_to):
             data_to.scenes = data_from.scenes
         for scene in bpy.data.scenes:
@@ -962,7 +974,7 @@ class LoadLink(bpy.types.Operator):
         link = bpy.context.scene.BIMProjectProperties.links.get(self.filepath)
         link.is_loaded = True
 
-    def link_ifc(self):
+    def link_ifc(self) -> Union[set[str], None]:
         blend_filepath = self.filepath + ".cache.blend"
         h5_filepath = self.filepath + ".cache.h5"
 
@@ -982,11 +994,14 @@ except Exception as e:
     exit(1)
             """
 
+            t = time.time()
             with tempfile.NamedTemporaryFile(mode="w", suffix=".py", delete=False) as temp_file:
                 temp_file.write(code)
             run = subprocess.run([bpy.app.binary_path, "-b", "--python", temp_file.name, "--python-exit-code", "1"])
             if run.returncode == 1:
                 print("An error occurred while processing your IFC.")
+                if not os.path.exists(blend_filepath) or os.stat(blend_filepath).st_mtime < t:
+                    return {"CANCELLED"}
 
         self.link_blend(blend_filepath)
 

src/blenderbim/blenderbim/bim/module/root/data.py

@@ -185,6 +185,8 @@ class IfcClassData:
         if element:
             if element.is_a("IfcOpeningElement") or element.is_a("IfcOpeningStandardCase"):
                 return False
+            if element.is_a() in ("IfcWindowStyle", "IfcDoorStyle"): #see https://github.com/IfcOpenShell/IfcOpenShell/issues/4622#issuecomment-2095676368
+                return True
             for product in cls.ifc_products():
                 if element.is_a(product[0]):
                     return True

src/blenderbim/blenderbim/bim/module/style/operator.py

@@ -23,6 +23,7 @@ import blenderbim.bim.handler
 import blenderbim.tool as tool
 import blenderbim.core.style as core
 import ifcopenshell.util.representation
+from blenderbim.bim.module.style.prop import switch_shading
 from pathlib import Path
 from mathutils import Vector
 
@@ -126,6 +127,10 @@ class DisableEditingStyle(bpy.types.Operator, tool.Ifc.Operator):
         tool.Style.reload_material_from_ifc(material)
         props.is_editing_style = 0
 
+        # restore selected style type
+        material = tool.Ifc.get_object(style)
+        material.BIMStyleProperties.active_style_type = material.BIMStyleProperties.active_style_type
+
 
 class EditStyle(bpy.types.Operator, tool.Ifc.Operator):
     bl_idname = "bim.edit_style"
@@ -246,14 +251,15 @@ class BrowseExternalStyle(bpy.types.Operator):
     )
 
     def invoke(self, context, event):
-        external_style = None
+        style_elements = None
         if self.active_surface_style_id:
             style = tool.Ifc.get().by_id(self.active_surface_style_id)
-            external_style = tool.Style.get_style_elements(style).get("IfcExternallyDefinedSurfaceStyle", None)
+            style_elements = tool.Style.get_style_elements(style)
 
         # automatically select previously selected external style in file browser
         # if it exists in the file
-        if external_style and self.filepath == "":
+        if style_elements and self.filepath == "" and tool.Style.has_blender_external_style(style_elements):
+            external_style = style_elements["IfcExternallyDefinedSurfaceStyle"]
             style_path = Path(tool.Ifc.resolve_uri(external_style.Location))
             self.directory = str(style_path.parent)
             self.filepath = str(style_path)
@@ -310,6 +316,9 @@ class BrowseExternalStyle(bpy.types.Operator):
         attributes["Location"].string_value = filepath
         attributes["Identification"].string_value = f"{self.data_block_type}/{self.data_block}"
         attributes["Name"].string_value = self.data_block
+
+        style = tool.Ifc.get().by_id(self.active_surface_style_id)
+        bpy.ops.bim.activate_external_style(material_name=tool.Ifc.get_object(style).name)
         return {"FINISHED"}
 
 
@@ -325,14 +334,23 @@ class ActivateExternalStyle(bpy.types.Operator, tool.Ifc.Operator):
             material = context.active_object.active_material
         else:
             material = bpy.data.materials[self.material_name]
-        external_style = tool.Style.get_style_elements(material)["IfcExternallyDefinedSurfaceStyle"]
-        data_block_type, data_block = external_style.Identification.split("/")
-        style_path = Path(tool.Ifc.resolve_uri(external_style.Location))
+
+        props = context.scene.BIMStylesProperties
+        if props.is_editing:
+            location = props.external_style_attributes["Location"].string_value
+            identification = props.external_style_attributes["Identification"].string_value
+        else:
+            external_style = tool.Style.get_style_elements(material)["IfcExternallyDefinedSurfaceStyle"]
+            location = external_style.Location
+            identification = external_style.Identification
+
+        data_block_type, data_block = identification.split("/")
+        style_path = Path(tool.Ifc.resolve_uri(location))
 
         if style_path.suffix != ".blend":
             self.report(
                 {"ERROR"},
-                f"Error loading external style for \"{material.name}\" - only Blender external styles are supported",
+                f'Error loading external style for "{material.name}" - only Blender external styles are supported',
             )
             return {"CANCELLED"}
 
@@ -587,7 +605,8 @@ class EnableEditingSurfaceStyle(bpy.types.Operator, tool.Ifc.Operator):
         props.is_editing_class = self.ifc_class
         tool.Style.set_surface_style_props()
 
-        surface_style = tool.Style.get_style_elements(style).get(self.ifc_class, None)
+        style_elements = tool.Style.get_style_elements(style)
+        surface_style = style_elements.get(self.ifc_class, None)
         attributes = tool.Style.get_style_ui_props_attributes(self.ifc_class)
 
         # lighting style require special handling since Attribute doesn't support colors
@@ -607,6 +626,17 @@ class EnableEditingSurfaceStyle(bpy.types.Operator, tool.Ifc.Operator):
             attributes.clear()
             blenderbim.bim.helper.import_attributes2(surface_style or self.ifc_class, attributes, callback)
 
+        material = tool.Ifc.get_object(style)
+        active_style_type = material.BIMStyleProperties.active_style_type
+        if self.ifc_class == "IfcExternallyDefinedSurfaceStyle" and active_style_type != "External":
+            if tool.Style.has_blender_external_style(style_elements):
+                switch_shading(material, "External")
+        elif (
+            self.ifc_class in ("IfcSurfaceStyleShading", "IfcSurfaceStyleRendering", "IfcSurfaceStyleWithTextures")
+            and active_style_type != "Shading"
+        ):
+            switch_shading(material, "Shading")
+
 
 class EditSurfaceStyle(bpy.types.Operator, tool.Ifc.Operator):
     bl_idname = "bim.edit_surface_style"
@@ -631,6 +661,10 @@ class EditSurfaceStyle(bpy.types.Operator, tool.Ifc.Operator):
         self.props.is_editing_style = 0
         core.load_styles(tool.Style, style_type=self.props.style_type)
 
+        # restore selected style type
+        material = tool.Ifc.get_object(self.style)
+        material.BIMStyleProperties.active_style_type = material.BIMStyleProperties.active_style_type
+
     def edit_existing_style(self):
         material = tool.Ifc.get_object(self.style)
         if self.surface_style.is_a() == "IfcSurfaceStyleShading":

src/blenderbim/blenderbim/bim/module/style/prop.py

@@ -33,6 +33,8 @@ from bpy.props import (
 )
 
 import gettext
+from typing import Literal
+
 
 _ = gettext.gettext
 
@@ -251,19 +253,15 @@ class BIMStylesProperties(PropertyGroup):
     )
 
 
-def update_shading_style(self, context):
-    blender_material = self.id_data
-    style_elements = tool.Style.get_style_elements(blender_material)
-    if self.active_style_type == "External":
-        if tool.Style.has_blender_external_style(style_elements):
-            try:
-                bpy.ops.bim.activate_external_style(material_name=blender_material.name)
-            except RuntimeError as error:
-                if str(error).startswith("Error: Error loading external style for "):
-                    return
-                raise error
-
-    elif self.active_style_type == "Shading":
+def switch_shading(blender_material: bpy.types.Material, style_type: Literal["External", "Shading"]) -> None:
+    if style_type == "External":
+        try:
+            bpy.ops.bim.activate_external_style(material_name=blender_material.name)
+        except RuntimeError as error:
+            if str(error).startswith("Error: Error loading external style for "):
+                return
+            raise error
+    elif style_type == "Shading":
         style_elements = tool.Style.get_style_elements(blender_material)
         rendering_style = None
         texture_style = None
@@ -279,6 +277,16 @@ def update_shading_style(self, context):
 
         if rendering_style and texture_style:
             tool.Loader.create_surface_style_with_textures(blender_material, rendering_style, texture_style)
+
+
+def update_shading_style(self, context):
+    blender_material = self.id_data
+    style_elements = tool.Style.get_style_elements(blender_material)
+    if self.active_style_type == "External":
+        if tool.Style.has_blender_external_style(style_elements):
+            switch_shading(blender_material, self.active_style_type)
+    elif self.active_style_type == "Shading":
+        switch_shading(blender_material, self.active_style_type)
     tool.Style.record_shading(blender_material)
 
 

src/blenderbim/blenderbim/bim/module/type/operator.py

@@ -146,23 +146,51 @@ class SelectType(bpy.types.Operator):
     relating_type: bpy.props.IntProperty()
 
     def execute(self, context):
-        element = tool.Ifc.get().by_id(self.relating_type)
-        obj = tool.Ifc.get_object(element)
-        if obj:
-            try:
-                tool.Blender.select_and_activate_single_object(context, obj)
-            except:
-                self.report({"INFO"}, "Type object is hidden.")
-        # IfcTypeProducts are only used for annotations and not part of the model interface.
-        if element.is_a() != "IfcTypeProduct":
-            try:
-                context.scene.BIMModelProperties.ifc_class = element.is_a()
-                context.scene.BIMModelProperties.relating_type_id = str(self.relating_type)
-            except:
-                # Potentially our BIM Tool is filtered to a specific element.
-                pass
+
+        if self.relating_type: #if operator button sends a relating_type, the iterator only selects this one type
+            element = tool.Ifc.get().by_id(self.relating_type)
+            obj = tool.Ifc.get_object(element)
+            selected_objs = [obj]
+        else:    #else, the iterator selects all the types of all the selected objects
+            selected_objs = context.selected_objects
+            active_obj = context.active_object
+            selected_objs.append(active_obj) #update selected_objs so the active_obj is at the end of the list
+        
+        last_relating_type_obj = None
+        types_collection_in_view_layer = self.find_collection_in_ifcproject(context, collection_name = "Types")
+        types_collection_in_view_layer.hide_viewport = False
+        types_collection = bpy.data.collections.get("Types")
+        for type_obj in types_collection.objects:
+            type_obj.hide_set(True)
+        for obj in selected_objs:
+            element = tool.Ifc.get_entity(obj)
+            relating_type = ifcopenshell.util.element.get_type(element)
+            if relating_type:
+                relating_type_obj = tool.Ifc.get_object(relating_type)
+                if relating_type_obj:
+                    if relating_type_obj.hide_get():  
+                        relating_type_obj.hide_set(False)  
+                    relating_type_obj.select_set(True)  
+                    last_relating_type_obj = relating_type_obj
+            if not element.is_a("IfcTypeObject"): 
+                obj.select_set(False)
+
+        context.view_layer.objects.active = last_relating_type_obj #makes the active_obj's type the active object
+
         return {"FINISHED"}
 
+    def find_collection_in_ifcproject(self, context, collection_name):
+
+        ifc_project_collection = None
+        for child in context.view_layer.layer_collection.children:
+            if "IfcProject" in child.name:
+                ifc_project_collection = child
+                break
+        
+        if ifc_project_collection:
+            collection_in_view_layer = ifc_project_collection.children.get(collection_name)
+            return collection_in_view_layer
+
 
 class SelectSimilarType(bpy.types.Operator):
     bl_idname = "bim.select_similar_type"

src/blenderbim/blenderbim/bim/module/type/ui.py

@@ -88,7 +88,7 @@ class BIM_PT_type(Panel):
             if TypeData.data["relating_type"]:
                 row.label(text=TypeData.data["relating_type"]["name"])
                 op = row.operator("bim.select_type", icon="OBJECT_DATA", text="")
-                op.relating_type = TypeData.data["relating_type"]["id"]
+                op.relating_type = 0 #will only select the relating types of only the selected objects 
                 row.operator("bim.select_similar_type", icon="RESTRICT_SELECT_OFF", text="")
                 row.operator("bim.enable_editing_type", icon="GREASEPENCIL", text="")
                 row.operator("bim.unassign_type", icon="X", text="")

src/blenderbim/blenderbim/core/drawing.py

@@ -145,7 +145,7 @@ def rename_sheet(ifc, drawing, sheet: ifcopenshell.entity_instance, identificati
 
 
 def rename_reference(ifc, drawing, reference=None, identification=None):
-    attributes = drawing.generate_reference_attributes(reference, Identifiaction=identification)
+    attributes = drawing.generate_reference_attributes(reference, Identification=identification)
     ifc.run("document.edit_reference", reference=reference, attributes=attributes)
 
 

src/blenderbim/blenderbim/tool/geometry.py

@@ -23,9 +23,14 @@ import hashlib
 import logging
 import numpy as np
 import ifcopenshell
+import ifcopenshell.api
+import ifcopenshell.util.element
+import ifcopenshell.util.system
 import blenderbim.core.tool
+import blenderbim.core.drawing
 import blenderbim.core.style
 import blenderbim.core.spatial
+import blenderbim.core.system
 import blenderbim.core.geometry
 import blenderbim.tool as tool
 import blenderbim.bim.import_ifc

src/blenderbim/blenderbim/tool/search.py

@@ -160,10 +160,16 @@ class ImportFilterQueryTransformer(lark.Transformer):
         return args[0]
 
     def instance(self, args):
-        return {"type": "instance", "value": " ".join([a.children[0].value for a in args])}
+        if args[0].data == "not":
+            return {"type": "instance", "value": "!" + args[1].children[0].value}
+        else:
+            return {"type": "instance", "value": args[0].children[0].value}
 
     def entity(self, args):
-        return {"type": "entity", "value": " ".join([a.children[0].value for a in args])}
+        if args[0].data == "not":
+            return {"type": "entity", "value": "!" + args[1].children[0].value}
+        else:
+            return {"type": "entity", "value": args[0].children[0].value}
 
     def attribute(self, args):
         name, comparison, value = args

src/blenderbim/blenderbim/tool/system.py

@@ -17,6 +17,7 @@
 # along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
 
 import bpy
+import ifcopenshell.util.element
 import ifcopenshell.util.system
 import blenderbim.core.tool
 import blenderbim.tool as tool
@@ -145,7 +146,7 @@ class System(blenderbim.core.tool.System):
             new.ifc_class = system.is_a()
 
     @classmethod
-    def load_ports(cls, element, ports):
+    def load_ports(cls, element: ifcopenshell.entity_instance, ports: list[ifcopenshell.entity_instance]) -> None:
         if not ports:
             return
         obj = tool.Ifc.get_object(element)
@@ -155,7 +156,13 @@ class System(blenderbim.core.tool.System):
         ifc_importer.calculate_unit_scale()
         ifc_importer.process_context_filter()
         ifc_importer.create_generic_elements(set(ports))
+
+        container = ifcopenshell.util.element.get_container(element)
+        if container:
+            collection = tool.Ifc.get_object(container).BIMObjectProperties.collection
+            ifc_importer.collections[container.GlobalId] = collection
         ifc_importer.place_objects_in_collections()
+
         for port_obj in ifc_importer.added_data.values():
             port_obj.parent = obj
             port_obj.matrix_parent_inverse = obj.matrix_world.inverted()

src/blenderbim/docs/_static/custom.css

@@ -16,6 +16,7 @@ a {
 }
 .sidebar-brand-text {
     font-size: 1rem;
+    text-align: center;
 }
 .blockbutton {
     max-width: 500px;

src/blenderbim/docs/conf.py

@@ -95,7 +95,10 @@ html_theme_options = {
         "color-background-border": "#cfd0cb",
         "color-foreground-primary": "#2e3436",
         "color-sidebar-item-background--hover": "#f7f7f6",
+        "color-link": "#39b54a",
+        "color-link--visited": "#39b54a",
         "color-link--hover": "#d98014",
+        "color-link--visited--hover": "#d98014",
         "font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
     },
     "dark_css_variables": {
@@ -106,7 +109,10 @@ html_theme_options = {
         "color-background-border": "#2e3436",
         "color-foreground-primary": "#eeeeec",
         "color-sidebar-item-background--hover": "#2e3436",
+        "color-link": "#39b54a",
+        "color-link--visited": "#39b54a",
         "color-link--hover": "#d98014",
+        "color-link--visited--hover": "#d98014",
         "font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
     },
 

src/blenderbim/docs/devs/installation.rst

@@ -92,13 +92,14 @@ For Linux or Mac:
     $ ln -s $PWD/src/blenderbim/blenderbim/tool $BLENDER_ADDON_PATH/tool
     $ ln -s $PWD/src/blenderbim/blenderbim/bim $BLENDER_ADDON_PATH/bim
 
-    # Remove the IfcOpenShell dependency Python code
-    $ rm -r $BLENDER_ADDON_PATH/libs/site/packages/ifcopenshell/api
-    $ rm -r $BLENDER_ADDON_PATH/libs/site/packages/ifcopenshell/util
+    # Copy over compiled IfcOpenShell files
+    $ cp $BLENDER_ADDON_PATH/libs/site/packages/ifcopenshell/*_wrapper* $PWD/src/ifcopenshell-python/ifcopenshell/
+    
+    # Remove the IfcOpenShell dependency
+    $ rm -r $BLENDER_ADDON_PATH/libs/site/packages/ifcopenshell
 
     # Replace them with links to the Git repository
-    $ ln -s $PWD/src/ifcopenshell-python/ifcopenshell/api $BLENDER_ADDON_PATH/libs/site/packages/ifcopenshell/api
-    $ ln -s $PWD/src/ifcopenshell-python/ifcopenshell/util $BLENDER_ADDON_PATH/libs/site/packages/ifcopenshell/util
+    $ ln -s $PWD/src/ifcopenshell-python/ifcopenshell $BLENDER_ADDON_PATH/libs/site/packages/ifcopenshell
 
     # Remove and link other IfcOpenShell utilities
     $ rm -r $BLENDER_ADDON_PATH/libs/site/packages/ifccsv.py
@@ -153,21 +154,19 @@ Before running it follow the instructions descibed after `rem` tags.
     rd /S /Q "%blenderbim%\tool\"
     rd /S /Q "%blenderbim%\bim\"
 
-
     echo Replacing them with links to the Git repository...
     mklink /D "%blenderbim%\core" "%cd%\src\blenderbim\blenderbim\core"
     mklink /D "%blenderbim%\tool" "%cd%\src\blenderbim\blenderbim\tool"
     mklink /D "%blenderbim%\bim" "%cd%\src\blenderbim\blenderbim\bim"
 
+    echo Copy over compiled IfcOpenShell files...
+    copy "%blenderbim%\libs\site\packages\ifcopenshell\*_wrapper*" "%cd%\src\ifcopenshell-python\ifcopenshell\"
 
-    echo Remove the IfcOpenShell dependency Python code...
-    rd /S /Q "%blenderbim%\libs\site\packages\ifcopenshell\api"
-    rd /S /Q "%blenderbim%\libs\site\packages\ifcopenshell\util"
+    echo Remove the IfcOpenShell dependency...
+    rd /S /Q "%blenderbim%\libs\site\packages\ifcopenshell"
 
-
-    echo Replacing them with links to the Git repository...
-    mklink /D "%blenderbim%\libs\site\packages\ifcopenshell\api" "%cd%\src\ifcopenshell-python\ifcopenshell\api"
-    mklink /D "%blenderbim%\libs\site\packages\ifcopenshell\util" "%cd%\src\ifcopenshell-python\ifcopenshell\util"
+    echo Replace them with links to the Git repository...
+    mklink /D "%blenderbim%\libs\site\packages\ifcopenshell" "%cd%\src\ifcopenshell-python\ifcopenshell"
 
     echo Remove and link other IfcOpenShell utilities...
     del "%blenderbim%\libs\site\packages\ifccsv.py"

src/blenderbim/scripts/generate_au_library.py

@@ -40,7 +40,7 @@ class LibraryGenerator:
             "root.create_entity", self.file, ifc_class="IfcProjectLibrary", name="Australian Library"
         )
         ifcopenshell.api.run(
-            "project.assign_declaration", self.file, definition=self.library, relating_context=self.project
+            "project.assign_declaration", self.file, definitions=[self.library], relating_context=self.project
         )
         unit = ifcopenshell.api.run("unit.add_si_unit", self.file, unit_type="LENGTHUNIT", prefix="MILLI")
         ifcopenshell.api.run("unit.assign_unit", self.file, units=[unit])
@@ -196,7 +196,7 @@ class LibraryGenerator:
             )
             layer.Name = layer_data[0]
             layer.LayerThickness = layer_data[2]
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
         return element
 
     def create_layer_type(self, ifc_class, name, thickness):
@@ -205,7 +205,7 @@ class LibraryGenerator:
         layer_set = rel.RelatingMaterial
         layer = ifcopenshell.api.run("material.add_layer", self.file, layer_set=layer_set, material=self.materials["TBD"]["ifc"])
         layer.LayerThickness = thickness
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
         return element
 
     def create_profile_type(self, ifc_class, name, profile):
@@ -216,7 +216,7 @@ class LibraryGenerator:
             "material.add_profile", self.file, profile_set=profile_set, material=self.materials["TBD"]["ifc"]
         )
         ifcopenshell.api.run("material.assign_profile", self.file, material_profile=material_profile, profile=profile)
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
 
     def create_type(self, ifc_class, name, representations):
         element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class=ifc_class, name=name)
@@ -248,7 +248,7 @@ class LibraryGenerator:
             ifcopenshell.api.run(
                 "geometry.assign_representation", self.file, product=element, representation=representation
             )
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
 
 
 LibraryGenerator().generate()

src/blenderbim/scripts/generate_demo_library.py

@@ -35,7 +35,7 @@ class LibraryGenerator:
             "root.create_entity", self.file, ifc_class="IfcProjectLibrary", name="BlenderBIM Demo Library"
         )
         ifcopenshell.api.run(
-            "project.assign_declaration", self.file, definition=self.library, relating_context=self.project
+            "project.assign_declaration", self.file, definitions=[self.library], relating_context=self.project
         )
         ifcopenshell.api.run("unit.assign_unit", self.file, length={"is_metric": True, "raw": "METERS"})
         model = ifcopenshell.api.run("context.add_context", self.file, context_type="Model")
@@ -209,7 +209,7 @@ class LibraryGenerator:
         layer_set = rel.RelatingMaterial
         layer = ifcopenshell.api.run("material.add_layer", self.file, layer_set=layer_set, material=self.material)
         layer.LayerThickness = thickness
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
         return element
 
     def create_profile_type(self, ifc_class, name, profile):
@@ -220,7 +220,7 @@ class LibraryGenerator:
             "material.add_profile", self.file, profile_set=profile_set, material=self.material
         )
         ifcopenshell.api.run("material.assign_profile", self.file, material_profile=material_profile, profile=profile)
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
 
     def create_type(self, ifc_class, name, representations):
         element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class=ifc_class, name=name)
@@ -252,7 +252,7 @@ class LibraryGenerator:
             ifcopenshell.api.run(
                 "geometry.assign_representation", self.file, product=element, representation=representation
             )
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
 
 
 LibraryGenerator().generate()

src/blenderbim/scripts/generate_entourage_library.py

@@ -42,7 +42,7 @@ class LibraryGenerator:
             "root.create_entity", self.file, ifc_class="IfcProjectLibrary", name=library_name
         )
         ifcopenshell.api.run(
-            "project.assign_declaration", self.file, definition=self.library, relating_context=self.project
+            "project.assign_declaration", self.file, definitions=[self.library], relating_context=self.project
         )
         unit = ifcopenshell.api.run("unit.add_si_unit", self.file, unit_type="LENGTHUNIT", prefix="MILLI")
         ifcopenshell.api.run("unit.assign_unit", self.file, units=[unit])
@@ -131,7 +131,7 @@ class LibraryGenerator:
             ifcopenshell.api.run(
                 "geometry.assign_representation", self.file, product=element, representation=representation
             )
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
 
 
 if __name__ == "__main__":

src/blenderbim/scripts/generate_furniture_library.py

@@ -37,7 +37,7 @@ class LibraryGenerator:
             "root.create_entity", self.file, ifc_class="IfcProjectLibrary", name=library_name
         )
         ifcopenshell.api.run(
-            "project.assign_declaration", self.file, definition=self.library, relating_context=self.project
+            "project.assign_declaration", self.file, definitions=[self.library], relating_context=self.project
         )
         unit = ifcopenshell.api.run("unit.add_si_unit", self.file, unit_type="LENGTHUNIT", prefix="MILLI")
         ifcopenshell.api.run("unit.assign_unit", self.file, units=[unit])
@@ -1797,7 +1797,7 @@ class LibraryGenerator:
         ifcopenshell.api.run(
             "geometry.assign_representation", self.file, product=element, representation=representation_2d
         )
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
         return element
 
     def create_layer_set_type(self, name, data):
@@ -1811,7 +1811,7 @@ class LibraryGenerator:
             )
             layer.Name = layer_data[0]
             layer.LayerThickness = layer_data[2]
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
         return element
 
     def create_layer_type(self, ifc_class, name, thickness):
@@ -1822,7 +1822,7 @@ class LibraryGenerator:
             "material.add_layer", self.file, layer_set=layer_set, material=self.materials["TBD"]["ifc"]
         )
         layer.LayerThickness = thickness
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
         return element
 
     def create_profile_type(self, ifc_class, name, profile):
@@ -1837,7 +1837,7 @@ class LibraryGenerator:
             # material=self.materials["TBD"]["ifc"]
         )
         ifcopenshell.api.run("material.assign_profile", self.file, material_profile=material_profile, profile=profile)
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
 
     def create_type(self, ifc_class, name, representations):
         element = ifcopenshell.api.run("root.create_entity", self.file, ifc_class=ifc_class, name=name)
@@ -1869,7 +1869,7 @@ class LibraryGenerator:
             ifcopenshell.api.run(
                 "geometry.assign_representation", self.file, product=element, representation=representation
             )
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
 
 
 if __name__ == "__main__":

src/blenderbim/scripts/generate_landscape_library.py

@@ -319,7 +319,7 @@ class LibraryGenerator:
             "root.create_entity", self.file, ifc_class="IfcProjectLibrary", name=library_name
         )
         ifcopenshell.api.run(
-            "project.assign_declaration", self.file, definition=self.library, relating_context=self.project
+            "project.assign_declaration", self.file, definitions=[self.library], relating_context=self.project
         )
         unit = ifcopenshell.api.run("unit.add_si_unit", self.file, unit_type="LENGTHUNIT", prefix="MILLI")
         ifcopenshell.api.run("unit.assign_unit", self.file, units=[unit])
@@ -447,7 +447,7 @@ class LibraryGenerator:
         ifcopenshell.api.run(
             "geometry.assign_representation", self.file, product=element, representation=representation_2d
         )
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
         return element
 
     def create_type(self, ifc_class, name, representations):
@@ -480,7 +480,7 @@ class LibraryGenerator:
             ifcopenshell.api.run(
                 "geometry.assign_representation", self.file, product=element, representation=representation
             )
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
 
 
 

src/blenderbim/scripts/generate_site_library.py

@@ -35,7 +35,7 @@ class LibraryGenerator:
             "root.create_entity", self.file, ifc_class="IfcProjectLibrary", name="BlenderBIM Demo Library"
         )
         ifcopenshell.api.run(
-            "project.assign_declaration", self.file, definition=self.library, relating_context=self.library
+            "project.assign_declaration", self.file, definitions=[self.library], relating_context=self.library
         )
         ifcopenshell.api.run("unit.assign_unit", self.file, length={"is_metric": True, "raw": "METERS"})
         model = ifcopenshell.api.run("context.add_context", self.file, context_type="Model")
@@ -98,7 +98,7 @@ class LibraryGenerator:
             ifcopenshell.api.run(
                 "geometry.assign_representation", self.file, product=element, representation=representation
             )
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
 
 
 LibraryGenerator().generate()

src/blenderbim/scripts/generate_steel_profiles_library.py

@@ -43,7 +43,7 @@ class LibraryGenerator:
             "root.create_entity", self.file, ifc_class="IfcProjectLibrary", name=f"{parse_profiles_type} Steel Profiles Library"
         )
         ifcopenshell.api.run(
-            "project.assign_declaration", self.file, definition=self.library, relating_context=self.project
+            "project.assign_declaration", self.file, definitions=[self.library], relating_context=self.project
         )
         dim_exponents = self.file.createIfcDimensionalExponents(0, 0, 0, 0, 0, 0, 0)
         length_unit = ifcopenshell.api.run("unit.add_si_unit", self.file, unit_type="LENGTHUNIT", prefix="MILLI")
@@ -182,7 +182,7 @@ class LibraryGenerator:
             # material=self.materials["TBD"]["ifc"]
         )
         ifcopenshell.api.run("material.assign_profile", self.file, material_profile=material_profile, profile=profile)
-        ifcopenshell.api.run("project.assign_declaration", self.file, definition=element, relating_context=self.library)
+        ifcopenshell.api.run("project.assign_declaration", self.file, definitions=[element], relating_context=self.library)
 
     def create_double_l_profile(self, profile, resulting_profile_name=None, profiles_gap=0, mode = "LLBB"):
         def create_derived_profile(profile, mirrored=False):

src/blenderbim/scripts/shape_builder_examples.py

@@ -91,7 +91,7 @@ def mirror_placement_test():
     library = ifcopenshell.api.run(
         "root.create_entity", ifc_file, ifc_class="IfcProjectLibrary", name=f"Non-structural assets library"
     )
-    ifcopenshell.api.run("project.assign_declaration", ifc_file, definition=library, relating_context=project)
+    ifcopenshell.api.run("project.assign_declaration", ifc_file, definitions=[library], relating_context=project)
     unit = ifcopenshell.api.run("unit.add_si_unit", ifc_file, unit_type="LENGTHUNIT", prefix="MILLI")
     ifcopenshell.api.run("unit.assign_unit", ifc_file, units=[unit])
     model = ifcopenshell.api.run("context.add_context", ifc_file, context_type="Model")
@@ -152,7 +152,7 @@ def mirror_placement_test():
 
     element = ifcopenshell.api.run("root.create_entity", ifc_file, ifc_class="IfcFurnitureType", name="test")
     ifcopenshell.api.run("geometry.assign_representation", ifc_file, product=element, representation=representation_3d)
-    ifcopenshell.api.run("project.assign_declaration", ifc_file, definition=element, relating_context=library)
+    ifcopenshell.api.run("project.assign_declaration", ifc_file, definitions=[element], relating_context=library)
 
     ifc_file.write("tmp.ifc")
 
@@ -165,7 +165,7 @@ def curve_between_two_points_test():
     library = ifcopenshell.api.run(
         "root.create_entity", ifc_file, ifc_class="IfcProjectLibrary", name=f"Non-structural assets library"
     )
-    ifcopenshell.api.run("project.assign_declaration", ifc_file, definition=library, relating_context=project)
+    ifcopenshell.api.run("project.assign_declaration", ifc_file, definitions=[library], relating_context=project)
     unit = ifcopenshell.api.run("unit.add_si_unit", ifc_file, unit_type="LENGTHUNIT", prefix="MILLI")
     ifcopenshell.api.run("unit.assign_unit", ifc_file, units=[unit])
     model = ifcopenshell.api.run("context.add_context", ifc_file, context_type="Model")
@@ -217,7 +217,7 @@ def curve_between_two_points_test():
     print(representation_2d)
     element = ifcopenshell.api.run("root.create_entity", ifc_file, ifc_class="IfcFurnitureType", name="test")
     ifcopenshell.api.run("geometry.assign_representation", ifc_file, product=element, representation=representation_2d)
-    ifcopenshell.api.run("project.assign_declaration", ifc_file, definition=element, relating_context=library)
+    ifcopenshell.api.run("project.assign_declaration", ifc_file, definitions=[element], relating_context=library)
 
     ifc_file.write("tmp.ifc")
 

src/ifccsv/ifccsv.py

@@ -61,20 +61,20 @@ class IfcCsv:
 
     def export(
         self,
-        ifc_file,
-        elements,
+        ifc_file: ifcopenshell.file,
+        elements: ifcopenshell.entity_instance,
         attributes,
         headers=None,
         output=None,
         format=None,
-        should_preserve_existing=False,
-        include_global_id=True,
-        delimiter=",",
-        null="-",
-        empty="",
-        bool_true="YES",
-        bool_false="NO",
-        concat=", ",
+        should_preserve_existing: bool = False,
+        include_global_id: bool = True,
+        delimiter: str = ",",
+        null: str = "-",
+        empty: str = "",
+        bool_true: str = "YES",
+        bool_false: str = "NO",
+        concat: str = ", ",
         sort=None,
         groups=None,
         summaries=None,
@@ -382,8 +382,16 @@ class IfcCsv:
         return ["{}.{}".format(pset_qto_name, n) for n in results]
 
     def Import(
-        self, ifc_file, table, attributes=None, delimiter=",", null="-", empty="", bool_true="YES", bool_false="NO"
-    ):
+        self,
+        ifc_file: ifcopenshell.file,
+        table: str,
+        attributes: Optional[list[Union[str, None]]] = None,
+        delimiter: str = ",",
+        null: str = "-",
+        empty: str = "",
+        bool_true: str = "YES",
+        bool_false: str = "NO",
+    ) -> None:
         ext = table.split(".")[-1].lower()
 
         if ext == "csv":

src/ifcgeom/IfcGeom.cpp

@@ -549,6 +549,36 @@ IfcSchema::IfcRelVoidsElement::list::ptr IfcGeom::Kernel::find_openings(IfcSchem
 	return openings;
 }
 
+namespace {
+	template <typename T>
+	IfcSchema::IfcMaterial* get_single_from_aggregate(bool take_first_regardless_of_size, const T& agg) {
+		if (take_first_regardless_of_size ? agg->size() >= 1 : agg->size() == 1) {
+			auto* layer_or_profile = *agg->begin();
+			if (layer_or_profile->Material()) {
+				return layer_or_profile->Material();
+			}
+		}
+		return nullptr;
+	}
+#ifdef SCHEMA_HAS_IfcMaterialProfileSet
+	IfcSchema::IfcMaterial* get_single_from_set(bool take_first_regardless_of_size, IfcSchema::IfcMaterialProfileSet* profileset) {
+		return get_single_from_aggregate(take_first_regardless_of_size, profileset->MaterialProfiles());
+	}
+#endif
+	IfcSchema::IfcMaterial* get_single_from_set(bool take_first_regardless_of_size, IfcSchema::IfcMaterialLayerSet* profileset) {
+		return get_single_from_aggregate(take_first_regardless_of_size, profileset->MaterialLayers());
+	}
+
+	IfcSchema::IfcMaterial* get_single_from_usage(bool take_first_regardless_of_size, IfcSchema::IfcMaterialLayerSetUsage* usage) {
+		return get_single_from_set(take_first_regardless_of_size, usage->ForLayerSet());
+	}
+#ifdef SCHEMA_HAS_IfcMaterialProfileSet
+	IfcSchema::IfcMaterial* get_single_from_usage(bool take_first_regardless_of_size, IfcSchema::IfcMaterialProfileSetUsage* usage) {
+		return get_single_from_set(take_first_regardless_of_size, usage->ForProfileSet());
+	}
+#endif
+}
+
 const IfcSchema::IfcMaterial* IfcGeom::Kernel::get_single_material_association(const IfcSchema::IfcProduct* product) {
 	IfcSchema::IfcMaterial* single_material = 0;
 	IfcSchema::IfcRelAssociatesMaterial::list::ptr associated_materials = product->HasAssociations()->as<IfcSchema::IfcRelAssociatesMaterial>();
@@ -566,14 +596,19 @@ const IfcSchema::IfcMaterial* IfcGeom::Kernel::get_single_material_association(c
 			single_material = associated_material->as<IfcSchema::IfcMaterial>();
 			// NB: IfcMaterialLayerSets are also considered, regardless of --enable-layerset-slicing. Picking
 			// the first material (in accordance with other viewers) when layerset-slicing is disabled.
-			if (!single_material && associated_material->as<IfcSchema::IfcMaterialLayerSetUsage>()) {
-				IfcSchema::IfcMaterialLayerSet* layerset = associated_material->as<IfcSchema::IfcMaterialLayerSetUsage>()->ForLayerSet();
-				if (getValue(GV_LAYERSET_FIRST) > 0.0 ? layerset->MaterialLayers()->size() >= 1 : layerset->MaterialLayers()->size() == 1) {
-					IfcSchema::IfcMaterialLayer* layer = (*layerset->MaterialLayers()->begin());
-					if (layer->Material()) {
-						single_material = layer->Material();
-					}
+			if (!single_material) {
+				if (auto* m = associated_material->as<IfcSchema::IfcMaterialLayerSetUsage>()) {
+					single_material = get_single_from_usage(getValue(GV_LAYERSET_FIRST) > 0.0, m);
+				} else if (auto* m = associated_material->as<IfcSchema::IfcMaterialLayerSet>()) {
+					single_material = get_single_from_set(getValue(GV_LAYERSET_FIRST) > 0.0, m);
 				}
+#ifdef SCHEMA_HAS_IfcMaterialProfileSet
+				else if (auto* m = associated_material->as<IfcSchema::IfcMaterialProfileSetUsage>()) {
+					single_material = get_single_from_usage(getValue(GV_LAYERSET_FIRST) > 0.0, m);
+				} else if (auto* m = associated_material->as<IfcSchema::IfcMaterialProfileSet>()) {
+					single_material = get_single_from_set(getValue(GV_LAYERSET_FIRST) > 0.0, m);
+				}
+#endif
 			}
 		}
 	}

src/ifcopenshell-python/docs/_autoapi_templates/index.rst

@@ -0,0 +1,16 @@
+Python API Reference
+====================
+
+This page contains auto-generated API reference documentation [#f1]_.
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   {% for page in pages %}
+   {% if page.top_level_object and page.display %}
+   {{ page.include_path }}
+   {% endif %}
+   {% endfor %}
+
+.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

src/ifcopenshell-python/docs/_autoapi_templates/python/module.rst

@@ -0,0 +1,114 @@
+{% if not obj.display %}
+:orphan:
+
+{% endif %}
+:py:mod:`{{ obj.name }}`
+=========={{ "=" * obj.name|length }}
+
+.. py:module:: {{ obj.name }}
+
+{% if obj.docstring %}
+.. autoapi-nested-parse::
+
+   {{ obj.docstring|indent(3) }}
+
+{% endif %}
+
+{% block subpackages %}
+{% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
+{% if visible_subpackages %}
+Subpackages
+-----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+{% for subpackage in visible_subpackages %}
+   {{ subpackage.short_name }}/index.rst
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% block submodules %}
+{% set visible_submodules = obj.submodules|selectattr("display")|list %}
+{% if visible_submodules %}
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+{% for submodule in visible_submodules %}
+   {{ submodule.short_name }}/index.rst
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% block content %}
+{% if obj.all is not none %}
+{% set visible_children = obj.children|selectattr("short_name", "in", obj.all)|list %}
+{% elif obj.type is equalto("package") %}
+{% set visible_children = obj.children|selectattr("display")|list %}
+{% else %}
+{% set visible_children = obj.children|selectattr("display")|rejectattr("imported")|list %}
+{% endif %}
+{% if visible_children %}
+{{ obj.type|title }} Contents
+{{ "-" * obj.type|length }}---------
+
+{% set visible_classes = visible_children|selectattr("type", "equalto", "class")|list %}
+{% set visible_functions = visible_children|selectattr("type", "equalto", "function")|list %}
+{% set visible_attributes = visible_children|selectattr("type", "equalto", "data")|list %}
+{% if "show-module-summary" in autoapi_options and (visible_classes or visible_functions) %}
+{% block classes scoped %}
+{% if visible_classes %}
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+{% for klass in visible_classes %}
+   {{ klass.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+
+{% block functions scoped %}
+{% if visible_functions %}
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+{% for function in visible_functions %}
+   {{ function.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+
+{% block attributes scoped %}
+{% if visible_attributes %}
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+{% for attribute in visible_attributes %}
+   {{ attribute.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% endif %}
+{% for obj_item in visible_children %}
+{{ obj_item.render()|indent(0) }}
+{% endfor %}
+{% endif %}
+{% endblock %}

src/ifcopenshell-python/docs/_static/custom.css

@@ -8,6 +8,9 @@ h1, h2, h3, h4 {
     -webkit-background-clip: text;
     -webkit-text-fill-color: transparent;
 }
+h1 code.literal {
+    background: none;
+}
 a {
     text-decoration: none;
 }
@@ -16,6 +19,7 @@ a {
 }
 .sidebar-brand-text {
     font-size: 1rem;
+    text-align: center;
 }
 .blockbutton {
     max-width: 500px;
@@ -47,14 +51,32 @@ section img {
     box-shadow: rgba(0, 0, 0, 0.24) 0px 3px 8px;
     border-radius: 5px;
 }
+
+/* Make it clearer which signatures are part of a class */
 .py.class {
-    /* Make it clearer which signatures are part of a class */
     border-left: 3px solid var(--color-brand-primary);
 }
-.py.function, .py.method {
-    /* Make it clearer which signatures are part of a method or function */
-    border-left: 3px solid var(--color-background-item);
+.py.class > .sig {
+    background: var(--color-brand-primary) !important;
+    margin: 0;
+    border-radius: 0;
 }
+.py.class > .sig * {
+    color: #2e3436 !important;
+}
+.py.class > .sig a {
+    color: #fff;
+}
+
+/* Make it easier to spot functions and methods */
+.py.function, .py.method {
+    border-top: 1px solid var(--color-background-item);
+}
+dl.py.property, dl.py.attribute, dl.py.method, dl.py.function {
+    padding-top: 10px;
+    padding-bottom: 10px;
+}
+
 .field-list > dt {
     /* Clearly distinguish parameters otherwise it looks like a wall of text */
     color: var(--color-brand-content);

src/ifcopenshell-python/docs/conf.py

@@ -74,6 +74,9 @@ autoapi_dirs = ['../ifcopenshell', '../../bcf/src', '../../bsdd', '../../ifccsv'
 # These are auto-generated based on the IFC schema, so exclude them
 autoapi_ignore = ['*ifcopenshell/express/rules*']
 
+# Custom autoapi templates to make it easier to read our docs
+autoapi_template_dir = "_autoapi_templates"
+
 # autoapi_options doesn't have show-module-summary, as it tends to create one
 # page per function which contradicts the presentation of showing all functions
 # as a list. This creates two possible locations where a function is documented
@@ -81,7 +84,7 @@ autoapi_ignore = ['*ifcopenshell/express/rules*']
 # ifcopenshell.file is imported from ifcopenshell.file.file, but it gets pretty
 # confusing to see the docs again in multiple places (seriously,
 # ifcopenshell.file.file is everywhere).
-autoapi_options = ['members', 'undoc-members', 'private-members', 'special-members', 'show-inheritance']
+autoapi_options = ['members', 'undoc-members', 'show-inheritance', 'imported-members']
 
 # This option is set to both to allow both class docstrings and __init__ docstrings.
 autoapi_python_class_content = 'both'
@@ -130,7 +133,10 @@ html_theme_options = {
         "color-background-border": "#cfd0cb",
         "color-foreground-primary": "#2e3436",
         "color-sidebar-item-background--hover": "#f7f7f6",
+        "color-link": "#39b54a",
+        "color-link--visited": "#39b54a",
         "color-link--hover": "#d98014",
+        "color-link--visited--hover": "#d98014",
         "font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
     },
     "dark_css_variables": {
@@ -141,7 +147,10 @@ html_theme_options = {
         "color-background-border": "#2e3436",
         "color-foreground-primary": "#eeeeec",
         "color-sidebar-item-background--hover": "#2e3436",
+        "color-link": "#39b54a",
+        "color-link--visited": "#39b54a",
         "color-link--hover": "#d98014",
+        "color-link--visited--hover": "#d98014",
         "font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
     },
 

src/ifcopenshell-python/docs/ifcopenshell-python/selector_syntax.rst

@@ -116,6 +116,8 @@ the following comparison checks:
     "``>=``", "Must be greater than or equal to the value."
     "``<``", "Must be less than the value."
     "``<=``", "Must be less than or equal to the value."
+    "``*=``", "Must contain the value."
+    "``!*=``", "Must not contain the value."
 
 When you specify a ``{{pset}}``, ``{{prop}}``, or ``{{value}}``, there are
 three ways you can do so:

src/ifcopenshell-python/docs/introduction/how_to_contribute.rst

@@ -21,14 +21,15 @@ Python API documentation is autogenerated from docstrings present in the source
 code of the respective Python module.
 
 If you want to build the documentation locally, the documentation system uses
-`Sphinx <https://www.sphinx-doc.org/en/master/>`_. First, install the theme and
-theme dependencies:
+`Sphinx <https://www.sphinx-doc.org/en/master/>`_. First, install Sphinx and
+dependencies:
 
 .. code-block:: console
 
-    $ pip install furo
+    $ pip install sphinx
     $ pip install sphinx-autoapi
     $ pip install sphinx-copybutton
+    $ pip install furo
 
 Now you can generate the documentation:
 

src/ifcopenshell-python/ifcopenshell/__init__.py

@@ -16,32 +16,51 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
-"""The entry module for IfcOpenShell
+"""Welcome to IfcOpenShell! IfcOpenShell provides a way to read and write IFCs.
 
-Typically used for opening an IFC via a filepath, or accessing one of the
-submodules.
+IfcOpenShell can open IFC files, read entities (such as walls, buildings,
+properties, systems, etc), edit attributes, write out ``.ifc`` files and more.
+
+This module provides primitive functions to interact with IFC, including:
+
+- For most users, you can open and read IFC models, see docs for :func:`open`.
+  This returns an :class:`file` object representing the IFC model. You can then
+  query the model to filter elements.
+- For developers, you can query the schema itself, see docs for
+  :func:`schema_by_name`. This returns a schema object which you can use to
+  analyse the definitions of IFC classes and data types.
+
+You may also be interested in:
+
+- For model authoring and editing operations, see :mod:`ifcopenshell.api`.
+- For extracting information from models, see :mod:`ifcopenshell.util`.
+- For processing geometry, see :mod:`ifcopenshell.geom`.
+
+
+For more details, consult https://docs.ifcopenshell.org/
 
 Example:
 
 .. code:: python
 
     import ifcopenshell
-    print(ifcopenshell.version) # v0.7.0-1b1fd1e6
-    model = ifcopenshell.open("/path/to/model.ifc")
-"""
 
-from __future__ import absolute_import
-from __future__ import division
-from __future__ import print_function
+    print(ifcopenshell.version) # v0.7.0-1b1fd1e6
+
+    model = ifcopenshell.open("/path/to/model.ifc")
+    walls = model.by_type("IfcWall")
+
+    for wall in walls:
+        print(wall.Name)
+"""
 
 import os
 import sys
-import tempfile
 import zipfile
+import tempfile
 from pathlib import Path
-from typing import Optional
+from typing import Optional, Union
 
-import ifcopenshell.util.file
 
 if hasattr(os, "uname"):
     platform_system = os.uname()[0].lower()
@@ -60,22 +79,17 @@ sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "lib", p
 
 try:
     from . import ifcopenshell_wrapper
-except Exception as e:
-    if int(python_version_tuple[0]) == 2:
-        # Only for py2, as py3 has exception chaining
-        import traceback
-
-        traceback.print_exc()
-        print("-" * 64)
+except Exception:
     raise ImportError("IfcOpenShell not built for '%s'" % python_distribution)
 
-from . import guid
 from .file import file
 from .entity_instance import entity_instance, register_schema_attributes
 from .sql import sqlite, sqlite_entity
+
 try:
     from .stream import stream, stream_entity
-except: pass
+except:
+    pass
 
 READ_ERROR = ifcopenshell_wrapper.file_open_status.READ_ERROR
 NO_HEADER = ifcopenshell_wrapper.file_open_status.NO_HEADER
@@ -84,19 +98,22 @@ UNSUPPORTED_SCHEMA = ifcopenshell_wrapper.file_open_status.UNSUPPORTED_SCHEMA
 
 class Error(Exception):
     """Error used when a generic problem occurs"""
+
     pass
 
 
 class SchemaError(Error):
     """Error used when an IFC schema related problem occurs"""
+
     pass
 
 
-def open(path: "os.PathLike | str", format: str = None, should_stream: bool = False) -> file:
+def open(path: Union[os.PathLike, str], format: Optional[str] = None, should_stream: bool = False) -> file:
     """Loads an IFC dataset from a filepath
 
-    You can specify a file format. If no format is given, it is guessed from its extension.
-    Currently supported specified format : .ifc | .ifcZIP | .ifcXML
+    You can specify a file format. If no format is given, it is guessed from
+    its extension. Currently supported specified format: .ifc | .ifcZIP |
+    .ifcXML.
 
     You can then filter by element ID, class, etc, and subscript by id or guid.
 
@@ -114,7 +131,7 @@ def open(path: "os.PathLike | str", format: str = None, should_stream: bool = Fa
     """
     path = Path(path)
     if format is None:
-        format = ifcopenshell.util.file.guess_format(path)
+        format = guess_format(path)
     if format == ".ifcXML":
         f = ifcopenshell_wrapper.parse_ifcxml(str(path.absolute()))
         if f:
@@ -141,8 +158,7 @@ def open(path: "os.PathLike | str", format: str = None, should_stream: bool = Fa
             NO_HEADER: (Error, "Unable to parse IFC SPF header"),
             UNSUPPORTED_SCHEMA: (
                 SchemaError,
-                "Unsupported schema: %s"
-                % ",".join(f.header.file_schema.schema_identifiers),
+                "Unsupported schema: %s" % ",".join(f.header.file_schema.schema_identifiers),
             ),
         }[f.good().value()]
         raise exc(msg)
@@ -152,7 +168,7 @@ def create_entity(type, schema="IFC4", *args, **kwargs):
     """Creates a new IFC entity that does not belong to an IFC file object
 
     Note that it is more common to create entities within a existing file
-    object. See :meth:`ifcopenshell.file.file.create_entity`.
+    object. See :meth:`ifcopenshell.file.create_entity`.
 
     :param type: Case insensitive name of the IFC class
     :type type: string
@@ -161,7 +177,7 @@ def create_entity(type, schema="IFC4", *args, **kwargs):
     :param args: The positional arguments of the IFC class
     :param kwargs: The keyword arguments of the IFC class
     :returns: An entity instance
-    :rtype: ifcopenshell.entity_instance.entity_instance
+    :rtype: ifcopenshell.entity_instance
 
     Example:
 
@@ -226,4 +242,35 @@ def schema_by_name(
     return ifcopenshell_wrapper.schema_by_name(schema)
 
 
-from .main import *
+def guess_format(path: Path) -> Union[str | None]:
+    """Guesses the IFC format using file extension
+
+    IFCs may be serialised as different formats. The most common is a ``.ifc``
+    file, which is plaintext and stores data using the STEP Physical File
+    format. IFC can also be stored as a Zipfile, XML, JSON, or SQL.
+
+    This will return the canonical form of the format. For example, if a path
+    has the extension of .xml or .ifcxml (case insensitive), it will return
+    .ifcXML.
+
+    Users generally won't call this function. The :func:`open` function uses
+    this internally to guess the file format.
+
+    :return: Either .ifc, .ifcZIP, .ifcXML, .ifcJSON, .ifcSQLite, or None.
+    """
+    suffix = path.suffix.lower()
+    if suffix == ".ifc":
+        return ".ifc"
+    elif suffix in (".ifczip", ".zip"):
+        return ".ifcZIP"
+    elif suffix in (".ifcxml", ".xml"):
+        return ".ifcXML"
+    elif suffix in (".ifcjson", ".json"):
+        return ".ifcJSON"
+    elif suffix in (".ifcsqlite", ".sqlite", ".db"):
+        return ".ifcSQLite"
+    return None
+
+
+version = ifcopenshell_wrapper.version()
+get_log = ifcopenshell_wrapper.get_log

src/ifcopenshell-python/ifcopenshell/api/__init__.py

@@ -16,19 +16,27 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
-"""High level user-oriented IFC authoring capabilities"""
+"""High level IFC authoring and editing functions
+
+Authoring, editing, and deleting IFC data requires a detailed understanding of
+the rules of the IFC schema. This API module provides simple to use authoring
+functions that hide this complexity from you. Things like managing differences
+between IFC versions, tracking owernship changes, or cleaning up after orphaned
+relationships are all handled automatically.
+"""
 
 import json
 import numpy
+import pkgutil
+import inspect
 import importlib
 import ifcopenshell
-import ifcopenshell.api
 from typing import Callable, Any, Optional
 from functools import partial
 
 
-pre_listeners = {}
-post_listeners = {}
+pre_listeners: dict[str, dict] = {}
+post_listeners: dict[str, dict] = {}
 
 
 def batching_argument_deprecation(
@@ -117,25 +125,39 @@ ARGUMENTS_DEPRECATION = {
     "constraint.unassign_constraint": partial(
         batching_argument_deprecation, prev_argument="product", new_argument="products"
     ),
+    "project.assign_declaration": partial(
+        batching_argument_deprecation, prev_argument="definition", new_argument="definitions"
+    ),
+    "project.unassign_declaration": partial(
+        batching_argument_deprecation, prev_argument="definition", new_argument="definitions"
+    ),
 }
 
 
-CACHED_USECASE_CLASSES = dict()
+CACHED_USECASE_CLASSES: dict[str, Callable] = {}
+CACHED_USECASES: dict[str, Callable] = {}
 
 
 def run(
     usecase_path: str,
     ifc_file: Optional[ifcopenshell.file] = None,
-    should_run_listeners=True,
+    should_run_listeners: bool = True,
     **settings: Any,
 ) -> Any:
+    usecase_function = CACHED_USECASES.get(usecase_path)
+    if not usecase_function:
+        importlib.import_module(f"ifcopenshell.api.{usecase_path}")
+        module, usecase = usecase_path.split(".")
+        usecase_function = getattr(getattr(ifcopenshell.api, module), usecase)
+        CACHED_USECASES[usecase_path] = usecase_function
+    if ifc_file:
+        return usecase_function(ifc_file, should_run_listeners=should_run_listeners, **settings)
+    return usecase_function(should_run_listeners=should_run_listeners, **settings)
+
     if should_run_listeners:
         for listener in pre_listeners.get(usecase_path, {}).values():
             listener(usecase_path, ifc_file, settings)
 
-    # see #4531
-    if usecase_path in ARGUMENTS_DEPRECATION:
-        usecase_path, settings = ARGUMENTS_DEPRECATION[usecase_path](usecase_path, settings)
 
     # TODO: settings serialization for client-server systems
     # def serialise_entity_instance(entity):
@@ -229,11 +251,8 @@ def remove_all_listeners():
 
 def extract_docs(module, usecase):
     import typing
-    import inspect
     import collections
 
-    results = []
-
     inputs = collections.OrderedDict()
 
     function_init = getattr(getattr(ifcopenshell.api, module), usecase).Usecase.__init__
@@ -275,3 +294,84 @@ def extract_docs(module, usecase):
     node_data["description"] = description.strip()
     node_data["inputs"] = inputs
     return node_data
+
+
+def wrap_usecase(usecase_path, usecase):
+    """Wraps an API function in pre/post listeners."""
+
+    def wrapper(*args, should_run_listeners: bool = True, **settings):
+        ifc_file = args[0] if args else None
+        nonlocal usecase_path
+        if should_run_listeners:
+            for listener in pre_listeners.get(usecase_path, {}).values():
+                listener(usecase_path, ifc_file, settings)
+
+        # see #4531
+        if usecase_path in ARGUMENTS_DEPRECATION:
+            usecase_path, settings = ARGUMENTS_DEPRECATION[usecase_path](usecase_path, settings)
+
+        try:
+            result = usecase(*args, **settings)
+        except TypeError as e:
+            msg = f"Incorrect function arguments provided for {usecase_path}\n{str(e)}. You specified args {args} and settings {settings}\n\nCorrect signature is {inspect.signature(usecase)}\nSee help(ifcopenshell.api.{usecase_path}) for documentation."
+            raise TypeError(msg) from e
+
+        if should_run_listeners:
+            for listener in post_listeners.get(usecase_path, {}).values():
+                listener(usecase_path, ifc_file, settings)
+
+        return result
+
+    wrapper.__signature__ = inspect.signature(usecase)
+    wrapper.__doc__ = usecase.__doc__
+    wrapper.__name__ = usecase_path
+    return wrapper
+
+
+# Expose all submodules. This means that the user can just type `import ifcopenshell.api`.
+import ifcopenshell.api.aggregate as aggregate
+import ifcopenshell.api.attribute as attribute
+import ifcopenshell.api.boundary as boundary
+import ifcopenshell.api.classification as classification
+import ifcopenshell.api.constraint as constraint
+import ifcopenshell.api.context as context
+import ifcopenshell.api.control as control
+import ifcopenshell.api.cost as cost
+import ifcopenshell.api.document as document
+import ifcopenshell.api.drawing as drawing
+import ifcopenshell.api.geometry as geometry
+import ifcopenshell.api.georeference as georeference
+import ifcopenshell.api.grid as grid
+import ifcopenshell.api.group as group
+import ifcopenshell.api.layer as layer
+import ifcopenshell.api.library as library
+import ifcopenshell.api.material as material
+import ifcopenshell.api.nest as nest
+import ifcopenshell.api.owner as owner
+import ifcopenshell.api.profile as profile
+import ifcopenshell.api.project as project
+import ifcopenshell.api.pset as pset
+import ifcopenshell.api.pset_template as pset_template
+import ifcopenshell.api.resource as resource
+import ifcopenshell.api.root as root
+import ifcopenshell.api.sequence as sequence
+import ifcopenshell.api.spatial as spatial
+import ifcopenshell.api.structural as structural
+import ifcopenshell.api.style as style
+import ifcopenshell.api.system as system
+import ifcopenshell.api.type as type  # Whoohoo!
+import ifcopenshell.api.unit as unit
+import ifcopenshell.api.void as void
+
+# Wrap all submodule usecases with listeners.
+# This for loop also conveniently ensures that the above imports are comprehensive.
+for loader, module_name, is_pkg in pkgutil.iter_modules(__path__, __name__ + "."):
+    # Check if it's a direct child (only one level deep)
+    if module_name.count(".") == __name__.count(".") + 1:
+        module_name = module_name.split(".")[-1]
+        module = globals()[module_name]
+        for usecase_name in vars(module):
+            usecase = getattr(module, usecase_name)
+            if callable(usecase):
+                usecase_path = f"{module_name}.{usecase_name}"
+                setattr(module, usecase_name, wrap_usecase(usecase_path, usecase))

src/ifcopenshell-python/ifcopenshell/api/aggregate/__init__.py

@@ -22,3 +22,6 @@ One common use is spatial elements, such as how a site has multiple buildings,
 and a building has multiple storeys. Another is for regular elements, such as
 how a wall is made out of members and coverings.
 """
+
+from .assign_object import assign_object
+from .unassign_object import unassign_object

src/ifcopenshell-python/ifcopenshell/api/aggregate/assign_object.py

@@ -23,148 +23,144 @@ import ifcopenshell.util.placement
 from typing import Union
 
 
-class Usecase:
-    def __init__(
-        self,
-        file: ifcopenshell.file,
-        products: list[ifcopenshell.entity_instance],
-        relating_object: ifcopenshell.entity_instance,
-    ):
-        """Assigns object as an aggregate to the products
+def assign_object(
+    file: ifcopenshell.file,
+    products: list[ifcopenshell.entity_instance],
+    relating_object: ifcopenshell.entity_instance,
+) -> Union[ifcopenshell.entity_instance, None]:
+    """Assigns object as an aggregate to the products
 
-        All physical IFC model elements must be part of a hierarchical tree
-        called the "spatial decomposition", where large things are made up of
-        smaller things. This tree always begins at an "IfcProject" and is then
-        broken down using "decomposition" relationships, of which aggregation is
-        the first relationship you will use.
+    All physical IFC model elements must be part of a hierarchical tree
+    called the "spatial decomposition", where large things are made up of
+    smaller things. This tree always begins at an "IfcProject" and is then
+    broken down using "decomposition" relationships, of which aggregation is
+    the first relationship you will use.
 
-        Typically used when you want to describe how large spaces are made up of
-        smaller spaces. For example large spatial elements (e.g. sites,
-        buidings) can be made out of smaller spatial elements (e.g. storeys,
-        spaces).
+    Typically used when you want to describe how large spaces are made up of
+    smaller spaces. For example large spatial elements (e.g. sites,
+    buidings) can be made out of smaller spatial elements (e.g. storeys,
+    spaces).
 
-        The largest space (typically the IfcSite) can then be aggregated in a
-        project. It is requirement for all spatial structures to be directly or
-        indirectly aggregated back to the IfcProject to create a hierarchy of
-        spaces.
+    The largest space (typically the IfcSite) can then be aggregated in a
+    project. It is requirement for all spatial structures to be directly or
+    indirectly aggregated back to the IfcProject to create a hierarchy of
+    spaces.
 
-        The other common usecase is when larger physical products are made up of
-        smaller physical products. For example, a stair might be made out of a
-        flight, a landing, a railing and so on. Or a wall might be made out of
-        stud members, and coverings.
+    The other common usecase is when larger physical products are made up of
+    smaller physical products. For example, a stair might be made out of a
+    flight, a landing, a railing and so on. Or a wall might be made out of
+    stud members, and coverings.
 
-        As a product may only have a single location in the "spatial
-        decomposition" tree, assigning an aggregate relationship will remove any
-        previous aggregation, containment, or nesting relationships it may have.
+    As a product may only have a single location in the "spatial
+    decomposition" tree, assigning an aggregate relationship will remove any
+    previous aggregation, containment, or nesting relationships it may have.
 
-        IFC placements follow a convention where the placement is relative to
-        its parent in the spatial hierarchy. If your product has a placement,
-        its placement will be recalculated to follow this convention.
+    IFC placements follow a convention where the placement is relative to
+    its parent in the spatial hierarchy. If your product has a placement,
+    its placement will be recalculated to follow this convention.
 
-        :param products: The list of parts of the aggregate, typically of IfcElement or
-            IfcSpatialStructureElement subclass
-        :type product: list[ifcopenshell.entity_instance.entity_instance]
-        :param relating_object: The whole of the aggregate, typically an
-            IfcElement or IfcSpatialStructureElement subclass
-        :type relating_object: ifcopenshell.entity_instance.entity_instance
-        :return: The IfcRelAggregate relationship instance
-            or `None` if `products` was empty list.
-        :rtype: Union[ifcopenshell.entity_instance.entity_instance, None]
+    :param products: The list of parts of the aggregate, typically of IfcElement or
+        IfcSpatialStructureElement subclass
+    :type product: list[ifcopenshell.entity_instance]
+    :param relating_object: The whole of the aggregate, typically an
+        IfcElement or IfcSpatialStructureElement subclass
+    :type relating_object: ifcopenshell.entity_instance
+    :return: The IfcRelAggregate relationship instance
+        or `None` if `products` was empty list.
+    :rtype: Union[ifcopenshell.entity_instance, None]
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            project = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcProject")
-            element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSite")
-            subelement = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
+        project = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcProject")
+        element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSite")
+        subelement = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
 
-            # The project contains a site (note that project aggregation is a special case in IFC)
-            ifcopenshell.api.run("aggregate.assign_object", model, products=[element], relating_object=project)
+        # The project contains a site (note that project aggregation is a special case in IFC)
+        ifcopenshell.api.run("aggregate.assign_object", model, products=[element], relating_object=project)
 
-            # The site has a building
-            ifcopenshell.api.run("aggregate.assign_object", model, products=[subelement], relating_object=element)
-        """
-        self.file = file
-        self.settings = {
-            "products": products,
-            "relating_object": relating_object,
-        }
+        # The site has a building
+        ifcopenshell.api.run("aggregate.assign_object", model, products=[subelement], relating_object=element)
+    """
+    settings = {
+        "products": products,
+        "relating_object": relating_object,
+    }
 
-    def execute(self) -> Union[ifcopenshell.entity_instance, None]:
-        if not self.settings["products"]:
-            return
+    if not settings["products"]:
+        return
 
-        products = set(self.settings["products"])
-        relating_object = self.settings["relating_object"]
-        is_decomposed_by = next((i for i in relating_object.IsDecomposedBy if i.is_a("IfcRelAggregates")), None)
+    products = set(settings["products"])
+    relating_object = settings["relating_object"]
+    is_decomposed_by = next((i for i in relating_object.IsDecomposedBy if i.is_a("IfcRelAggregates")), None)
 
-        previous_aggregates_rels: set[ifcopenshell.entity_instance] = set()
-        products_without_aggregates: list[ifcopenshell.entity_instance] = []
-        products_with_aggregates: list[ifcopenshell.entity_instance] = []
+    previous_aggregates_rels: set[ifcopenshell.entity_instance] = set()
+    products_without_aggregates: list[ifcopenshell.entity_instance] = []
+    products_with_aggregates: list[ifcopenshell.entity_instance] = []
 
-        # check if there is anything to change
-        for product in products:
-            product_rel = next(iter(product.Decomposes), None)
+    # check if there is anything to change
+    for product in products:
+        product_rel = next(iter(product.Decomposes), None)
 
-            if product_rel is None:
-                products_without_aggregates.append(product)
-                continue
+        if product_rel is None:
+            products_without_aggregates.append(product)
+            continue
 
-            # either is_decomposed_by is None or product is part of different rel
-            if product_rel != is_decomposed_by:
-                previous_aggregates_rels.add(product_rel)
-                products_with_aggregates.append(product)
+        # either is_decomposed_by is None or product is part of different rel
+        if product_rel != is_decomposed_by:
+            previous_aggregates_rels.add(product_rel)
+            products_with_aggregates.append(product)
 
-            # products with already assigned aggregates will be skipped
+        # products with already assigned aggregates will be skipped
 
-        products_to_change = products_without_aggregates + products_with_aggregates
-        # nothing to change
-        if not products_to_change:
-            return is_decomposed_by
+    products_to_change = products_without_aggregates + products_with_aggregates
+    # nothing to change
+    if not products_to_change:
+        return is_decomposed_by
 
-        # can be either only aggregated or only contained at the same time
-        # some product might not be able to have a container
-        possibly_contained_products = [p for p in products_without_aggregates if hasattr(p, "ContainedInStructure")]
-        ifcopenshell.api.run("spatial.unassign_container", self.file, products=possibly_contained_products)
+    # can be either only aggregated or only contained at the same time
+    # some product might not be able to have a container
+    possibly_contained_products = [p for p in products_without_aggregates if hasattr(p, "ContainedInStructure")]
+    ifcopenshell.api.run("spatial.unassign_container", file, products=possibly_contained_products)
 
-        # unassign elements from previous aggregates
-        for decomposes in previous_aggregates_rels:
-            related_objects = set(decomposes.RelatedObjects) - products
-            if related_objects:
-                decomposes.RelatedObjects = list(related_objects)
-                ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": decomposes})
-            else:
-                history = decomposes.OwnerHistory
-                self.file.remove(decomposes)
-                if history:
-                    ifcopenshell.util.element.remove_deep2(self.file, history)
-
-        # assign elements to a new aggregate
-        if is_decomposed_by:
-            is_decomposed_by.RelatedObjects = list(set(is_decomposed_by.RelatedObjects) | products)
-            ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": is_decomposed_by})
+    # unassign elements from previous aggregates
+    for decomposes in previous_aggregates_rels:
+        related_objects = set(decomposes.RelatedObjects) - products
+        if related_objects:
+            decomposes.RelatedObjects = list(related_objects)
+            ifcopenshell.api.run("owner.update_owner_history", file, **{"element": decomposes})
         else:
-            is_decomposed_by = self.file.create_entity(
-                "IfcRelAggregates",
-                **{
-                    "GlobalId": ifcopenshell.guid.new(),
-                    "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),
-                    "RelatedObjects": list(products),
-                    "RelatingObject": relating_object,
-                }
+            history = decomposes.OwnerHistory
+            file.remove(decomposes)
+            if history:
+                ifcopenshell.util.element.remove_deep2(file, history)
+
+    # assign elements to a new aggregate
+    if is_decomposed_by:
+        is_decomposed_by.RelatedObjects = list(set(is_decomposed_by.RelatedObjects) | products)
+        ifcopenshell.api.run("owner.update_owner_history", file, **{"element": is_decomposed_by})
+    else:
+        is_decomposed_by = file.create_entity(
+            "IfcRelAggregates",
+            **{
+                "GlobalId": ifcopenshell.guid.new(),
+                "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", file),
+                "RelatedObjects": list(products),
+                "RelatingObject": relating_object,
+            }
+        )
+
+    # localize placement relative to a new aggregate for affected products
+    for product in products_to_change:
+        placement = getattr(product, "ObjectPlacement", None)
+        if placement and placement.is_a("IfcLocalPlacement"):
+            ifcopenshell.api.run(
+                "geometry.edit_object_placement",
+                file,
+                product=product,
+                matrix=ifcopenshell.util.placement.get_local_placement(product.ObjectPlacement),
+                is_si=False,
             )
 
-        # localize placement relative to a new aggregate for affected products
-        for product in products_to_change:
-            placement = getattr(product, "ObjectPlacement", None)
-            if placement and placement.is_a("IfcLocalPlacement"):
-                ifcopenshell.api.run(
-                    "geometry.edit_object_placement",
-                    self.file,
-                    product=product,
-                    matrix=ifcopenshell.util.placement.get_local_placement(product.ObjectPlacement),
-                    is_si=False,
-                )
-
-        return is_decomposed_by
+    return is_decomposed_by

src/ifcopenshell-python/ifcopenshell/api/aggregate/unassign_object.py

@@ -21,60 +21,57 @@ import ifcopenshell.api
 import ifcopenshell.util.element
 
 
-class Usecase:
-    def __init__(self, file: ifcopenshell.file, products: list[ifcopenshell.entity_instance]):
-        """Unassigns products from their aggregate
+def unassign_object(file: ifcopenshell.file, products: list[ifcopenshell.entity_instance]) -> None:
+    """Unassigns products from their aggregate
 
-        A product (i.e. a smaller part of a whole) may be aggregated into zero
-        or one larger space or element. This function will remove that
-        aggregation relationship.
+    A product (i.e. a smaller part of a whole) may be aggregated into zero
+    or one larger space or element. This function will remove that
+    aggregation relationship.
 
-        As all physical IFC model elements must be part of a hierarchical tree
-        called the "spatial decomposition", using this function will remove the
-        product from that tree. This is a dangerous operation and may result in
-        the product no longer being visible in IFC applications.
+    As all physical IFC model elements must be part of a hierarchical tree
+    called the "spatial decomposition", using this function will remove the
+    product from that tree. This is a dangerous operation and may result in
+    the product no longer being visible in IFC applications.
 
-        If the product is not part of an aggregation relationship, nothing will
-        happen.
+    If the product is not part of an aggregation relationship, nothing will
+    happen.
 
-        :param products: The list of parts of the aggregate, typically of IfcElements or
-            IfcSpatialStructureElement subclass
-        :type product: list[ifcopenshell.entity_instance.entity_instance]
-        :return: None
-        :rtype: None
+    :param products: The list of parts of the aggregate, typically of IfcElements or
+        IfcSpatialStructureElement subclass
+    :type product: list[ifcopenshell.entity_instance]
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSite")
-            subelement1 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
-            subelement2 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
-            ifcopenshell.api.run("aggregate.assign_object", model, products=[subelement1], relating_object=element)
-            ifcopenshell.api.run("aggregate.assign_object", model, products=[subelement2], relating_object=element)
-            # nothing is returned
-            ifcopenshell.api.run("aggregate.unassign_object", model, products=[subelement1])
-            # nothing is returned, relationship is removed
-            ifcopenshell.api.run("aggregate.unassign_object", model, products=[subelement2])
-        """
-        self.file = file
-        self.settings = {"products": products}
+        element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSite")
+        subelement1 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
+        subelement2 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
+        ifcopenshell.api.run("aggregate.assign_object", model, products=[subelement1], relating_object=element)
+        ifcopenshell.api.run("aggregate.assign_object", model, products=[subelement2], relating_object=element)
+        # nothing is returned
+        ifcopenshell.api.run("aggregate.unassign_object", model, products=[subelement1])
+        # nothing is returned, relationship is removed
+        ifcopenshell.api.run("aggregate.unassign_object", model, products=[subelement2])
+    """
+    settings = {"products": products}
 
-    def execute(self) -> None:
-        products = set(self.settings["products"])
-        rels = set(
-            rel
-            for product in products
-            if (rel := next((rel for rel in product.Decomposes if rel.is_a("IfcRelAggregates")), None))
-        )
+    products = set(settings["products"])
+    rels = set(
+        rel
+        for product in products
+        if (rel := next((rel for rel in product.Decomposes if rel.is_a("IfcRelAggregates")), None))
+    )
 
-        for rel in rels:
-            related_objects = set(rel.RelatedObjects) - products
-            if related_objects:
-                rel.RelatedObjects = list(related_objects)
-                ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": rel})
-            else:
-                history = rel.OwnerHistory
-                self.file.remove(rel)
-                if history:
-                    ifcopenshell.util.element.remove_deep2(self.file, history)
+    for rel in rels:
+        related_objects = set(rel.RelatedObjects) - products
+        if related_objects:
+            rel.RelatedObjects = list(related_objects)
+            ifcopenshell.api.run("owner.update_owner_history", file, **{"element": rel})
+        else:
+            history = rel.OwnerHistory
+            file.remove(rel)
+            if history:
+                ifcopenshell.util.element.remove_deep2(file, history)

src/ifcopenshell-python/ifcopenshell/api/attribute/__init__.py

@@ -15,3 +15,5 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+from .edit_attributes import edit_attributes

src/ifcopenshell-python/ifcopenshell/api/attribute/edit_attributes.py

@@ -19,64 +19,49 @@
 import ifcopenshell.api
 
 
-class Usecase:
-    def __init__(self, file, product=None, attributes=None):
-        """Edit the attributes of a product
+def edit_attributes(file, product=None, attributes=None) -> None:
+    """Edit the attributes of a product
 
-        All IFC entities have attributes. Normally they can be edited directly,
-        by simply assigning a new value to them. In some scenarios, you may wish
-        to also ensure that ownership history is updated. This function provides
-        that convenience.
+    All IFC entities have attributes. Normally they can be edited directly,
+    by simply assigning a new value to them. In some scenarios, you may wish
+    to also ensure that ownership history is updated. This function provides
+    that convenience.
 
-        :param product: The product you want to edit. This may be any rooted IFC
-            entity.
-        :type product: ifcopenshell.entity_instance.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :return: None
-        :rtype: None
+    :param product: The product you want to edit. This may be any rooted IFC
+        entity.
+    :type product: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
-            ifcopenshell.api.run("attribute.edit_attributes", model,
-                product=element, attributes={"Name": "Waldo"})
-        """
-        self.file = file
-        self.settings = {"product": product, "attributes": attributes or {}}
+        element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
+        ifcopenshell.api.run("attribute.edit_attributes", model,
+            product=element, attributes={"Name": "Waldo"})
+    """
+    settings = {"product": product, "attributes": attributes or {}}
 
-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["product"], name, value)
-        if hasattr(self.settings["product"], "PredefinedType"):
-            if hasattr(self.settings["product"], "ElementType"):
-                if (
-                    self.settings["product"].ElementType is None
-                    and self.settings["product"].PredefinedType == "USERDEFINED"
-                ):
-                    self.settings["product"].PredefinedType = "NOTDEFINED"
-                elif (
-                    self.settings["product"].ElementType
-                    and self.settings["product"].PredefinedType != "USERDEFINED"
-                ):
-                    self.settings["product"].PredefinedType = "USERDEFINED"
-            elif hasattr(self.settings["product"], "ObjectType"):
-                relating_type = ifcopenshell.util.element.get_type(self.settings["product"])
-                # Allow for None due to https://github.com/buildingSMART/IFC4.3.x-development/issues/818
-                if relating_type and relating_type.PredefinedType not in ("NOTDEFINED", None):
-                    self.settings["product"].ObjectType = None
-                    self.settings["product"].PredefinedType = None
-                elif (
-                    self.settings["product"].ObjectType is None
-                    and self.settings["product"].PredefinedType == "USERDEFINED"
-                ):
-                    self.settings["product"].PredefinedType = "NOTDEFINED"
-                elif (
-                    self.settings["product"].ObjectType
-                    and self.settings["product"].PredefinedType != "USERDEFINED"
-                ):
-                    self.settings["product"].PredefinedType = "USERDEFINED"
-        if hasattr(self.settings["product"], "OwnerHistory"):
-            ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": self.settings["product"]})
+    for name, value in settings["attributes"].items():
+        setattr(settings["product"], name, value)
+    if hasattr(settings["product"], "PredefinedType"):
+        if hasattr(settings["product"], "ElementType"):
+            if settings["product"].ElementType is None and settings["product"].PredefinedType == "USERDEFINED":
+                settings["product"].PredefinedType = "NOTDEFINED"
+            elif settings["product"].ElementType and settings["product"].PredefinedType != "USERDEFINED":
+                settings["product"].PredefinedType = "USERDEFINED"
+        elif hasattr(settings["product"], "ObjectType"):
+            relating_type = ifcopenshell.util.element.get_type(settings["product"])
+            # Allow for None due to https://github.com/buildingSMART/IFC4.3.x-development/issues/818
+            if relating_type and relating_type.PredefinedType not in ("NOTDEFINED", None):
+                settings["product"].ObjectType = None
+                settings["product"].PredefinedType = None
+            elif settings["product"].ObjectType is None and settings["product"].PredefinedType == "USERDEFINED":
+                settings["product"].PredefinedType = "NOTDEFINED"
+            elif settings["product"].ObjectType and settings["product"].PredefinedType != "USERDEFINED":
+                settings["product"].PredefinedType = "USERDEFINED"
+    if hasattr(settings["product"], "OwnerHistory"):
+        ifcopenshell.api.run("owner.update_owner_history", file, **{"element": settings["product"]})

src/ifcopenshell-python/ifcopenshell/api/boundary/__init__.py

@@ -19,3 +19,8 @@
 """Boundaries are primarily used for representing virtual interfaces between
 spaces for energy analysis.
 """
+
+from .assign_connection_geometry import assign_connection_geometry
+from .copy_boundary import copy_boundary
+from .edit_attributes import edit_attributes
+from .remove_boundary import remove_boundary

src/ifcopenshell-python/ifcopenshell/api/boundary/assign_connection_geometry.py

@@ -19,68 +19,80 @@
 import ifcopenshell.util.unit
 
 
+def assign_connection_geometry(
+    file,
+    rel_space_boundary=None,
+    outer_boundary=None,
+    inner_boundaries=None,
+    location=None,
+    axis=None,
+    ref_direction=None,
+    unit_scale=None,
+) -> None:
+    """Create and assign a connection geometry to a space boundary relationship
+
+    A space boundary may optionally have a plane that represents how that
+    space is adjacent to another space, known as the connection geometry.
+    You may specify this plane in terms of an outer boundary polyline, zero
+    or more inner boundaries (such as for windows), and a positional matrix
+    for the orientation of the plane.
+
+    :param rel_space_boundary: The space boundary relationship to assign the
+        connection geometry to.
+    :type rel_space_boundary: ifcopenshell.entity_instance
+    :param outer_boundary: A list of 2D points representing an open
+        polyline.  The last point will connect to the first point. Each
+        point is represented by an interable of 2 floats. The coordinates of
+        the points are relative to the positional matrix arguments.
+    :type outer_boundary: list[list[float]]
+    :param inner_boundaries: A list of zero or more inner boundaries to use
+        for the plane. Each boundary is represented by an open polyline, as
+        defined by the outer_boundary argument.
+    :type inner_boundaries: list[list[list[float]]], optional
+    :param location: The local origin of the connection geometry, defined as
+        an XYZ coordinate relative to the placement of the space that is
+        being bounded.
+    :type location: list[float]
+    :param axis: The local X axis of the connection geometry, defined as an
+        XYZ vector relative to the placement of the space that is being
+        bounded.
+    :type axis: list[float]
+    :param ref_direction: The local Z axis of the connection geometry,
+        defined as an XYZ vector relative to the placement of the space that
+        is being bounded. The Y vector is automatically derived using the
+        right hand rule.
+    :type ref_direction: list[float]
+    :param unit_scale: The unit scale as calculated by
+        ifcopenshell.util.unit.calculate_unit_scale. If not provided, it
+        will be automatically calculated for you.
+    :type unit_scale: float, optional
+    :return: None
+    :rtype: None
+
+    Example:
+
+    .. code:: python
+
+        ifcopenshell.api.run("boundary.assign_connection_geometry", model,
+            rel_space_boundary=element,
+            outer_boundary=[(0., 0.), (1., 0.), (1., 1.), (0., 1.)],
+            location=[0., 0., 0.], axis=[1., 0., 0.], ref_direction=[0., 0., 1.],
+            )
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.rel_space_boundary = rel_space_boundary
+    usecase.outer_boundary = outer_boundary
+    usecase.inner_boundaries = inner_boundaries or ()
+    usecase.location = location
+    usecase.axis = axis
+    usecase.ref_direction = ref_direction
+    usecase.unit_scale = unit_scale
+    usecase.ifc_vertices = []
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(self, file, rel_space_boundary=None, outer_boundary=None, inner_boundaries=None, location=None, axis=None, ref_direction=None, unit_scale=None):
-        """Create and assign a connection geometry to a space boundary relationship
-
-        A space boundary may optionally have a plane that represents how that
-        space is adjacent to another space, known as the connection geometry.
-        You may specify this plane in terms of an outer boundary polyline, zero
-        or more inner boundaries (such as for windows), and a positional matrix
-        for the orientation of the plane.
-
-        :param rel_space_boundary: The space boundary relationship to assign the
-            connection geometry to.
-        :type rel_space_boundary: ifcopenshell.entity_instance.entity_instance
-        :param outer_boundary: A list of 2D points representing an open
-            polyline.  The last point will connect to the first point. Each
-            point is represented by an interable of 2 floats. The coordinates of
-            the points are relative to the positional matrix arguments.
-        :type outer_boundary: list[list[float]]
-        :param inner_boundaries: A list of zero or more inner boundaries to use
-            for the plane. Each boundary is represented by an open polyline, as
-            defined by the outer_boundary argument.
-        :type inner_boundaries: list[list[list[float]]], optional
-        :param location: The local origin of the connection geometry, defined as
-            an XYZ coordinate relative to the placement of the space that is
-            being bounded.
-        :type location: list[float]
-        :param axis: The local X axis of the connection geometry, defined as an
-            XYZ vector relative to the placement of the space that is being
-            bounded.
-        :type axis: list[float]
-        :param ref_direction: The local Z axis of the connection geometry,
-            defined as an XYZ vector relative to the placement of the space that
-            is being bounded. The Y vector is automatically derived using the
-            right hand rule.
-        :type ref_direction: list[float]
-        :param unit_scale: The unit scale as calculated by
-            ifcopenshell.util.unit.calculate_unit_scale. If not provided, it
-            will be automatically calculated for you.
-        :type unit_scale: float, optional
-        :return: None
-        :rtype: None
-
-        Example:
-
-        .. code:: python
-
-            ifcopenshell.api.run("boundary.assign_connection_geometry", model,
-                rel_space_boundary=element,
-                outer_boundary=[(0., 0.), (1., 0.), (1., 1.), (0., 1.)],
-                location=[0., 0., 0.], axis=[1., 0., 0.], ref_direction=[0., 0., 1.],
-                )
-        """
-        self.file = file
-        self.rel_space_boundary = rel_space_boundary
-        self.outer_boundary = outer_boundary
-        self.inner_boundaries = inner_boundaries or ()
-        self.location = location
-        self.axis = axis
-        self.ref_direction = ref_direction
-        self.unit_scale = unit_scale
-        self.ifc_vertices = []
-
     def execute(self):
         if self.unit_scale is None:
             self.unit_scale = ifcopenshell.util.unit.calculate_unit_scale(self.file)

src/ifcopenshell-python/ifcopenshell/api/boundary/copy_boundary.py

@@ -19,29 +19,26 @@
 import ifcopenshell.util.element
 
 
-class Usecase:
-    def __init__(self, file, boundary=None):
-        """Copies a space boundary
+def copy_boundary(file, boundary=None) -> None:
+    """Copies a space boundary
 
-        :param boundary: The IfcRelSpaceBoundary you want to copy.
-        :type boundary: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
+    :param boundary: The IfcRelSpaceBoundary you want to copy.
+    :type boundary: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-            # A boring boundary with no geometry. Note that this boundary is
-            # invalid and does not relate to any space or building element.
-            boundary = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcRelSpaceBoundary")
+        # A boring boundary with no geometry. Note that this boundary is
+        # invalid and does not relate to any space or building element.
+        boundary = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcRelSpaceBoundary")
 
-            # And now we have two
-            boundary_copy = ifcopenshell.api.run("boundary.copy_boundary", model, boundary=boundary)
-        """
-        self.file = file
-        self.settings = {"boundary": boundary}
+        # And now we have two
+        boundary_copy = ifcopenshell.api.run("boundary.copy_boundary", model, boundary=boundary)
+    """
+    settings = {"boundary": boundary}
 
-    def execute(self):
-        result = ifcopenshell.util.element.copy(self.file, self.settings["boundary"])
-        if result.ConnectionGeometry:
-            result.ConnectionGeometry = ifcopenshell.util.element.copy_deep(self.file, result.ConnectionGeometry)
-        return result
+    result = ifcopenshell.util.element.copy(file, settings["boundary"])
+    if result.ConnectionGeometry:
+        result.ConnectionGeometry = ifcopenshell.util.element.copy_deep(file, result.ConnectionGeometry)
+    return result

src/ifcopenshell-python/ifcopenshell/api/boundary/edit_attributes.py

@@ -17,45 +17,49 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, entity=None, relating_space=None, related_building_element=None, parent_boundary=None, corresponding_boundary=None):
-        """Modify the relationships of a space boundary relationship
+def edit_attributes(
+    file,
+    entity=None,
+    relating_space=None,
+    related_building_element=None,
+    parent_boundary=None,
+    corresponding_boundary=None,
+) -> None:
+    """Modify the relationships of a space boundary relationship
 
-        Currently this function is quite minimal and offers no advantage to
-        manual assignment of the space boundary attributes.
+    Currently this function is quite minimal and offers no advantage to
+    manual assignment of the space boundary attributes.
 
-        :param entity: The IfcRelSpaceBoundary to modify
-        :type entity: ifcopenshell.entity_instance.entity_instance
-        :param relating_space: The IfcSpace or IfcExternalSpatialElement that
-            the space boundary is related to.
-        :type relating_space: ifcopenshell.entity_instance.entity_instance
-        :param related_building_element: The IfcElement that defines the
-            boundary, typically an IfcWall.
-        :type relating_space: ifcopenshell.entity_instance.entity_instance
-        :param parent_boundary: A parent IfcRelSpaceBoundary, only provided if
-            this is an inner boundary. This can apply to 1st and 2nd level
-            boundaries.
-        :type parent_boundary: ifcopenshell.entity_instance.entity_instance,
-            optional
-        :param corresponding_boundary: The other IfcRelSpaceBoundary on the
-            other side of the related element. The pair together represents a
-            thermal boundary. This only applies to 2nd level boundaries.
-        :type corresponding_boundary: ifcopenshell.entity_instance.entity_instance,
-            optional
-        :return: None
-        :rtype: None
-        """
-        self.file = file
-        self.entity = entity
-        self.relating_space = relating_space
-        self.related_building_element = related_building_element
-        self.parent_boundary = parent_boundary
-        self.corresponding_boundary = corresponding_boundary
+    :param entity: The IfcRelSpaceBoundary to modify
+    :type entity: ifcopenshell.entity_instance
+    :param relating_space: The IfcSpace or IfcExternalSpatialElement that
+        the space boundary is related to.
+    :type relating_space: ifcopenshell.entity_instance
+    :param related_building_element: The IfcElement that defines the
+        boundary, typically an IfcWall.
+    :type relating_space: ifcopenshell.entity_instance
+    :param parent_boundary: A parent IfcRelSpaceBoundary, only provided if
+        this is an inner boundary. This can apply to 1st and 2nd level
+        boundaries.
+    :type parent_boundary: ifcopenshell.entity_instance,
+        optional
+    :param corresponding_boundary: The other IfcRelSpaceBoundary on the
+        other side of the related element. The pair together represents a
+        thermal boundary. This only applies to 2nd level boundaries.
+    :type corresponding_boundary: ifcopenshell.entity_instance,
+        optional
+    :return: None
+    :rtype: None
+    """
+    entity = entity
+    relating_space = relating_space
+    related_building_element = related_building_element
+    parent_boundary = parent_boundary
+    corresponding_boundary = corresponding_boundary
 
-    def execute(self):
-        self.entity.RelatingSpace = self.relating_space
-        self.entity.RelatedBuildingElement = self.related_building_element
-        if hasattr(self.entity, "ParentBoundary"):
-            self.entity.ParentBoundary = self.parent_boundary
-        if hasattr(self.entity, "CorrespondingBoundary"):
-            self.entity.CorrespondingBoundary = self.corresponding_boundary
+    entity.RelatingSpace = relating_space
+    entity.RelatedBuildingElement = related_building_element
+    if hasattr(entity, "ParentBoundary"):
+        entity.ParentBoundary = parent_boundary
+    if hasattr(entity, "CorrespondingBoundary"):
+        entity.CorrespondingBoundary = corresponding_boundary

src/ifcopenshell-python/ifcopenshell/api/boundary/remove_boundary.py

@@ -20,36 +20,33 @@ import ifcopenshell
 import ifcopenshell.util.element
 
 
-class Usecase:
-    def __init__(self, file, boundary=None):
-        """Removes a space boundary
+def remove_boundary(file, boundary=None) -> None:
+    """Removes a space boundary
 
-        The relating space or related building element is untouched. Only the
-        boundary and its connection geometry is removed.
+    The relating space or related building element is untouched. Only the
+    boundary and its connection geometry is removed.
 
-        :param boundary: The IfcRelSpaceBoundary you want to remove.
-        :type boundary: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
+    :param boundary: The IfcRelSpaceBoundary you want to remove.
+    :type boundary: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-            # A boring boundary with no geometry. Note that this boundary is
-            # invalid and does not relate to any space or building element.
-            boundary = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcRelSpaceBoundary")
+        # A boring boundary with no geometry. Note that this boundary is
+        # invalid and does not relate to any space or building element.
+        boundary = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcRelSpaceBoundary")
 
-            # Let's remove it!
-            ifcopenshell.api.run("boundary.remove_boundary", model, boundary=boundary)
-        """
-        self.file = file
-        self.settings = {"boundary": boundary}
+        # Let's remove it!
+        ifcopenshell.api.run("boundary.remove_boundary", model, boundary=boundary)
+    """
+    settings = {"boundary": boundary}
 
-    def execute(self):
-        geometry = self.settings["boundary"].ConnectionGeometry
-        if geometry:
-            self.settings["boundary"].ConnectionGeometry = None
-            ifcopenshell.util.element.remove_deep2(self.file, geometry)
-        history = self.settings["boundary"].OwnerHistory
-        self.file.remove(self.settings["boundary"])
-        if history:
-            ifcopenshell.util.element.remove_deep2(self.file, history)
+    geometry = settings["boundary"].ConnectionGeometry
+    if geometry:
+        settings["boundary"].ConnectionGeometry = None
+        ifcopenshell.util.element.remove_deep2(file, geometry)
+    history = settings["boundary"].OwnerHistory
+    file.remove(settings["boundary"])
+    if history:
+        ifcopenshell.util.element.remove_deep2(file, history)

src/ifcopenshell-python/ifcopenshell/api/classification/__init__.py

@@ -15,3 +15,10 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+from .add_classification import add_classification
+from .add_reference import add_reference
+from .edit_classification import edit_classification
+from .edit_reference import edit_reference
+from .remove_classification import remove_classification
+from .remove_reference import remove_reference

src/ifcopenshell-python/ifcopenshell/api/classification/add_classification.py

@@ -22,67 +22,72 @@ import ifcopenshell.util.date
 from typing import Union
 
 
+def add_classification(
+    file: ifcopenshell.file, classification: Union[str, ifcopenshell.entity_instance]
+) -> ifcopenshell.entity_instance:
+    """Adds a new classification system to the project
+
+    External classification systems such as Uniclass or Omniclass are
+    ways of categorising elements in the AEC industry, typically
+    standardised or nominated by governments or companies. A system
+    typically contains a series of hierarchical reference codes and labels
+    like Pr_12_23_34.
+
+    Classifications may be applied to many things, not just physical
+    elements, such as doors and windows, spatial elements, tasks, cost
+    items, or even resources.
+
+    Prior to assigning classificaion references, you need to add the name
+    and metadata of the classification system that you will use in your
+    project. Classification systems may be revised over time, so this
+    metadata includes the edition date.
+
+    Common classification systems are provided as an IFC library which may
+    be downloaded from https://github.com/Moult/IfcClassification for your
+    convenience. It is advised to use these to ensure that the
+    classification metadata is standardised.
+
+    Adding a classification system will not add the entire hierarchy of
+    references available in the classification. References need to be added
+    separately. Typically, you'd only add the references that you use in
+    your project, see ifcopenshell.api.classification.add_reference for more
+    information.
+
+    :param classification: If a string is provided, it is assumed to be the
+        name of your classification system. This is necessary if you are
+        creating your own custom classification system. Alternatively, you
+        may provide an entity_instance of an IfcClassification from an IFC
+        classification library. The latter approach is preferred if you are
+        using a commonly known system such as Uniclass, as this will ensure
+        all metadata is added correctly.
+    :type classification: str,ifcopenshell.entity_instance
+    :return: The added IfcClassification element
+    :rtype: ifcopenshell.entity_instance
+
+    Example:
+
+    .. code:: python
+
+        # Option 1: adding a custom clasification from scratch
+        ifcopenshell.api.run("classification.add_classification", model,
+            classification="MyCustomClassification")
+
+        # Option 2: adding a popular classification from a library
+        library = ifcopenshell.open("/path/to/Uniclass.ifc")
+        classification = library.by_type("IfcClassification")[0]
+        ifcopenshell.api.run("classification.add_classification", model,
+            classification=classification)
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.settings = {
+        "classification": classification,
+    }
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(self, file: ifcopenshell.file, classification: Union[str, ifcopenshell.entity_instance]):
-        """Adds a new classification system to the project
-
-        External classification systems such as Uniclass or Omniclass are
-        ways of categorising elements in the AEC industry, typically
-        standardised or nominated by governments or companies. A system
-        typically contains a series of hierarchical reference codes and labels
-        like Pr_12_23_34.
-
-        Classifications may be applied to many things, not just physical
-        elements, such as doors and windows, spatial elements, tasks, cost
-        items, or even resources.
-
-        Prior to assigning classificaion references, you need to add the name
-        and metadata of the classification system that you will use in your
-        project. Classification systems may be revised over time, so this
-        metadata includes the edition date.
-
-        Common classification systems are provided as an IFC library which may
-        be downloaded from https://github.com/Moult/IfcClassification for your
-        convenience. It is advised to use these to ensure that the
-        classification metadata is standardised.
-
-        Adding a classification system will not add the entire hierarchy of
-        references available in the classification. References need to be added
-        separately. Typically, you'd only add the references that you use in
-        your project, see ifcopenshell.api.classification.add_reference for more
-        information.
-
-        :param classification: If a string is provided, it is assumed to be the
-            name of your classification system. This is necessary if you are
-            creating your own custom classification system. Alternatively, you
-            may provide an entity_instance of an IfcClassification from an IFC
-            classification library. The latter approach is preferred if you are
-            using a commonly known system such as Uniclass, as this will ensure
-            all metadata is added correctly.
-        :type classification: str,ifcopenshell.entity_instance.entity_instance
-        :return: The added IfcClassification element
-        :rtype: ifcopenshell.entity_instance.entity_instance
-
-        Example:
-
-        .. code:: python
-
-            # Option 1: adding a custom clasification from scratch
-            ifcopenshell.api.run("classification.add_classification", model,
-                classification="MyCustomClassification")
-
-            # Option 2: adding a popular classification from a library
-            library = ifcopenshell.open("/path/to/Uniclass.ifc")
-            classification = library.by_type("IfcClassification")[0]
-            ifcopenshell.api.run("classification.add_classification", model,
-                classification=classification)
-        """
-        self.file = file
-        self.settings = {
-            "classification": classification,
-        }
-
-    def execute(self) -> ifcopenshell.entity_instance:
+    def execute(self):
         if isinstance(self.settings["classification"], str):
             classification = self.file.createIfcClassification(Name=self.settings["classification"])
             self.relate_to_project(classification)

src/ifcopenshell-python/ifcopenshell/api/classification/add_reference.py

@@ -23,117 +23,119 @@ import ifcopenshell.util.schema
 from typing import Optional, Union
 
 
+def add_reference(
+    file: ifcopenshell.file,
+    products: list[ifcopenshell.entity_instance],
+    reference: Optional[ifcopenshell.entity_instance] = None,
+    identification: Optional[str] = None,
+    name: Optional[str] = None,
+    classification: Optional[ifcopenshell.entity_instance] = None,
+    is_lightweight=True,
+) -> Union[ifcopenshell.entity_instance, None]:
+    """Adds a new classification reference and assigns it to the list of products
+
+    A classification reference is a single entry such as "Pr_12_23_34" that
+    is part of an external classification system (such as Uniclass or
+    Omniclass).
+
+    References can be added to almost any object in IFC, including physical
+    objects, object types, properties, tasks, costs, resources, or even
+    resources such as profiles, documents, libraries, and so on.
+
+    Classification references can be added in two ways. Option 1) specify  a
+    custom arbitrary reference, where you have to manually specify the
+    identification (e.g. "Pr_12_23_45") and name (e.g. "Door Products").
+    Option 2) add a reference from an IFC classification library. The latter
+    is preferred if you are using a common classification system such as
+    Uniclass, as the library will be prepopulated with all the valid
+    classifications already.
+
+    Objects are allowed to have multiple classification references from
+    multiple classification systems. This means that adding a new reference
+    will not remove existing references.
+
+    References can be inherited from types. This means that if an
+    IfcWallType has a classification reference of Pr_12_23_34, then all
+    IfcWall occurrences of that type automatically get the same
+    classification of Pr_12_23_34. This means that it is more efficient to
+    assign to types where possible. If a classification reference is
+    assigned to both the type and an occurrence, then the assignment at the
+    occurrence will override the type classification.
+
+    :param product: The list of IFC objects, properties, or resources you want to
+        associate the classification reference to.
+    :type product: list[ifcopenshell.entity_instance]
+    :param reference: The classification reference entity taken from an
+        IFC classification library. If you supply this parameter, you will
+        use option 2.
+    :type reference: ifcopenshell.entity_instance, optional
+    :param identification: If you choose option 1 and do not specify a
+        reference, you may manually specify an identification code. The code
+        is typically a short identifier and may have punctuation to separate
+        the levels of hierarchy in the classificaion (e.g. Pr_12_23_34).
+    :type identification: str, optional
+    :param name: If you choose option 1 and do not specify a reference, you
+        may manually specify a name. The name is typically human readable.
+    :type name: str, optional
+    :param classification: The IfcClassification entity in your IFC model
+        (not the library, if you are doing option 2) that the reference is
+        part of.
+    :type classification: ifcopenshell.entity_instance
+    :param is_lightweight: If you are doing option 2, choose whether or not
+        to only add that particular reference (lighweight) or also add all
+        of its parent references in the classification hierarchy (not
+        lighweight). For example, adding a lightweight reference to
+        Pr_12_23_34 will only add Pr_12_23_34, but adding a heavy reference
+        to Pr_12_23_34 will also add Pr_12_23 and Pr_12. These parent
+        references merely help describe the "tree" of classifications, but
+        is generally unnecessary. Using lightweight classifications are
+        recommended and is the default.
+    :type is_lightweight: bool, optional
+
+    :raises TypeError: If file is IFC2X3 and `products` has non-IfcRoot elements.
+
+    :return: The newly added IfcClassificationReference
+        or `None` if `products` was empty list.
+    :rtype: Union[ifcopenshell.entity_instance, None]
+
+    Example:
+
+    .. code:: python
+
+        # Option 1: adding and assigning a new reference from scratch
+        wall_type = model.by_type("IfcWallType")[0]
+        classification = ifcopenshell.api.run("classification.add_classification",
+            model, classification="MyCustomClassification")
+        ifcopenshell.api.run("classification.add_reference", model,
+            products=[wall_type], classification=classification,
+            identification="W_01", name="Interior Walls")
+
+        # Option 2: adding a popular classification from a library
+        library = ifcopenshell.open("/path/to/Uniclass.ifc")
+        lib_classification = library.by_type("IfcClassification")[0]
+        classification = ifcopenshell.api.run("classification.add_classification",
+            model, classification=lib_classification)
+        reference = [r for r in library.by_type("IfcClassificationReference")
+            if r.Identification == "XYZ"][0]
+        ifcopenshell.api.run("classification.add_reference", model,
+            products=[wall_type], classification=classification,
+            reference=reference)
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.settings = {
+        "products": products,
+        "reference": reference,
+        "identification": identification,
+        "name": name,
+        "classification": classification,
+        "is_lightweight": is_lightweight,
+    }
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(
-        self,
-        file: ifcopenshell.file,
-        products: list[ifcopenshell.entity_instance],
-        reference: Optional[ifcopenshell.entity_instance] = None,
-        identification: Optional[str] = None,
-        name: Optional[str] = None,
-        classification: Optional[ifcopenshell.entity_instance] = None,
-        is_lightweight=True,
-    ):
-        """Adds a new classification reference and assigns it to the list of products
-
-        A classification reference is a single entry such as "Pr_12_23_34" that
-        is part of an external classification system (such as Uniclass or
-        Omniclass).
-
-        References can be added to almost any object in IFC, including physical
-        objects, object types, properties, tasks, costs, resources, or even
-        resources such as profiles, documents, libraries, and so on.
-
-        Classification references can be added in two ways. Option 1) specify  a
-        custom arbitrary reference, where you have to manually specify the
-        identification (e.g. "Pr_12_23_45") and name (e.g. "Door Products").
-        Option 2) add a reference from an IFC classification library. The latter
-        is preferred if you are using a common classification system such as
-        Uniclass, as the library will be prepopulated with all the valid
-        classifications already.
-
-        Objects are allowed to have multiple classification references from
-        multiple classification systems. This means that adding a new reference
-        will not remove existing references.
-
-        References can be inherited from types. This means that if an
-        IfcWallType has a classification reference of Pr_12_23_34, then all
-        IfcWall occurrences of that type automatically get the same
-        classification of Pr_12_23_34. This means that it is more efficient to
-        assign to types where possible. If a classification reference is
-        assigned to both the type and an occurrence, then the assignment at the
-        occurrence will override the type classification.
-
-        :param product: The list of IFC objects, properties, or resources you want to
-            associate the classification reference to.
-        :type product: list[ifcopenshell.entity_instance.entity_instance]
-        :param reference: The classification reference entity taken from an
-            IFC classification library. If you supply this parameter, you will
-            use option 2.
-        :type reference: ifcopenshell.entity_instance.entity_instance, optional
-        :param identification: If you choose option 1 and do not specify a
-            reference, you may manually specify an identification code. The code
-            is typically a short identifier and may have punctuation to separate
-            the levels of hierarchy in the classificaion (e.g. Pr_12_23_34).
-        :type identification: str, optional
-        :param name: If you choose option 1 and do not specify a reference, you
-            may manually specify a name. The name is typically human readable.
-        :type name: str, optional
-        :param classification: The IfcClassification entity in your IFC model
-            (not the library, if you are doing option 2) that the reference is
-            part of.
-        :type classification: ifcopenshell.entity_instance.entity_instance
-        :param is_lightweight: If you are doing option 2, choose whether or not
-            to only add that particular reference (lighweight) or also add all
-            of its parent references in the classification hierarchy (not
-            lighweight). For example, adding a lightweight reference to
-            Pr_12_23_34 will only add Pr_12_23_34, but adding a heavy reference
-            to Pr_12_23_34 will also add Pr_12_23 and Pr_12. These parent
-            references merely help describe the "tree" of classifications, but
-            is generally unnecessary. Using lightweight classifications are
-            recommended and is the default.
-        :type is_lightweight: bool, optional
-
-        :raises TypeError: If file is IFC2X3 and `products` has non-IfcRoot elements.
-
-        :return: The newly added IfcClassificationReference
-            or `None` if `products` was empty list.
-        :rtype: Union[ifcopenshell.entity_instance.entity_instance, None]
-
-        Example:
-
-        .. code:: python
-
-            # Option 1: adding and assigning a new reference from scratch
-            wall_type = model.by_type("IfcWallType")[0]
-            classification = ifcopenshell.api.run("classification.add_classification",
-                model, classification="MyCustomClassification")
-            ifcopenshell.api.run("classification.add_reference", model,
-                products=[wall_type], classification=classification,
-                identification="W_01", name="Interior Walls")
-
-            # Option 2: adding a popular classification from a library
-            library = ifcopenshell.open("/path/to/Uniclass.ifc")
-            lib_classification = library.by_type("IfcClassification")[0]
-            classification = ifcopenshell.api.run("classification.add_classification",
-                model, classification=lib_classification)
-            reference = [r for r in library.by_type("IfcClassificationReference")
-                if r.Identification == "XYZ"][0]
-            ifcopenshell.api.run("classification.add_reference", model,
-                products=[wall_type], classification=classification,
-                reference=reference)
-        """
-        self.file = file
-        self.settings = {
-            "products": products,
-            "reference": reference,
-            "identification": identification,
-            "name": name,
-            "classification": classification,
-            "is_lightweight": is_lightweight,
-        }
-
-    def execute(self) -> Union[ifcopenshell.entity_instance, None]:
+    def execute(self):
         if not self.settings["products"]:
             return
 

src/ifcopenshell-python/ifcopenshell/api/classification/edit_classification.py

@@ -17,32 +17,29 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, classification=None, attributes=None):
-        """Edits the attributes of an IfcClassification
+def edit_classification(file, classification=None, attributes=None) -> None:
+    """Edits the attributes of an IfcClassification
 
-        For more information about the attributes and data types of an
-        IfcClassification, consult the IFC documentation.
+    For more information about the attributes and data types of an
+    IfcClassification, consult the IFC documentation.
 
-        :param classification: The IfcClassification entity you want to edit
-        :type classification: ifcopenshell.entity_instance.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :return: None
-        :rtype: None
+    :param classification: The IfcClassification entity you want to edit
+    :type classification: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            classification = model.by_type("IfcClassification")[0]
-            # Change the name of the classification system to "Foo"
-            ifcopenshell.api.run("classification.edit_classification", model,
-                classification=classification, attributes={"Name": "Foo"})
-        """
-        self.file = file
-        self.settings = {"classification": classification, "attributes": attributes or {}}
+        classification = model.by_type("IfcClassification")[0]
+        # Change the name of the classification system to "Foo"
+        ifcopenshell.api.run("classification.edit_classification", model,
+            classification=classification, attributes={"Name": "Foo"})
+    """
+    settings = {"classification": classification, "attributes": attributes or {}}
 
-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["classification"], name, value)
+    for name, value in settings["attributes"].items():
+        setattr(settings["classification"], name, value)

src/ifcopenshell-python/ifcopenshell/api/classification/edit_reference.py

@@ -17,32 +17,29 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, reference=None, attributes=None):
-        """Edits the attributes of an IfcClassificationReference
+def edit_reference(file, reference=None, attributes=None) -> None:
+    """Edits the attributes of an IfcClassificationReference
 
-        For more information about the attributes and data types of an
-        IfcClassificationReference, consult the IFC documentation.
+    For more information about the attributes and data types of an
+    IfcClassificationReference, consult the IFC documentation.
 
-        :param reference: The IfcClassificationReference entity you want to edit
-        :type reference: ifcopenshell.entity_instance.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :return: None
-        :rtype: None
+    :param reference: The IfcClassificationReference entity you want to edit
+    :type reference: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            reference = model.by_type("IfcClassification")[0]
-            # Change the name of the reference to "Foo"
-            ifcopenshell.api.run("classification.edit_reference", model,
-                reference=reference, attributes={"Name": "Foo"})
-        """
-        self.file = file
-        self.settings = {"reference": reference, "attributes": attributes or {}}
+        reference = model.by_type("IfcClassification")[0]
+        # Change the name of the reference to "Foo"
+        ifcopenshell.api.run("classification.edit_reference", model,
+            reference=reference, attributes={"Name": "Foo"})
+    """
+    settings = {"reference": reference, "attributes": attributes or {}}
 
-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["reference"], name, value)
+    for name, value in settings["attributes"].items():
+        setattr(settings["reference"], name, value)

src/ifcopenshell-python/ifcopenshell/api/classification/remove_classification.py

@@ -20,30 +20,33 @@ import ifcopenshell
 import ifcopenshell.util.element
 
 
+def remove_classification(file: ifcopenshell.entity_instance, classification: ifcopenshell.entity_instance) -> None:
+    """Removes an IfcClassification from the project and all references
+
+    The classification and all of its relationships, children references,
+    and relationships between objects and child references are completely
+    removed from a project.
+
+    :param classification: The IfcClassification entity you want to remove
+    :type classification: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
+
+    Example:
+
+    .. code:: python
+
+        classification = model.by_type("IfcClassification")[0]
+        ifcopenshell.api.run("classification.remove_classification", model,
+            classification=classification)
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.settings = {"classification": classification}
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(self, file, classification=None):
-        """Removes an IfcClassification from the project and all references
-
-        The classification and all of its relationships, children references,
-        and relationships between objectse and child references are completely
-        removed from a project.
-
-        :param classification: The IfcClassification entity you want to remove
-        :type classification: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
-
-        Example:
-
-        .. code:: python
-
-            classification = model.by_type("IfcClassification")[0]
-            ifcopenshell.api.run("classification.remove_classification", model,
-                classification=classification)
-        """
-        self.file = file
-        self.settings = {"classification": classification}
-
     def execute(self):
         references = self.get_references(self.settings["classification"])
         for reference in references:

src/ifcopenshell-python/ifcopenshell/api/classification/remove_reference.py

@@ -21,107 +21,102 @@ import ifcopenshell.api
 import ifcopenshell.util.element
 
 
-class Usecase:
-    def __init__(
-        self,
-        file: ifcopenshell.file,
-        reference: ifcopenshell.entity_instance,
-        products: list[ifcopenshell.entity_instance],
-    ):
-        """Removes a classification reference from the list of products
+def remove_reference(
+    file: ifcopenshell.file,
+    reference: ifcopenshell.entity_instance,
+    products: list[ifcopenshell.entity_instance],
+) -> None:
+    """Removes a classification reference from the list of products
 
-        If the classification reference is no longer associated to any products,
-        the classification reference itself is also removed.
+    If the classification reference is no longer associated to any products,
+    the classification reference itself is also removed.
 
-        :param reference: The IfcClassificationReference entity of the
-            relationship you want to remove.
-        :type reference: ifcopenshell.entity_instance.entity_instance
-        :param product: The list fo object entities of the relationship you want to
-            remove.
-        :type product: list[ifcopenshell.entity_instance.entity_instance]
+    :param reference: The IfcClassificationReference entity of the
+        relationship you want to remove.
+    :type reference: ifcopenshell.entity_instance
+    :param product: The list fo object entities of the relationship you want to
+        remove.
+    :type product: list[ifcopenshell.entity_instance]
 
-        :raises TypeError: If file is IFC2X3 and `products` has non-IfcRoot elements.
+    :raises TypeError: If file is IFC2X3 and `products` has non-IfcRoot elements.
 
-        :return: None
-        :rtype: None
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            wall_type = model.by_type("IfcWallType")[0]
-            classification = ifcopenshell.api.run("classification.add_classification",
-                model, classification="MyCustomClassification")
-            reference = ifcopenshell.api.run("classification.add_reference", model,
-                products=[wall_type], classification=classification,
-                identification="W_01", name="Interior Walls")
-            ifcopenshell.api.run("classification.remove_reference", model,
-                reference=reference, products=[wall_type])
-        """
-        self.file = file
-        self.settings = {"reference": reference, "products": products}
+        wall_type = model.by_type("IfcWallType")[0]
+        classification = ifcopenshell.api.run("classification.add_classification",
+            model, classification="MyCustomClassification")
+        reference = ifcopenshell.api.run("classification.add_reference", model,
+            products=[wall_type], classification=classification,
+            identification="W_01", name="Interior Walls")
+        ifcopenshell.api.run("classification.remove_reference", model,
+            reference=reference, products=[wall_type])
+    """
+    settings = {"reference": reference, "products": products}
 
-    def execute(self) -> None:
-        is_ifc2x3 = self.file.schema == "IFC2X3"
-        products = set(self.settings["products"])
-        referenced = ifcopenshell.util.element.get_referenced_elements(self.settings["reference"])
-        products -= products.difference(referenced)
+    is_ifc2x3 = file.schema == "IFC2X3"
+    products = set(settings["products"])
+    referenced = ifcopenshell.util.element.get_referenced_elements(settings["reference"])
+    products -= products.difference(referenced)
 
-        # all products are already unassigned from a reference
-        if not products:
-            return
+    # all products are already unassigned from a reference
+    if not products:
+        return
 
-        rooted_products: set[ifcopenshell.entity_instance] = set()
-        non_rooted_products: set[ifcopenshell.entity_instance] = set()
-        for product in self.settings["products"]:
-            if product.is_a("IfcRoot"):
-                rooted_products.add(product)
+    rooted_products: set[ifcopenshell.entity_instance] = set()
+    non_rooted_products: set[ifcopenshell.entity_instance] = set()
+    for product in settings["products"]:
+        if product.is_a("IfcRoot"):
+            rooted_products.add(product)
+        else:
+            non_rooted_products.add(product)
+
+    if non_rooted_products and is_ifc2x3:
+        raise TypeError(f"Cannot add reference to non-IfcRoot element in IFC2X3: {non_rooted_products}.")
+
+    if rooted_products:
+        reference_rels: set[ifcopenshell.entity_instance] = set()
+        for product in rooted_products:
+            reference_rels.update(product.HasAssociations)
+
+        reference_rels = {
+            rel
+            for rel in reference_rels
+            if rel.is_a("IfcRelAssociatesClassification") and rel.RelatingClassification == settings["reference"]
+        }
+
+        for rel in reference_rels:
+            related_objects = set(rel.RelatedObjects) - rooted_products
+            if related_objects:
+                rel.RelatedObjects = list(related_objects)
+                ifcopenshell.api.run("owner.update_owner_history", file, **{"element": rel})
             else:
-                non_rooted_products.add(product)
+                history = rel.OwnerHistory
+                file.remove(rel)
+                if history:
+                    ifcopenshell.util.element.remove_deep2(file, history)
 
-        if non_rooted_products and is_ifc2x3:
-            raise TypeError(f"Cannot add reference to non-IfcRoot element in IFC2X3: {non_rooted_products}.")
+    if non_rooted_products:
+        reference_rels: set[ifcopenshell.entity_instance] = set()
+        for product in non_rooted_products:
+            rels = getattr(product, "HasExternalReferences", None)
+            if rels is None:
+                rels = getattr(product, "HasExternalReference", [])
+            reference_rels.update(rels)
 
-        if rooted_products:
-            reference_rels: set[ifcopenshell.entity_instance] = set()
-            for product in rooted_products:
-                reference_rels.update(product.HasAssociations)
+        reference_rels = {rel for rel in reference_rels if rel.RelatingReference == settings["reference"]}
+        for rel in reference_rels:
+            related_objects = set(rel.RelatedResourceObjects) - non_rooted_products
+            if related_objects:
+                rel.RelatedResourceObjects = list(related_objects)
+            else:
+                file.remove(rel)
 
-            reference_rels = {
-                rel
-                for rel in reference_rels
-                if rel.is_a("IfcRelAssociatesClassification")
-                and rel.RelatingClassification == self.settings["reference"]
-            }
-
-            for rel in reference_rels:
-                related_objects = set(rel.RelatedObjects) - rooted_products
-                if related_objects:
-                    rel.RelatedObjects = list(related_objects)
-                    ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": rel})
-                else:
-                    history = rel.OwnerHistory
-                    self.file.remove(rel)
-                    if history:
-                        ifcopenshell.util.element.remove_deep2(self.file, history)
-
-        if non_rooted_products:
-            reference_rels: set[ifcopenshell.entity_instance] = set()
-            for product in non_rooted_products:
-                rels = getattr(product, "HasExternalReferences", None)
-                if rels is None:
-                    rels = getattr(product, "HasExternalReference", [])
-                reference_rels.update(rels)
-
-            reference_rels = {rel for rel in reference_rels if rel.RelatingReference == self.settings["reference"]}
-            for rel in reference_rels:
-                related_objects = set(rel.RelatedResourceObjects) - non_rooted_products
-                if related_objects:
-                    rel.RelatedResourceObjects = list(related_objects)
-                else:
-                    self.file.remove(rel)
-
-        # TODO: we only handle lightweight classifications here
-        referenced_elements = ifcopenshell.util.element.get_referenced_elements(self.settings["reference"])
-        if not referenced_elements:
-            self.file.remove(self.settings["reference"])
+    # TODO: we only handle lightweight classifications here
+    referenced_elements = ifcopenshell.util.element.get_referenced_elements(settings["reference"])
+    if not referenced_elements:
+        file.remove(settings["reference"])

src/ifcopenshell-python/ifcopenshell/api/constraint/__init__.py

@@ -15,3 +15,13 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+from .add_metric import add_metric
+from .add_metric_reference import add_metric_reference
+from .add_objective import add_objective
+from .assign_constraint import assign_constraint
+from .edit_metric import edit_metric
+from .edit_objective import edit_objective
+from .remove_constraint import remove_constraint
+from .remove_metric import remove_metric
+from .unassign_constraint import unassign_constraint

src/ifcopenshell-python/ifcopenshell/api/constraint/add_metric.py

@@ -19,44 +19,41 @@
 import ifcopenshell
 
 
-class Usecase:
-    def __init__(self, file, objective=None):
-        """Add a new metric benchmark
+def add_metric(file, objective=None) -> None:
+    """Add a new metric benchmark
 
-        Qualitative constraints may have a series of quantitative benchmarks
-        linked to it known as metrics. Metrics may be parametrically linked to
-        computed model properties or quantities. Metrics need to be satisfied
-        to meet the objective of the constraint.
+    Qualitative constraints may have a series of quantitative benchmarks
+    linked to it known as metrics. Metrics may be parametrically linked to
+    computed model properties or quantities. Metrics need to be satisfied
+    to meet the objective of the constraint.
 
-        :param objective: The IfcObjective that this metric is a benchmark of.
-        :type objective: ifcopenshell.entity_instance.entity_instance
-        :return: The newly created IfcMetric entity
-        :rtype: ifcopenshell.entity_instance.entity_instance
+    :param objective: The IfcObjective that this metric is a benchmark of.
+    :type objective: ifcopenshell.entity_instance
+    :return: The newly created IfcMetric entity
+    :rtype: ifcopenshell.entity_instance
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            objective = ifcopenshell.api.run("constraint.add_objective", model)
-            metric = ifcopenshell.api.run("constraint.add_metric", model,
-                objective=objective)
-        """
-        self.file = file
-        self.settings = {
-            "objective": objective,
+        objective = ifcopenshell.api.run("constraint.add_objective", model)
+        metric = ifcopenshell.api.run("constraint.add_metric", model,
+            objective=objective)
+    """
+    settings = {
+        "objective": objective,
+    }
+
+    metric = file.create_entity(
+        "IfcMetric",
+        **{
+            "Name": "Unnamed",
+            "ConstraintGrade": "NOTDEFINED",
+            "Benchmark": "EQUALTO",
         }
-
-    def execute(self):
-        metric = self.file.create_entity(
-            "IfcMetric",
-            **{
-                "Name": "Unnamed",
-                "ConstraintGrade": "NOTDEFINED",
-                "Benchmark": "EQUALTO",
-            }
-        )
-        if self.settings["objective"]:
-            benchmark_values = list(self.settings["objective"].BenchmarkValues or [])
-            benchmark_values.append(metric)
-            self.settings["objective"].BenchmarkValues = benchmark_values
-        return metric
+    )
+    if settings["objective"]:
+        benchmark_values = list(settings["objective"].BenchmarkValues or [])
+        benchmark_values.append(metric)
+        settings["objective"].BenchmarkValues = benchmark_values
+    return metric

src/ifcopenshell-python/ifcopenshell/api/constraint/add_metric_reference.py

@@ -18,28 +18,26 @@
 
 import ifcopenshell
 
-class Usecase:
-    def __init__(self, file, metric=None, reference_path=None):
-        """
-        Adds a chain of references to a metric. The reference path is a string of the form "attribute.attribute.attribute" 
-        Used to reference a value of an attribute of an instance through a metric objective entity.
-        """
-        self.file = file
-        self.settings = {"metric": metric, "reference_path": reference_path}
 
-    def execute(self):
-        if self.settings["reference_path"]:
-            attributes = self.settings["reference_path"].split(".")
-            references_created = []
-            for i in range(len(attributes)):
-                if i == 0:
-                    reference = self.file.create_entity("IfcReference")
-                    reference.AttributeIdentifier = attributes[i]
-                    self.settings["metric"].ReferencePath = reference
-                    references_created.append(reference)
-                else:
-                    reference = self.file.create_entity("IfcReference")
-                    reference.AttributeIdentifier = attributes[i]
-                    references_created[i-1].InnerReference = reference
-                    references_created.append(reference)
-            return references_created
+def add_metric_reference(file, metric=None, reference_path=None) -> None:
+    """
+    Adds a chain of references to a metric. The reference path is a string of the form "attribute.attribute.attribute"
+    Used to reference a value of an attribute of an instance through a metric objective entity.
+    """
+    settings = {"metric": metric, "reference_path": reference_path}
+
+    if settings["reference_path"]:
+        attributes = settings["reference_path"].split(".")
+        references_created = []
+        for i in range(len(attributes)):
+            if i == 0:
+                reference = file.create_entity("IfcReference")
+                reference.AttributeIdentifier = attributes[i]
+                settings["metric"].ReferencePath = reference
+                references_created.append(reference)
+            else:
+                reference = file.create_entity("IfcReference")
+                reference.AttributeIdentifier = attributes[i]
+                references_created[i - 1].InnerReference = reference
+                references_created.append(reference)
+        return references_created

src/ifcopenshell-python/ifcopenshell/api/constraint/add_objective.py

@@ -19,34 +19,31 @@
 import ifcopenshell
 
 
-class Usecase:
-    def __init__(self, file):
-        """Add a new objective constraint
+def add_objective(file) -> None:
+    """Add a new objective constraint
 
-        Parametric constraints may be defined by the user. The constraint is defined
-        by first creating an objective describing the purpose of the constraint and
-        whether it is a hard or soft constraint. Later on, metrics may be added to
-        check whether the constraint has been met by connecting it to properties and
-        quantities. See ifcopenshell.api.constraint.add_metric for more information.
+    Parametric constraints may be defined by the user. The constraint is defined
+    by first creating an objective describing the purpose of the constraint and
+    whether it is a hard or soft constraint. Later on, metrics may be added to
+    check whether the constraint has been met by connecting it to properties and
+    quantities. See ifcopenshell.api.constraint.add_metric for more information.
 
-        :return: The newly created IfcObjective entity
-        :rtype: ifcopenshell.entity_instance.entity_instance
+    :return: The newly created IfcObjective entity
+    :rtype: ifcopenshell.entity_instance
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            # Create a new objective for code compliance requirements
-            objective = ifcopenshell.api.run("constraint.add_objective", model)
-            objective.ConstraintGrade = "ADVISORY"
-            objective.ObjectiveQualifier = "CODECOMPLIANCE"
-            # Note: the objective right now is purely qualitative and for
-            # information purposes. You may wish to add quantiative metrics.
-        """
-        self.file = file
-        self.settings = {}
+        # Create a new objective for code compliance requirements
+        objective = ifcopenshell.api.run("constraint.add_objective", model)
+        objective.ConstraintGrade = "ADVISORY"
+        objective.ObjectiveQualifier = "CODECOMPLIANCE"
+        # Note: the objective right now is purely qualitative and for
+        # information purposes. You may wish to add quantiative metrics.
+    """
+    settings = {}
 
-    def execute(self):
-        return self.file.create_entity(
-            "IfcObjective", **{"Name": "Unnamed", "ConstraintGrade": "NOTDEFINED", "ObjectiveQualifier": "NOTDEFINED"}
-        )
+    return file.create_entity(
+        "IfcObjective", **{"Name": "Unnamed", "ConstraintGrade": "NOTDEFINED", "ObjectiveQualifier": "NOTDEFINED"}
+    )

src/ifcopenshell-python/ifcopenshell/api/constraint/assign_constraint.py

@@ -21,39 +21,41 @@ import ifcopenshell.api
 from typing import Union
 
 
+def assign_constraint(
+    file: ifcopenshell.file,
+    products: list[ifcopenshell.entity_instance],
+    constraint: ifcopenshell.entity_instance,
+) -> Union[ifcopenshell.entity_instance, None]:
+    """Assigns a constraint to a list of products
+
+    This assigns a relationship between a product and a constraint, so that
+    when a product's properties and quantities do not match the requirements
+    of the constraint's metrics, results can be flagged.
+
+    It is assumed (but not explicit in the IFC documentation) that
+    constraints are inherited from the type. This way, it is not necessary
+    to create lots of constraint assignments.
+
+    :param products: The list of products the constraint applies to. This is anything
+        which can have properties or quantities.
+    :type products: list[ifcopenshell.entity_instance]
+    :param constraint: The IfcObjective constraint
+    :type constraint: ifcopenshell.entity_instance
+    :return: The new or updated IfcRelAssociatesConstraint relationship
+        or `None` if `products` was an empty list.
+    :rtype: ifcopenshell.entity_instance
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.settings = {
+        "products": products,
+        "constraint": constraint,
+    }
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(
-        self,
-        file: ifcopenshell.file,
-        products: list[ifcopenshell.entity_instance],
-        constraint: ifcopenshell.entity_instance,
-    ):
-        """Assigns a constraint to a list of products
-
-        This assigns a relationship between a product and a constraint, so that
-        when a product's properties and quantities do not match the requirements
-        of the constraint's metrics, results can be flagged.
-
-        It is assumed (but not explicit in the IFC documentation) that
-        constraints are inherited from the type. This way, it is not necessary
-        to create lots of constraint assignments.
-
-        :param products: The list of products the constraint applies to. This is anything
-            which can have properties or quantities.
-        :type products: list[ifcopenshell.entity_instance.entity_instance]
-        :param constraint: The IfcObjective constraint
-        :type constraint: ifcopenshell.entity_instance.entity_instance
-        :return: The new or updated IfcRelAssociatesConstraint relationship
-            or `None` if `products` was an empty list.
-        :rtype: ifcopenshell.entity_instance.entity_instance
-        """
-        self.file = file
-        self.settings = {
-            "products": products,
-            "constraint": constraint,
-        }
-
-    def execute(self) -> Union[ifcopenshell.entity_instance, None]:
+    def execute(self):
         products = set(self.settings["products"])
         if not products:
             return

src/ifcopenshell-python/ifcopenshell/api/constraint/edit_metric.py

@@ -17,33 +17,30 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, metric=None, attributes=None):
-        """Edit the attributes of a metric
+def edit_metric(file, metric=None, attributes=None) -> None:
+    """Edit the attributes of a metric
 
-        For more information about the attributes and data types of an
-        IfcMetric, consult the IFC documentation.
+    For more information about the attributes and data types of an
+    IfcMetric, consult the IFC documentation.
 
-        :param metric: The IfcMetric you want to edit.
-        :type metric: ifcopenshell.entity_instance.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :return: None
-        :rtype: None
+    :param metric: The IfcMetric you want to edit.
+    :type metric: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            objective = ifcopenshell.api.run("constraint.add_objective", model)
-            metric = ifcopenshell.api.run("constraint.add_metric", model,
-                objective=objective)
-            ifcopenshell.api.run("constraint.edit_metric", model,
-                metric=metric, attributes={"ConstraintGrade": "HARD"})
-        """
-        self.file = file
-        self.settings = {"metric": metric, "attributes": attributes or {}}
+        objective = ifcopenshell.api.run("constraint.add_objective", model)
+        metric = ifcopenshell.api.run("constraint.add_metric", model,
+            objective=objective)
+        ifcopenshell.api.run("constraint.edit_metric", model,
+            metric=metric, attributes={"ConstraintGrade": "HARD"})
+    """
+    settings = {"metric": metric, "attributes": attributes or {}}
 
-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["metric"], name, value)
+    for name, value in settings["attributes"].items():
+        setattr(settings["metric"], name, value)

src/ifcopenshell-python/ifcopenshell/api/constraint/edit_objective.py

@@ -17,31 +17,28 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, objective=None, attributes=None):
-        """Edit the attributes of a objective
+def edit_objective(file, objective=None, attributes=None) -> None:
+    """Edit the attributes of a objective
 
-        For more information about the attributes and data types of an
-        IfcObjective, consult the IFC documentation.
+    For more information about the attributes and data types of an
+    IfcObjective, consult the IFC documentation.
 
-        :param objective: The IfcObjective you want to edit.
-        :type objective: ifcopenshell.entity_instance.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :return: None
-        :rtype: None
+    :param objective: The IfcObjective you want to edit.
+    :type objective: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            objective = ifcopenshell.api.run("constraint.add_objective", model)
-            ifcopenshell.api.run("constraint.edit_objective", model,
-                objective=objective, attributes={"ConstraintGrade": "HARD"})
-        """
-        self.file = file
-        self.settings = {"objective": objective, "attributes": attributes or {}}
+        objective = ifcopenshell.api.run("constraint.add_objective", model)
+        ifcopenshell.api.run("constraint.edit_objective", model,
+            objective=objective, attributes={"ConstraintGrade": "HARD"})
+    """
+    settings = {"objective": objective, "attributes": attributes or {}}
 
-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["objective"], name, value)
+    for name, value in settings["attributes"].items():
+        setattr(settings["objective"], name, value)

src/ifcopenshell-python/ifcopenshell/api/constraint/remove_constraint.py

@@ -20,36 +20,33 @@ import ifcopenshell
 import ifcopenshell.util.element
 
 
-class Usecase:
-    def __init__(self, file, constraint=None):
-        """Remove a constraint (typically an objective)
+def remove_constraint(file, constraint=None) -> None:
+    """Remove a constraint (typically an objective)
 
-        Removes a constraint definition and all of its associations to any
-        products. Typically this would be an IfcObjective, although technically
-        you can associate IfcMetrics ith products too, though the meaning may be
-        unclear.
+    Removes a constraint definition and all of its associations to any
+    products. Typically this would be an IfcObjective, although technically
+    you can associate IfcMetrics ith products too, though the meaning may be
+    unclear.
 
-        :param constraint: The IfcObjective you want to remove.
-        :type constraint: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
+    :param constraint: The IfcObjective you want to remove.
+    :type constraint: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            objective = ifcopenshell.api.run("constraint.add_objective", model)
-            ifcopenshell.api.run("constraint.remove_constraint", model,
-                constraint=objective)
-        """
-        self.file = file
-        self.settings = {"constraint": constraint}
+        objective = ifcopenshell.api.run("constraint.add_objective", model)
+        ifcopenshell.api.run("constraint.remove_constraint", model,
+            constraint=objective)
+    """
+    settings = {"constraint": constraint}
 
-    def execute(self):
-        self.file.remove(self.settings["constraint"])
-        for rel in self.file.by_type("IfcRelAssociatesConstraint"):
-            if not rel.RelatingConstraint:
-                history = rel.OwnerHistory
-                self.file.remove(rel)
-                if history:
-                    ifcopenshell.util.element.remove_deep2(self.file, history)
+    file.remove(settings["constraint"])
+    for rel in file.by_type("IfcRelAssociatesConstraint"):
+        if not rel.RelatingConstraint:
+            history = rel.OwnerHistory
+            file.remove(rel)
+            if history:
+                ifcopenshell.util.element.remove_deep2(file, history)

src/ifcopenshell-python/ifcopenshell/api/constraint/remove_metric.py

@@ -17,31 +17,34 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
+def remove_metric(file, metric=None) -> None:
+    """Remove a metric benchmark
+
+    Removes a metric benchmark and all of its associations to any products
+    and objectives.
+
+    :param metric: The IfcMetric you want to remove.
+    :type metric: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
+
+    Example:
+
+    .. code:: python
+
+        objective = ifcopenshell.api.run("constraint.add_objective", model)
+        metric = ifcopenshell.api.run("constraint.add_metric", model,
+            objective=objective)
+        ifcopenshell.api.run("constraint.remove_metric", model,
+            metric=metric)
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.settings = {"metric": metric}
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(self, file, metric=None):
-        """Remove a metric benchmark
-
-        Removes a metric benchmark and all of its associations to any products
-        and objectives.
-
-        :param metric: The IfcMetric you want to remove.
-        :type metric: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
-
-        Example:
-
-        .. code:: python
-
-            objective = ifcopenshell.api.run("constraint.add_objective", model)
-            metric = ifcopenshell.api.run("constraint.add_metric", model,
-                objective=objective)
-            ifcopenshell.api.run("constraint.remove_metric", model,
-                metric=metric)
-        """
-        self.file = file
-        self.settings = {"metric": metric}
-
     def execute(self):
         if self.settings["metric"].ReferencePath:
             reference = self.settings["metric"].ReferencePath

src/ifcopenshell-python/ifcopenshell/api/constraint/unassign_constraint.py

@@ -21,31 +21,33 @@ import ifcopenshell.api
 import ifcopenshell.util.element
 
 
+def unassign_constraint(
+    file: ifcopenshell.file,
+    products: list[ifcopenshell.entity_instance],
+    constraint: ifcopenshell.entity_instance,
+) -> None:
+    """Unassigns a constraint from a list of products
+
+    The constraint will not be deleted and is available to be assigned to
+    other products.
+
+    :param products: The list of products the constraint applies to.
+    :type products: list[ifcopenshell.entity_instance]
+    :param constraint: The IfcObjective constraint
+    :type constraint: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.settings = {
+        "products": products,
+        "constraint": constraint,
+    }
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(
-        self,
-        file: ifcopenshell.file,
-        products: list[ifcopenshell.entity_instance],
-        constraint: ifcopenshell.entity_instance,
-    ):
-        """Unassigns a constraint from a list of products
-
-        The constraint will not be deleted and is available to be assigned to
-        other products.
-
-        :param products: The list of products the constraint applies to.
-        :type products: list[ifcopenshell.entity_instance.entity_instance]
-        :param constraint: The IfcObjective constraint
-        :type constraint: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
-        """
-        self.file = file
-        self.settings = {
-            "products": products,
-            "constraint": constraint,
-        }
-
     def execute(self):
         products = set(self.settings["products"])
         if not products:

src/ifcopenshell-python/ifcopenshell/api/context/__init__.py

@@ -15,3 +15,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+from .add_context import add_context
+from .edit_context import edit_context
+from .remove_context import remove_context

src/ifcopenshell-python/ifcopenshell/api/context/add_context.py

@@ -17,168 +17,171 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
+def add_context(file, context_type=None, context_identifier=None, target_view=None, parent=None) -> None:
+    """Adds a new geometric representation context
+
+    In IFC, physical objects may have zero, one, or multiple geometric
+    representations associated with it. For example, a building storey might
+    not have any geometry, but simply be a coordinate in space.
+    Alternatively, a wall might have a 3D body representation in the form of
+    a cuboid. As a final example, a door might also have a 3D body
+    representation of a 3D door panel and door frame, but may additionally
+    have a 2D door plan view representation of the door swing, and even a 2D
+    elevation view of the door, a 3D box representing the disabled clearance
+    zone of the door, a 2D profile representing the profile of the door to
+    cut out in a wall, and so on. In this situation, a door will have
+    multiple geometric representations.
+
+    To distinguish between the different purposes of multiple geometric
+    representations, each geometric representation must belong to a
+    geometric representation "context". There are typically always 2
+    contexts, one for 3D representations and one for 2D representations.
+    These 2 contexts then have subcontexts for things like the 3D body
+    representation, clearance representations, annotation representations,
+    and so on. Each representation of a physical IFC product (e.g. a door)
+    must be assigned to one of these subcontexts. Therefore setting up
+    appropriate contexts is critical prior to authoring any IFC model which
+    contains geometry.
+
+    There are two steps to setting up appropriate subcontexts. First, a 2D
+    and/or 3D context must be added. These must be always called the "Model"
+    context for 3D and the "Plan" context for 2D (even if the 2D geometry is
+    not a plan view). Then, one or more subcontexts are added using either
+    the "Model" or "Plan" as their parent. These subcontexts are further
+    distinguished using an "identifier" and "target view". The "identifier"
+    describes the purpose of the representation, and the "target view"
+    describes the typical diagrammatic presentation that context's geometry
+    should be viewed in. The most common identifiers you might use are:
+
+    - Body: for the actual shape of the object
+    - Box: the bounding box of the object (useful for shape analytics)
+    - Axis: the parametric line determining the shape of the object
+    - Profile: the elevation silhouette of the object, useful for cutting
+          out holes for the object to fit into host elements
+    - Footprint: the plan view silhouette of the object, useful for certain
+          quantity take-off rules
+    - Clearance: the clearance zone of the object
+    - Annotation: symbolic annotations typically used in diagrams or
+          drawings
+
+    The most common "target views" you might use are:
+
+    - MODEL_VIEW: for 3D geometry you might see in a BIM viewer
+    - PLAN_VIEW: for 2D geometry you might see in a plan representation
+    - ELEVATION_VIEW: for 2D geometry you might see in an elevation representation
+    - SECTION_VIEW: for 2D geometry you might see in a section representation
+    - GRAPH_VIEW: for 2D or 3D line or frame or path connectivity diagrams
+          you might use for structural frame analysis, axis-based parametric
+          modeling
+    - SKETCH_VIEW: for viewing abstract high-level representations such as
+          in bubble diagrams of spatial topology
+
+    This may sound like a lot, but after a few typical contexts are set up
+    at the beginning, it becomes easy to navigate and isolate geometry for
+    different purposes. There is also the concept of a target scale, which
+    represents the zoom level detail of geometry, but this is not currently
+    supported by this API. Setting up all these contexts are also optional,
+    and you may only use a single Model context and Body subcontext for
+    simple models, but this simplification sacrifices the ability of more
+    parametric or analytical usecases.
+
+    :param context_type: The type of the context, must be one of "Model" or
+        "Plan" only.
+    :type context_type: str
+    :param context_identifier: The identifier of the context, chosen from
+        one of the common identifiers above or consult the IFC documentation
+        (under the IfcShapeRepresentation page) for more details. Optional
+        for contexts, but mandatory for subcontexts.
+    :type context_identifier: str, optional
+    :param target_view: the target view of the context, chosen from one of
+        the common target views above or consult the IFC documentation
+        (under the IfcShapeRepresentation page) for more details. Optional
+        for contexts, but mandatory for subcontexts.
+    :type target_view: str, optional
+    :param parent: the parent context. Must be left as None (the default)
+        for contexts, and only set for subcontexts. Note that there are only
+        contexts and subcontexts, a subcontext cannot have any children.
+    :type parent: ifcopenshell.entity_instance, optional
+    :return: the newly created IfcGeometricRepresentationContext or
+        IfcGeometricRepresentationSubContext entity
+    :rtype: ifcopenshell.entity_instance, optional
+
+    Example:
+
+    .. code:: python
+
+        # If we plan to store 3D geometry in our IFC model, we have to setup
+        # a "Model" context.
+        model3d = ifcopenshell.api.run("context.add_context", model, context_type="Model")
+
+        # And/Or, if we plan to store 2D geometry, we need a "Plan" context
+        plan = ifcopenshell.api.run("context.add_context", model, context_type="Plan")
+
+        # Now we setup the subcontexts with each of the geometric "purposes"
+        # we plan to store in our model. "Body" is by far the most important
+        # and common context, as most IFC models are assumed to be viewable
+        # in 3D.
+        body = ifcopenshell.api.run("context.add_context", model,
+            context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model3d)
+
+        # The 3D Axis subcontext is important if any "axis-based" parametric
+        # geometry is going to be created. For example, a beam, or column
+        # may be drawn using a single 3D axis line, and for this we need an
+        # Axis subcontext.
+        ifcopenshell.api.run("context.add_context", model,
+            context_type="Model", context_identifier="Axis", target_view="GRAPH_VIEW", parent=model3d)
+
+        # The 3D Box subcontext is useful for clash detection or shape
+        # analysis, or even lazy-loading of large models.
+        ifcopenshell.api.run("context.add_context", model,
+            context_type="Model", context_identifier="Box", target_view="MODEL_VIEW", parent=model3d)
+
+        # It's also important to have a 2D Axis subcontext for things like
+        # walls and claddings which can be drawn using a 2D axis line.
+        ifcopenshell.api.run("context.add_context", model,
+            context_type="Plan", context_identifier="Axis", target_view="GRAPH_VIEW", parent=plan)
+
+        # A 2D annotation subcontext for plan views are important for door
+        # swings, window cuts, and symbols for equipment like GPOs, fire
+        # extinguishers, and so on.
+        ifcopenshell.api.run("context.add_context", model,
+            context_type="Plan", context_identifier="Annotation", target_view="PLAN_VIEW", parent=plan)
+
+        # You may also create 2D annotation subcontexts for sections and
+        # elevation views.
+        ifcopenshell.api.run("context.add_context", model,
+            context_type="Plan", context_identifier="Annotation", target_view="SECTION_VIEW", parent=plan)
+        ifcopenshell.api.run("context.add_context", model,
+            context_type="Plan", context_identifier="Annotation", target_view="ELEVATION_VIEW", parent=plan)
+
+        # Let's create a new wall. The wall does not have any geometry yet.
+        wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
+
+        # Let's use the "3D Body" representation we created earlier to add a
+        # new wall-like body geometry, 5 meters long, 3 meters high, and
+        # 200mm thick
+        representation = ifcopenshell.api.run("geometry.add_wall_representation", model,
+            context=body, length=5, height=3, thickness=0.2)
+
+        # Assign our new body geometry back to our wall
+        ifcopenshell.api.run("geometry.assign_representation", model,
+            product=wall, representation=representation)
+
+        # Place our wall at the origin
+        ifcopenshell.api.run("geometry.edit_object_placement", model, product=wall)
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.settings = {
+        "context_type": context_type,
+        "parent": parent,
+        "context_identifier": context_identifier,
+        "target_view": target_view,
+    }
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(self, file, context_type=None, context_identifier=None, target_view=None, parent=None):
-        """Adds a new geometric representation context
-
-        In IFC, physical objects may have zero, one, or multiple geometric
-        representations associated with it. For example, a building storey might
-        not have any geometry, but simply be a coordinate in space.
-        Alternatively, a wall might have a 3D body representation in the form of
-        a cuboid. As a final example, a door might also have a 3D body
-        representation of a 3D door panel and door frame, but may additionally
-        have a 2D door plan view representation of the door swing, and even a 2D
-        elevation view of the door, a 3D box representing the disabled clearance
-        zone of the door, a 2D profile representing the profile of the door to
-        cut out in a wall, and so on. In this situation, a door will have
-        multiple geometric representations.
-
-        To distinguish between the different purposes of multiple geometric
-        representations, each geometric representation must belong to a
-        geometric representation "context". There are typically always 2
-        contexts, one for 3D representations and one for 2D representations.
-        These 2 contexts then have subcontexts for things like the 3D body
-        representation, clearance representations, annotation representations,
-        and so on. Each representation of a physical IFC product (e.g. a door)
-        must be assigned to one of these subcontexts. Therefore setting up
-        appropriate contexts is critical prior to authoring any IFC model which
-        contains geometry.
-
-        There are two steps to setting up appropriate subcontexts. First, a 2D
-        and/or 3D context must be added. These must be always called the "Model"
-        context for 3D and the "Plan" context for 2D (even if the 2D geometry is
-        not a plan view). Then, one or more subcontexts are added using either
-        the "Model" or "Plan" as their parent. These subcontexts are further
-        distinguished using an "identifier" and "target view". The "identifier"
-        describes the purpose of the representation, and the "target view"
-        describes the typical diagrammatic presentation that context's geometry
-        should be viewed in. The most common identifiers you might use are:
-
-        - Body: for the actual shape of the object
-        - Box: the bounding box of the object (useful for shape analytics)
-        - Axis: the parametric line determining the shape of the object
-        - Profile: the elevation silhouette of the object, useful for cutting
-              out holes for the object to fit into host elements
-        - Footprint: the plan view silhouette of the object, useful for certain
-              quantity take-off rules
-        - Clearance: the clearance zone of the object
-        - Annotation: symbolic annotations typically used in diagrams or
-              drawings
-
-        The most common "target views" you might use are:
-
-        - MODEL_VIEW: for 3D geometry you might see in a BIM viewer
-        - PLAN_VIEW: for 2D geometry you might see in a plan representation
-        - ELEVATION_VIEW: for 2D geometry you might see in an elevation representation
-        - SECTION_VIEW: for 2D geometry you might see in a section representation
-        - GRAPH_VIEW: for 2D or 3D line or frame or path connectivity diagrams
-              you might use for structural frame analysis, axis-based parametric
-              modeling
-        - SKETCH_VIEW: for viewing abstract high-level representations such as
-              in bubble diagrams of spatial topology
-
-        This may sound like a lot, but after a few typical contexts are set up
-        at the beginning, it becomes easy to navigate and isolate geometry for
-        different purposes. There is also the concept of a target scale, which
-        represents the zoom level detail of geometry, but this is not currently
-        supported by this API. Setting up all these contexts are also optional,
-        and you may only use a single Model context and Body subcontext for
-        simple models, but this simplification sacrifices the ability of more
-        parametric or analytical usecases.
-
-        :param context_type: The type of the context, must be one of "Model" or
-            "Plan" only.
-        :type context_type: str
-        :param context_identifier: The identifier of the context, chosen from
-            one of the common identifiers above or consult the IFC documentation
-            (under the IfcShapeRepresentation page) for more details. Optional
-            for contexts, but mandatory for subcontexts.
-        :type context_identifier: str, optional
-        :param target_view: the target view of the context, chosen from one of
-            the common target views above or consult the IFC documentation
-            (under the IfcShapeRepresentation page) for more details. Optional
-            for contexts, but mandatory for subcontexts.
-        :type target_view: str, optional
-        :param parent: the parent context. Must be left as None (the default)
-            for contexts, and only set for subcontexts. Note that there are only
-            contexts and subcontexts, a subcontext cannot have any children.
-        :type parent: ifcopenshell.entity_instance.entity_instance, optional
-        :return: the newly created IfcGeometricRepresentationContext or
-            IfcGeometricRepresentationSubContext entity
-        :rtype: ifcopenshell.entity_instance.entity_instance, optional
-
-        Example:
-
-        .. code:: python
-
-            # If we plan to store 3D geometry in our IFC model, we have to setup
-            # a "Model" context.
-            model3d = ifcopenshell.api.run("context.add_context", model, context_type="Model")
-
-            # And/Or, if we plan to store 2D geometry, we need a "Plan" context
-            plan = ifcopenshell.api.run("context.add_context", model, context_type="Plan")
-
-            # Now we setup the subcontexts with each of the geometric "purposes"
-            # we plan to store in our model. "Body" is by far the most important
-            # and common context, as most IFC models are assumed to be viewable
-            # in 3D.
-            body = ifcopenshell.api.run("context.add_context", model,
-                context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model3d)
-
-            # The 3D Axis subcontext is important if any "axis-based" parametric
-            # geometry is going to be created. For example, a beam, or column
-            # may be drawn using a single 3D axis line, and for this we need an
-            # Axis subcontext.
-            ifcopenshell.api.run("context.add_context", model,
-                context_type="Model", context_identifier="Axis", target_view="GRAPH_VIEW", parent=model3d)
-
-            # The 3D Box subcontext is useful for clash detection or shape
-            # analysis, or even lazy-loading of large models.
-            ifcopenshell.api.run("context.add_context", model,
-                context_type="Model", context_identifier="Box", target_view="MODEL_VIEW", parent=model3d)
-
-            # It's also important to have a 2D Axis subcontext for things like
-            # walls and claddings which can be drawn using a 2D axis line.
-            ifcopenshell.api.run("context.add_context", model,
-                context_type="Plan", context_identifier="Axis", target_view="GRAPH_VIEW", parent=plan)
-
-            # A 2D annotation subcontext for plan views are important for door
-            # swings, window cuts, and symbols for equipment like GPOs, fire
-            # extinguishers, and so on.
-            ifcopenshell.api.run("context.add_context", model,
-                context_type="Plan", context_identifier="Annotation", target_view="PLAN_VIEW", parent=plan)
-
-            # You may also create 2D annotation subcontexts for sections and
-            # elevation views.
-            ifcopenshell.api.run("context.add_context", model,
-                context_type="Plan", context_identifier="Annotation", target_view="SECTION_VIEW", parent=plan)
-            ifcopenshell.api.run("context.add_context", model,
-                context_type="Plan", context_identifier="Annotation", target_view="ELEVATION_VIEW", parent=plan)
-
-            # Let's create a new wall. The wall does not have any geometry yet.
-            wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
-
-            # Let's use the "3D Body" representation we created earlier to add a
-            # new wall-like body geometry, 5 meters long, 3 meters high, and
-            # 200mm thick
-            representation = ifcopenshell.api.run("geometry.add_wall_representation", model,
-                context=body, length=5, height=3, thickness=0.2)
-
-            # Assign our new body geometry back to our wall
-            ifcopenshell.api.run("geometry.assign_representation", model,
-                product=wall, representation=representation)
-
-            # Place our wall at the origin
-            ifcopenshell.api.run("geometry.edit_object_placement", model, product=wall)
-        """
-        self.file = file
-        self.settings = {
-            "context_type": context_type,
-            "parent": parent,
-            "context_identifier": context_identifier,
-            "target_view": target_view,
-        }
-
     def execute(self):
         if not self.settings["parent"]:
             if self.settings["context_type"] == "Plan":

src/ifcopenshell-python/ifcopenshell/api/context/edit_context.py

@@ -17,37 +17,34 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, context, attributes):
-        """Edits the attributes of an IfcGeometricRepresentationContext
+def edit_context(file, context, attributes) -> None:
+    """Edits the attributes of an IfcGeometricRepresentationContext
 
-        For more information about the attributes and data types of an
-        IfcGeometricRepresentationContext, consult the IFC documentation.
+    For more information about the attributes and data types of an
+    IfcGeometricRepresentationContext, consult the IFC documentation.
 
-        :param context: The IfcGeometricRepresentationContext entity you want to edit
-        :type context: ifcopenshell.entity_instance.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :return: None
-        :rtype: None
+    :param context: The IfcGeometricRepresentationContext entity you want to edit
+    :type context: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            model = ifcopenshell.api.run("context.add_context", model, context_type="Model")
-            # Revit had a bug where they incorrectly called the body representation a "Facetation"
-            body = ifcopenshell.api.run("context.add_context", model,
-                context_type="Model", context_identifier="Facetation", target_view="MODEL_VIEW", parent=model
-            )
+        model = ifcopenshell.api.run("context.add_context", model, context_type="Model")
+        # Revit had a bug where they incorrectly called the body representation a "Facetation"
+        body = ifcopenshell.api.run("context.add_context", model,
+            context_type="Model", context_identifier="Facetation", target_view="MODEL_VIEW", parent=model
+        )
 
-            # Let's fix it!
-            ifcopenshell.api.run("context.edit_context", model,
-                context=body, attributes={"ContextIdentifier": "Body"})
-        """
-        self.file = file
-        self.settings = {"context": context, "attributes": attributes or {}}
+        # Let's fix it!
+        ifcopenshell.api.run("context.edit_context", model,
+            context=body, attributes={"ContextIdentifier": "Body"})
+    """
+    settings = {"context": context, "attributes": attributes or {}}
 
-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["context"], name, value)
+    for name, value in settings["attributes"].items():
+        setattr(settings["context"], name, value)

src/ifcopenshell-python/ifcopenshell/api/context/remove_context.py

@@ -19,49 +19,46 @@
 import ifcopenshell
 
 
-class Usecase:
-    def __init__(self, file, context=None):
-        """Removes an IfcGeometricRepresentationContext
+def remove_context(file: ifcopenshell.entity_instance, context: ifcopenshell.entity_instance) -> None:
+    """Removes an IfcGeometricRepresentationContext
 
-        Any representation geometry that is assigned to the context is also
-        removed. If a context is removed, then any subcontexts are also removed.
+    Any representation geometry that is assigned to the context is also
+    removed. If a context is removed, then any subcontexts are also removed.
 
-        :param context: The IfcGeometricRepresentationContext entity to remove
-        :type context: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
+    :param context: The IfcGeometricRepresentationContext entity to remove
+    :type context: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            model = ifcopenshell.api.run("context.add_context", model, context_type="Model")
-            # Revit had a bug where they incorrectly called the body representation a "Facetation"
-            body = ifcopenshell.api.run("context.add_context", model,
-                context_type="Model", context_identifier="Facetation", target_view="MODEL_VIEW", parent=model
-            )
+        model = ifcopenshell.api.run("context.add_context", model, context_type="Model")
+        # Revit had a bug where they incorrectly called the body representation a "Facetation"
+        body = ifcopenshell.api.run("context.add_context", model,
+            context_type="Model", context_identifier="Facetation", target_view="MODEL_VIEW", parent=model
+        )
 
-            # Let's just get rid of it completely
-            ifcopenshell.api.run("context.remove_context", model, context=body)
-        """
-        self.file = file
-        self.settings = {"context": context}
+        # Let's just get rid of it completely
+        ifcopenshell.api.run("context.remove_context", model, context=body)
+    """
+    settings = {"context": context}
 
-    def execute(self):
-        for subcontext in self.settings["context"].HasSubContexts:
-            ifcopenshell.api.run("context.remove_context", self.file, context=subcontext)
+    for subcontext in settings["context"].HasSubContexts:
+        ifcopenshell.api.run("context.remove_context", file, context=subcontext)
 
-        if getattr(self.settings["context"], "ParentContext", None):
-            new = self.settings["context"].ParentContext
-            for inverse in self.file.get_inverse(self.settings["context"]):
-                if inverse.is_a("IfcCoordinateOperation"):
-                    inverse.SourceCRS = inverse.TargetCRS
-                    ifcopenshell.util.element.remove_deep(self.file, inverse)
-                else:
-                    ifcopenshell.util.element.replace_attribute(inverse, self.settings["context"], new)
-            self.file.remove(self.settings["context"])
-        else:
-            representations_in_context = self.settings["context"].RepresentationsInContext
-            self.file.remove(self.settings["context"])
-            for element in representations_in_context:
-                ifcopenshell.api.run("geometry.remove_representation", self.file, representation=element)
+    if getattr(settings["context"], "ParentContext", None):
+        new = settings["context"].ParentContext
+        for inverse in file.get_inverse(settings["context"]):
+            if inverse.is_a("IfcCoordinateOperation"):
+                inverse.SourceCRS = inverse.TargetCRS
+                ifcopenshell.util.element.remove_deep(file, inverse)
+            else:
+                ifcopenshell.util.element.replace_attribute(inverse, settings["context"], new)
+        file.remove(settings["context"])
+    else:
+        representations_in_context = settings["context"].RepresentationsInContext
+        file.remove(settings["context"])
+        for element in representations_in_context:
+            ifcopenshell.api.run("geometry.remove_representation", file, representation=element)

src/ifcopenshell-python/ifcopenshell/api/control/__init__.py

@@ -15,3 +15,6 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+from .assign_control import assign_control
+from .unassign_control import unassign_control

src/ifcopenshell-python/ifcopenshell/api/control/assign_control.py

@@ -20,87 +20,81 @@ import ifcopenshell
 import ifcopenshell.api
 
 
-class Usecase:
-    def __init__(self, file, relating_control=None, related_object=None):
-        """Assigns a planning control or constraint to an object
+def assign_control(file, relating_control=None, related_object=None) -> None:
+    """Assigns a planning control or constraint to an object
 
-        IFC can describe concepts that control other objects. For example, a
-        planning calendar controls the availability of working days for
-        construction planning. As another example, a cost item might constrain
-        or limit the ability to procure and build a product.
+    IFC can describe concepts that control other objects. For example, a
+    planning calendar controls the availability of working days for
+    construction planning. As another example, a cost item might constrain
+    or limit the ability to procure and build a product.
 
-        This usecase lets you assign controls following the rules of the IFC
-        specification. This is an advanced topic and assumes knowledge of the
-        IFC concepts to determine what is allowed to control what. In the
-        future, this API will likely be deprecated in favour of multiple usecase
-        specific APIs.
+    This usecase lets you assign controls following the rules of the IFC
+    specification. This is an advanced topic and assumes knowledge of the
+    IFC concepts to determine what is allowed to control what. In the
+    future, this API will likely be deprecated in favour of multiple usecase
+    specific APIs.
 
-        :param relating_control: The IfcControl entity that is creating the
-            control or constraint
-        :type relating_control: ifcopenshell.entity_instance.entity_instance
-        :param related_object: The IfcObjectDefinition that is being controlled
-        :type related_object: ifcopenshell.entity_instance.entity_instance
-        :return: The newly created IfcRelAssignsToControl. If relationship already
-            existed before and wasn't changed then returns None.
-        :rtype: ifcopenshell.entity_instance.entity_instance, None
+    :param relating_control: The IfcControl entity that is creating the
+        control or constraint
+    :type relating_control: ifcopenshell.entity_instance
+    :param related_object: The IfcObjectDefinition that is being controlled
+    :type related_object: ifcopenshell.entity_instance
+    :return: The newly created IfcRelAssignsToControl. If relationship already
+        existed before and wasn't changed then returns None.
+    :rtype: ifcopenshell.entity_instance, None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            # One common usecase is to assign a calendar to a task
-            calendar = ifcopenshell.api.run("sequence.add_work_calendar", model)
-            schedule = ifcopenshell.api.run("sequence.add_work_schedule", model)
-            task = ifcopenshell.api.run("sequence.add_task", model,
-                work_schedule=schedule)
+        # One common usecase is to assign a calendar to a task
+        calendar = ifcopenshell.api.run("sequence.add_work_calendar", model)
+        schedule = ifcopenshell.api.run("sequence.add_work_schedule", model)
+        task = ifcopenshell.api.run("sequence.add_task", model,
+            work_schedule=schedule)
 
-            # All subtasks will inherit this calendar, so assigning a single
-            # calendar to the root task effectively defines a "default" calendar
-            ifcopenshell.api.run("control.assign_control", model,
-                relating_control=calendar, related_object=task)
+        # All subtasks will inherit this calendar, so assigning a single
+        # calendar to the root task effectively defines a "default" calendar
+        ifcopenshell.api.run("control.assign_control", model,
+            relating_control=calendar, related_object=task)
 
-            # Another common example might be relating a cost item and a product
-            wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            cost_item = ifcopenshell.api.run("cost.add_cost_item", model,
-                cost_schedule=schedule)
-            ifcopenshell.api.run("control.assign_control", model,
-                relating_control=cost_item, related_object=wall)
-        """
-        self.file = file
-        self.settings = {
-            "relating_control": relating_control,
-            "related_object": related_object,
-        }
+        # Another common example might be relating a cost item and a product
+        wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        cost_item = ifcopenshell.api.run("cost.add_cost_item", model,
+            cost_schedule=schedule)
+        ifcopenshell.api.run("control.assign_control", model,
+            relating_control=cost_item, related_object=wall)
+    """
+    settings = {
+        "relating_control": relating_control,
+        "related_object": related_object,
+    }
 
-    def execute(self):
-        if self.settings["related_object"].HasAssignments:
-            for assignment in self.settings["related_object"].HasAssignments:
-                if (
-                    assignment.is_a("IfcRelAssignsToControl")
-                    and assignment.RelatingControl == self.settings["relating_control"]
-                ):
-                    return
-
-        controls = None
-        if self.settings["relating_control"].Controls:
-            controls = self.settings["relating_control"].Controls[0]
-
-        if controls:
-            if self.settings["related_object"] in controls.RelatedObjects:
+    if settings["related_object"].HasAssignments:
+        for assignment in settings["related_object"].HasAssignments:
+            if assignment.is_a("IfcRelAssignsToControl") and assignment.RelatingControl == settings["relating_control"]:
                 return
-            related_objects = set(controls.RelatedObjects)
-            related_objects.add(self.settings["related_object"])
-            controls.RelatedObjects = list(related_objects)
-            ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": controls})
-        else:
-            controls = self.file.create_entity(
-                "IfcRelAssignsToControl",
-                **{
-                    "GlobalId": ifcopenshell.guid.new(),
-                    "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),
-                    "RelatedObjects": [self.settings["related_object"]],
-                    "RelatingControl": self.settings["relating_control"],
-                },
-            )
-        return controls
+
+    controls = None
+    if settings["relating_control"].Controls:
+        controls = settings["relating_control"].Controls[0]
+
+    if controls:
+        if settings["related_object"] in controls.RelatedObjects:
+            return
+        related_objects = set(controls.RelatedObjects)
+        related_objects.add(settings["related_object"])
+        controls.RelatedObjects = list(related_objects)
+        ifcopenshell.api.run("owner.update_owner_history", file, **{"element": controls})
+    else:
+        controls = file.create_entity(
+            "IfcRelAssignsToControl",
+            **{
+                "GlobalId": ifcopenshell.guid.new(),
+                "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", file),
+                "RelatedObjects": [settings["related_object"]],
+                "RelatingControl": settings["relating_control"],
+            },
+        )
+    return controls

src/ifcopenshell-python/ifcopenshell/api/control/unassign_control.py

@@ -21,54 +21,51 @@ import ifcopenshell.api
 import ifcopenshell.util.element
 
 
-class Usecase:
-    def __init__(self, file, relating_control=None, related_object=None):
-        """Unassigns a planning control or constraint to an object
+def unassign_control(file, relating_control=None, related_object=None) -> None:
+    """Unassigns a planning control or constraint to an object
 
-        :param relating_control: The IfcControl entity that is creating the
-            control or constraint
-        :type relating_control: ifcopenshell.entity_instance.entity_instance
-        :param related_object: The IfcObjectDefinition that is being controlled
-        :type related_object: ifcopenshell.entity_instance.entity_instance
-        :return: If the control still is related to other objects, the
-            IfcRelAssignsToControl is returned, otherwise None.
-        :rtype: ifcopenshell.entity_instance.entity_instance, None
+    :param relating_control: The IfcControl entity that is creating the
+        control or constraint
+    :type relating_control: ifcopenshell.entity_instance
+    :param related_object: The IfcObjectDefinition that is being controlled
+    :type related_object: ifcopenshell.entity_instance
+    :return: If the control still is related to other objects, the
+        IfcRelAssignsToControl is returned, otherwise None.
+    :rtype: ifcopenshell.entity_instance, None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            # Let's relate a cost item and a product
-            wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            cost_item = ifcopenshell.api.run("cost.add_cost_item", model,
-                cost_schedule=schedule)
-            ifcopenshell.api.run("control.assign_control", model,
-                relating_control=cost_item, related_object=wall)
+        # Let's relate a cost item and a product
+        wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        cost_item = ifcopenshell.api.run("cost.add_cost_item", model,
+            cost_schedule=schedule)
+        ifcopenshell.api.run("control.assign_control", model,
+            relating_control=cost_item, related_object=wall)
 
-            # And now let's change our mind
-            ifcopenshell.api.run("control.unassign_control", model,
-                relating_control=cost_item, related_object=wall)
-        """
+        # And now let's change our mind
+        ifcopenshell.api.run("control.unassign_control", model,
+            relating_control=cost_item, related_object=wall)
+    """
 
-        self.file = file
-        self.settings = {
-            "relating_control": relating_control,
-            "related_object": related_object,
-        }
+    settings = {
+        "relating_control": relating_control,
+        "related_object": related_object,
+    }
 
-    def execute(self):
-        for rel in self.settings["related_object"].HasAssignments or []:
-            if not rel.is_a("IfcRelAssignsToControl") or rel.RelatingControl != self.settings["relating_control"]:
-                continue
-            if len(rel.RelatedObjects) == 1:
-                history = rel.OwnerHistory
-                self.file.remove(rel)
-                if history:
-                    ifcopenshell.util.element.remove_deep2(self.file, history)
-                return
-            related_objects = list(rel.RelatedObjects)
-            related_objects.remove(self.settings["related_object"])
-            rel.RelatedObjects = related_objects
-            ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": rel})
-            return rel
+    for rel in settings["related_object"].HasAssignments or []:
+        if not rel.is_a("IfcRelAssignsToControl") or rel.RelatingControl != settings["relating_control"]:
+            continue
+        if len(rel.RelatedObjects) == 1:
+            history = rel.OwnerHistory
+            file.remove(rel)
+            if history:
+                ifcopenshell.util.element.remove_deep2(file, history)
+            return
+        related_objects = list(rel.RelatedObjects)
+        related_objects.remove(settings["related_object"])
+        rel.RelatedObjects = related_objects
+        ifcopenshell.api.run("owner.update_owner_history", file, **{"element": rel})
+        return rel

src/ifcopenshell-python/ifcopenshell/api/cost/__init__.py

@@ -15,3 +15,23 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+from .add_cost_item import add_cost_item
+from .add_cost_item_quantity import add_cost_item_quantity
+from .add_cost_schedule import add_cost_schedule
+from .add_cost_value import add_cost_value
+from .assign_cost_item_quantity import assign_cost_item_quantity
+from .assign_cost_value import assign_cost_value
+from .calculate_cost_item_resource_value import calculate_cost_item_resource_value
+from .copy_cost_item import copy_cost_item
+from .copy_cost_item_values import copy_cost_item_values
+from .edit_cost_item import edit_cost_item
+from .edit_cost_item_quantity import edit_cost_item_quantity
+from .edit_cost_schedule import edit_cost_schedule
+from .edit_cost_value import edit_cost_value
+from .edit_cost_value_formula import edit_cost_value_formula
+from .remove_cost_item import remove_cost_item
+from .remove_cost_item_quantity import remove_cost_item_quantity
+from .remove_cost_schedule import remove_cost_schedule
+from .remove_cost_value import remove_cost_value
+from .unassign_cost_item_quantity import unassign_cost_item_quantity

src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item.py

@@ -19,55 +19,52 @@
 import ifcopenshell.api
 
 
-class Usecase:
-    def __init__(self, file, cost_schedule=None, cost_item=None):
-        """Add a new cost item
+def add_cost_item(file, cost_schedule=None, cost_item=None) -> None:
+    """Add a new cost item
 
-        A cost item represents a single line item in a cost schedule. Cost items
-        may then be broken down into cost subitems.
+    A cost item represents a single line item in a cost schedule. Cost items
+    may then be broken down into cost subitems.
 
-        :param cost_schedule: If the cost item is to be added as a root or top
-            level cost item to a cost schedule, the IfcCostSchedule may be
-            specified. This is mutually exlclusive to the cost_item parameter.
-        :type cost_schedule: ifcopenshell.entity_instance.entity_instance
-        :param cost_item: If the cost item is to be added as a subitem to an
-            existing cost item, the parent IfcCostItem may be specified. This is
-            mutually exclusive to the cost_schedule parameter.
-        :type cost_item: ifcopenshell.entity_instance.entity_instance
-        :return: The newly created IfcCostItem
-        :rtype: ifcopenshell.entity_instance.entity_instance
+    :param cost_schedule: If the cost item is to be added as a root or top
+        level cost item to a cost schedule, the IfcCostSchedule may be
+        specified. This is mutually exlclusive to the cost_item parameter.
+    :type cost_schedule: ifcopenshell.entity_instance
+    :param cost_item: If the cost item is to be added as a subitem to an
+        existing cost item, the parent IfcCostItem may be specified. This is
+        mutually exclusive to the cost_schedule parameter.
+    :type cost_item: ifcopenshell.entity_instance
+    :return: The newly created IfcCostItem
+    :rtype: ifcopenshell.entity_instance
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            # The very first cost item must be in a cost schedule
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        # The very first cost item must be in a cost schedule
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
 
-            # You may add cost items as top level item in the schedule
-            item1 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        # You may add cost items as top level item in the schedule
+        item1 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
 
-            # Alternatively you may add them as subitems
-            item2 = ifcopenshell.api.run("cost.add_cost_item", model, cost_item=item1)
-        """
-        self.file = file
-        self.settings = {"cost_schedule": cost_schedule, "cost_item": cost_item}
+        # Alternatively you may add them as subitems
+        item2 = ifcopenshell.api.run("cost.add_cost_item", model, cost_item=item1)
+    """
+    settings = {"cost_schedule": cost_schedule, "cost_item": cost_item}
 
-    def execute(self):
-        cost_item = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcCostItem")
+    cost_item = ifcopenshell.api.run("root.create_entity", file, ifc_class="IfcCostItem")
 
-        if self.settings["cost_schedule"]:
-            self.file.create_entity(
-                "IfcRelAssignsToControl",
-                **{
-                    "GlobalId": ifcopenshell.guid.new(),
-                    "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),
-                    "RelatedObjects": [cost_item],
-                    "RelatingControl": self.settings["cost_schedule"],
-                }
-            )
-        elif self.settings["cost_item"]:
-            ifcopenshell.api.run(
-                "nest.assign_object", self.file, related_objects=[cost_item], relating_object=self.settings["cost_item"]
-            )
-        return cost_item
+    if settings["cost_schedule"]:
+        file.create_entity(
+            "IfcRelAssignsToControl",
+            **{
+                "GlobalId": ifcopenshell.guid.new(),
+                "OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", file),
+                "RelatedObjects": [cost_item],
+                "RelatingControl": settings["cost_schedule"],
+            }
+        )
+    elif settings["cost_item"]:
+        ifcopenshell.api.run(
+            "nest.assign_object", file, related_objects=[cost_item], relating_object=settings["cost_item"]
+        )
+    return cost_item

src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item_quantity.py

@@ -19,73 +19,70 @@
 import ifcopenshell.api
 
 
-class Usecase:
-    def __init__(self, file, cost_item=None, ifc_class="IfcQuantityCount"):
-        """Adds a new quantity associated with a cost item
+def add_cost_item_quantity(file, cost_item=None, ifc_class="IfcQuantityCount") -> None:
+    """Adds a new quantity associated with a cost item
 
-        Cost items calculate their subtotal by multiplying the sum of the cost
-        item's "values" by the sum of the cost item's "quantities". The
-        quantities may be either parametrically linked to quantities measured on
-        physical product, or manually specified.
+    Cost items calculate their subtotal by multiplying the sum of the cost
+    item's "values" by the sum of the cost item's "quantities". The
+    quantities may be either parametrically linked to quantities measured on
+    physical product, or manually specified.
 
-        The quantity must be of a particular type, common examples are:
+    The quantity must be of a particular type, common examples are:
 
-        - IfcQuantityCount: to count the total occurrences of a product, useful
-          for things like doors, windows, and furniture
-        - IfcQuantityNumber: any other generic numeric quantity
-        - IfcQuantityLength
-        - IfcQuantityArea
-        - IfcQuantityVolume
-        - IfcQuantityWeight
-        - IfcQuantityTime
+    - IfcQuantityCount: to count the total occurrences of a product, useful
+      for things like doors, windows, and furniture
+    - IfcQuantityNumber: any other generic numeric quantity
+    - IfcQuantityLength
+    - IfcQuantityArea
+    - IfcQuantityVolume
+    - IfcQuantityWeight
+    - IfcQuantityTime
 
-        A cost item must not mix quantities of different types.
+    A cost item must not mix quantities of different types.
 
-        If an IfcQuantityCount is used, then this API will automatically count
-        all products that this cost item controls (see
-        ifcopenshell.api.controls.assign_control) and prefill that quantity.
+    If an IfcQuantityCount is used, then this API will automatically count
+    all products that this cost item controls (see
+    ifcopenshell.api.controls.assign_control) and prefill that quantity.
 
-        For all other quantity types, the quantity is left as zero and the user
-        must either manually specify the quantity or parametrically link it
-        using another API call.
+    For all other quantity types, the quantity is left as zero and the user
+    must either manually specify the quantity or parametrically link it
+    using another API call.
 
-        :param cost_item: The IfcCostItem to add the quantity to
-        :type cost_item: ifcopenshell.entity_instance.entity_instance
-        :param ifc_class: The type of quantity to add
-        :type ifc_class: str, optional
-        :return: The newly created quantity entity, chosen from the ifc_class
-            parameter
-        :rtype: ifcopenshell.entity_instance.entity_instance
+    :param cost_item: The IfcCostItem to add the quantity to
+    :type cost_item: ifcopenshell.entity_instance
+    :param ifc_class: The type of quantity to add
+    :type ifc_class: str, optional
+    :return: The newly created quantity entity, chosen from the ifc_class
+        parameter
+    :rtype: ifcopenshell.entity_instance
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            chair = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcFurniture")
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-            ifcopenshell.api.run("control.assign_control", model,
-                relating_control=cost_item, related_object=chair)
+        chair = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcFurniture")
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        ifcopenshell.api.run("control.assign_control", model,
+            relating_control=cost_item, related_object=chair)
 
-            # Let's assume we want to count the amount of chairs to calculate our cost item
-            # Because this is an IfcQuantityCount the count will be automatically set to "1" chair
-            ifcopenshell.api.run("cost.add_cost_item_quantity", model,
-                cost_item=item, ifc_class="IfcQuantityCount")
-        """
-        self.file = file
-        self.settings = {"cost_item": cost_item, "ifc_class": ifc_class}
+        # Let's assume we want to count the amount of chairs to calculate our cost item
+        # Because this is an IfcQuantityCount the count will be automatically set to "1" chair
+        ifcopenshell.api.run("cost.add_cost_item_quantity", model,
+            cost_item=item, ifc_class="IfcQuantityCount")
+    """
+    settings = {"cost_item": cost_item, "ifc_class": ifc_class}
 
-    def execute(self):
-        quantity = self.file.create_entity(self.settings["ifc_class"], Name="Unnamed")
-        quantity[3] = 0.0
-        # This is a bold assumption
-        # https://forums.buildingsmart.org/t/how-does-a-cost-item-know-that-it-is-counting-a-controlled-product/3564
-        if self.settings["ifc_class"] == "IfcQuantityCount" and self.settings["cost_item"].Controls:
-            count = 0
-            for rel in self.settings["cost_item"].Controls:
-                count += len(rel.RelatedObjects)
-            quantity[3] = count
-        quantities = list(self.settings["cost_item"].CostQuantities or [])
-        quantities.append(quantity)
-        self.settings["cost_item"].CostQuantities = quantities
-        return quantity
+    quantity = file.create_entity(settings["ifc_class"], Name="Unnamed")
+    quantity[3] = 0.0
+    # This is a bold assumption
+    # https://forums.buildingsmart.org/t/how-does-a-cost-item-know-that-it-is-counting-a-controlled-product/3564
+    if settings["ifc_class"] == "IfcQuantityCount" and settings["cost_item"].Controls:
+        count = 0
+        for rel in settings["cost_item"].Controls:
+            count += len(rel.RelatedObjects)
+        quantity[3] = count
+    quantities = list(settings["cost_item"].CostQuantities or [])
+    quantities.append(quantity)
+    settings["cost_item"].CostQuantities = quantities
+    return quantity

src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_schedule.py

@@ -21,48 +21,45 @@ import ifcopenshell.util.date
 from datetime import datetime
 
 
-class Usecase:
-    def __init__(self, file, name=None, predefined_type="NOTDEFINED"):
-        """Add a new cost schedule
+def add_cost_schedule(file, name=None, predefined_type="NOTDEFINED") -> None:
+    """Add a new cost schedule
 
-        A cost schedule is a group of cost items which typically represent a
-        cost plan or breakdown of the project. This may be used as an estimate,
-        bid, or actual cost.
+    A cost schedule is a group of cost items which typically represent a
+    cost plan or breakdown of the project. This may be used as an estimate,
+    bid, or actual cost.
 
-        Alternatively, a cost schedule may also represent a schedule of rates,
-        which include cost items which capture unit rates for different elements
-        or processes.
+    Alternatively, a cost schedule may also represent a schedule of rates,
+    which include cost items which capture unit rates for different elements
+    or processes.
 
-        As such, creating a cost schedule is necessary prior to creating and
-        managing any cost items.
+    As such, creating a cost schedule is necessary prior to creating and
+    managing any cost items.
 
-        :param name: The name of the cost schedule.
-        :type name: str, optional
-        :param predefined_type: The predefined type of the cost schedule, chosen
-            from a valid type in the IFC documentation for
-            IfcCostScheduleTypeEnum
-        :type predefined_type: str, optional
-        :return: The newly created IfcCostSchedule entity
-        :rtype: ifcopenshell.entity_instance.entity_instance
+    :param name: The name of the cost schedule.
+    :type name: str, optional
+    :param predefined_type: The predefined type of the cost schedule, chosen
+        from a valid type in the IFC documentation for
+        IfcCostScheduleTypeEnum
+    :type predefined_type: str, optional
+    :return: The newly created IfcCostSchedule entity
+    :rtype: ifcopenshell.entity_instance
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            # Now that we have a cost schedule, we may add cost items to it
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-        """
-        self.file = file
-        self.settings = {"name": name, "predefined_type": predefined_type}
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        # Now that we have a cost schedule, we may add cost items to it
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+    """
+    settings = {"name": name, "predefined_type": predefined_type}
 
-    def execute(self):
-        cost_schedule = ifcopenshell.api.run(
-            "root.create_entity",
-            self.file,
-            ifc_class="IfcCostSchedule",
-            predefined_type=self.settings["predefined_type"],
-            name=self.settings["name"],
-        )
-        cost_schedule.UpdateDate = ifcopenshell.util.date.datetime2ifc(datetime.now(), "IfcDateTime")
-        return cost_schedule
+    cost_schedule = ifcopenshell.api.run(
+        "root.create_entity",
+        file,
+        ifc_class="IfcCostSchedule",
+        predefined_type=settings["predefined_type"],
+        name=settings["name"],
+    )
+    cost_schedule.UpdateDate = ifcopenshell.util.date.datetime2ifc(datetime.now(), "IfcDateTime")
+    return cost_schedule

src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_value.py

@@ -17,95 +17,92 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, parent=None):
-        """Adds a new value or subvalue to a cost item
+def add_cost_value(file, parent=None) -> None:
+    """Adds a new value or subvalue to a cost item
 
-        A cost item's subtotal can be specified in two ways.
+    A cost item's subtotal can be specified in two ways.
 
-        Option 1 is by simply manually specifying the subtotal value, which
-        represents the full cost of that cost item. This option occurs when a
-        cost item has no quantities associated with it.
+    Option 1 is by simply manually specifying the subtotal value, which
+    represents the full cost of that cost item. This option occurs when a
+    cost item has no quantities associated with it.
 
-        Option 2 is by specifying a unit cost value of the cost item, which is
-        then multiplied by the associated quantity of the cost item, to give us
-        the subtotal. This option occurs when a cost item has quantities
-        associated with it.
+    Option 2 is by specifying a unit cost value of the cost item, which is
+    then multiplied by the associated quantity of the cost item, to give us
+    the subtotal. This option occurs when a cost item has quantities
+    associated with it.
 
-        For either option 1 (full cost value) or option 2 (unit cost value), the
-        cost value may be specified as a single number, or as a sum of
-        subcomponents or formulas (e.g. multiplication by wastage factor, or
-        adding taxes or other adjustments).
+    For either option 1 (full cost value) or option 2 (unit cost value), the
+    cost value may be specified as a single number, or as a sum of
+    subcomponents or formulas (e.g. multiplication by wastage factor, or
+    adding taxes or other adjustments).
 
-        This function lets you add a single top level unit value to a cost item,
-        or alternatively price subcomponents by using the "parent" parameter.
+    This function lets you add a single top level unit value to a cost item,
+    or alternatively price subcomponents by using the "parent" parameter.
 
-        More advanced usage, which involves summing, subcategory-filtered costs,
-        and formulas are possible but not yet documented.
+    More advanced usage, which involves summing, subcategory-filtered costs,
+    and formulas are possible but not yet documented.
 
-        :param parent: A parent IfcCostItem, if specifying a price directly to a
-            cost item, or a top-level price component. Alternatively, this can
-            be set to a IfcCostValue, if specifying price subcomponents.
-        :type parent: ifcopenshell.entity_instance.entity_instance
-        :return: The newly created IfcCostValue
-        :rtype: ifcopenshell.entity_instance.entity_instance
+    :param parent: A parent IfcCostItem, if specifying a price directly to a
+        cost item, or a top-level price component. Alternatively, this can
+        be set to a IfcCostValue, if specifying price subcomponents.
+    :type parent: ifcopenshell.entity_instance
+    :return: The newly created IfcCostValue
+    :rtype: ifcopenshell.entity_instance
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            # We always need a schedule first prior to adding any cost items
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        # We always need a schedule first prior to adding any cost items
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
 
-            # Option 1: This cost item will have a full cost of 42.0
-            item1 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item1)
-            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
-                attributes={"AppliedValue": 42.0})
+        # Option 1: This cost item will have a full cost of 42.0
+        item1 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item1)
+        ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
+            attributes={"AppliedValue": 42.0})
 
-            # Option 2: This cost item will have a unit cost of 5.0 per unit
-            # area, multiplied by the quantity of area specified explicitly as
-            # 3.0, giving us a subtotal cost of 15.0.
-            item2 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item2)
-            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
-                attributes={"AppliedValue": 5.0})
-            quantity = ifcopenshell.api.run("cost.add_cost_item_quantity", model,
-                cost_item=item2, ifc_class="IfcQuantityVolume")
-            ifcopenshell.api.run("cost.edit_cost_item_quantity", model,
-                physical_quantity=quantity, "attributes": {"VolumeValue": 3.0})
+        # Option 2: This cost item will have a unit cost of 5.0 per unit
+        # area, multiplied by the quantity of area specified explicitly as
+        # 3.0, giving us a subtotal cost of 15.0.
+        item2 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item2)
+        ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
+            attributes={"AppliedValue": 5.0})
+        quantity = ifcopenshell.api.run("cost.add_cost_item_quantity", model,
+            cost_item=item2, ifc_class="IfcQuantityVolume")
+        ifcopenshell.api.run("cost.edit_cost_item_quantity", model,
+            physical_quantity=quantity, "attributes": {"VolumeValue": 3.0})
 
-            # A cost value may also be specified in terms of the sum of its
-            # subcomponents. In this case, it's broken down into 2 subvalues.
-            item1 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item1)
-            subvalue1 = ifcopenshell.api.run("cost.add_cost_value", model, parent=value)
-            subvalue2 = ifcopenshell.api.run("cost.add_cost_value", model, parent=value)
+        # A cost value may also be specified in terms of the sum of its
+        # subcomponents. In this case, it's broken down into 2 subvalues.
+        item1 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item1)
+        subvalue1 = ifcopenshell.api.run("cost.add_cost_value", model, parent=value)
+        subvalue2 = ifcopenshell.api.run("cost.add_cost_value", model, parent=value)
 
-            # This specifies that the value is the sum of all subitems
-            # regardless of their cost category. The first subvalue is 2.0 and
-            # the second is 3.0, giving a total value of 5.0.
-            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value, attributes={"Category": "*"})
-            ifcopenshell.api.run("cost.edit_cost_value", model,
-                cost_value=subvalue1, attributes={"AppliedValue": 2.0})
-            ifcopenshell.api.run("cost.edit_cost_value", model,
-                cost_value=subvalue2, attributes={"AppliedValue": 3.0})
-        """
-        self.file = file
-        self.settings = {"parent": parent}
+        # This specifies that the value is the sum of all subitems
+        # regardless of their cost category. The first subvalue is 2.0 and
+        # the second is 3.0, giving a total value of 5.0.
+        ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value, attributes={"Category": "*"})
+        ifcopenshell.api.run("cost.edit_cost_value", model,
+            cost_value=subvalue1, attributes={"AppliedValue": 2.0})
+        ifcopenshell.api.run("cost.edit_cost_value", model,
+            cost_value=subvalue2, attributes={"AppliedValue": 3.0})
+    """
+    settings = {"parent": parent}
 
-    def execute(self):
-        value = self.file.create_entity("IfcCostValue")
-        if self.settings["parent"].is_a("IfcCostItem"):
-            values = list(self.settings["parent"].CostValues or [])
-            values.append(value)
-            self.settings["parent"].CostValues = values
-        elif self.settings["parent"].is_a("IfcConstructionResource"):
-            values = list(self.settings["parent"].BaseCosts or [])
-            values.append(value)
-            self.settings["parent"].BaseCosts = values
-        elif self.settings["parent"].is_a("IfcCostValue"):
-            values = list(self.settings["parent"].Components or [])
-            values.append(value)
-            self.settings["parent"].Components = values
-        return value
+    value = file.create_entity("IfcCostValue")
+    if settings["parent"].is_a("IfcCostItem"):
+        values = list(settings["parent"].CostValues or [])
+        values.append(value)
+        settings["parent"].CostValues = values
+    elif settings["parent"].is_a("IfcConstructionResource"):
+        values = list(settings["parent"].BaseCosts or [])
+        values.append(value)
+        settings["parent"].BaseCosts = values
+    elif settings["parent"].is_a("IfcCostValue"):
+        values = list(settings["parent"].Components or [])
+        values.append(value)
+        settings["parent"].Components = values
+    return value

src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_item_quantity.py

@@ -19,82 +19,82 @@
 import ifcopenshell.api
 
 
+def assign_cost_item_quantity(file, cost_item=None, products=None, prop_name="") -> None:
+    """Adds a cost item quantity that is parametrically connected to a product
+
+    A cost item may have its subtotal calculated by multiplying a unit value
+    by a quantity associated with the cost item. That quantity may be either
+    manually specified or parametrically connected to a quantity on a
+    product. This API function lets you create that parametric connection.
+
+    For example, you may wish to have a cost item linked to the "NetVolume"
+    quantity on all IfcSlabs. Each quantity has a name which you can
+    specify. If the quantity is updated in-place (which should occur for
+    Native IFC applications) then the quantity for the cost item will
+    automatically update as well. If the quantity is deleted and then
+    re-added, then the parametric relationship is also lost.
+
+    This API also automatically assigns a control relationship between the
+    cost item and the product, so it is not necessary to use
+    ifcopenshell.api.control.assign_control.
+
+    :param cost_item: The IfcCostItem to assign parametric quantities to
+    :type cost_item: ifcopenshell.entity_instance
+    :param products: The IfcObjects to assign parametric quantities to
+    :type products: list[ifcopenshell.entity_instance]
+    :param prop_name: The name of the quantity. If this is not specified,
+        then it is assumed that there is no calculated quantity, and the
+        number of objects are counted instead.
+    :type prop_name: str, optional
+    :return: None
+    :rtype: None
+
+    Example:
+
+    .. code:: python
+
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+
+        # Let's imagine a unit cost of 5.0 per unit volume
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
+        ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
+            attributes={"AppliedValue": 5.0})
+
+        slab = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSlab")
+        # Usually the quantity would be automatically calculated via a
+        # graphical authoring application but let's assign a manual quantity
+        # for now.
+        qto = ifcopenshell.api.run("pset.add_qto", model, product=slab, name="Qto_SlabBaseQuantities")
+        ifcopenshell.api.run("pset.edit_qto", model, qto=qto, properties={"NetVolume": 42.0})
+
+        # Now let's parametrically link the slab's quantity to the cost
+        # item. If the slab is edited in the future and 42.0 changes, then
+        # the updated value will also automatically be applied to the cost
+        # item.
+        ifcopenshell.api.run("cost.assign_cost_item_quantity", model,
+            cost_item=item, products=[slab], prop_name="NetVolume")
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.settings = {
+        "cost_item": cost_item,
+        "products": products or [],
+        "prop_name": prop_name,
+    }
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(self, file, cost_item=None, products=None, prop_name=""):
-        """Adds a cost item quantity that is parametrically connected to a product
-
-        A cost item may have its subtotal calculated by multiplying a unit value
-        by a quantity associated with the cost item. That quantity may be either
-        manually specified or parametrically connected to a quantity on a
-        product. This API function lets you create that parametric connection.
-
-        For example, you may wish to have a cost item linked to the "NetVolume"
-        quantity on all IfcSlabs. Each quantity has a name which you can
-        specify. If the quantity is updated in-place (which should occur for
-        Native IFC applications) then the quantity for the cost item will
-        automatically update as well. If the quantity is deleted and then
-        re-added, then the parametric relationship is also lost.
-
-        This API also automatically assigns a control relationship between the
-        cost item and the product, so it is not necessary to use
-        ifcopenshell.api.control.assign_control.
-
-        :param cost_item: The IfcCostItem to assign parametric quantities to
-        :type cost_item: ifcopenshell.entity_instance.entity_instance
-        :param products: The IfcObjects to assign parametric quantities to
-        :type products: list[ifcopenshell.entity_instance.entity_instance]
-        :param prop_name: The name of the quantity. If this is not specified,
-            then it is assumed that there is no calculated quantity, and the
-            number of objects are counted instead.
-        :type prop_name: str, optional
-        :return: None
-        :rtype: None
-
-        Example:
-
-        .. code:: python
-
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-
-            # Let's imagine a unit cost of 5.0 per unit volume
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
-            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
-                attributes={"AppliedValue": 5.0})
-
-            slab = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSlab")
-            # Usually the quantity would be automatically calculated via a
-            # graphical authoring application but let's assign a manual quantity
-            # for now.
-            qto = ifcopenshell.api.run("pset.add_qto", model, product=slab, name="Qto_SlabBaseQuantities")
-            ifcopenshell.api.run("pset.edit_qto", model, qto=qto, properties={"NetVolume": 42.0})
-
-            # Now let's parametrically link the slab's quantity to the cost
-            # item. If the slab is edited in the future and 42.0 changes, then
-            # the updated value will also automatically be applied to the cost
-            # item.
-            ifcopenshell.api.run("cost.assign_cost_item_quantity", model,
-                cost_item=item, products=[slab], prop_name="NetVolume")
-        """
-        self.file = file
-        self.settings = {
-            "cost_item": cost_item,
-            "products": products or [],
-            "prop_name": prop_name,
-        }
-
     def execute(self):
         if self.settings["prop_name"]:
             self.quantities = set(self.settings["cost_item"].CostQuantities or [])
         for product in self.settings["products"]:
-            self.assign_cost_control(
-                related_object=product, cost_item=self.settings["cost_item"]
-            )
+            self.assign_cost_control(related_object=product, cost_item=self.settings["cost_item"])
             if self.settings["prop_name"]:
                 if (
                     self.settings["cost_item"].CostQuantities
-                    and self.settings["cost_item"].CostQuantities[0].Name.lower()
-                    != self.settings["prop_name"].lower()
+                    and self.settings["cost_item"].CostQuantities[0].Name.lower() != self.settings["prop_name"].lower()
                 ) or not product.is_a("IfcObject"):
                     continue
                 self.add_quantity_from_related_object(product)
@@ -120,10 +120,7 @@ class Usecase:
         if not qto.is_a("IfcElementQuantity"):
             return
         for prop in qto.Quantities:
-            if (
-                prop.is_a("IfcPhysicalSimpleQuantity")
-                and prop.Name.lower() == self.settings["prop_name"].lower()
-            ):
+            if prop.is_a("IfcPhysicalSimpleQuantity") and prop.Name.lower() == self.settings["prop_name"].lower():
                 self.quantities.add(prop)
 
     def update_cost_item_count(self):

src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_value.py

@@ -19,60 +19,57 @@
 import ifcopenshell.api
 
 
-class Usecase:
-    def __init__(self, file, cost_item=None, cost_rate=None):
-        """Assigns a cost value to a cost item from a schedule of rates
+def assign_cost_value(file, cost_item=None, cost_rate=None) -> None:
+    """Assigns a cost value to a cost item from a schedule of rates
 
-        Instead of assigning cost values from scratch for each cost item in a
-        cost schedule, the cost values may instead be assigned from a schedule
-        of rates.
+    Instead of assigning cost values from scratch for each cost item in a
+    cost schedule, the cost values may instead be assigned from a schedule
+    of rates.
 
-        A schedule of rates is just another cost schedule which have cost values
-        but no quantities. This API will allow you to "copy" the values from a
-        cost item in the schedule of rates into another cost item in your own
-        cost schedule. When the schedule of rates value is updated, then your
-        cost item values will also be updated. You can think of the schedule of
-        rates as a "template" to quickly populate your rates from.
+    A schedule of rates is just another cost schedule which have cost values
+    but no quantities. This API will allow you to "copy" the values from a
+    cost item in the schedule of rates into another cost item in your own
+    cost schedule. When the schedule of rates value is updated, then your
+    cost item values will also be updated. You can think of the schedule of
+    rates as a "template" to quickly populate your rates from.
 
-        :param cost_item: The IfcCostItem that you want to copy the values to
-        :type cost_item: ifcopenshell.entity_instance.entity_instance
-        :param cost_rate: The IfcCostItem that you want to copy the values from
-        :type cost_rate: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
+    :param cost_item: The IfcCostItem that you want to copy the values to
+    :type cost_item: ifcopenshell.entity_instance
+    :param cost_rate: The IfcCostItem that you want to copy the values from
+    :type cost_rate: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            # Let's create a schedule of rates with a single rate in it of 5.0
-            rate_tables = ifcopenshell.api.run("cost.add_cost_schedule", model,
-                predefined_type="SCHEDULEOFRATES")
-            rate = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=rate)
-            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
-                attributes={"AppliedValue": 5.0})
+        # Let's create a schedule of rates with a single rate in it of 5.0
+        rate_tables = ifcopenshell.api.run("cost.add_cost_schedule", model,
+            predefined_type="SCHEDULEOFRATES")
+        rate = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=rate)
+        ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
+            attributes={"AppliedValue": 5.0})
 
-            # And this schedule will be for our actual cost plan / estimate / etc
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        # And this schedule will be for our actual cost plan / estimate / etc
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
 
-            # Now the cost item has the same rate as the one from the schedule of rate's item
-            ifcopenshell.api.run("cost.assign_cost_value", model, cost_item=item, cost_rate=rate)
-        """
-        self.file = file
-        self.settings = {"cost_item": cost_item, "cost_rate": cost_rate}
+        # Now the cost item has the same rate as the one from the schedule of rate's item
+        ifcopenshell.api.run("cost.assign_cost_value", model, cost_item=item, cost_rate=rate)
+    """
+    settings = {"cost_item": cost_item, "cost_rate": cost_rate}
 
-    def execute(self):
-        if self.settings["cost_item"].CostValues:
-            [
-                ifcopenshell.api.run(
-                    "cost.remove_cost_value",
-                    self.file,
-                    parent=self.settings["cost_item"],
-                    cost_value=cost_value,
-                )
-                for cost_value in self.settings["cost_item"].CostValues
-            ]
-        # This is an assumption, and not part of the official IFC documentation
-        self.settings["cost_item"].CostValues = self.settings["cost_rate"].CostValues
+    if settings["cost_item"].CostValues:
+        [
+            ifcopenshell.api.run(
+                "cost.remove_cost_value",
+                file,
+                parent=settings["cost_item"],
+                cost_value=cost_value,
+            )
+            for cost_value in settings["cost_item"].CostValues
+        ]
+    # This is an assumption, and not part of the official IFC documentation
+    settings["cost_item"].CostValues = settings["cost_rate"].CostValues

src/ifcopenshell-python/ifcopenshell/api/cost/calculate_cost_item_resource_value.py

@@ -21,100 +21,97 @@ import ifcopenshell.util.date
 import ifcopenshell.util.resource
 
 
-class Usecase:
-    def __init__(self, file, cost_item=None):
-        """Calculates the total cost of all resources associated with a cost item
+def calculate_cost_item_resource_value(file, cost_item=None) -> None:
+    """Calculates the total cost of all resources associated with a cost item
 
-        A cost item may have construction resources (e.g. equipment, material,
-        etc) assigned to it. Construction resources may be assigned directly to
-        the cost item, or assigned first to a task, and the task is then
-        assigned to the cost item.
+    A cost item may have construction resources (e.g. equipment, material,
+    etc) assigned to it. Construction resources may be assigned directly to
+    the cost item, or assigned first to a task, and the task is then
+    assigned to the cost item.
 
-        The cost of a resource is calculated by the total sum of all of its base
-        costs. If no quantity is provided, that sum is considered to be the
-        total cost. Otherwise, it is considered to be a unit cost, and is then
-        multiplied by the resource quantity. The quantity is either stored as a
-        base quantity (such as a volume) for a things like material resources,
-        or as a duration as a daily rate for labour resources.
+    The cost of a resource is calculated by the total sum of all of its base
+    costs. If no quantity is provided, that sum is considered to be the
+    total cost. Otherwise, it is considered to be a unit cost, and is then
+    multiplied by the resource quantity. The quantity is either stored as a
+    base quantity (such as a volume) for a things like material resources,
+    or as a duration as a daily rate for labour resources.
 
-        The final calculated cost is set as the cost item's value. Any
-        previously existing values are removed.
+    The final calculated cost is set as the cost item's value. Any
+    previously existing values are removed.
 
-        :param cost_item: The IfcCostItem to calculate
-        :type cost_item: ifccopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
+    :param cost_item: The IfcCostItem to calculate
+    :type cost_item: ifccopenshell.entity_instance.entity_instance
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            # First, we need a cost schedule and item
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        # First, we need a cost schedule and item
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
 
-            # Let's imagine we have our own formworking crew
-            crew = ifcopenshell.api.run("resource.add_resource", model, ifc_class="IfcCrewResource")
+        # Let's imagine we have our own formworking crew
+        crew = ifcopenshell.api.run("resource.add_resource", model, ifc_class="IfcCrewResource")
 
-            # ... and they need concrete
-            concrete = ifcopenshell.api.run("resource.add_resource", model,
-                ifc_class="IfcConstructionMaterialResource", parent_resource=crew)
-            ifcopenshell.api.run("control.assign_control", model,
-                relating_control=item, related_object=concrete)
-            # ... which has a unit price of 42.0 per m3
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=concrete)
-            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
-                attributes={"AppliedValue": 42.0})
-            # ... and a volume of 200m3
-            quantity = ifcopenshell.api.run("resource.add_resource_quantity", model,
-                resource=concrete, ifc_class="IfcQuantityVolume")
-            ifcopenshell.api.run("resource.edit_resource_quantity", model,
-                physical_quantity=quantity, "attributes": {"VolumeValue": 200.0})
+        # ... and they need concrete
+        concrete = ifcopenshell.api.run("resource.add_resource", model,
+            ifc_class="IfcConstructionMaterialResource", parent_resource=crew)
+        ifcopenshell.api.run("control.assign_control", model,
+            relating_control=item, related_object=concrete)
+        # ... which has a unit price of 42.0 per m3
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=concrete)
+        ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
+            attributes={"AppliedValue": 42.0})
+        # ... and a volume of 200m3
+        quantity = ifcopenshell.api.run("resource.add_resource_quantity", model,
+            resource=concrete, ifc_class="IfcQuantityVolume")
+        ifcopenshell.api.run("resource.edit_resource_quantity", model,
+            physical_quantity=quantity, "attributes": {"VolumeValue": 200.0})
 
-            # Let's say they also need some equipment
-            equipment = ifcopenshell.api.run("resource.add_resource", model,
-                ifc_class="IfcConstructionEquipmentResource", parent_resource=crew)
-            ifcopenshell.api.run("control.assign_control", model,
-                relating_control=item, related_object=equipment)
-            # ... with a fixed price of 50,000
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=concrete)
-            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
-                attributes={"AppliedValue": 42.0})
+        # Let's say they also need some equipment
+        equipment = ifcopenshell.api.run("resource.add_resource", model,
+            ifc_class="IfcConstructionEquipmentResource", parent_resource=crew)
+        ifcopenshell.api.run("control.assign_control", model,
+            relating_control=item, related_object=equipment)
+        # ... with a fixed price of 50,000
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=concrete)
+        ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
+            attributes={"AppliedValue": 42.0})
 
-            # (42 * 200) + 50000 = 58400 is our calculated cost
-            ifcopenshell.api.run("cost.calculate_cost_item_resource_value", model, cost_item=item)
-        """
-        self.file = file
-        self.settings = {"cost_item": cost_item}
+        # (42 * 200) + 50000 = 58400 is our calculated cost
+        ifcopenshell.api.run("cost.calculate_cost_item_resource_value", model, cost_item=item)
+    """
+    settings = {"cost_item": cost_item}
 
-    def execute(self):
-        for cost_value in self.settings["cost_item"].CostValues or []:
-            ifcopenshell.api.run(
-                "cost.remove_cost_value", self.file, parent=self.settings["cost_item"], cost_value=cost_value
-            )
+    for cost_value in settings["cost_item"].CostValues or []:
+        ifcopenshell.api.run("cost.remove_cost_value", file, parent=settings["cost_item"], cost_value=cost_value)
 
-        resources = []
-        for rel in self.settings["cost_item"].Controls or []:
-            for related_object in rel.RelatedObjects:
-                if related_object.is_a("IfcConstructionResource"):
-                    resources.append(related_object)
-                elif related_object.is_a("IfcTask"):
-                    for rel2 in related_object.OperatesOn or []:
-                        for related_object2 in rel2.RelatedObjects:
-                            if related_object2.is_a("IfcConstructionResource"):
-                                resources.append(related_object2)
+    resources = []
+    for rel in settings["cost_item"].Controls or []:
+        for related_object in rel.RelatedObjects:
+            if related_object.is_a("IfcConstructionResource"):
+                resources.append(related_object)
+            elif related_object.is_a("IfcTask"):
+                for rel2 in related_object.OperatesOn or []:
+                    for related_object2 in rel2.RelatedObjects:
+                        if related_object2.is_a("IfcConstructionResource"):
+                            resources.append(related_object2)
 
-        for resource in resources:
-            cost, unit = ifcopenshell.util.resource.get_cost(resource)
-            if not cost:
-                cost, unit  = ifcopenshell.util.resource.get_parent_cost(resource) # Concept to standardise - Not defined in schema, but this makes manual scheduling of resources 10x faster and less duplicate data.
-            quantity = ifcopenshell.util.resource.get_quantity(resource)
-            if not cost or not quantity:
-                continue
-            if unit and "day" in unit:
-                quantity = quantity / 8 # Assume 8 hour working day - TODO implement resource calendar
-            quantity = round(quantity, 2)
-            formula = "{}*{}".format(cost, quantity)
-            cost_value = ifcopenshell.api.run("cost.add_cost_value", self.file, parent=self.settings["cost_item"])
-            cost_value.Name = resource.Name
-            ifcopenshell.api.run("cost.edit_cost_value_formula", self.file, cost_value=cost_value, formula=formula)
+    for resource in resources:
+        cost, unit = ifcopenshell.util.resource.get_cost(resource)
+        if not cost:
+            cost, unit = ifcopenshell.util.resource.get_parent_cost(
+                resource
+            )  # Concept to standardise - Not defined in schema, but this makes manual scheduling of resources 10x faster and less duplicate data.
+        quantity = ifcopenshell.util.resource.get_quantity(resource)
+        if not cost or not quantity:
+            continue
+        if unit and "day" in unit:
+            quantity = quantity / 8  # Assume 8 hour working day - TODO implement resource calendar
+        quantity = round(quantity, 2)
+        formula = "{}*{}".format(cost, quantity)
+        cost_value = ifcopenshell.api.run("cost.add_cost_value", file, parent=settings["cost_item"])
+        cost_value.Name = resource.Name
+        ifcopenshell.api.run("cost.edit_cost_value_formula", file, cost_value=cost_value, formula=formula)

src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item.py

@@ -21,35 +21,38 @@ import ifcopenshell.api
 import ifcopenshell.util.element
 
 
+def copy_cost_item(file, cost_item=None) -> None:
+    """Copies all cost items and related relationships
+
+    The following relationships are also duplicated:
+
+    * The copy will have the same attributes and property sets as the original cost item
+    * The copy will be assigned to the parent cost schedule
+    * The copy will have duplicated nested cost items
+
+    :param cost_item: The cost item to be duplicated
+    :type cost_item: ifcopenshell.entity_instance
+    :return: The duplicated cost item or the list of duplicated cost items if the latter has children
+    :rtype: ifcopenshell.entity_instance or list of ifcopenshell.entity_instance
+
+    Example:
+    .. code:: python
+
+        # We have a cost item
+        cost_item = CostItem(name="Design new feature", deadline="2023-03-01")
+
+        # And now we have two
+        duplicated_cost_item = project.duplicate_cost_item(cost_item)
+
+
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.settings = {"cost_item": cost_item}
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(self, file, cost_item=None):
-        """Copies all cost items and related relationships
-
-        The following relationships are also duplicated:
-
-        * The copy will have the same attributes and property sets as the original cost item
-        * The copy will be assigned to the parent cost schedule
-        * The copy will have duplicated nested cost items
-
-        :param cost_item: The cost item to be duplicated
-        :type cost_item: ifcopenshell.entity_instance.entity_instance
-        :return: The duplicated cost item or the list of duplicated cost items if the latter has children
-        :rtype: ifcopenshell.entity_instance.entity_instance or list of ifcopenshell.entity_instance.entity_instance
-
-        Example:
-        .. code:: python
-
-            # We have a cost item
-            cost_item = CostItem(name="Design new feature", deadline="2023-03-01")
-
-            # And now we have two
-            duplicated_cost_item = project.duplicate_cost_item(cost_item)
-
-
-        """
-        self.file = file
-        self.settings = {"cost_item": cost_item}
-
     def execute(self):
         self.new_cost_items = []
         self.duplicate_cost_item(self.settings["cost_item"])

src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item_values.py

@@ -20,45 +20,42 @@ import ifcopenshell.util.element
 import ifcopenshell.api
 
 
-class Usecase:
-    def __init__(self, file, source=None, destination=None):
-        """Copies all cost values from one cost item to another
+def copy_cost_item_values(file, source=None, destination=None) -> None:
+    """Copies all cost values from one cost item to another
 
-        Any previously existing values will be removed. The entire value is
-        copied, including all components and formulas. However they are not
-        parametrically linked, so if one value changes, the other will not.
+    Any previously existing values will be removed. The entire value is
+    copied, including all components and formulas. However they are not
+    parametrically linked, so if one value changes, the other will not.
 
-        :param source: The IfcCostItem to copy cost values from
-        :type source: ifcopenshell.entity_instance.entity_instance
-        :param destination: The IfcCostItem to copy cost values from
-        :type destination: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
+    :param source: The IfcCostItem to copy cost values from
+    :type source: ifcopenshell.entity_instance
+    :param destination: The IfcCostItem to copy cost values from
+    :type destination: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            # Assume we have a schedule with multiple items in it
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item1 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-            item2 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        # Assume we have a schedule with multiple items in it
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item1 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        item2 = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
 
-            # One of the items has a value
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
-            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
-                attributes={"AppliedValue": 5000.0})
+        # One of the items has a value
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
+        ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
+            attributes={"AppliedValue": 5000.0})
 
-            # Let's copy the value from one item to another
-            ifcopenshell.api.run("cost.copy_cost_item_values", model, source=item1, destination=item2)
-        """
-        self.file = file
-        self.settings = {"source": source, "destination": destination}
+        # Let's copy the value from one item to another
+        ifcopenshell.api.run("cost.copy_cost_item_values", model, source=item1, destination=item2)
+    """
+    settings = {"source": source, "destination": destination}
 
-    def execute(self):
-        for cost_value in self.settings["destination"].CostValues or []:
-            ifcopenshell.api.run("cost.remove_cost_item_value", self.file, cost_value=cost_value)
-        copied_cost_values = []
-        for cost_value in self.settings["source"].CostValues or []:
-            copied_cost_values.append(ifcopenshell.util.element.copy_deep(self.file, cost_value))
-        self.settings["destination"].CostValues = copied_cost_values
+    for cost_value in settings["destination"].CostValues or []:
+        ifcopenshell.api.run("cost.remove_cost_item_value", file, cost_value=cost_value)
+    copied_cost_values = []
+    for cost_value in settings["source"].CostValues or []:
+        copied_cost_values.append(ifcopenshell.util.element.copy_deep(file, cost_value))
+    settings["destination"].CostValues = copied_cost_values

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item.py

@@ -17,31 +17,28 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, cost_item=None, attributes=None):
-        """Edits the attributes of an IfcCostItem
+def edit_cost_item(file, cost_item=None, attributes=None) -> None:
+    """Edits the attributes of an IfcCostItem
 
-        For more information about the attributes and data types of an
-        IfcCostItem, consult the IFC documentation.
+    For more information about the attributes and data types of an
+    IfcCostItem, consult the IFC documentation.
 
-        :param cost_item: The IfcCostItem entity you want to edit
-        :type cost_item: ifcopenshell.entity_instance.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :return: None
-        :rtype: None
+    :param cost_item: The IfcCostItem entity you want to edit
+    :type cost_item: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-            ifcopenshell.api.run("cost.edit_cost_item", model, cost_item=item, attributes={"Name": "Foo"})
-        """
-        self.file = file
-        self.settings = {"cost_item": cost_item, "attributes": attributes or {}}
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        ifcopenshell.api.run("cost.edit_cost_item", model, cost_item=item, attributes={"Name": "Foo"})
+    """
+    settings = {"cost_item": cost_item, "attributes": attributes or {}}
 
-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["cost_item"], name, value)
+    for name, value in settings["attributes"].items():
+        setattr(settings["cost_item"], name, value)

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item_quantity.py

@@ -17,39 +17,36 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, physical_quantity=None, attributes=None):
-        """Edits the attributes of an IfcPhysicalQuantity
+def edit_cost_item_quantity(file, physical_quantity=None, attributes=None) -> None:
+    """Edits the attributes of an IfcPhysicalQuantity
 
-        For more information about the attributes and data types of an
-        IfcPhysicalQuantity, consult the IFC documentation.
+    For more information about the attributes and data types of an
+    IfcPhysicalQuantity, consult the IFC documentation.
 
-        :param physical_quantity: The IfcPhysicalQuantity entity you want to edit
-        :type physical_quantity: ifcopenshell.entity_instance.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :return: None
-        :rtype: None
+    :param physical_quantity: The IfcPhysicalQuantity entity you want to edit
+    :type physical_quantity: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
 
-            # This cost item will have a unit cost of 5 and a volume of 3
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
-            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
-                attributes={"AppliedValue": 5.0})
-            quantity = ifcopenshell.api.run("cost.add_cost_item_quantity", model,
-                cost_item=item, ifc_class="IfcQuantityVolume")
-            ifcopenshell.api.run("cost.edit_cost_item_quantity", model,
-                physical_quantity=quantity, "attributes": {"VolumeValue": 3.0})
-        """
-        self.file = file
-        self.settings = {"physical_quantity": physical_quantity, "attributes": attributes or {}}
+        # This cost item will have a unit cost of 5 and a volume of 3
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
+        ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
+            attributes={"AppliedValue": 5.0})
+        quantity = ifcopenshell.api.run("cost.add_cost_item_quantity", model,
+            cost_item=item, ifc_class="IfcQuantityVolume")
+        ifcopenshell.api.run("cost.edit_cost_item_quantity", model,
+            physical_quantity=quantity, "attributes": {"VolumeValue": 3.0})
+    """
+    settings = {"physical_quantity": physical_quantity, "attributes": attributes or {}}
 
-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["physical_quantity"], name, value)
+    for name, value in settings["attributes"].items():
+        setattr(settings["physical_quantity"], name, value)

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_schedule.py

@@ -17,32 +17,29 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, cost_schedule=None, attributes=None):
-        """Edits the attributes of an IfcCostSchedule
+def edit_cost_schedule(file, cost_schedule=None, attributes=None) -> None:
+    """Edits the attributes of an IfcCostSchedule
 
-        For more information about the attributes and data types of an
-        IfcCostSchedule, consult the IFC documentation.
+    For more information about the attributes and data types of an
+    IfcCostSchedule, consult the IFC documentation.
 
-        :param cost_schedule: The IfcCostSchedule entity you want to edit
-        :type cost_schedule: ifcopenshell.entity_instance.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :return: None
-        :rtype: None
+    :param cost_schedule: The IfcCostSchedule entity you want to edit
+    :type cost_schedule: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            ifcopenshell.api.run("cost.edit_cost_schedule", model,
-                cost_schedule=schedule, attributes={"Name": "Foo"})
-        """
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        ifcopenshell.api.run("cost.edit_cost_schedule", model,
+            cost_schedule=schedule, attributes={"Name": "Foo"})
+    """
 
-        self.file = file
-        self.settings = {"cost_schedule": cost_schedule, "attributes": attributes or {}}
+    settings = {"cost_schedule": cost_schedule, "attributes": attributes or {}}
 
-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            setattr(self.settings["cost_schedule"], name, value)
+    for name, value in settings["attributes"].items():
+        setattr(settings["cost_schedule"], name, value)

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value.py

@@ -21,48 +21,45 @@ import ifcopenshell.util.unit
 import ifcopenshell.util.element
 
 
-class Usecase:
-    def __init__(self, file, cost_value=None, attributes=None):
-        """Edits the attributes of an IfcCostValue
+def edit_cost_value(file, cost_value=None, attributes=None) -> None:
+    """Edits the attributes of an IfcCostValue
 
-        For more information about the attributes and data types of an
-        IfcCostValue, consult the IFC documentation.
+    For more information about the attributes and data types of an
+    IfcCostValue, consult the IFC documentation.
 
-        :param cost_value: The IfcCostValue entity you want to edit
-        :type cost_value: ifcopenshell.entity_instance.entity_instance
-        :param attributes: a dictionary of attribute names and values.
-        :type attributes: dict, optional
-        :return: None
-        :rtype: None
+    :param cost_value: The IfcCostValue entity you want to edit
+    :type cost_value: ifcopenshell.entity_instance
+    :param attributes: a dictionary of attribute names and values.
+    :type attributes: dict, optional
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
 
-            # This cost item will have a total cost of 42
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
-            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
-                attributes={"AppliedValue": 42.0})
-        """
-        self.file = file
-        self.settings = {"cost_value": cost_value, "attributes": attributes or {}}
+        # This cost item will have a total cost of 42
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
+        ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
+            attributes={"AppliedValue": 42.0})
+    """
+    settings = {"cost_value": cost_value, "attributes": attributes or {}}
 
-    def execute(self):
-        for name, value in self.settings["attributes"].items():
-            if name == "AppliedValue" and value is not None:
-                # TODO: support all applied value select types
-                value = self.file.createIfcMonetaryMeasure(value)
-            elif name == "UnitBasis":
-                old_unit_basis = self.settings["cost_value"].UnitBasis
-                if value:
-                    value_component = self.file.create_entity(
-                        ifcopenshell.util.unit.get_unit_measure_class(value["UnitComponent"].UnitType),
-                        value["ValueComponent"],
-                    )
-                    value = self.file.create_entity("IfcMeasureWithUnit", value_component, value["UnitComponent"])
-                if old_unit_basis and len(self.file.get_inverse(old_unit_basis)) == 0:
-                    ifcopenshell.util.element.remove_deep(self.file, old_unit_basis)
-            setattr(self.settings["cost_value"], name, value)
+    for name, value in settings["attributes"].items():
+        if name == "AppliedValue" and value is not None:
+            # TODO: support all applied value select types
+            value = file.createIfcMonetaryMeasure(value)
+        elif name == "UnitBasis":
+            old_unit_basis = settings["cost_value"].UnitBasis
+            if value:
+                value_component = file.create_entity(
+                    ifcopenshell.util.unit.get_unit_measure_class(value["UnitComponent"].UnitType),
+                    value["ValueComponent"],
+                )
+                value = file.create_entity("IfcMeasureWithUnit", value_component, value["UnitComponent"])
+            if old_unit_basis and len(file.get_inverse(old_unit_basis)) == 0:
+                ifcopenshell.util.element.remove_deep(file, old_unit_basis)
+        setattr(settings["cost_value"], name, value)

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value_formula.py

@@ -22,37 +22,40 @@ import ifcopenshell.util.unit
 import ifcopenshell.util.element
 
 
+def edit_cost_value_formula(file, cost_value=None, formula=None) -> None:
+    """Sets a cost value based on a formula, similar to formulas in spreadsheets
+
+    Costs may be made up of many components (e.g. labour, material, waste
+    factor, taxes, etc). This can be easily represented in the form of a
+    formula similar thta would be used in spreadsheet applications.
+
+    For more information, see ifcopenshell.util.cost
+
+    :param cost_value: The IfcCostValue to set the values of
+    :type cost_value: ifcopenshell.entity_instance
+    :param formula: The formula following the language of ifcopenshell.util.cost
+    :type formula: str
+    :return: None
+    :rtype: None
+
+    Example:
+
+    .. code:: python
+
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+
+        value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
+        ifcopenshell.api.run("cost.edit_cost_value_formula", model, cost_value=value,
+            formula="5000 * 1.19")
+    """
+    usecase = Usecase()
+    usecase.file = file
+    usecase.settings = {"cost_value": cost_value, "formula": formula or {}}
+    return usecase.execute()
+
+
 class Usecase:
-    def __init__(self, file, cost_value=None, formula=None):
-        """Sets a cost value based on a formula, similar to formulas in spreadsheets
-
-        Costs may be made up of many components (e.g. labour, material, waste
-        factor, taxes, etc). This can be easily represented in the form of a
-        formula similar thta would be used in spreadsheet applications.
-
-        For more information, see ifcopenshell.util.cost
-
-        :param cost_value: The IfcCostValue to set the values of
-        :type cost_value: ifcopenshell.entity_instance.entity_instance
-        :param formula: The formula following the language of ifcopenshell.util.cost
-        :type formula: str
-        :return: None
-        :rtype: None
-
-        Example:
-
-        .. code:: python
-
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-
-            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
-            ifcopenshell.api.run("cost.edit_cost_value_formula", model, cost_value=value,
-                formula="5000 * 1.19")
-        """
-        self.file = file
-        self.settings = {"cost_value": cost_value, "formula": formula or {}}
-
     def execute(self):
         try:
             data = ifcopenshell.util.cost.unserialise_cost_value(self.settings["formula"], self.settings["cost_value"])

src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item.py

@@ -21,48 +21,45 @@ import ifcopenshell.api
 import ifcopenshell.util.element
 
 
-class Usecase:
-    def __init__(self, file, cost_item=None):
-        """Removes a cost item
+def remove_cost_item(file, cost_item=None) -> None:
+    """Removes a cost item
 
-        All associated relationships with the cost item are also removed,
-        however the related resources, products, and tasks themselves are
-        retained.
+    All associated relationships with the cost item are also removed,
+    however the related resources, products, and tasks themselves are
+    retained.
 
-        :param cost_item: The IfcCostItem entity you want to remove
-        :type cost_item: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
+    :param cost_item: The IfcCostItem entity you want to remove
+    :type cost_item: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-            ifcopenshell.api.run("cost.remove_cost_item", model, cost_item=item)
-        """
-        self.file = file
-        self.settings = {"cost_item": cost_item}
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        ifcopenshell.api.run("cost.remove_cost_item", model, cost_item=item)
+    """
+    settings = {"cost_item": cost_item}
 
-    def execute(self):
-        # TODO: do a deep purge
-        for inverse in self.file.get_inverse(self.settings["cost_item"]):
-            if inverse.is_a("IfcRelNests"):
-                if inverse.RelatingObject == self.settings["cost_item"]:
-                    for related_object in inverse.RelatedObjects:
-                        ifcopenshell.api.run("cost.remove_cost_item", self.file, cost_item=related_object)
-                elif inverse.RelatedObjects == (self.settings["cost_item"],):
-                    history = inverse.OwnerHistory
-                    self.file.remove(inverse)
-                    if history:
-                        ifcopenshell.util.element.remove_deep2(self.file, history)
-            elif inverse.is_a("IfcRelAssignsToControl"):
+    # TODO: do a deep purge
+    for inverse in file.get_inverse(settings["cost_item"]):
+        if inverse.is_a("IfcRelNests"):
+            if inverse.RelatingObject == settings["cost_item"]:
+                for related_object in inverse.RelatedObjects:
+                    ifcopenshell.api.run("cost.remove_cost_item", file, cost_item=related_object)
+            elif inverse.RelatedObjects == (settings["cost_item"],):
                 history = inverse.OwnerHistory
-                self.file.remove(inverse)
+                file.remove(inverse)
                 if history:
-                    ifcopenshell.util.element.remove_deep2(self.file, history)
-        history = self.settings["cost_item"].OwnerHistory
-        self.file.remove(self.settings["cost_item"])
-        if history:
-            ifcopenshell.util.element.remove_deep2(self.file, history)
+                    ifcopenshell.util.element.remove_deep2(file, history)
+        elif inverse.is_a("IfcRelAssignsToControl"):
+            history = inverse.OwnerHistory
+            file.remove(inverse)
+            if history:
+                ifcopenshell.util.element.remove_deep2(file, history)
+    history = settings["cost_item"].OwnerHistory
+    file.remove(settings["cost_item"])
+    if history:
+        ifcopenshell.util.element.remove_deep2(file, history)

src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item_quantity.py

@@ -17,40 +17,37 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 
-class Usecase:
-    def __init__(self, file, cost_item=None, physical_quantity=None):
-        """Removes a quantity assigned to a cost item
+def remove_cost_item_quantity(file, cost_item=None, physical_quantity=None) -> None:
+    """Removes a quantity assigned to a cost item
 
-        If the quantity is part of a product (e.g. wall), then the quantity will
-        still exist and merely the relationship to the cost item will be
-        removed.
+    If the quantity is part of a product (e.g. wall), then the quantity will
+    still exist and merely the relationship to the cost item will be
+    removed.
 
-        :param cost_item: The IfcCostItem that the quantity is assigned to
-        :type cost_item: ifcopenshell.entity_instance.entity_instance
-        :param physical_quantity: The IfcPhysicalQuantity to remove
-        :type physical_quantity: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
+    :param cost_item: The IfcCostItem that the quantity is assigned to
+    :type cost_item: ifcopenshell.entity_instance
+    :param physical_quantity: The IfcPhysicalQuantity to remove
+    :type physical_quantity: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-            quantity = ifcopenshell.api.run("cost.add_cost_item_quantity", model,
-                cost_item=item, ifc_class="IfcQuantityVolume")
-            # Let's change our mind and delete it
-            ifcopenshell.api.run("cost.remove_cost_item", model,
-                cost_item=item, physical_quantity=quantity)
-        """
-        self.file = file
-        self.settings = {"cost_item": cost_item, "physical_quantity": physical_quantity}
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        quantity = ifcopenshell.api.run("cost.add_cost_item_quantity", model,
+            cost_item=item, ifc_class="IfcQuantityVolume")
+        # Let's change our mind and delete it
+        ifcopenshell.api.run("cost.remove_cost_item", model,
+            cost_item=item, physical_quantity=quantity)
+    """
+    settings = {"cost_item": cost_item, "physical_quantity": physical_quantity}
 
-    def execute(self):
-        if len(self.file.get_inverse(self.settings["physical_quantity"])) == 1:
-            self.file.remove(self.settings["physical_quantity"])
-            return
-        quantities = list(self.settings["cost_item"].CostQuantities or [])
-        quantities.remove(self.settings["physical_quantity"])
-        self.settings["cost_item"].CostQuantities = quantities
+    if len(file.get_inverse(settings["physical_quantity"])) == 1:
+        file.remove(settings["physical_quantity"])
+        return
+    quantities = list(settings["cost_item"].CostQuantities or [])
+    quantities.remove(settings["physical_quantity"])
+    settings["cost_item"].CostQuantities = quantities

src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_schedule.py

@@ -21,41 +21,36 @@ import ifcopenshell.api
 import ifcopenshell.util.element
 
 
-class Usecase:
-    def __init__(self, file, cost_schedule=None):
-        """Removes a cost schedule
+def remove_cost_schedule(file, cost_schedule=None) -> None:
+    """Removes a cost schedule
 
-        All associated relationships with the cost schedule are also removed,
-        including all cost items.
+    All associated relationships with the cost schedule are also removed,
+    including all cost items.
 
-        :param cost_schedule: The IfcCostSchedule entity you want to remove
-        :type cost_schedule: ifcopenshell.entity_instance.entity_instance
-        :return: None
-        :rtype: None
+    :param cost_schedule: The IfcCostSchedule entity you want to remove
+    :type cost_schedule: ifcopenshell.entity_instance
+    :return: None
+    :rtype: None
 
-        Example:
+    Example:
 
-        .. code:: python
+    .. code:: python
 
-            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
-            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
-            ifcopenshell.api.run("cost.remove_cost_schedule", model, cost_schedule=schedule)
-        """
-        self.file = file
-        self.settings = {"cost_schedule": cost_schedule}
+        schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+        item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+        ifcopenshell.api.run("cost.remove_cost_schedule", model, cost_schedule=schedule)
+    """
+    settings = {"cost_schedule": cost_schedule}
 
-    def execute(self):
-        # TODO: do a deep purge
-        for inverse in self.file.get_inverse(self.settings["cost_schedule"]):
-            if inverse.is_a("IfcRelAssignsToControl"):
-                [
-                    ifcopenshell.api.run(
-                        "cost.remove_cost_item", self.file, cost_item=related_object
-                    )
-                    for related_object in inverse.RelatedObjects
-                    if related_object.is_a("IfcCostItem")
-                ]
-        history = self.settings["cost_schedule"].OwnerHistory
-        self.file.remove(self.settings["cost_schedule"])
-        if history:
-            ifcopenshell.util.element.remove_deep2(self.file, history)
+    # TODO: do a deep purge
+    for inverse in file.get_inverse(settings["cost_schedule"]):
+        if inverse.is_a("IfcRelAssignsToControl"):
+            [
+                ifcopenshell.api.run("cost.remove_cost_item", file, cost_item=related_object)
+                for related_object in inverse.RelatedObjects
+                if related_object.is_a("IfcCostItem")
+            ]
+    history = settings["cost_schedule"].OwnerHistory
+    file.remove(settings["cost_schedule"])
+    if history:
+        ifcopenshell.util.element.remove_deep2(file, history)