#!/usr/bin/env python3
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
# This file is part of qutebrowser.
#
# qutebrowser 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.
#
# qutebrowser 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 qutebrowser. If not, see <http://www.gnu.org/licenses/>.
"""Symlink PyQt into a given virtualenv."""
import os
import argparse
import shutil
import os.path
import sys
import glob
import subprocess
import platform
import filecmp
class Error(Exception):
"""Exception raised when linking fails."""
pass
def verbose_copy(src, dst, *, follow_symlinks=True):
"""Copy function for shutil.copytree which prints copied files."""
print('{} -> {}'.format(src, dst))
shutil.copy(src, dst, follow_symlinks=follow_symlinks)
def get_ignored_files(directory, files):
"""Get the files which should be ignored for link_pyqt() on Windows."""
needed_exts = ('.py', '.dll', '.pyd', '.so')
ignored_dirs = ('examples', 'qml', 'uic', 'doc')
filtered = []
for f in files:
ext = os.path.splitext(f)[1]
full_path = os.path.join(directory, f)
if os.path.isdir(full_path) and f in ignored_dirs:
filtered.append(f)
elif (ext not in needed_exts) and os.path.isfile(full_path):
filtered.append(f)
return filtered
def needs_update(source, dest):
"""Check if a file to be linked/copied needs to be updated."""
if os.path.islink(dest):
# No need to delete a link and relink -> skip this
return False
elif os.path.isdir(dest):
diffs = filecmp.dircmp(source, dest)
ignored = get_ignored_files(source, diffs.left_only)
has_new_files = set(ignored) != set(diffs.left_only)
return (has_new_files or diffs.right_only or
diffs.common_funny or diffs.diff_files or
diffs.funny_files)
else:
return not filecmp.cmp(source, dest)
def link_pyqt(sys_path, venv_path):
"""Symlink the systemwide PyQt/sip into the venv.
Args:
sys_path: The path to the system-wide site-packages.
venv_path: The path to the virtualenv site-packages.
"""
globbed_sip = (glob.glob(os.path.join(sys_path, 'sip*.so')) +
glob.glob(os.path.join(sys_path, 'sip*.pyd')))
if not globbed_sip:
raise Error("Did not find sip in {}!".format(sys_path))
files = [('PyQt5', True), ('sipconfig.py', False)]
files += [(os.path.basename(e), True) for e in globbed_sip]
for fn, required in files:
source = os.path.join(sys_path, fn)
dest = os.path.join(venv_path, fn)
if not os.path.exists(source):
if required:
raise FileNotFoundError(source)
else:
continue
if os.path.exists(dest):
if needs_update(source, dest):
remove(dest)
else:
continue
copy_or_link(source, dest)
def copy_or_link(source, dest):
"""Copy or symlink source to dest."""
if os.name == 'nt':
if os.path.isdir(source):
shutil.copytree(source, dest, ignore=get_ignored_files,
copy_function=verbose_copy)
else:
print('{} -> {}'.format(source, dest))
shutil.copy(source, dest)
else:
print('{} -> {}'.format(source, dest))
os.symlink(source, dest)
def remove(filename):
"""Remove a given filename, regardless of whether it's a file or dir."""
if os.path.isdir(filename):
shutil.rmtree(filename)
else:
os.unlink(filename)
def get_python_lib(executable, venv=False):
"""Get the python site-packages directory for the given executable.
Args:
venv: True if the path is inside a virtualenv, so our special
treatments for Windows/Ubuntu shouldn't take place.
"""
distribution = platform.linux_distribution(full_distribution_name=False)
if os.name == 'nt' and not venv:
# For some reason, we get an empty string from get_python_lib() on
# Windows when running via tox, and sys.prefix is empty too...
return os.path.join(os.path.dirname(executable), '..', 'Lib',
'site-packages')
elif distribution[0].lower() in ('debian', 'ubuntu') and not venv:
# For some reason, we get '/usr/lib/python3.4/site-packages' instead of
# '/usr/lib/python3/dist-packages' on debian with tox...
cmd = [executable, '-c', 'import sys\nprint(sys.prefix)']
prefix = subprocess.check_output(cmd, universal_newlines=True).rstrip()
return os.path.join(prefix, 'lib', 'python3', 'dist-packages')
else:
cmd = [executable, '-c',
'from distutils.sysconfig import get_python_lib\n'
'print(get_python_lib())']
return subprocess.check_output(cmd, universal_newlines=True).rstrip()
def get_tox_syspython(venv_path):
"""Get the system python based on a virtualenv created by tox."""
path = os.path.join(venv_path, '.tox-config1')
with open(path, encoding='ascii') as f:
line = f.readline()
_md5, sys_python = line.rstrip().split(' ')
return sys_python
def main():
"""Main entry point."""
parser = argparse.ArgumentParser()
parser.add_argument('path', help="Base path to the venv.")
parser.add_argument('--tox', help="Add when called via tox.",
action='store_true')
args = parser.parse_args()
if args.tox:
sys_path = get_python_lib(get_tox_syspython(args.path))
else:
sys_path = get_python_lib(sys.executable)
subdir = 'Scripts' if os.name == 'nt' else 'bin'
executable = os.path.join(args.path, subdir, 'python')
venv_path = get_python_lib(executable, venv=True)
link_pyqt(sys_path, venv_path)
if __name__ == '__main__':
try:
main()
except Error as e:
print(str(e), file=sys.stderr)
sys.exit(1)