IfcOpenShell/src/ifcopenshell-python/ifcopenshell/api/profile/remove_profile.py

# 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.util.element


def remove_profile(file, profile=None) -> None:
    """Removes a profile

    :param profile: The IfcProfileDef to remove.
    :type profile: ifcopenshell.entity_instance
    :return: None
    :rtype: None

    Example:

    .. code:: python

        circle = ifcopenshell.api.run("profile.add_parameterized_profile", model,
            ifc_class="IfcCircleProfileDef")
        circle = 1.
        ifcopenshell.api.run("profile.remove_profile", model, profile=circle)
    """
    settings = {"profile": profile}

    subelements = set()
    for attribute in settings["profile"]:
        if isinstance(attribute, ifcopenshell.entity_instance):
            subelements.add(attribute)
    file.remove(settings["profile"])
    for subelement in subelements:
        ifcopenshell.util.element.remove_deep2(file, subelement)