Source code for ddrescue_gui.Tools.DDRescueTools.decorators

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# DDRescue Tools (decorators) in the Tools Package for DDRescue-GUI
# This file is part of DDRescue-GUI.
# Copyright (C) 2013-2023 Hamish McIntyre-Bhatty
# DDRescue-GUI is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 3 or,
# at your option, any later version.
#
# DDRescue-GUI 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with DDRescue-GUI.  If not, see <http://www.gnu.org/licenses/>.

"""
Decorators for DDRescue tools
"""

def define_versions(function):
    """
    Reads the function docstring to find the ddrescue versions the function
    supports. This is used on all of the tools in the modules in the
    DDRescueTools package.

    This information is saved in the function's SUPPORTEDVERSIONS attribute.

    Args:
        function.       The function object that we are creating the attribute
                        for.
    """

    function.SUPPORTEDVERSIONS = []

    for version in function.__doc__.split("Works with ddrescue versions: ")[1].split(","):
        function.SUPPORTEDVERSIONS.append(version.replace(" ", "").replace("\n", ""))

    return function