tasks.py

# type:ignore
# flake8: noqa
import os
import pathlib
import sys

import yaml
from invoke import task


def try_import():
    try:
        import iio

        print("---IIO version found:", iio.version)
        return True
    except ImportError:
        return False


def add_libiio(do_prints=False, add_to_path=False):
    not_installed = False
    if not try_import():
        # Maybe its not on path
        if not os.name == "nt":
            # Try to add the correct directory to path
            for p in ["/usr/local", "/usr"]:
                for v in range(2, 4):
                    for k in range(1, 9):
                        temp = p + "/lib/python{}.{}/site-packages".format(v, k)
                        if os.path.isdir(temp):
                            sys.path.append(temp)
                            if not try_import():
                                not_installed = True
                            else:
                                if do_prints:
                                    print(
                                        "---libiio found in directory %s ---" % (temp)
                                    )
                                    print(
                                        "---Add to path with: export PYTHONPATH=$PYTHONPATH:%s"
                                        % (temp)
                                    )
                                # if add_to_path:
                                #     os.environ["PYTHONPATH"] = sys.path
                                return False
                            break
        else:
            if do_prints:
                print("Automatic module search only works on Linux right now")
            not_installed = True
            return False
        if not_installed:
            if do_prints:
                print("---libiio not found---")
            return False
    else:
        if do_prints:
            print("---libiio is already on path---")
        return True


@task
def libiiopath(c):
    """Search for libiio python bindings"""
    add_libiio(do_prints=True)


@task
def setup(c):
    """Install required python packages for development through pip"""
    c.run("pip3 install -r requirements.txt")
    c.run("pip3 install -r requirements_dev.txt")
    c.run("pip3 install -r requirements_doc.txt")
    print("---Python packages all setup (be sure to verify libiio is installed)")


@task
def builddoc(c):
    """Build sphinx doc"""
    c.run("sphinx-build doc/source doc/build")


@task(builddoc)
def build(c, docs=False):
    """Build python package"""
    c.run("python setup.py build")


@task(
    help={
        "message": "Custom message for tag. Defaults to `Beta release vXX`, where XX is auto determined",
        "inc": "Revision class increment position. major=X.2.3, minor==1.X.3, rev==1.2.X. Defaults to rev",
    }
)
def createrelease(c, message=None, inc="rev"):
    """Create GitHub release

    The following is performed:
    1. Test are run to check passing
    2. Tag is created
    3. __version__ file is updated with bumped version
    4. Commit is created for updated __version__ file

    Note that nothing is pushed!
    """
    # Check all tests are passing
    import pytest

    e = pytest.main(["-q"])
    if e:
        raise Exception("Some tests are failing, cannot create release")

    # Create tag from version
    import adi

    v = adi.__version__
    if not message:
        message = "Beta release v{}".format(v)
    cmd = 'git tag -a v{} -m "{}"'.format(v, message)
    print("Creating tagged commit")
    c.run(cmd)

    # Bump version and create commit
    import fileinput

    for line in fileinput.input("adi/__init__.py", inplace=True, backup=".bkp"):
        if line.find("__version__") > -1:
            l = line[len("__version__ = ") + 1 :].strip()[:-1].split(".")
            if inc == "major":
                major = int(l[0]) + 1
                minor = 0
                rev = 0
            elif inc == "minor":
                major = int(l[0])
                minor = int(l[1]) + 1
                rev = 0
            else:
                major = int(l[0])
                minor = int(l[1])
                rev = int(l[2]) + 1
            line = '__version__ = "{}.{}.{}"\n'.format(major, minor, rev)
            ver_string = "v{}.{}.{}".format(major, minor, rev)
        print(line, end="")
    c.run("git add adi/__init__.py")
    c.run('git commit -s -m "Bump to version {}"'.format(ver_string))


@task
def test(c):
    """Run pytest tests"""
    if not add_libiio(do_prints=True):
        print("---libiio not on path. Need to add first before testing")
    else:
        c.run("python3 -m pytest -v")


@task
def checkparts(c):
    """Check for missing parts in supported_parts.md"""
    print("Running supported_parts check")
    mod = __import__("adi")
    parts = []
    ignored_parts = [
        "ad9361",
        "ad9363",
        "ad9364",
        "ad9371",
        "ad9375",
        "ad937x",
        "adrv9009_zu11eg",
        "adrv9009_zu11eg_multi",
        "adrv9009_zu11eg_fmcomms8",
        "adar1000_array",
        "ad9081_mc",
        "ad9084_mc",
        "ad717x",
        "ad916x",
        "ad719x",
        "ad469x",
        "ad777x",
        "ad579x",
        "adaq42xx",
    ]
    for c in dir(mod):
        if (
            any(c.lower().startswith(pre) for pre in ("ad", "hmc", "lt", "cn", "max"))
            and not c in ignored_parts
        ):
            parts.append(c)
    # Check if in README
    count = 1
    with open("supported_parts.md") as reader:
        rm = reader.read()
        s = rm.find("### Currently supported hardware")
        e = rm.find("### Dependencies")
        rm = rm[s:e]
        count = 0
        for p in parts:
            p = p.replace("_", "-")
            if not p.lower() in rm.lower():
                count += 1
                print("Missing", p, "from README")
        if count == 0:
            print("No parts missing from supported_parts.md")

    print("------------------------")
    sys.exit(count)


@task
def checkemulation(c):
    """Check for missing emulation contexts for devices"""
    print("Running emulation context check")
    mod = __import__("adi")
    parts = []
    ignored_parts = [
        "adrv9009_zu11eg",
        "adrv9009_zu11eg_multi",
        "adrv9009_zu11eg_fmcomms8",
        "adar1000_array",
        "ad9081_mc",
        "ad9084_mc",
        "ad717x",
        "ad916x",
        "ad719x",
        "ad469x",
        "ad777x",
        "ad4110",
        "ad4130",
        "ad4630",
        "ad5627",
        "ad5686",
        "ad5940",
        "ad7124",
        "ad7606",
        "ad7689",
        "ad7746",
        "ad7799",
        "ad9083",
        "ad9094",
        "ad9136",
        "ad9144",
        "ad9152",
        "ad9162",
        "ad9166",
        "ad9250",
        "ad936x",
        "ad937x",
        "ad9371",
        "ad9375",
        "ad9467",
        "ad9625",
        "ad9680",
        "ada4961",
        "adaq8092",
        "adar1000",
        "adf4159",
        "adf4355",
        "adf4371",
        "adf5610",
        "adg2128",
        "adis16460",
        "adis16475",
        "adis16495",
        "adis16507",
        "adl5240",
        "adl5960",
        "admv8818",
        "adpd1080",
        "adpd188",
        "adpd410x",
        "adrf5720",
        "adt7420",
        "adxl313",
        "adxl345",
        "adxrs290",
        "cn0532",
        "cn0566",
        "ltc2314_14",
        "ltc2499",
        "ltc2983",
        "max11205",
        "max31855",
    ]
    for c in dir(mod):
        if (
            any(c.lower().startswith(pre) for pre in ("ad", "hmc", "lt", "cn", "max"))
            and not c in ignored_parts
        ):
            parts.append(c)
    # read in yaml file
    path = pathlib.Path(__file__).parent.absolute()
    filename = os.path.join(path, "test", "emu", "hardware_map.yml")
    with open(filename, "r") as f:
        hw_map = yaml.safe_load(f)
    # Build list of all supported classes
    classes_wth_emu = []
    for k in hw_map.keys():
        for item in hw_map[k]:
            if isinstance(item, dict) and "pyadi_iio_class_support" in item.keys():
                classes_wth_emu += item["pyadi_iio_class_support"]

    count = 0
    for p in parts:
        if not p in classes_wth_emu:
            print("Missing", p, "from hardware_map.yml emulation context map")
            count += 1

    print("------------------------")
    if count:
        print("All classes must have an emulation context defined in hardware_map.yml")
        print(
            "Please see doc for more information: https://analogdevicesinc.github.io/pyadi-iio/dev/index.html#testing"
        )
    else:
        print("All classes have an emulation context defined in hardware_map.yml")
    sys.exit(count)


@task(checkparts)
def precommit(c):
    """Run precommit checks"""
    c.run("pre-commit run --all-files")


@task
def changelog(c, since=None):
    """Print changelog from last release"""
    if not since:
        r = c.run(f"git describe --abbrev=0 --tags", encoding="utf-8", hide=True)
        since = r.stdout.splitlines()[0]
    r = c.run(f"git log {since}..HEAD --format=%s", encoding="utf-8", hide=True)
    changes = r.stdout.splitlines()
    print(f"Changes since {since}:")
    for change in changes:
        print(f"- {change}")


@task
def bumpversion_test(c):
    """Bump version to {current-version}.dev.{date}
    Used for marking development releases for test-pypi
    """
    import fileinput
    import time

    for line in fileinput.input("adi/__init__.py", inplace=True):
        if line.find("__version__") > -1:
            l = line[len("__version__ = ") + 1 :].strip()[:-1].split(".")
            major = int(l[0])
            minor = int(l[1])
            rev = int(l[2])
            seconds = int(time.time())
            line = '__version__ = "{}.{}.{}.dev.{}"\n'.format(
                major, minor, rev, seconds
            )
            ver_string = "v{}.{}.{}.dev.{}".format(major, minor, rev, seconds)
        print(line, end="")

    print(f"Version bumped to {ver_string}")