1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
|
# This file is part of MyPaint.
# Imports:
from __future__ import print_function
from contextlib import contextmanager
import subprocess
import glob
import os
import os.path
import pprint
import sys
import textwrap
import tempfile
import shutil
from setuptools.command.build import build
from setuptools import setup
from setuptools import Extension
from setuptools import Command
from setuptools.command.build_ext import build_ext
from setuptools.command.install import install
from setuptools.command.install_scripts import install_scripts
# Constants
# Some versions of clang requires different flag configurations than gcc
# to link correctly, so we enable configuration via environment variables.
OPENMP_CFLAG = os.getenv("OPENMP_CFLAG", "-fopenmp")
OPENMP_LDFLAG = os.getenv("OPENMP_LDFLAG", "-fopenmp")
# Libmypaint dependency
LIBMYPAINT = "libmypaint"
# Helper classes and routines:
def print_err(msg):
print(msg, file=sys.stderr)
def pkgconf():
"""Returns the name used to execute pkg-config
Uses the value of the PKG_CONFIG environment variable if it is set.
"""
return os.getenv("PKG_CONFIG", "pkg-config")
def pkgconfig_variable(package, variable_name):
try:
cmd = [pkgconf(), '--variable=%s' % variable_name, package]
return subprocess.check_output(cmd).decode().strip()
except subprocess.CalledProcessError as e:
print_err(e)
print_err('pkg-config could not find package %s' % package)
sys.exit(1)
def msgfmt():
"""Returns the name used to execute msgfmt
"""
return os.getenv("MSGFMT", "msgfmt")
class BuildTranslations (Command):
"""Builds binary message catalogs for installation.
This is declared as a subcommand of "build", but it can be invoked
in its own right. The generated message catalogs are later installed
as data files.
"""
@staticmethod
def all_locales():
return [f[:-3] for f in os.listdir("./po/") if f.endswith('.po')]
@staticmethod
def get_translation_paths(command, lang_codes=None):
"""Returns paths for building and installing message catalogs
The returned data is a tuple with two lists.
The first contains (source, destination) pairs for building
*.mo files from *.po files (relative paths).
The second contains (gen_mo_src_dir, [mo_target_path]) tuples
that are used by the 'install' command.
"""
lang_codes = lang_codes or BuildTranslations.all_locales()
tmpdir = command.get_finalized_command("build").build_temp
msg_path_pairs = []
data_path_pairs = []
for lang in lang_codes:
po_path = os.path.join("po", lang + ".po")
mo_dir = os.path.join("locale", lang, "LC_MESSAGES")
targ = os.path.join(tmpdir, mo_dir, "mypaint.mo")
msg_path_pairs.append((po_path, targ))
data_path_pairs.append((mo_dir, [targ]))
return (msg_path_pairs, data_path_pairs)
description = "build binary message catalogs (*.mo)"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
msg_paths = BuildTranslations.get_translation_paths(self)[0]
po_failures = []
for po_path, mo_path in msg_paths:
try:
self._compile_message_catalog(po_path, mo_path)
except subprocess.CalledProcessError as e:
# msgfmt creates the .mo file even if the checks fail.
# It is removed here so further tests aren't skipped
shutil.rmtree(os.path.dirname(mo_path))
if not isinstance(e.output, str):
e.output = e.output.decode('utf-8')
po_failures.append((po_path, e.output))
if po_failures:
paths, errors = map(list, zip(*po_failures))
errmsg = "There are format errors in the following .po files:"
print_err("=" * 80 + "\n" + errmsg + "\n" + "=" * 80)
print_err("\n".join(paths) + "\n")
print_err("\n".join(errors))
sys.exit(1)
tmp_dir = self.get_finalized_command("build").build_temp
# Try to create a symlink to the locale directory to enable
# use of translations when running from the source dir.
base, tmp = os.path.split(tmp_dir)
link_dest = os.path.join(base, "locale")
link_src = os.path.join(tmp, "locale")
try:
if os.path.exists(link_dest):
os.remove(link_dest)
os.symlink(link_src, link_dest)
except Exception:
msg = ("Could not make symlink: {symlink}\n"
"In order to get working translations when running "
"from the source directory, a corresponding link or "
"copy needs to be created.")
symlink = str(link_dest) + " --> " + str(link_src)
print_err(msg.format(symlink=symlink))
def _compile_message_catalog(self, po_file_path, mo_file_path):
needs_update = not (
os.path.exists(mo_file_path) and
os.stat(mo_file_path).st_mtime >=
os.stat(po_file_path).st_mtime
)
if needs_update:
cmd = (msgfmt(), "-c", po_file_path, "-o", mo_file_path)
if self.dry_run:
self.announce("would run %s" % (" ".join(cmd),), level=2)
else:
self.announce("running %s" % (" ".join(cmd),), level=2)
self.mkpath(os.path.dirname(mo_file_path))
subprocess.check_output(cmd, stderr=subprocess.STDOUT)
assert os.path.exists(mo_file_path)
class BuildConfig (Command):
"""Builds configuration file config.py.
This allows python files to know where to find data when it is
provided as a separate package, i.e. the brushes.
It also handles which translation files will be included
(all of them, for non-release builds)
It can also be used to set the directory where message catalogs
for the libmypaint translations should be found, if they don't
share the same prefix as the mypaint installation.
"""
description = "generate lib/config.py using fetched or provided values"
user_options = [
("brushdir-path=", None,
"use the provided argument as brush directory path"),
("libmypaint-locale-path-from-pkgconf", None,
"set the location of libmypaint's message catalogs using pkg-config"
"\n The path is set to {prefix}/share/locale, where \"prefix\" is"
" fetched from libmypaint's pkg-config data."),
("libmypaint-locale-path=", None,
"set the location of the libmypaint message catalogs\n"
" If ``--libmypaint-locale-path-from-pkgconf`` is set, using this"
" flag will raise an error. If neither flag is used, or the value"
" passed is the empty string, the directory used for mypaint's own"
" locale data is used for libmypaint's as well."),
("translation-threshold=", None,
"Limit translations to those with a completion percentage"
"at or above the given threshold. Argument range: [0..100]"),
]
LOCALE_CACHE = "locale_cache"
COMPLETION_THRESHOLD = 75
WARNING_TEMPLATE = (
"# == THIS FILE IS GENERATED ==\n"
"# DO NOT EDIT OR ADD TO VERSION CONTROL\n"
"# The structure is defined in {input}\n"
"# The generation is done by the {cmd} command in {script}\n"
"\n"
)
def initialize_options(self):
self.brushdir_path = None
self.libmypaint_locale_path_from_pkgconf = False
self.libmypaint_locale_path = None
self.translation_threshold = 0
def finalize_options(self):
if self.brushdir_path and self.brushdir_path.strip()[0] == '/':
print("WARNING: supplied brush directory path is not relative")
self.translation_threshold = int(self.translation_threshold)
assert(0 <= self.translation_threshold <= 100)
def run(self):
# Determine path to the brushes directory
brushdir = self.brushdir_path or BuildConfig.pkgconf_brushdir_path()
# Determine which locales are supported, based on existing po files
# and optionally their level of completeness (% of strings translated)
locales = self._get_locales()
# Pretty print sorted locales to individual lines in list
locstring = " " + pprint.pformat(sorted(locales), indent=4)[1:-1] + ","
conf_vars = {
'mypaint_brushdir': brushdir,
'libmypaint_version': LIBMYPAINT,
'libmypaint_locale_dir': self.get_libmypaint_locale_dir(),
'supported_locales': locstring,
}
self.instantiate_template('config.py.in', 'lib/config.py', conf_vars)
def get_libmypaint_locale_dir(self):
path = self.libmypaint_locale_path
use_pkgconf = self.libmypaint_locale_path_from_pkgconf
if path is not None and use_pkgconf:
print_err(
"At most one of the options for setting "
"libmypaint's locale path can be used!"
)
sys.exit(1)
if not use_pkgconf and not path:
return "None"
elif use_pkgconf:
path = pkgconfig_variable(LIBMYPAINT, "prefix")
path = os.path.join(path, 'share', 'locale')
return "'%s'" % path
@staticmethod
def translation_completion_func():
"""Get a function for calculating translation completeness
Tries to use polib if possible, but falls back to a shell script
that only uses existing dependencies if polib is not installed.
:return: Function calculating po translation completeness
"""
try:
import polib
def py_completion(path, template=False):
po = polib.pofile(path)
if template:
return len(po)
else:
return len(po.translated_entries())
return py_completion
except ImportError:
print("polib not installed, falling back to shellscript!")
def msgattrib_completion(path, template=False):
cmd = ['msgattrib']
if not template:
cmd.extend(['--translated', '--no-fuzzy', '--no-obsolete'])
cmd.append(path)
result = subprocess.check_output(cmd)
if not isinstance(result, str):
result = result.decode('utf-8')
return result.count('\nmsgstr')
return msgattrib_completion
def _get_locales(self):
"""Return a list of locales to use/install
If no limitation is set (default) all locales are based solely on
the existing *.po-files in the po directory. If limitation is enabled,
the list is filtered based on the percentage of strings translated
for each translation file.
:return: A list of locales
"""
locales = BuildTranslations.all_locales()
if not self.translation_threshold:
# No limit - just return all of them
return locales
# Get the completion percentage for translation files
# and cache the result to allow for partial updates
always_include = [
"en_CA",
"en_GB",
]
completion = BuildConfig.translation_completion_func()
template_path = os.path.join("po", "mypaint.pot")
total = float(completion(template_path, template=True))
# Read/update cache
with self._get_locale_data_cache() as cache:
for loc in locales:
# For static always-include locales, claim full translation,
# but set timestamp to 0 to force calculation if they are
# removed from the always-include list.
if loc in always_include:
cache[loc] = (total, 0)
continue
po_path = os.path.join("po", loc + ".po")
po_modified_time = os.stat(po_path).st_mtime
if loc not in cache or cache[loc][1] < po_modified_time:
print("Updating cache:", loc)
# Add some margin to mtime avoid rounding problems
cache[loc] = (completion(po_path), po_modified_time + 0.1)
threshold = self.translation_threshold / 100.0
return [l for l, t in cache.items() if t[0] / total > threshold]
@contextmanager
def _get_locale_data_cache(self):
"""Retrieve/update locale info cache
The locale cache holds cached information about the
level of completion for individual locales, along
with a timestamp for when this completion was last
calculated.
"""
# Place the cache file directly under the build dir
# to share it between python versions.
build_dir = self.get_finalized_command("build").build_base
cache_file = os.path.join(build_dir, self.LOCALE_CACHE)
if not os.path.isfile(cache_file):
info_dict = dict()
else:
# Read in file to a list of lines
with open(cache_file, "r") as f:
info_lines = f.read().strip().split("\n")
# Turn list of lines into a dict of (completion, timestamp)
# tuples, keyed by the locale code.
info_line_lists = [l.split("\t") for l in info_lines]
info_dict = {loc: (int(completion), float(timestamp))
for loc, completion, timestamp in info_line_lists}
yield info_dict
# Turn the (modified) dict back into space-separated values
# and overwrite the cache file (cache file timestamp is irrelevant)
out = ["%s\t%d\t%f" % (loc, v[0], v[1])
for loc, v in info_dict.items()]
self.mkpath(build_dir)
with open(cache_file, "w") as f:
f.write("\n".join(out))
@staticmethod
def pkgconf_brushdir_path():
return pkgconfig_variable('mypaint-brushes-2.0', 'brushesdir')
def instantiate_template(self, template_path, output_path, substitutions):
"""Instantiate a template and write result to a file
:param template_path: The path of the template file
:param output_path: The path of the instantiated output file
:param substitutions: A dictionary of substitutions that fully
cover the {keyword} instances in the template file contents.
"""
warning = self.WARNING_TEMPLATE.format(
input=template_path, cmd=self.__class__.__name__, script=__file__
)
try:
with open(template_path, "r") as template:
template_string = template.read()
with open(output_path, "w") as output_file:
output_file.write(warning)
output_file.write(template_string.format(**substitutions))
except IOError as e:
print_err(e)
msg = 'Failed to instantiate "{}" to "{}". Check permissions.'
print_err(msg.format(template_path, output_path))
sys.exit(1)
except KeyError as e:
print_err(e)
print_err("Template key not provided!")
sys.exit(1)
class Build (build):
"""Custom build (build_ext 1st for swig, run build_translations)
distutils.command.build.build doesn't generate the extension.py for
an _extension.so, unless the build_ext is done first or you install
twice. The fix is to do the build_ext subcommand before build_py.
In our case, swig runs first. Still needed as of Python 2.7.13.
Fix adapted from https://stackoverflow.com/questions/17666018>.
This build also ensures that build_translations is run.
"""
sub_commands = (
[("build_config", None)] +
[(a, b) for (a, b) in build.sub_commands if a == 'build_ext'] +
[(a, b) for (a, b) in build.sub_commands if a != 'build_ext'] +
[("build_translations", None)]
)
class BuildExt (build_ext):
"""Custom build_ext.
Adds additional behaviour to --debug option and
adds an option to amend the rpath with library paths
from dependencies found via pkg-config
"""
user_options = [
("set-rpath", "f",
"[MyPaint] Add dependency library paths from pkg-config "
"to the rpath of mypaintlib (linux/bsd only)"),
("disable-openmp", None,
"Don't use openmp, even if the platform supports it."),
] + build_ext.user_options
def initialize_options(self):
self.set_rpath = False
self.disable_openmp = False
build_ext.initialize_options(self)
def finalize_options(self):
build_ext.finalize_options(self)
if self.set_rpath and (sys.platform.startswith("linux")
or "bsd" in sys.platform):
# The directories in runtime_library_dirs will be added
# to the linker args as '-Wl,-R{dirs}' This _should_ be
# compatible with the --rpath= build_ext option
for ext in self.extensions:
rt_libs = uniq(ext.library_dirs + ext.runtime_library_dirs)
# Retain original list reference, just in case
ext.runtime_library_dirs[:] = rt_libs
def build_extension(self, ext):
ccflags = ext.extra_compile_args
linkflags = ext.extra_link_args
if sys.platform != "darwin" and not self.disable_openmp:
linkflags.append(OPENMP_CFLAG)
ccflags.append(OPENMP_LDFLAG)
if self.debug:
skip = ["-DNDEBUG"]
ccflags[:] = [f for f in ccflags if f not in skip]
ccflags.extend([
"-O0",
"-g",
"-DHEAVY_DEBUG",
])
linkflags.extend([
"-O0",
])
else:
linkflags.append("-O3")
ccflags.append("-O3")
return build_ext.build_extension(self, ext)
class Install (install):
"""Custom install to handle translation files
Same options as the regular install command.
"""
def run(self):
# lib.config is a module generated as part of the build process,
# and may not exist when the setup script is run,
# hence it should not (and often cannot) be a top-level import.
import lib.config
# We only install the locales added in the build_config step.
locales = lib.config.supported_locales
data_paths = BuildTranslations.get_translation_paths(self, locales)[1]
self.distribution.data_files.extend(data_paths)
install.run(self)
class Demo (Command):
"""Builds, then do a test run from a temporary install tree"""
description = "[MyPaint] build, install, and run in a throwaway folder"
user_options = [
("args=", None, "flags and arguments to pass on, as a string"),
("temp-root=", None,
"parent dir (retained) for the demo install (deleted)"),
]
def initialize_options(self):
self.args = None
self.temp_root = None
def finalize_options(self):
pass
def run(self):
if self.dry_run:
self.announce(
"The demo command can't do anything in dry-run mode",
level=2,
)
return
build = self.get_finalized_command("build")
build.run()
build_scripts = self.get_finalized_command("build_scripts")
demo_cmd = [build_scripts.executable]
temp_dir = tempfile.mkdtemp(
prefix="demo-",
suffix="",
dir=self.temp_root,
)
try:
inst = self.distribution.get_command_obj("install", 1)
inst.root = temp_dir
inst.prefix = ""
inst.ensure_finalized()
inst.run()
script_path = None
potential_script_names = ["mypaint.py", "mypaint"]
for s in potential_script_names:
p = os.path.join(inst.install_scripts, s)
if os.path.exists(p):
script_path = p
break
if not script_path:
raise RuntimeError(
"Cannot locate installed script. "
"Tried all of %r in %r."
% (potential_script_names, inst.install_scripts)
)
config_dir = os.path.join(temp_dir, "_config")
demo_cmd.extend([script_path, "-c", config_dir])
# Arguments to mypaint (e.g. a file path)
if self.args:
demo_cmd.extend(self.args.split(' '))
self.announce("Demo: running %r..." % (demo_cmd,), level=2)
subprocess.check_call(demo_cmd)
except Exception:
raise
finally:
self.announce("Demo: cleaning up %r..." % (temp_dir,), level=2)
shutil.rmtree(temp_dir, ignore_errors=True)
class InstallScripts (install_scripts):
"""Install scripts with ".py" suffix removal and version headers.
Bakes version information into each installed script.
The .py suffix is also removed on most platforms we support.
"""
def run(self):
if not self.skip_build:
self.run_command('build_scripts')
sys.path.insert(0, ".")
import lib.meta
relinfo_script = lib.meta._get_release_info_script(gitprefix="git")
header_tmpl = textwrap.dedent("""
#
# ***DO NOT EDIT THIS FILE***: edit {source} instead.
#
# Auto-generated version info follows.
{relinfo_script}
""")
self.mkpath(self.install_dir)
self.outfiles = []
src_patt = os.path.join(self.build_dir, "*")
for src in glob.glob(src_patt):
header = header_tmpl.format(
relinfo_script=relinfo_script,
source=os.path.basename(src),
)
outfiles = self._install_script(src, header)
self.outfiles.extend(outfiles)
def _install_script(self, src, header):
strip_ext = True
set_mode = False
if sys.platform == "win32":
if "MSYSTEM" not in os.environ: # and not MSYS2
strip_ext = False
targ_basename = os.path.basename(src)
if strip_ext and targ_basename.endswith(".py"):
targ_basename = targ_basename[:-3]
targ = os.path.join(self.install_dir, targ_basename)
self.announce("installing %s as %s" % (src, targ_basename), level=2)
if self.dry_run:
return []
with open(src, "r") as in_fp:
with open(targ, "w") as out_fp:
line = in_fp.readline().rstrip()
if line.startswith("#!"):
print(line, file=out_fp)
print(header, file=out_fp)
if os.name == 'posix':
set_mode = True
else:
print(header, file=out_fp)
print(line, file=out_fp)
for line in in_fp.readlines():
line = line.rstrip()
print(line, file=out_fp)
if set_mode:
mode = ((os.stat(targ).st_mode) | 0o555) & 0o7777
self.announce("changing mode of %s to %o" % (targ, mode), level=2)
os.chmod(targ, mode)
return [targ]
class _ManagedInstBase (Command):
"""Base for commands that work on managed installs."""
MANAGED_FILES_LIST = "managed_files.txt"
# Common options:
user_options = [
("prefix=", None, "POSIX-style install prefix, e.g. /usr"),
]
def initialize_options(self):
self.prefix = "/usr/local"
def finalize_options(self):
self.prefix = os.path.abspath(self.prefix)
# Utility methods for subclasses:
def is_installed(self):
"""True if an installation is present at the prefix."""
inst = self.distribution.get_command_obj("install", 1)
inst.root = self.prefix
inst.prefix = "."
inst.ensure_finalized()
inst.record = os.path.join(inst.install_lib, self.MANAGED_FILES_LIST)
return os.path.isfile(inst.record)
def uninstall(self):
"""Uninstalls an existing install."""
self.announce(
"Uninstalling from %r..." % (self.prefix,),
level=2,
)
inst = self.distribution.get_command_obj("install", 1)
inst.root = self.prefix
inst.prefix = "."
inst.ensure_finalized()
inst.record = os.path.join(inst.install_lib, self.MANAGED_FILES_LIST)
self.announce(
"Using the installation record in %r" % (inst.record,),
level=2,
)
with open(inst.record, "r") as fp:
for path_rel in fp:
path_rel = path_rel.rstrip("\r\n")
path = os.path.join("/", path_rel)
self.rm(path)
self.rm(inst.record)
# Remove the trees that are entirely MyPaint's too
# See setup.cfg's [install] and get_data_files()
mypaint_data_trees = [
inst.install_lib,
os.path.join(inst.install_data, "mypaint"),
]
for path in mypaint_data_trees:
path = os.path.normpath(path)
assert os.path.basename(path) == "mypaint", \
"path %r does not end in mypaint" % (path,)
self.rmtree(path)
def rmtree(self, path):
"""Remove a tree recursively."""
self.announce("recursively removing %r" % (path,), level=2)
if not self.dry_run:
shutil.rmtree(path, ignore_errors=True)
def rm(self, path):
"""Remove a single file."""
self.announce("removing %r" % (path,), level=2)
if not self.dry_run:
if os.path.isfile(path):
os.unlink(path)
elif os.path.exists(path):
raise RuntimeError(
"ERROR: %r exists, but it is no longer a file"
% (path,)
)
else:
self.announce("remove: %r is already gone" % (path,), level=1)
class ManagedInstall (_ManagedInstBase):
"""Simplified "install" with a list of installed files.
This command and ManagedUninstall are temporary hacks which we have
to use because `pip {install,uninstall}` doesn't work yet. Once we
have proper namespacing (prefixed `mypaint.{lib,gui}` modules), we
may be able to drop these commands and use standard ones.
"""
description = "[MyPaint] like install, but allow managed_uninstall"
def run(self):
if self.is_installed():
self.announce("Already installed, uninstalling first...", level=2)
self.uninstall()
self.announce(
"Installing (manageably) to %r" % (self.prefix,),
level=2,
)
inst = self.distribution.get_command_obj("install", 1)
inst.root = self.prefix
inst.prefix = "."
inst.ensure_finalized()
inst.record = os.path.join(inst.install_lib, self.MANAGED_FILES_LIST)
self.announce(
"Record will be saved to %r" % (inst.record,),
level=2,
)
if not self.dry_run:
inst.run()
assert os.path.isfile(inst.record)
class ManagedUninstall (_ManagedInstBase):
"""Removes the files created by ManagedInstall."""
description = "[MyPaint] remove files that managed_install wrote"
user_options = [
("prefix=", None, "same as used in your earlier managed_install"),
]
def initialize_options(self):
self.prefix = "/usr/local"
def finalize_options(self):
self.prefix = os.path.abspath(self.prefix)
def run(self):
self.uninstall()
def uniq(items):
"""Order-preserving uniq()"""
seen = set()
result = []
for i in items:
if i in seen:
continue
seen.add(i)
result.append(i)
return result
def pkgconfig(packages, **kwopts):
"""Runs pkgconfig to update its args.
Also returns the modified args dict. Recipe adapted from
http://code.activestate.com/recipes/502261/
"""
flag_map = {
'-I': 'include_dirs',
'-L': 'library_dirs',
'-l': 'libraries',
}
extra_args_map = {
"--libs": "extra_link_args",
"--cflags": "extra_compile_args",
}
for (pc_arg, extras_key) in extra_args_map.items():
cmd = [pkgconf(), pc_arg] + list(packages)
cmd_output = subprocess.check_output(
cmd,
universal_newlines=True,
)
for conf_arg in cmd_output.split():
flag = conf_arg[:2]
flag_value = conf_arg[2:]
flag_key = flag_map.get(flag)
if flag_key:
kw = flag_key
val = flag_value
else:
kw = extras_key
val = conf_arg
kwopts.setdefault(kw, []).append(val)
for kw, val in list(kwopts.items()):
kwopts[kw] = uniq(val)
return kwopts
def check_dependencies(deps):
with open(os.devnull, 'w') as devnull:
# Check with a single invocation in case everything is available
if subprocess.call([pkgconf(), "--libs"] + deps, stdout=devnull):
# Already printed to stderr, but easier to see in a summary
print_err("\nThe following required dependencies were not found:")
for dep in deps:
if subprocess.call([pkgconf(), dep]):
print_err(dep)
sys.exit(1)
def get_ext_modules():
"""Return a list of binary Extensions for setup() to process."""
import numpy
extra_compile_args = [
'--std=c++11',
'-Wall',
'-Wno-sign-compare',
'-Wno-write-strings',
'-D_POSIX_C_SOURCE=200809L',
"-DNO_TESTS", # FIXME: we're building against shared libmypaint now
'-g', # always include symbols, for profiling
]
extra_link_args = []
if sys.platform == "darwin":
pass
elif sys.platform == "win32":
pass
elif sys.platform == "msys":
pass
elif sys.platform.startswith("linux") or "bsd" in sys.platform:
# Look up libraries dependencies relative to the library.
extra_link_args.append('-Wl,-z,origin')
extra_link_args.append('-Wl,-rpath,$ORIGIN')
initial_deps = ["%s >= 1.6" % LIBMYPAINT]
remaining_deps = [
"pygobject-3.0",
"glib-2.0",
"libpng",
"lcms2",
"gtk+-3.0",
"mypaint-brushes-2.0",
]
check_dependencies(initial_deps + remaining_deps)
# Ensure that the lib path of libmypaint is added first
# to the rpath when the --set-rpath option is used.
# For most users this will be the case anyway, due to the
# order of the pkg-config output, but this ensures it.
mypaintlib_opts = pkgconfig(
packages=initial_deps,
include_dirs=[
numpy.get_include(),
],
extra_link_args=extra_link_args,
extra_compile_args=extra_compile_args,
)
# Append the info from the rest of the dependencies
mypaintlib_opts = pkgconfig(
packages=remaining_deps,
**mypaintlib_opts
)
mypaintlib_swig_opts = ['-Wall', '-noproxydel', '-c++']
mypaintlib_swig_opts.extend([
"-I" + d
for d in mypaintlib_opts["include_dirs"]
])
# FIXME: building against the new shared lib, omit old test code
mypaintlib_swig_opts.extend(['-DNO_TESTS'])
mypaintlib = Extension(
'lib._mypaintlib',
[
'lib/mypaintlib.i',
'lib/gdkpixbuf2numpy.cpp',
'lib/pixops.cpp',
'lib/fastpng.cpp',
'lib/brushsettings.cpp',
'lib/fill/fill_common.cpp',
'lib/fill/fill_constants.cpp',
'lib/fill/floodfill.cpp',
'lib/fill/gap_closing_fill.cpp',
'lib/fill/gap_detection.cpp',
'lib/fill/blur.cpp',
'lib/fill/morphology.cpp',
],
swig_opts=mypaintlib_swig_opts,
language='c++',
**mypaintlib_opts
)
return [mypaintlib]
def get_data_files():
"""Return a list of data_files entries for setup() to process."""
# Target paths are relative to $base/share, assuming setup.py's
# default value for install-data.
data_files = [
# TARGDIR, SRCFILES
("metainfo", ["desktop/mypaint.appdata.xml"]),
("applications", ["desktop/mypaint.desktop"]),
("thumbnailers", ["desktop/mypaint-ora.thumbnailer"]),
]
# Paths which can only derived from globbing the source tree.
data_file_patterns = [
# SRCDIR, SRCPATT, TARGDIR
("desktop/icons", "hicolor/*/*/*", "icons"),
("backgrounds", "*.*", "mypaint/backgrounds"),
("backgrounds", "*/*.*", "mypaint/backgrounds"),
("palettes", "*.gpl", "mypaint/palettes"),
("pixmaps", "*.png", "mypaint/pixmaps"),
]
for (src_prefix, src_pattern, targ_prefix) in data_file_patterns:
for src_file in glob.glob(os.path.join(src_prefix, src_pattern)):
file_rel = os.path.relpath(src_file, src_prefix)
targ_dir = os.path.join(targ_prefix, os.path.dirname(file_rel))
data_files.append((targ_dir, [src_file]))
return data_files
# Setup script "main()":
setup(
name='MyPaint',
version='2.0.0a0',
description='Simple painting program for use with graphics tablets.',
author='Andrew Chadwick',
author_email='a.t.chadwick@gmail.com',
license="GPLv2+",
url="http://mypaint.org",
packages=['lib', 'lib.layer', 'gui', 'gui.colors'],
package_data={
"gui": ['*.xml', '*.glade'],
},
data_files=get_data_files(),
cmdclass={
"build": Build,
"build_ext": BuildExt,
"build_translations": BuildTranslations,
"build_config": BuildConfig,
"demo": Demo,
"install": Install,
"managed_install": ManagedInstall,
"managed_uninstall": ManagedUninstall,
"install_scripts": InstallScripts,
# "clean": Clean,
},
scripts=[
"mypaint.py",
"desktop/mypaint-ora-thumbnailer.py",
],
test_suite='tests',
ext_modules=get_ext_modules(),
)
|