spiff-arena/spiffworkflow-backend/bin/codemod/update_file_to_remove_function.py

"""This is used by bin/codemod/remove_all_unused_functions to remove a function from a file."""

from bowler import Query

# This came about because vulture (actually dead, from the list of Similar programs at https://pypi.org/project/vulture/)
# actually found unused stuff, and I wanted to remove it.
# See also https://github.com/craigds/decrapify


def remove_function(filename: str, function_name: str) -> None:
    """Does the dirty work of actually removing the function from the file in place, or failing if it cannot."""

    def remove_statement(node, capture, filename):
        node.remove()

    bowler_query = (
        Query(filename)
        .select_function(function_name)
        .modify(remove_statement)
        .execute(write=True, silent=True, interactive=False)
    )

    if len(bowler_query.exceptions) > 0:
        print(f"Failed to remove function {function_name} from {filename}.")
        raise Exception(bowler_query.exceptions[0])

    print(f"Function {function_name} successfully removed from {filename}.")


if __name__ == "__main__":
    import argparse

    parser = argparse.ArgumentParser(description="Remove a function from a Python file while preserving comments.")
    parser.add_argument("filename", help="the file to modify")
    parser.add_argument("function_name", help="the name of the function to remove")
    args = parser.parse_args()

    remove_function(args.filename, args.function_name)