Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-10 09:48:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

deprecate spatial.remove_container in favor of spatial.assign_container

Browse Source 
added temporary support for old version with warnings:

WARNING. `spatial.remove_container` api method is deprecated and should be replaced with spatial.unassign_container
WARNING. `product` argument is deprecated for API method "spatial.remove_container" and should be replaced with `products`.
This commit is contained in:
Andrej730
2024-04-09 16:06:21 +05:00
parent 24716a0089
commit d03f9237e2
7 changed files with 40 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ifcopenshell-python/ifcopenshell/api/__init__.py
+17 -4
View File
@@ -31,7 +31,12 @@ pre_listeners = {}
post_listeners = {}
def batching_argument_deprecation(usecase_path: str, settings: dict, prev_argument: str, new_argument: str) -> dict:
def batching_argument_deprecation(
usecase_path: str, settings: dict, prev_argument: str, new_argument: str, replace_usecase: Optional[str] = None
) -> tuple[str, dict]:
if replace_usecase is not None:
print(f"WARNING. `{usecase_path}` api method is deprecated and should be replaced with `{replace_usecase}`.")
if prev_argument in settings:
print(
f"WARNING. `{prev_argument}` argument is deprecated for API method "
@@ -39,7 +44,7 @@ def batching_argument_deprecation(usecase_path: str, settings: dict, prev_argume
)
settings = settings | {new_argument: [settings[prev_argument]]}
settings.pop(prev_argument)
return settings
return (replace_usecase or usecase_path, settings)
ARGUMENTS_DEPRECATION = {
@@ -51,9 +56,17 @@ ARGUMENTS_DEPRECATION = {
),
"group.unassign_group": partial(batching_argument_deprecation, prev_argument="product", new_argument="products"),
"aggregate.assign_object": partial(batching_argument_deprecation, prev_argument="product", new_argument="products"),
"aggregate.unassign_object": partial(batching_argument_deprecation, prev_argument="product", new_argument="products"),
"aggregate.unassign_object": partial(
batching_argument_deprecation, prev_argument="product", new_argument="products"
),
"layer.assign_layer": partial(batching_argument_deprecation, prev_argument="item", new_argument="items"),
"layer.unassign_layer": partial(batching_argument_deprecation, prev_argument="item", new_argument="items"),
"spatial.remove_container": partial(
batching_argument_deprecation,
prev_argument="product",
new_argument="products",
replace_usecase="spatial.unassign_container",
),
}
@@ -69,7 +82,7 @@ def run(
# see #4531
if usecase_path in ARGUMENTS_DEPRECATION:
settings = ARGUMENTS_DEPRECATION[usecase_path](usecase_path, settings)
usecase_path, settings = ARGUMENTS_DEPRECATION[usecase_path](usecase_path, settings)
# TODO: settings serialization for client-server systems
# def serialise_entity_instance(entity):
src/ifcopenshell-python/ifcopenshell/api/spatial/remove_container.py
-77
View File
@@ -1,77 +0,0 @@
# IfcOpenShell - IFC toolkit and geometry engine
# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
#
# This file is part of IfcOpenShell.
#
# IfcOpenShell is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# IfcOpenShell is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with IfcOpenShell. If not, see <http://www.gnu.org/licenses/>.
import ifcopenshell
import ifcopenshell.api
import ifcopenshell.util.element
class Usecase:
def __init__(self, file, product=None):
"""Unassigns a container from a product.
Caution: this API function may be replaced by spatial.unassign_container
:param product: The IfcProduct to remove the containment from.
:type product: ifcopenshell.entity_instance.entity_instance
:return: None
:rtype: None
Example:
.. code:: python
project = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcProject")
site = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSite")
building = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
storey = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuildingStorey")
# The project contains a site (note that project aggregation is a special case in IFC)
ifcopenshell.api.run("aggregate.assign_object", model, products=[site], relating_object=project)
# The site has a building, the building has a storey, and the storey has a space
ifcopenshell.api.run("aggregate.assign_object", model, products=[building], relating_object=site)
ifcopenshell.api.run("aggregate.assign_object", model, products=[storey], relating_object=building)
# Create a wall
wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
# The wall is in the storey
ifcopenshell.api.run("spatial.assign_container", model, products=[wall], relating_structure=storey)
# Not anymore!
ifcopenshell.api.run("spatial.remove_container", model, product=wall)
"""
self.file = file
self.settings = {"product": product}
def execute(self):
contained_in_structure = self.settings["product"].ContainedInStructure
if not contained_in_structure:
return
related_elements = list(contained_in_structure[0].RelatedElements)
related_elements.remove(self.settings["product"])
if related_elements:
contained_in_structure[0].RelatedElements = related_elements
ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": contained_in_structure[0]})
else:
history = contained_in_structure[0].OwnerHistory
self.file.remove(contained_in_structure[0])
if history:
ifcopenshell.util.element.remove_deep2(self.file, history)