Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-07 16:31:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

ifc5d typing and refactor

Browse Source 
no functional changes
This commit is contained in:
Andrej730
2025-04-16 10:48:19 +05:00
parent e8b74245ce
commit 6499ac41cf
2 changed files with 143 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ifc5d/ifc5d/csv2ifc.py
+69 -25
View File
@@ -16,25 +16,61 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Ifc5D. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import csv
import ifcopenshell
import ifcopenshell.api
import ifcopenshell.api.cost
import ifcopenshell.api.root
import ifcopenshell.util.unit
import ifcopenshell.util.selector
import ifcopenshell.util.element
import locale
from typing import Any, Optional
from typing import Any, Union, Optional, TypedDict, NotRequired
CostItem = dict[str, Any]
class CsvHeader(TypedDict):
Name: int
Quantity: int
Unit: int
Identification: NotRequired[int]
Value: NotRequired[int]
# Not schedule of rates:
Property: int
Query: int
class CostItem(TypedDict):
children: list[CostItem]
assignments: dict[str, Any]
ifc: NotRequired[ifcopenshell.entity_instance]
Identification: Union[str, None]
Name: Union[str, None]
Unit: Union[str, None]
Quantity: Union[float, None]
CostValues: Union[dict[str, float], float, None]
class Csv2Ifc:
# Inputs.
csv: str
file: Union[ifcopenshell.file, None] = None
"""If not provided, boilerplate file will be created."""
cost_schedule: Union[ifcopenshell.entity_instance, None] = None
"""Cost schedule to load cost items to. If not provided, new one will be created."""
is_schedule_of_rates: bool = False
"""Whether imported schedule is a schedule of rates."""
# Output.
cost_items: list[CostItem]
# Private.
headers: CsvHeader
units: dict[str, ifcopenshell.entity_instance]
def __init__(self):
self.csv: str = None
self.file: ifcopenshell.file = None
self.cost_items: list[CostItem] = []
self.cost_schedule: ifcopenshell.entity_instance = None
self.is_schedule_of_rates: bool = False
self.units: dict[str, ifcopenshell.entity_instance] = {}
def execute(self) -> None:
@@ -42,8 +78,11 @@ class Csv2Ifc:
self.create_ifc()
def parse_csv(self) -> None:
self.parents = {}
"""Fill ``headers`` and ``cost_items`` based on data from csv file."""
self.cost_items = []
self.headers = {}
parents: dict[int, CostItem] = {}
locale.setlocale(locale.LC_ALL, "") # set the system locale
with open(self.csv, "r", encoding="utf-8") as csv_file:
reader = csv.reader(csv_file)
@@ -76,8 +115,8 @@ class Csv2Ifc:
if hierarchy_key == 1:
self.cost_items.append(cost_data)
else:
self.parents[hierarchy_key - 1]["children"].append(cost_data)
self.parents[hierarchy_key] = cost_data
parents[hierarchy_key - 1]["children"].append(cost_data)
parents[hierarchy_key] = cost_data
def get_row_cost_data(self, row: list[str]) -> CostItem:
name = row[self.headers["Name"]]
@@ -102,6 +141,7 @@ class Csv2Ifc:
and row[v]
}
else:
assert "Value" in self.headers
cost_values = row[self.headers["Value"]]
cost_values = float(cost_values) if cost_values else None
return {
@@ -118,7 +158,7 @@ class Csv2Ifc:
if not self.file:
self.create_boilerplate_ifc()
if not self.cost_schedule:
self.cost_schedule = ifcopenshell.api.run("cost.add_cost_schedule", self.file, name="CSV Import")
self.cost_schedule = ifcopenshell.api.cost.add_cost_schedule(self.file, name="CSV Import")
if self.is_schedule_of_rates:
self.cost_schedule.PredefinedType = "SCHEDULEOFRATES"
self.create_cost_items(self.cost_items)
@@ -126,25 +166,27 @@ class Csv2Ifc:
def create_cost_items(
self, cost_items: list[CostItem], parent: Optional[ifcopenshell.entity_instance] = None
) -> None:
# Not using `self.cost_items` directly to allow recursion.
for cost_item in cost_items:
self.create_cost_item(cost_item, parent)
def create_cost_item(self, cost_item: CostItem, parent: Optional[ifcopenshell.entity_instance] = None) -> None:
if parent is None:
cost_item["ifc"] = ifcopenshell.api.run("cost.add_cost_item", self.file, cost_schedule=self.cost_schedule)
cost_item["ifc"] = ifcopenshell.api.cost.add_cost_item(self.file, cost_schedule=self.cost_schedule)
else:
cost_item["ifc"] = ifcopenshell.api.run("cost.add_cost_item", self.file, cost_item=parent)
cost_item["ifc"] = ifcopenshell.api.cost.add_cost_item(self.file, cost_item=parent)
cost_item["ifc"].Name = cost_item["Name"]
cost_item["ifc"].Identification = cost_item["Identification"]
if not cost_item["CostValues"] and cost_item["children"]:
if not self.is_schedule_of_rates:
cost_value = ifcopenshell.api.run("cost.add_cost_value", self.file, parent=cost_item["ifc"])
cost_value = ifcopenshell.api.cost.add_cost_value(self.file, parent=cost_item["ifc"])
cost_value.Category = "*"
elif self.has_categories:
assert isinstance(cost_item["CostValues"], dict)
for category, value in cost_item["CostValues"].items():
cost_value = ifcopenshell.api.run("cost.add_cost_value", self.file, parent=cost_item["ifc"])
cost_value = ifcopenshell.api.cost.add_cost_value(self.file, parent=cost_item["ifc"])
cost_value.AppliedValue = self.file.createIfcMonetaryMeasure(value)
if category != "Rate" or category != "Price":
if "Rate" in category or "Price" in category:
@@ -152,7 +194,7 @@ class Csv2Ifc:
category = category.strip()
cost_value.Category = category
elif cost_item["CostValues"]:
cost_value = ifcopenshell.api.run("cost.add_cost_value", self.file, parent=cost_item["ifc"])
cost_value = ifcopenshell.api.cost.add_cost_value(self.file, parent=cost_item["ifc"])
cost_value.AppliedValue = self.file.createIfcMonetaryMeasure(cost_item["CostValues"])
if self.is_schedule_of_rates:
measure_class = ifcopenshell.util.unit.get_symbol_measure_class(cost_item["Unit"])
@@ -181,8 +223,8 @@ class Csv2Ifc:
prop_name = cost_item["assignments"]["PropertyName"]
if not self.is_schedule_of_rates and cost_item["Quantity"] is not None:
quantity = ifcopenshell.api.run(
"cost.add_cost_item_quantity", self.file, cost_item=cost_item["ifc"], ifc_class=quantity_class
quantity = ifcopenshell.api.cost.add_cost_item_quantity(
self.file, cost_item=cost_item["ifc"], ifc_class=quantity_class
)
# 3 IfcPhysicalSimpleQuantity Value
quantity[3] = int(cost_item["Quantity"]) if quantity_class == "IfcQuantityCount" else cost_item["Quantity"]
@@ -198,16 +240,15 @@ class Csv2Ifc:
# If query is provided it will override the defined value
# due current behaviour in cost.assign_cost_item_quantity.
if results:
ifcopenshell.api.run(
"cost.assign_cost_item_quantity",
ifcopenshell.api.cost.assign_cost_item_quantity(
self.file,
cost_item=cost_item["ifc"],
products=results,
prop_name=prop_name,
)
elif not quantity:
quantity = ifcopenshell.api.run(
"cost.add_cost_item_quantity", self.file, cost_item=cost_item["ifc"], ifc_class=quantity_class
quantity = ifcopenshell.api.cost.add_cost_item_quantity(
self.file, cost_item=cost_item["ifc"], ifc_class=quantity_class
)
self.create_cost_items(cost_item["children"], cost_item["ifc"])
@@ -216,15 +257,18 @@ class Csv2Ifc:
unit = self.units.get(symbol, None)
if unit:
return unit
unit = self.file.createIfcContextDependentUnit(
self.file.createIfcDimensionalExponents(0, 0, 0, 0, 0, 0, 0), "USERDEFINED", symbol
unit = self.file.create_entity(
"IfcContextDependentUnit",
self.file.create_entity("IfcDimensionalExponents", 0, 0, 0, 0, 0, 0, 0),
"USERDEFINED",
symbol,
)
self.units[symbol] = unit
return unit
def create_boilerplate_ifc(self) -> None:
self.file = ifcopenshell.file(schema="IFC4")
ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcProject")
ifcopenshell.api.root.create_entity(self.file, ifc_class="IfcProject")
def has_property(self, product: ifcopenshell.entity_instance, property_name: str) -> bool:
src/ifc5d/ifc5d/ifc5Dspreadsheet.py
+74 -39
View File
@@ -26,7 +26,21 @@ import ifcopenshell
import ifcopenshell.util.element
import ifcopenshell.util.cost
import ifcopenshell.util.date
from typing import Union, Optional, Any
from typing import Union, Optional, Any, TypedDict, NotRequired
class CostItem(TypedDict):
Index: int
Hierarchy: str
Id: int
Identification: Union[str, None]
Description: Union[str, None]
Unit: str
Quantity: int
ChildrenData: list["CostItem"]
# Total Price: float
# * Cost: str
# Rate Subtotal: float
class IfcDataGetter:
@@ -34,11 +48,9 @@ class IfcDataGetter:
def get_schedules(
file: ifcopenshell.file, filter_by_schedule: Optional[ifcopenshell.entity_instance] = None
) -> list[ifcopenshell.entity_instance]:
return [
schedule
for schedule in file.by_type("IfcCostSchedule")
if not filter_by_schedule or schedule == filter_by_schedule
]
if filter_by_schedule:
return [filter_by_schedule]
return file.by_type("IfcCostSchedule")
@staticmethod
def canonicalise_time(time: Union[datetime.datetime, None]) -> str:
@@ -96,17 +108,21 @@ class IfcDataGetter:
def process_cost_data(
file: ifcopenshell.file,
cost_item: ifcopenshell.entity_instance,
cost_items_data: list[dict[str, Any]],
cost_items_data: list[CostItem],
index: int,
hierarchy: str = "1",
) -> None:
"""
:param cost_items_data: A list to fill with cost items.
"""
def listToString(s):
return ", ".join([str(i) for i in s])
quantity_data = IfcDataGetter.get_cost_item_quantity(file, cost_item)
cost_values_data = IfcDataGetter.get_cost_item_values(cost_item)
data = {
data: CostItem = {
"Index": index,
"Hierarchy": hierarchy,
"Id": cost_item.id(),
@@ -140,8 +156,8 @@ class IfcDataGetter:
)
@staticmethod
def get_cost_items_data(file: ifcopenshell.file, schedule: ifcopenshell.entity_instance) -> list[dict[str, Any]]:
cost_items_data = []
def get_cost_items_data(file: ifcopenshell.file, schedule: ifcopenshell.entity_instance) -> list[CostItem]:
cost_items_data: list[cost_item] = []
index = 0
for cost_item in IfcDataGetter.get_root_costs(schedule):
IfcDataGetter.process_cost_data(file, cost_item, cost_items_data, index)
@@ -204,8 +220,43 @@ class IfcDataGetter:
}
class SheetData(TypedDict):
headers: list[str]
cost_items: list[CostItem]
# IFC attributes.
UpdateDate: str
PredefinedType: Union[str, None]
Name: str
"""Name should be unique as it's going to be used as a filename"""
class Ifc5Dwriter:
# Inputs.
file: ifcopenshell.file
output: str
"""Output filepath."""
cost_schedule: Union[ifcopenshell.entity_instance, None]
"""Cost schedule to export. If not provided - export all."""
colors: dict[int, str]
"""Colors to use for hierarchy indices."""
# Outputs.
sheet_data: dict[int, SheetData]
# Private.
cost_schedules: list[ifcopenshell.entity_instance]
"""List of cost schedules to export."""
column_indexes: list[str] = list("ABCDEFGHIJKLMNOPQRSTUVWXYZ")
default_colors: dict[int, str] = {
0: "0839C2", # 1st Row - Dark Blue
1: "266EF6", # Internal reference
2: "47C9FF", # External reference
3: "82E9FF", # Optional
4: "B8F2FF", # Secondary information
5: "DAECF5", # Project specific
6: "000000", # Not used
7: "fed8b1", # 2nd Row - Light Orange
}
def __init__(
self,
@@ -223,29 +274,14 @@ class Ifc5Dwriter:
else:
self.file = file
self.cost_schedule = cost_schedule
self.cost_schedules = []
self.sheet_data = {}
self.column_indexes = []
self.colours = {
0: "0839C2", # 1st Row - Dark Blue
1: "266EF6", # Internal reference
2: "47C9FF", # External reference
3: "82E9FF", # Optional
4: "B8F2FF", # Secondary information
5: "DAECF5", # Project specific
6: "000000", # Not used
7: "fed8b1", # 2nd Row - Light Orange
}
self.colours = self.default_colors.copy()
def parse(self):
self.column_indexes = []
self.used_names = []
for i in range(26):
self.column_indexes.append("ABCDEFGHIJKLMNOPQRSTUVWXYZ"[i % 26])
used_names: list[str] = []
for cost_schedule in self.cost_schedules:
sheet_id = cost_schedule.id()
self.sheet_data[sheet_id] = {}
self.sheet_data[sheet_id]["headers"] = [
self.sheet_data[sheet_id] = sheet_data = SheetData()
sheet_data["headers"] = [
"Id",
"Hierarchy",
"Index",
@@ -255,18 +291,18 @@ class Ifc5Dwriter:
"Unit",
]
cost_rate_categories = IfcDataGetter.get_cost_rates_categories(cost_schedule)
self.sheet_data[sheet_id]["headers"].extend(list(cost_rate_categories))
self.sheet_data[sheet_id]["headers"].extend(["Rate Subtotal", "Total Price", "Children"])
self.sheet_data[sheet_id]["cost_items"] = IfcDataGetter.get_cost_items_data(self.file, cost_schedule)
self.sheet_data[sheet_id]["UpdateDate"] = IfcDataGetter.canonicalise_time(
sheet_data["headers"].extend(list(cost_rate_categories))
sheet_data["headers"].extend(["Rate Subtotal", "Total Price", "Children"])
sheet_data["cost_items"] = IfcDataGetter.get_cost_items_data(self.file, cost_schedule)
sheet_data["UpdateDate"] = IfcDataGetter.canonicalise_time(
ifcopenshell.util.date.ifc2datetime(cost_schedule.UpdateDate)
)
self.sheet_data[sheet_id]["PredefinedType"] = cost_schedule.PredefinedType
sheet_data["PredefinedType"] = cost_schedule.PredefinedType
schedule_name = cost_schedule.Name or "Unnamed"
if schedule_name in self.used_names:
schedule_name = "{}_{}".format(schedule_name, self.used_names.count(schedule_name))
self.sheet_data[sheet_id]["Name"] = schedule_name
self.used_names.append(schedule_name)
if schedule_name in used_names:
schedule_name = "{}_{}".format(schedule_name, used_names.count(schedule_name))
sheet_data["Name"] = schedule_name
used_names.append(schedule_name)
def multiply_cells(self, cell1, cell2):
return "={}*{}".format(cell1, cell2)
@@ -437,7 +473,6 @@ class Ifc5DXlsxWriter(Ifc5Dwriter):
file_name += cost_schedule.Name or ""
self.file_path = os.path.join(self.output, "{}.xlsx".format(file_name))
self.workbook = xlsxwriter.Workbook(self.file_path)
self.used_names = []
for cost_schedule in self.cost_schedules:
self.write_table(cost_schedule)
self.workbook.close()