# 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


def remove_address(file: ifcopenshell.file, address: ifcopenshell.entity_instance) -> None:
    """Removes an address

    Naturally, any organisations or people using that address will have the
    relationship removed.

    :param address: The IfcAddress to remove.
    :type address: ifcopenshell.entity_instance
    :return: None
    :rtype: None

    Example:

    .. code:: python

        organisation = ifcopenshell.api.owner.add_organisation(model)
        address = ifcopenshell.api.owner.add_address(model,
            assigned_object=organisation, ifc_class="IfcPostalAddress")

        # Change our mind and delete it
        ifcopenshell.api.owner.remove_address(model, address=address)
    """
    settings = {"address": address}

    for inverse in file.get_inverse(settings["address"]):
        if inverse.is_a() in ("IfcOrganization", "IfcPerson"):
            if inverse.Addresses == (settings["address"],):
                inverse.Addresses = None
    file.remove(settings["address"])