mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-10 01:41:57 +00:00
Fix #4815. Purge deprecated old selector syntax.
This commit is contained in:
Dion Moult
@@ -276,7 +276,130 @@ def format(query: str) -> str:
|
||||
|
||||
def get_element_value(element: ifcopenshell.entity_instance, query: str) -> Any:
|
||||
keys: list[str] = GetElementTransformer().transform(get_element_grammar.parse(query))
|
||||
return Selector.get_element_value(element, keys)
|
||||
return _get_element_value(element, keys)
|
||||
|
||||
|
||||
def _get_element_value(element: ifcopenshell.entity_instance, keys: list[str]) -> Any:
|
||||
value = element
|
||||
for key in keys:
|
||||
if value is None:
|
||||
return
|
||||
if key == "type":
|
||||
value = ifcopenshell.util.element.get_type(value)
|
||||
elif key in ("material", "mat"):
|
||||
value = ifcopenshell.util.element.get_material(value, should_skip_usage=True)
|
||||
elif key in ("materials", "mats"):
|
||||
value = ifcopenshell.util.element.get_materials(value)
|
||||
elif key == "profiles":
|
||||
value = ifcopenshell.util.shape.get_profiles(value)
|
||||
elif key == "styles":
|
||||
value = ifcopenshell.util.element.get_styles(value)
|
||||
elif key in ("item", "i"):
|
||||
if value.is_a("IfcMaterialLayerSet"):
|
||||
value = value.MaterialLayers
|
||||
elif value.is_a("IfcMaterialProfileSet"):
|
||||
value = value.MaterialProfiles
|
||||
elif value.is_a("IfcMaterialConstituentSet"):
|
||||
value = value.MaterialConstituents
|
||||
elif key == "container":
|
||||
value = ifcopenshell.util.element.get_container(value)
|
||||
elif key == "space":
|
||||
value = ifcopenshell.util.element.get_container(value, ifc_class="IfcSpace")
|
||||
elif key == "storey":
|
||||
value = ifcopenshell.util.element.get_container(value, ifc_class="IfcBuildingStorey")
|
||||
elif key == "building":
|
||||
value = ifcopenshell.util.element.get_container(value, ifc_class="IfcBuilding")
|
||||
elif key == "site":
|
||||
value = ifcopenshell.util.element.get_container(value, ifc_class="IfcSite")
|
||||
elif key == "parent":
|
||||
value = ifcopenshell.util.element.get_parent(value)
|
||||
elif key in ("types", "occurrences"):
|
||||
value = ifcopenshell.util.element.get_types(value)
|
||||
elif key == "count":
|
||||
if isinstance(value, set):
|
||||
value = len(list(value))
|
||||
elif isinstance(value, (list, tuple)):
|
||||
value = len(value)
|
||||
else:
|
||||
value = 1
|
||||
elif key == "class":
|
||||
value = value.is_a()
|
||||
elif key == "predefined_type":
|
||||
value = ifcopenshell.util.element.get_predefined_type(value)
|
||||
elif key == "id":
|
||||
value = value.id()
|
||||
elif key == "classification":
|
||||
value = ifcopenshell.util.classification.get_references(value)
|
||||
elif key in ("x", "y", "z", "easting", "northing", "elevation") and hasattr(value, "ObjectPlacement"):
|
||||
if getattr(value, "ObjectPlacement", None):
|
||||
matrix = ifcopenshell.util.placement.get_local_placement(value.ObjectPlacement)
|
||||
xyz = matrix[:, 3][:3]
|
||||
if key in ("x", "y", "z"):
|
||||
value = xyz["xyz".index(key)]
|
||||
else:
|
||||
enh = ifcopenshell.util.geolocation.auto_xyz2enh(element.wrapped_data.file, *xyz)
|
||||
value = enh[("easting", "northing", "elevation").index(key)]
|
||||
else:
|
||||
value = None
|
||||
elif isinstance(value, ifcopenshell.entity_instance):
|
||||
if key == "Name" and value.is_a("IfcMaterialLayerSet"):
|
||||
key = "LayerSetName" # This oddity in the IFC spec is annoying so we account for it.
|
||||
|
||||
if isinstance(key, re.Pattern):
|
||||
attribute = None # Should we support regex attributes? Probably not for now.
|
||||
else:
|
||||
attribute = getattr(value, key, None)
|
||||
|
||||
if attribute is not None:
|
||||
value = attribute
|
||||
else:
|
||||
# Try to extract pset
|
||||
if isinstance(key, re.Pattern):
|
||||
psets = ifcopenshell.util.element.get_psets(value)
|
||||
matching_psets = []
|
||||
for pset_name, pset in psets.items():
|
||||
if key.match(pset_name):
|
||||
del pset["id"]
|
||||
matching_psets.append(pset)
|
||||
result = matching_psets or None
|
||||
if result and len(result) == 1:
|
||||
result = result[0]
|
||||
else:
|
||||
result = ifcopenshell.util.element.get_pset(value, key)
|
||||
if result:
|
||||
del result["id"]
|
||||
|
||||
value = result
|
||||
elif isinstance(value, dict): # Such as from the result of a prior get_pset
|
||||
if isinstance(key, re.Pattern):
|
||||
results = []
|
||||
for prop_name, prop_value in value.items():
|
||||
if key.match(prop_name):
|
||||
if isinstance(prop_value, (list, tuple)):
|
||||
results.extend(prop_value)
|
||||
else:
|
||||
results.append(prop_value)
|
||||
value = results or None
|
||||
if value and len(value) == 1:
|
||||
value = value[0]
|
||||
else:
|
||||
value = value.get(key, None)
|
||||
elif isinstance(value, (list, tuple, set)): # If we use regex
|
||||
if isinstance(key, str) and key.isnumeric():
|
||||
try:
|
||||
value = value[int(key)]
|
||||
except IndexError:
|
||||
return
|
||||
else:
|
||||
results = []
|
||||
for v in value:
|
||||
subvalue = _get_element_value(v, [key])
|
||||
if isinstance(subvalue, list):
|
||||
results.extend(subvalue)
|
||||
else:
|
||||
results.append(subvalue)
|
||||
value = results
|
||||
return value
|
||||
|
||||
|
||||
def filter_elements(
|
||||
@@ -840,368 +963,3 @@ class FacetTransformer(lark.Transformer):
|
||||
if comparison.startswith("!"):
|
||||
return not result
|
||||
return result
|
||||
|
||||
|
||||
class Selector:
|
||||
@classmethod
|
||||
def parse(
|
||||
cls, ifc_file: ifcopenshell.file, query: str, elements: Optional[list[ifcopenshell.entity_instance]] = None
|
||||
) -> list[ifcopenshell.entity_instance]:
|
||||
cls.file = ifc_file
|
||||
cls.elements = elements
|
||||
l = lark.Lark(
|
||||
"""start: query (lfunction query)*
|
||||
query: selector | group
|
||||
group: "(" query (lfunction query)* ")"
|
||||
selector: (inverse_relationship)? guid_selector | (inverse_relationship)? class_selector
|
||||
guid_selector: "#" /[0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_$]{22}/
|
||||
class_selector: "." WORD filter ?
|
||||
filter: "[" filter_key (comparison filter_value)? "]"
|
||||
filter_key: WORD | ESCAPED_STRING | keys_regex | keys_quoted | keys_simple
|
||||
filter_value: filter_regex | ESCAPED_STRING | SIGNED_FLOAT | SIGNED_INT | BOOLEAN | NULL
|
||||
filter_regex: "r" ESCAPED_STRING
|
||||
keys_regex: "r" ESCAPED_STRING ("." ESCAPED_STRING)*
|
||||
keys_quoted: ESCAPED_STRING ("." ESCAPED_STRING)*
|
||||
keys_simple: /[^\\W][^.=<>!%*\\]]*/ ("." /[^\\W][^.=<>!%*\\]]*/)*
|
||||
lfunction: and | or
|
||||
inverse_relationship: types | decomposed_by | bounded_by | grouped_by
|
||||
types: "*"
|
||||
decomposed_by: "@"
|
||||
bounded_by: "@@"
|
||||
grouped_by: "@@@"
|
||||
and: "&"
|
||||
or: "|"
|
||||
not: "!"
|
||||
comparison: (not)* (oneof | contains | morethanequalto | lessthanequalto | equal | morethan | lessthan)
|
||||
oneof: "%="
|
||||
contains: "*="
|
||||
morethanequalto: ">="
|
||||
lessthanequalto: "<="
|
||||
equal: "="
|
||||
morethan: ">"
|
||||
lessthan: "<"
|
||||
BOOLEAN: "TRUE" | "FALSE" | "true" | "false"| "True" | "False"
|
||||
NULL: "NULL"
|
||||
|
||||
// Embed common.lark for packaging
|
||||
DIGIT: "0".."9"
|
||||
HEXDIGIT: "a".."f"|"A".."F"|DIGIT
|
||||
INT: DIGIT+
|
||||
SIGNED_INT: ["+"|"-"] INT
|
||||
DECIMAL: INT "." INT? | "." INT
|
||||
_EXP: ("e"|"E") SIGNED_INT
|
||||
FLOAT: INT _EXP | DECIMAL _EXP?
|
||||
SIGNED_FLOAT: ["+"|"-"] FLOAT
|
||||
NUMBER: FLOAT | INT
|
||||
SIGNED_NUMBER: ["+"|"-"] NUMBER
|
||||
_STRING_INNER: /.*?/
|
||||
_STRING_ESC_INNER: _STRING_INNER /(?<!\\\\)(\\\\\\\\)*?/
|
||||
ESCAPED_STRING : "\\"" _STRING_ESC_INNER "\\""
|
||||
LCASE_LETTER: "a".."z"
|
||||
UCASE_LETTER: "A".."Z"
|
||||
LETTER: UCASE_LETTER | LCASE_LETTER
|
||||
WORD: LETTER+
|
||||
CNAME: ("_"|LETTER) ("_"|LETTER|DIGIT)*
|
||||
WS_INLINE: (" "|/\\t/)+
|
||||
WS: /[ \\t\\f\\r\\n]/+
|
||||
CR : /\\r/
|
||||
LF : /\\n/
|
||||
NEWLINE: (CR? LF)+
|
||||
|
||||
%ignore WS // Disregard spaces in text
|
||||
"""
|
||||
)
|
||||
|
||||
start = l.parse(query)
|
||||
return cls.get_group(start)
|
||||
|
||||
@classmethod
|
||||
def get_group(cls, group):
|
||||
lfunction = None
|
||||
for child in group.children:
|
||||
if child.data == "query":
|
||||
new_results = cls.get_query(child)
|
||||
if not lfunction:
|
||||
results = new_results
|
||||
elif lfunction == "or":
|
||||
results.extend(new_results)
|
||||
elif lfunction == "and":
|
||||
results = list(set(results).intersection(new_results))
|
||||
results = list(set(results))
|
||||
elif child.data == "lfunction":
|
||||
lfunction = child.children[0].data
|
||||
return results
|
||||
|
||||
@classmethod
|
||||
def get_query(cls, query):
|
||||
for child in query.children:
|
||||
if child.data == "selector":
|
||||
return cls.get_selector(child)
|
||||
elif child.data == "group":
|
||||
return cls.get_group(child)
|
||||
|
||||
@classmethod
|
||||
def get_selector(cls, selector):
|
||||
if len(selector.children) == 1:
|
||||
inverse_relationship = None
|
||||
class_or_guid_selector = selector.children[0]
|
||||
else:
|
||||
inverse_relationship = selector.children[0]
|
||||
class_or_guid_selector = selector.children[1]
|
||||
|
||||
if class_or_guid_selector.data == "class_selector":
|
||||
results = cls.get_class_selector(class_or_guid_selector)
|
||||
elif class_or_guid_selector.data == "guid_selector":
|
||||
results = cls.get_guid_selector(class_or_guid_selector)
|
||||
|
||||
if not inverse_relationship:
|
||||
return results
|
||||
return cls.parse_inverse_relationship(results, inverse_relationship.children[0].data)
|
||||
|
||||
@classmethod
|
||||
def parse_inverse_relationship(cls, elements, inverse_relationship):
|
||||
results = []
|
||||
for element in elements:
|
||||
if inverse_relationship == "types":
|
||||
if hasattr(element, "Types") and element.Types:
|
||||
results.extend(element.Types[0].RelatedObjects)
|
||||
elif hasattr(element, "ObjectTypeOf") and element.ObjectTypeOf:
|
||||
results.extend(element.ObjectTypeOf[0].RelatedObjects)
|
||||
elif inverse_relationship == "decomposed_by":
|
||||
results.extend(ifcopenshell.util.element.get_decomposition(element))
|
||||
elif inverse_relationship == "grouped_by":
|
||||
results.extend(ifcopenshell.util.element.get_grouped_by(element))
|
||||
elif inverse_relationship == "bounded_by" and hasattr(element, "BoundedBy"):
|
||||
for relationship in element.BoundedBy:
|
||||
results.append(relationship.RelatedBuildingElement)
|
||||
return results
|
||||
|
||||
@classmethod
|
||||
def get_class_selector(cls, class_selector):
|
||||
if class_selector.children[0] == "COBie":
|
||||
elements = ifcopenshell.util.fm.get_cobie_components(cls.file)
|
||||
elif class_selector.children[0] == "COBieType":
|
||||
elements = ifcopenshell.util.fm.get_cobie_types(cls.file)
|
||||
elif class_selector.children[0] == "FMHEM":
|
||||
elements = ifcopenshell.util.fm.get_fmhem_types(cls.file)
|
||||
else:
|
||||
if cls.elements is None:
|
||||
elements = cls.file.by_type(class_selector.children[0])
|
||||
else:
|
||||
elements = [e for e in cls.elements if e.is_a(class_selector.children[0])]
|
||||
if len(class_selector.children) > 1 and class_selector.children[1].data == "filter":
|
||||
return cls.filter_elements(elements, class_selector.children[1])
|
||||
return elements
|
||||
|
||||
@classmethod
|
||||
def filter_elements(cls, elements, filter_rule):
|
||||
results = []
|
||||
filter_query = cls.parse_filter_query(filter_rule.children[0].children[0])
|
||||
comparison = value = None
|
||||
if len(filter_rule.children) > 1:
|
||||
comparison = filter_rule.children[1].children[0].data
|
||||
if comparison == "not":
|
||||
comparison += filter_rule.children[1].children[1].data
|
||||
filter_value = filter_rule.children[2].children[0]
|
||||
if isinstance(filter_value, lark.Tree):
|
||||
is_regex = True
|
||||
token_type = filter_value.data
|
||||
else:
|
||||
is_regex = False
|
||||
token_type = filter_value.type
|
||||
if token_type == "filter_regex":
|
||||
value = str(filter_value.children[0][1:-1])
|
||||
elif token_type == "ESCAPED_STRING":
|
||||
value = str(filter_value[1:-1])
|
||||
elif token_type == "SIGNED_INT":
|
||||
value = int(filter_value)
|
||||
elif token_type == "SIGNED_FLOAT":
|
||||
value = float(filter_value)
|
||||
elif token_type == "BOOLEAN":
|
||||
value = filter_value.lower() == "true"
|
||||
elif token_type == "NULL":
|
||||
value = None
|
||||
for element in elements:
|
||||
if filter_query["is_regex"]:
|
||||
filter_query["keys"] = [re.compile(k) for k in filter_query["keys"]]
|
||||
element_value = cls.get_element_value(element, filter_query["keys"])
|
||||
if element_value is None and value is not None and "not" not in comparison:
|
||||
continue
|
||||
if comparison and cls.filter_element(element, element_value, comparison, value, is_regex=is_regex):
|
||||
results.append(element)
|
||||
elif not comparison and element_value:
|
||||
results.append(element)
|
||||
return results
|
||||
|
||||
@classmethod
|
||||
def parse_filter_query(cls, filter_query):
|
||||
keys = filter_query
|
||||
is_regex = False
|
||||
if isinstance(keys, str):
|
||||
keys = [keys]
|
||||
elif keys.data == "keys_regex":
|
||||
is_regex = True
|
||||
keys = [k[1:-1].replace('\\"', '"') for k in keys.children]
|
||||
elif keys.data == "keys_quoted":
|
||||
keys = [k[1:-1].replace('\\"', '"') for k in keys.children]
|
||||
elif keys.data == "keys_simple":
|
||||
keys = keys.children
|
||||
return {"keys": keys, "is_regex": is_regex}
|
||||
|
||||
@classmethod
|
||||
def get_element_value(cls, element: ifcopenshell.entity_instance, keys: list[str]) -> Any:
|
||||
value = element
|
||||
for key in keys:
|
||||
if value is None:
|
||||
return
|
||||
if key == "type":
|
||||
value = ifcopenshell.util.element.get_type(value)
|
||||
elif key in ("material", "mat"):
|
||||
value = ifcopenshell.util.element.get_material(value, should_skip_usage=True)
|
||||
elif key in ("materials", "mats"):
|
||||
value = ifcopenshell.util.element.get_materials(value)
|
||||
elif key == "profiles":
|
||||
value = ifcopenshell.util.shape.get_profiles(value)
|
||||
elif key == "styles":
|
||||
value = ifcopenshell.util.element.get_styles(value)
|
||||
elif key in ("item", "i"):
|
||||
if value.is_a("IfcMaterialLayerSet"):
|
||||
value = value.MaterialLayers
|
||||
elif value.is_a("IfcMaterialProfileSet"):
|
||||
value = value.MaterialProfiles
|
||||
elif value.is_a("IfcMaterialConstituentSet"):
|
||||
value = value.MaterialConstituents
|
||||
elif key == "container":
|
||||
value = ifcopenshell.util.element.get_container(value)
|
||||
elif key == "space":
|
||||
value = ifcopenshell.util.element.get_container(value, ifc_class="IfcSpace")
|
||||
elif key == "storey":
|
||||
value = ifcopenshell.util.element.get_container(value, ifc_class="IfcBuildingStorey")
|
||||
elif key == "building":
|
||||
value = ifcopenshell.util.element.get_container(value, ifc_class="IfcBuilding")
|
||||
elif key == "site":
|
||||
value = ifcopenshell.util.element.get_container(value, ifc_class="IfcSite")
|
||||
elif key == "parent":
|
||||
value = ifcopenshell.util.element.get_parent(value)
|
||||
elif key in ("types", "occurrences"):
|
||||
value = ifcopenshell.util.element.get_types(value)
|
||||
elif key == "count":
|
||||
if isinstance(value, set):
|
||||
value = len(list(value))
|
||||
elif isinstance(value, (list, tuple)):
|
||||
value = len(value)
|
||||
else:
|
||||
value = 1
|
||||
elif key == "class":
|
||||
value = value.is_a()
|
||||
elif key == "predefined_type":
|
||||
value = ifcopenshell.util.element.get_predefined_type(value)
|
||||
elif key == "id":
|
||||
value = value.id()
|
||||
elif key == "classification":
|
||||
value = ifcopenshell.util.classification.get_references(value)
|
||||
elif key in ("x", "y", "z", "easting", "northing", "elevation") and hasattr(value, "ObjectPlacement"):
|
||||
if getattr(value, "ObjectPlacement", None):
|
||||
matrix = ifcopenshell.util.placement.get_local_placement(value.ObjectPlacement)
|
||||
xyz = matrix[:, 3][:3]
|
||||
if key in ("x", "y", "z"):
|
||||
value = xyz["xyz".index(key)]
|
||||
else:
|
||||
enh = ifcopenshell.util.geolocation.auto_xyz2enh(element.wrapped_data.file, *xyz)
|
||||
value = enh[("easting", "northing", "elevation").index(key)]
|
||||
else:
|
||||
value = None
|
||||
elif isinstance(value, ifcopenshell.entity_instance):
|
||||
if key == "Name" and value.is_a("IfcMaterialLayerSet"):
|
||||
key = "LayerSetName" # This oddity in the IFC spec is annoying so we account for it.
|
||||
|
||||
if isinstance(key, re.Pattern):
|
||||
attribute = None # Should we support regex attributes? Probably not for now.
|
||||
else:
|
||||
attribute = getattr(value, key, None)
|
||||
|
||||
if attribute is not None:
|
||||
value = attribute
|
||||
else:
|
||||
# Try to extract pset
|
||||
if isinstance(key, re.Pattern):
|
||||
psets = ifcopenshell.util.element.get_psets(value)
|
||||
matching_psets = []
|
||||
for pset_name, pset in psets.items():
|
||||
if key.match(pset_name):
|
||||
del pset["id"]
|
||||
matching_psets.append(pset)
|
||||
result = matching_psets or None
|
||||
if result and len(result) == 1:
|
||||
result = result[0]
|
||||
else:
|
||||
result = ifcopenshell.util.element.get_pset(value, key)
|
||||
if result:
|
||||
del result["id"]
|
||||
|
||||
value = result
|
||||
elif isinstance(value, dict): # Such as from the result of a prior get_pset
|
||||
if isinstance(key, re.Pattern):
|
||||
results = []
|
||||
for prop_name, prop_value in value.items():
|
||||
if key.match(prop_name):
|
||||
if isinstance(prop_value, (list, tuple)):
|
||||
results.extend(prop_value)
|
||||
else:
|
||||
results.append(prop_value)
|
||||
value = results or None
|
||||
if value and len(value) == 1:
|
||||
value = value[0]
|
||||
else:
|
||||
value = value.get(key, None)
|
||||
elif isinstance(value, (list, tuple, set)): # If we use regex
|
||||
if isinstance(key, str) and key.isnumeric():
|
||||
try:
|
||||
value = value[int(key)]
|
||||
except IndexError:
|
||||
return
|
||||
else:
|
||||
results = []
|
||||
for v in value:
|
||||
subvalue = cls.get_element_value(v, [key])
|
||||
if isinstance(subvalue, list):
|
||||
results.extend(subvalue)
|
||||
else:
|
||||
results.append(subvalue)
|
||||
value = results
|
||||
return value
|
||||
|
||||
@classmethod
|
||||
def filter_element(cls, element, element_value, comparison, value, is_regex=False):
|
||||
if comparison.startswith("not"):
|
||||
return not cls.filter_element(element, element_value, comparison[3:], value, is_regex=is_regex)
|
||||
elif comparison == "equal" and isinstance(element_value, list):
|
||||
if is_regex:
|
||||
for element_v in element_value:
|
||||
if re.match(value, element_v):
|
||||
return True
|
||||
return False
|
||||
return value in element_value
|
||||
elif comparison == "equal":
|
||||
if is_regex:
|
||||
return bool(re.match(value, element_value))
|
||||
return element_value == value
|
||||
elif comparison == "contains" and isinstance(element_value, list):
|
||||
return bool([ev for ev in element_value if value in str(ev)])
|
||||
elif comparison == "contains":
|
||||
return value in str(element_value)
|
||||
elif comparison == "morethan":
|
||||
return element_value > value
|
||||
elif comparison == "lessthan":
|
||||
return element_value < value
|
||||
elif comparison == "morethanequalto":
|
||||
return element_value >= value
|
||||
elif comparison == "lessthanequalto":
|
||||
return element_value <= value
|
||||
elif comparison == "oneof":
|
||||
return element_value in value.split(",")
|
||||
return False
|
||||
|
||||
@classmethod
|
||||
def get_guid_selector(cls, guid_selector):
|
||||
return [cls.file.by_id(guid_selector.children[0])]
|
||||
|
||||
Reference in New Issue
Block a user