setup_helper.py

# This code is part of KQCircuits
# Copyright (C) 2022 IQM Finland Oy
#
# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program 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 this program. If not, see
# https://www.gnu.org/licenses/gpl-3.0.html.
#
# The software distribution should follow IQM trademark policy for open-source software
# (meetiqm.com/iqm-open-source-trademark-policy). IQM welcomes contributions to the code.
# Please see our contribution agreements for individuals (meetiqm.com/iqm-individual-contributor-license-agreement)
# and organizations (meetiqm.com/iqm-organization-contributor-license-agreement).

import os
import platform
import subprocess
from shutil import which


# Retuns KLayout's configuration directory already associated with `root_path`.
# If it is not found then creates and returns the right directory to use.
# If the default .klayout is used by an other KQC then use .klayout_alt/This_KQC
def klayout_configdir(root_path, configdir=""):
    if not configdir:
        if os.name == "nt":
            config_dir_name = "KLayout"
        elif os.name == "posix":
            config_dir_name = ".klayout"
        else:
            raise SystemError("Error: unsupported operating system")
        configdir = os.path.join(os.path.expanduser("~"), config_dir_name)

    # Directories may not exist, create them, if needed.
    if not os.path.exists(f"{configdir}/drc"):
        os.makedirs(f"{configdir}/drc")
    klayout_python_path = f"{configdir}/python"
    if not os.path.exists(klayout_python_path):
        os.makedirs(klayout_python_path)
        return configdir

    kqc_link = os.path.realpath(f"{klayout_python_path}/kqcircuits")
    kqc_target = f"{root_path}/klayout_package/python/kqcircuits"

    if not os.path.exists(kqc_link) or os.path.samefile(kqc_link, kqc_target):  # found it
        return configdir
    elif not configdir.endswith("_alt"):  # look for alternative location, like ".klayout_alt/my_2nd_kqc_dir"
        dir_name = os.path.split(root_path)[1]
        return klayout_configdir(root_path, f"{configdir}_alt/{dir_name}")
    else:  # Several alternatives with identical name. Discourage and overwrite.
        print(f"Warning: {configdir} already used! Reconfiguring for this source directory.")
        return configdir


# This function createst KLayout symlinks. Used by setup_within_klayout.py.
def setup_symlinks(root_path, configdir, link_map, unlink=False):
    for target, name in link_map:
        if target is not None:
            link_target = os.path.join(root_path, target)
        else:
            link_target = "Unknown"

        link_name = os.path.join(configdir, name)
        if os.path.lexists(link_name):
            os.unlink(link_name)
            if unlink:
                print(f'Removed symlink "{link_name}" to "{link_target}"')
        elif unlink:
            print(
                f'You set `unlink=True`, but symlink "{link_name}" to "{link_target}" does not exist... This is doing nothing.'
            )

        if not unlink:
            if os.name == "nt":
                # On Windows, create a Junction to avoid requiring Administrative privileges
                subprocess.check_call(
                    ["cmd", "/c", "mklink", "/J", os.path.normpath(link_name), os.path.normpath(link_target)]
                )
            else:
                os.symlink(link_target, link_name, target_is_directory=True)
            print(f'Created symlink "{link_name}" to "{link_target}"')


# Returns the python version, expected platform and site-packages path of KLayout's python distribution.
# A small script is run by KLayout in batch mode, and the output is read from external file.
def get_klayout_python_info():
    if platform.system() == "Windows":
        klayout_path = which("klayout_app.exe")
        if klayout_path is None:  # try the default location
            dwp = os.path.join(os.getenv("APPDATA"), "KLayout", "klayout_app.exe")
            if os.path.exists(dwp):
                klayout_path = str(dwp)
    else:
        klayout_path = which("klayout")  # Linux is simple :)
        if klayout_path is None and platform.system() == "Darwin":
            dwp = "/Applications/klayout.app/Contents/MacOS/klayout"
            if os.path.exists(dwp):
                klayout_path = dwp
            dwp = "/Applications/KLayout/klayout.app/Contents/MacOS/klayout"
            if os.path.exists(dwp):
                klayout_path = dwp
    if not klayout_path:
        raise Exception("Can't find klayout executable command!")
    if os.path.exists(".klayout-python.info"):
        os.remove(".klayout-python.info")
    subprocess.check_call([klayout_path, "-b", "-r", os.path.join("util", "get_klayout_python_info.py")])
    while not os.path.exists(".klayout-python.info"):
        continue
    klayout_py_version, klayout_py_platforms, klayout_site_packages = None, [], None
    for _ in range(10):
        with open(".klayout-python.info", encoding="utf-8") as f:
            for line in f:
                if line.startswith("KLayout python platform: "):
                    klayout_py_platforms.append(line.split("KLayout python platform: ")[1].strip())
                elif line.startswith("KLayout python version: "):
                    klayout_py_version = line.split("KLayout python version: ")[1].strip()
                elif line.startswith("KLayout site-packages: "):
                    klayout_site_packages = line.split("KLayout site-packages: ")[1].strip()
        if klayout_py_platforms and klayout_py_version and klayout_site_packages:
            break
    if os.path.exists(".klayout-python.info"):
        os.remove(".klayout-python.info")
    if not (klayout_py_platforms and klayout_py_version and klayout_site_packages):
        raise Exception("Couldn't get KLayout python's info")
    return klayout_py_version, klayout_py_platforms, klayout_site_packages