IfcOpenShell/src/ifcopenshell-python/ifcopenshell/api/document/remove_reference.py

# IfcOpenShell - IFC toolkit and geometry engine
# Copyright (C) 2022 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_reference(file: ifcopenshell.file, reference: ifcopenshell.entity_instance) -> None:
    """Remove a document reference

    All associations with objects are removed.

    :param reference: The IfcDocumentReference to remove
    :type reference: ifcopenshell.entity_instance
    :return: None
    :rtype: None

    Example:

    .. code:: python

        document = ifcopenshell.api.run("document.add_information", model)
        reference = ifcopenshell.api.run("document.add_reference", model, information=document)
        ifcopenshell.api.run("document.remove_reference", model, reference=reference)
    """
    settings = {"reference": reference}

    for rel in settings["reference"].DocumentRefForObjects or []:
        history = rel.OwnerHistory
        file.remove(rel)
        if history:
            ifcopenshell.util.element.remove_deep2(file, history)
    file.remove(settings["reference"])