Function execute

src/ifcpatch/ifcpatch/__init__.py:68–127

Execute a patch recipe The details of how the patch recipe is executed depends on the definition of the recipe, as well as the arguments passed to the recipe. See the documentation for each patch recipe separately to understand more. :param args: A dictionary of arguments, correspo

(args: ArgumentsDict)

def execute(args: ArgumentsDict) -> Union[ifcopenshell.file, str, None]:
    """Execute a patch recipe

    The details of how the patch recipe is executed depends on the definition of
    the recipe, as well as the arguments passed to the recipe. See the
    documentation for each patch recipe separately to understand more.

    :param args: A dictionary of arguments, corresponding to the parameters
        listed subsequent to this in this docstring.
    :type args: ArgumentsDict
    :param file: An IFC model to apply the patch recipe to.
        Required for most recipes except the ones that require `input`.
    :type file: ifcopenshell.file, optional
    :param input: A filepath to the incoming IFC file.
        Required/supported only for some recipes, see specific recipes descriptions,
        in other cases will be ignored.
    :type input: str, optional
    :param recipe: The name of the recipe. This is the same as the filename of
        the recipe. E.g. "ExtractElements".
    :type recipe: str
    :param log: A filepath to a logfile.
    :type log: str,optional
    :param arguments: A list of zero or more positional arguments, depending on
        the patch recipe. Some patch recipes will require you to specify
        arguments, some won't.
    :type arguments: list
    :return: The result of the patch. This is typically a patched model, either
        as an object or as a string.

    Example:

    .. code:: python

        output = ifcpatch.execute({
            "input": "input.ifc",
            "file": ifcopenshell.open("input.ifc"),
            "recipe": "ExtractElements",
            "arguments": [".IfcWall"],
        })
        ifcpatch.write(output, "output.ifc")
    """
    if "log" in args:
        logging.basicConfig(filename=args["log"], filemode="a", level=logging.DEBUG)
    logger = ensure_logger()
    if recipe_dir := os.environ.get("IFCPATCH_RECIPE_DIR"):
        spec = importlib.util.spec_from_file_location(args["recipe"], os.path.join(recipe_dir, args["recipe"] + ".py"))
        recipe = importlib.util.module_from_spec(spec)
        sys.modules[args["recipe"]] = recipe
        spec.loader.exec_module(recipe)
    else:
        recipe = importlib.import_module(f"ifcpatch.recipes.{args['recipe']}")

    arguments = args.get("arguments", None) or []
    if recipe.Patcher.__init__.__doc__ is not None:
        patcher = recipe.Patcher(args.get("file"), logger, *arguments)
    else:
        patcher = recipe.Patcher(args.get("file"), logger, arguments)
    patcher.patch()