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 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
|
#!usr/bin/env python
import os
import platform
import sys
###########################################################################
# Check Python's version info and exit early if it is too old
if sys.version_info < (3, 8):
print("This module requires Python >= 3.8")
sys.exit(0)
###########################################################################
from setuptools import find_packages, setup, Command, Extension
try:
from wheel.bdist_wheel import bdist_wheel
except ImportError:
bdist_wheel = None
import glob
import shlex
import shutil
import subprocess
import sysconfig
from contextlib import contextmanager
from pathlib import Path
from select import select
from shutil import which
from time import sleep
from typing import List, Iterable, Iterator, Optional, Tuple, TypeVar, Union
###########################################################################
LIBIGRAPH_FALLBACK_INCLUDE_DIRS = ["/usr/include/igraph", "/usr/local/include/igraph"]
LIBIGRAPH_FALLBACK_LIBRARIES = ["igraph"]
LIBIGRAPH_FALLBACK_LIBRARY_DIRS = []
# Check whether we are compiling for PyPy or wasm with emscripten. Headers will
# not be installed in these cases, or when the SKIP_HEADER_INSTALL envvar is
# set explicitly.
SKIP_HEADER_INSTALL = (
platform.python_implementation() == "PyPy"
or (sysconfig.get_config_var("HOST_GNU_TYPE") or "").endswith("emscripten")
or "SKIP_HEADER_INSTALL" in os.environ
)
###########################################################################
T = TypeVar("T")
def is_envvar_on(name: str) -> bool:
"""Returns whether the given environment variable is set to a truthy value
such as '1', 'on' or 'true'.
"""
value = os.environ.get(name, "")
return value and str(value).lower() in ("1", "on", "true")
def building_on_windows_msvc() -> bool:
"""Returns True when using the non-MinGW CPython interpreter on Windows"""
return platform.system() == "Windows" and sysconfig.get_platform() != "mingw"
def building_with_emscripten() -> bool:
"""Returns True when building with Emscripten to WebAssembly"""
return (sysconfig.get_config_var("HOST_GNU_TYPE") or "").endswith("emscripten")
def building_with_sanitizers() -> bool:
"""Returns True when the IGRAPH_USE_SANITIZERS envvar is set, indicating that
we want to build the Python interface with AddressSanitizer and LeakSanitizer
enabled. Currently works on Linux only and the primary use-case is to be able
to test igraph with sanitizers in CI.
"""
return platform.system() == "Linux" and is_envvar_on("IGRAPH_USE_SANITIZERS")
def exclude_from_list(items: Iterable[T], items_to_exclude: Iterable[T]) -> List[T]:
"""Excludes certain items from a list, keeping the original order of
the remaining items."""
itemset = set(items_to_exclude)
return [item for item in items if item not in itemset]
def fail(message: str, code: int = 1) -> None:
"""Fails the build with the given error message and exit code."""
print(message)
sys.exit(code)
def find_static_library(library_name: str, library_path: List[str]) -> Optional[str]:
"""Given the raw name of a library in `library_name`, tries to find a
static library with this name in the given `library_path`. `library_path`
is automatically extended with common library directories on Linux and Mac
OS X."""
variants = ["lib{0}.a", "{0}.a", "{0}.lib", "lib{0}.lib"]
if is_unix_like():
extra_libdirs = [
"/opt/homebrew/lib", # for newer Homebrew installations on macOS
"/usr/local/lib64",
"/usr/local/lib",
"/usr/lib/x86_64-linux-gnu",
"/usr/lib64",
"/usr/lib",
"/lib64",
"/lib",
]
else:
extra_libdirs = []
for path in extra_libdirs:
if path not in library_path and os.path.isdir(path):
library_path.append(path)
for path in library_path:
for variant in variants:
full_path = os.path.join(path, variant.format(library_name))
if os.path.isfile(full_path):
return full_path
def first(iterable: Iterable[T]) -> T:
"""Returns the first element from the given iterable."""
for item in iterable:
return item
raise ValueError("iterable is empty")
def get_output(args, encoding: str = "utf-8") -> Tuple[str, int]:
"""Returns the output of a command returning a single line of output, and
the exit code of the command.
"""
PIPE = subprocess.PIPE
try:
p = subprocess.Popen(args, shell=False, stdin=PIPE, stdout=PIPE, stderr=PIPE)
stdout, stderr = p.communicate()
returncode = p.returncode
except OSError:
stdout, stderr = None, None
returncode = 77
if isinstance(stdout, bytes):
stdout = str(stdout, encoding=encoding)
if isinstance(stderr, bytes):
stderr = str(stderr, encoding=encoding)
return (stdout or ""), returncode
def get_output_single_line(args, encoding: str = "utf-8") -> Tuple[str, int]:
"""Returns the first line of the output of a command, stripped from any
trailing newlines, and the exit code of the command.
"""
stdout, returncode = get_output(args, encoding=encoding)
line, _, _ = stdout.partition("\n")
return line, returncode
def is_unix_like(platform: str = sys.platform) -> bool:
"""Returns whether the given platform is a Unix-like platform with the usual
Unix filesystem. When the parameter is omitted, it defaults to ``sys.platform``
"""
platform = platform or sys.platform
platform = platform.lower()
return (
platform.startswith("linux")
or platform.startswith("darwin")
or platform.startswith("cygwin")
)
def wait_for_keypress(seconds: float) -> None:
"""Wait for a keypress or until the given number of seconds have passed,
whichever happens first.
"""
while seconds > 0:
if seconds > 1:
plural = "s"
else:
plural = ""
sys.stdout.write(
"\rContinuing in %2d second%s; press Enter to continue "
"immediately. " % (seconds, plural)
)
sys.stdout.flush()
if platform.system() == "Windows":
from msvcrt import kbhit # type: ignore
for _ in range(10):
if kbhit():
seconds = 0
break
sleep(0.1)
else:
rlist, _, _ = select([sys.stdin], [], [], 1)
if rlist:
sys.stdin.readline()
seconds = 0
break
seconds -= 1
sys.stdout.write("\r" + " " * 65 + "\r")
@contextmanager
def working_directory(dir: Union[str, Path]) -> Iterator[None]:
cwd = os.getcwd()
os.chdir(dir)
try:
yield
finally:
os.chdir(cwd)
###########################################################################
class IgraphCCoreCMakeBuilder:
"""Class responsible for downloading and building the C core of igraph
if it is not installed yet, assuming that the C core uses CMake as the
build tool. This is the case from igraph 0.9.
"""
def compile_in(
self, source_folder: Path, build_folder: Path, install_folder: Path
) -> Union[bool, List[str]]:
"""Compiles igraph from its source code in the given folder.
Parameters:
source_folder: absolute path to the folder that contains igraph's
source files
build_folder: absolute path to the folder where the build should be
executed
install_folder: absolute path to the folder where the built library
should be installed
Returns:
False if the build failed or the list of libraries to link to when
linking the Python interface to igraph
"""
with working_directory(build_folder):
return self._compile_in(source_folder, build_folder, install_folder)
def _compile_in(
self, source_folder: Path, build_folder: Path, install_folder: Path
) -> Union[bool, List[str]]:
cmake = which("cmake")
if not cmake:
print(
"igraph uses CMake as the build system. You need to install CMake "
"before compiling igraph."
)
return False
build_to_source_folder = os.path.relpath(source_folder, build_folder)
print("Configuring build...")
args = [cmake]
cmake_build_mode = "Release"
# Build to wasm requires invocation of the Emscripten SDK
if building_with_emscripten():
emcmake = which("emcmake")
if not emcmake:
print(
"You need to install emcmake from the Emscripten SDK before "
"compiling igraph."
)
return False
args.insert(0, emcmake)
args.append("-DIGRAPH_WARNINGS_AS_ERRORS:BOOL=OFF")
args.append("-DIGRAPH_GRAPHML_SUPPORT:BOOL=OFF")
# Build the Python interface with vendored libraries
for deps in "ARPACK BLAS GLPK GMP LAPACK".split():
args.append("-DIGRAPH_USE_INTERNAL_" + deps + "=ON")
# Use link-time optinization if available
args.append("-DIGRAPH_ENABLE_LTO=AUTO")
# -fPIC is needed on Linux so we can link to a static igraph lib from a
# Python shared library
args.append("-DCMAKE_POSITION_INDEPENDENT_CODE=ON")
# No need to build tests
args.append("-DBUILD_TESTING=OFF")
# Do not treat compilation warnings as errors in case someone is trying
# to "pip install" igraph in an environment for which we don't provide
# wheels and the compiler complains about harmless things
args.append("-DIGRAPH_WARNINGS_AS_ERRORS=OFF")
# Set install directory during config step instead of install step in order
# to avoid having the architecture name in the LIBPATH (e.g. lib/x86_64-linux-gnu)
args.append("-DCMAKE_INSTALL_PREFIX=" + str(install_folder))
# On macOS, compile the C core with the same macOS deployment target as
# the one that was used to compile Python itself
if sysconfig.get_config_var("MACOSX_DEPLOYMENT_TARGET"):
args.append(
"-DCMAKE_OSX_DEPLOYMENT_TARGET="
+ sysconfig.get_config_var("MACOSX_DEPLOYMENT_TARGET")
)
# Compile the C core with sanitizers if needed
if building_with_sanitizers():
args.append("-DUSE_SANITIZER=Address;Undefined")
args.append("-DFLEX_KEEP_LINE_NUMBERS=ON")
cmake_build_mode = "Debug"
# Add any extra CMake args from environment variables
if "IGRAPH_CMAKE_EXTRA_ARGS" in os.environ:
args.extend(
shlex.split(
os.environ["IGRAPH_CMAKE_EXTRA_ARGS"],
posix=not building_on_windows_msvc(),
)
)
# Finally, add the source folder path
args.append(str(build_to_source_folder))
retcode = subprocess.call(args)
if retcode:
return False
print("Running build...")
# We are _not_ using a parallel build; this is intentional, see igraph/igraph#1755
retcode = subprocess.call([cmake, "--build", ".", "--config", cmake_build_mode])
if retcode:
return False
print("Installing build...")
retcode = subprocess.call(
[
cmake,
"--install",
".",
"--config",
cmake_build_mode,
]
)
if retcode:
return False
for candidate in install_folder.rglob("igraph.pc"):
return self._parse_pkgconfig_file(candidate)
raise RuntimeError(
"no igraph.pc was found in the installation folder of igraph"
)
def create_build_config_file(
self, install_folder: Path, libraries: List[str]
) -> None:
with (install_folder / "build.cfg").open("w") as fp:
fp.write(repr(libraries))
def _parse_pkgconfig_file(self, filename: Path) -> List[str]:
building_on_windows = building_on_windows_msvc()
if building_on_windows:
libraries = ["igraph"]
else:
libraries = []
with filename.open("r") as fp:
for line in fp:
if line.startswith("Libs: ") or line.startswith("Libs.private: "):
words = line.strip().split()
libraries.extend(
word[2:] for word in words if word.startswith("-l")
)
# Remap known library names in Requires and Requires.private with
# prior knowledge -- we don't want to rebuild pkg-config in Python
if line.startswith("Requires: ") or line.startswith(
"Requires.private: "
):
for word in line.strip().split():
if word.startswith("libxml-"):
libraries.append("xml2")
if not libraries:
# Educated guess
libraries = ["igraph"]
return libraries
###########################################################################
class BuildConfiguration:
def __init__(self):
self.include_dirs = []
self.library_dirs = []
self.runtime_library_dirs = []
self.libraries = []
self.extra_compile_args = []
self.extra_link_args = []
self.define_macros = []
self.extra_objects = []
self.static_extension = False
self.use_pkgconfig = False
self.use_sanitizers = False
self.c_core_built = False
self.allow_educated_guess = True
self._has_pkgconfig = None
self.excluded_include_dirs = []
self.excluded_library_dirs = []
self.wait = platform.system() != "Windows"
@property
def has_pkgconfig(self) -> bool:
"""Returns whether ``pkg-config`` is available on the current system
and it knows about igraph or not."""
if self._has_pkgconfig is None:
if self.use_pkgconfig:
_, exit_code = get_output_single_line(["pkg-config", "igraph"])
self._has_pkgconfig = exit_code == 0
else:
self._has_pkgconfig = False
return self._has_pkgconfig
@property
def build_c_core(self) -> Command:
"""Returns a class representing a custom setup.py command that builds
the C core of igraph.
This is used in CI environments where we want to build the C core of
igraph once and then build the Python interface for various Python
versions without having to recompile the C core all the time.
If is also used as a custom building block of `build_ext`.
"""
buildcfg = self
class build_c_core(Command):
description = "Compile the C core of igraph only"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
buildcfg.c_core_built = buildcfg.compile_igraph_from_vendor_source()
return build_c_core
@property
def build_ext(self) -> Command:
"""Returns a class that can be used as a replacement for the
``build_ext`` command in ``setuptools`` and that will compile the C core
of igraph before compiling the Python extension.
"""
from setuptools.command.build_ext import build_ext
buildcfg = self
class custom_build_ext(build_ext):
def run(self):
# Bail out if we don't have the Python include files
include_dir = sysconfig.get_path("include")
if not os.path.isfile(os.path.join(include_dir, "Python.h")):
fail("You will need the Python headers to compile this extension.")
# Check whether the user asked us to discover a pre-built igraph
# with pkg-config
detected = False
if buildcfg.use_pkgconfig:
detected = buildcfg.detect_from_pkgconfig()
if not detected:
fail(
"Cannot find the C core of igraph on this system using pkg-config."
)
else:
# Build the C core from the vendored igraph source
self.run_command("build_c_core")
if not buildcfg.c_core_built:
# Fall back to an educated guess if everything else failed
if not detected:
if buildcfg.allow_educated_guess:
buildcfg.use_educated_guess()
else:
fail("Cannot build the C core of igraph.")
# Add any extra library paths if needed; this is needed for the
# Appveyor CI build
if "IGRAPH_EXTRA_LIBRARY_PATH" in os.environ:
buildcfg.library_dirs = (
list(os.environ["IGRAPH_EXTRA_LIBRARY_PATH"].split(os.pathsep))
+ buildcfg.library_dirs
)
# Add extra libraries that may have been specified
if "IGRAPH_EXTRA_LIBRARIES" in os.environ:
extra_libraries = os.environ["IGRAPH_EXTRA_LIBRARIES"].split(",")
buildcfg.libraries.extend(extra_libraries)
# Override build configuration based on environment variables
if "IGRAPH_STATIC_EXTENSION" in os.environ:
buildcfg.static_extension = is_envvar_on("IGRAPH_STATIC_EXTENSION")
buildcfg.use_sanitizers = building_with_sanitizers()
# Replaces library names with full paths to static libraries
# where possible. libm.a is excluded because it caused problems
# on Sabayon Linux where libm.a is probably not compiled with
# -fPIC
if buildcfg.static_extension:
if buildcfg.static_extension == "only_igraph":
buildcfg.replace_static_libraries(only=["igraph"])
else:
buildcfg.replace_static_libraries(exclusions=["m"])
# Add sanitizer flags
if buildcfg.use_sanitizers:
buildcfg.extra_link_args += [
"-fsanitize=address",
"-fsanitize=undefined",
]
buildcfg.extra_compile_args += [
"-g",
"-Og",
"-fno-omit-frame-pointer",
"-fdiagnostics-color",
]
# Add extra libraries that may have been specified
if "IGRAPH_EXTRA_DYNAMIC_LIBRARIES" in os.environ:
extra_libraries = os.environ[
"IGRAPH_EXTRA_DYNAMIC_LIBRARIES"
].split(",")
buildcfg.libraries.extend(extra_libraries)
# Remove C++ standard library as we will use the C++ linker
for lib in ("c++", "stdc++"):
if lib in buildcfg.libraries:
buildcfg.libraries.remove(lib)
# Prints basic build information
buildcfg.print_build_info()
# Find the igraph extension and configure it with the settings
# of this build configuration
ext = first(
extension
for extension in self.extensions
if extension.name == "igraph._igraph"
)
buildcfg.configure(ext)
# Run the original build_ext command
build_ext.run(self)
return custom_build_ext
@property
def sdist(self):
"""Returns a class that can be used as a replacement for the
``sdist`` command in ``setuptools`` and that will clean up
``vendor/source/igraph`` before running the original ``sdist``
command.
"""
from setuptools.command.sdist import sdist
def is_git_repo(folder) -> bool:
return (Path(folder) / ".git").exists()
def cleanup_git_repo(folder) -> None:
with working_directory(folder):
if os.path.exists(".git"):
retcode = subprocess.call("git clean -dfx", shell=True)
if retcode:
raise RuntimeError(f"Failed to clean {folder} with git")
class custom_sdist(sdist):
def run(self):
igraph_source_repo = Path("vendor", "source", "igraph")
igraph_build_dir = Path("vendor", "build", "igraph")
version_file = igraph_source_repo / "IGRAPH_VERSION"
version = None
# Check whether the source repo contains an IGRAPH_VERSION file,
# and extract the version number from that
if version_file.exists():
version = version_file.read_text().strip().split("\n")[0]
# If no IGRAPH_VERSION file exists, but we have a git repo, try
# git describe
if not version and is_git_repo(igraph_source_repo):
with working_directory(igraph_source_repo):
version = (
subprocess.check_output("git describe", shell=True)
.decode("utf-8")
.strip()
)
# If we still don't have a version number, try to parse it from
# include/igraph_version.h
if not version:
version_header = igraph_build_dir / "include" / "igraph_version.h"
if not version_header.exists():
raise RuntimeError(
"You need to build the C core of igraph first before generating a source tarball of the Python interface of igraph"
)
with version_header.open("r") as fp:
lines = [
line.strip()
for line in fp
if line.startswith("#define IGRAPH_VERSION ")
]
if len(lines) == 1:
version = lines[0].split('"')[1]
if not isinstance(version, str) or len(version) < 5:
raise RuntimeError(
f"Cannot determine the version number of the C core in {igraph_source_repo}"
)
if not is_git_repo(igraph_source_repo):
# The Python interface was extracted from an official
# tarball so there is no need to tweak anything
return sdist.run(self)
else:
# Clean up vendor/source/igraph with git
cleanup_git_repo(igraph_source_repo)
# Copy the generated parser sources from the build folder
parser_dir = igraph_build_dir / "src" / "io" / "parsers"
if parser_dir.is_dir():
shutil.copytree(
parser_dir, igraph_source_repo / "src" / "io" / "parsers"
)
else:
raise RuntimeError(
"You need to build the C core of igraph first before "
"generating a source tarball of the Python interface"
)
# Add a version file to the tarball
version_file.write_text(version)
# Run the original sdist command
retval = sdist.run(self)
# Clean up vendor/source/igraph with git again
cleanup_git_repo(igraph_source_repo)
return retval
return custom_sdist
def compile_igraph_from_vendor_source(self) -> bool:
"""Compiles igraph from the vendored source code inside `vendor/source/igraph`.
This folder typically comes from a git submodule.
"""
vendor_folder = Path("vendor")
source_folder = vendor_folder / "source" / "igraph"
build_folder = vendor_folder / "build" / "igraph"
install_folder = vendor_folder / "install" / "igraph"
if install_folder.exists():
# Vendored igraph already compiled and installed, just use it
self.use_vendored_igraph()
return True
if (source_folder / "CMakeLists.txt").exists():
igraph_builder = IgraphCCoreCMakeBuilder()
else:
print("Cannot find vendored igraph source in {0}".format(source_folder))
print("")
return False
print("We are going to build the C core of igraph.")
print(" Source folder: {0}".format(source_folder))
print(" Build folder: {0}".format(build_folder))
print(" Install folder: {0}".format(install_folder))
print("")
source_folder = source_folder.resolve()
build_folder = build_folder.resolve()
install_folder = install_folder.resolve()
Path(build_folder).mkdir(parents=True, exist_ok=True)
libraries = igraph_builder.compile_in(
source_folder=source_folder,
build_folder=build_folder,
install_folder=install_folder,
)
if libraries is False:
fail("Build failed for the C core of igraph.")
assert not isinstance(libraries, bool)
igraph_builder.create_build_config_file(install_folder, libraries)
self.use_vendored_igraph()
return True
def configure(self, ext) -> None:
"""Configures the given Extension object using this build configuration."""
ext.include_dirs = exclude_from_list(
self.include_dirs, self.excluded_include_dirs
)
ext.library_dirs = exclude_from_list(
self.library_dirs, self.excluded_library_dirs
)
ext.runtime_library_dirs = self.runtime_library_dirs
ext.libraries = self.libraries
ext.extra_compile_args = self.extra_compile_args
ext.extra_link_args = self.extra_link_args
ext.extra_objects = self.extra_objects
ext.define_macros = self.define_macros
def detect_from_pkgconfig(self) -> bool:
"""Detects the igraph include directory, library directory and the
list of libraries to link to using ``pkg-config``."""
if not buildcfg.has_pkgconfig:
return False
cmd = ["pkg-config", "igraph", "--cflags", "--libs"]
if self.static_extension:
cmd += ["--static"]
line, exit_code = get_output_single_line(cmd)
if exit_code > 0 or len(line) == 0:
return False
opts = line.strip().split()
self.libraries = [opt[2:] for opt in opts if opt.startswith("-l")]
self.library_dirs = [opt[2:] for opt in opts if opt.startswith("-L")]
self.include_dirs = [opt[2:] for opt in opts if opt.startswith("-I")]
return True
def print_build_info(self) -> None:
"""Prints the include and library path being used for debugging purposes."""
if self.static_extension == "only_igraph":
build_type = "dynamic extension with vendored igraph source"
elif self.static_extension:
build_type = "static extension"
else:
build_type = "dynamic extension"
print("Build type: %s" % build_type)
print("Include path: %s" % " ".join(self.include_dirs))
if self.excluded_include_dirs:
print(" - excluding: %s" % " ".join(self.excluded_include_dirs))
print("Library path: %s" % " ".join(self.library_dirs))
if self.excluded_library_dirs:
print(" - excluding: %s" % " ".join(self.excluded_library_dirs))
print("Runtime library path: %s" % " ".join(self.runtime_library_dirs))
print("Linked dynamic libraries: %s" % " ".join(self.libraries))
print("Linked static libraries: %s" % " ".join(self.extra_objects))
print("Extra compiler options: %s" % " ".join(self.extra_compile_args))
print("Extra linker options: %s" % " ".join(self.extra_link_args))
def process_args_from_command_line(self):
"""Preprocesses the command line options before they are passed to
setup.py and sets up the build configuration.
"""
# Yes, this is ugly, but we don't want to interfere with setup.py's own
# option handling
opts_to_remove = []
for idx, option in enumerate(sys.argv):
if not option.startswith("--"):
continue
if option == "--static":
opts_to_remove.append(idx)
self.static_extension = True
elif option == "--no-pkg-config":
opts_to_remove.append(idx)
self.use_pkgconfig = False
elif option == "--no-wait":
opts_to_remove.append(idx)
self.wait = False
elif option == "--use-pkg-config":
opts_to_remove.append(idx)
self.use_pkgconfig = True
for idx in reversed(opts_to_remove):
sys.argv[idx : (idx + 1)] = []
def process_environment_variables(self):
"""Processes environment variables that serve as replacements for the
command line options. This is typically useful in CI environments where
it is easier to set up a few environment variables permanently than to
pass the same options to ``setup.py build`` and ``setup.py install``
at the same time.
"""
def process_envvar(name, attr, value):
name = "IGRAPH_" + name.upper()
if name in os.environ:
value = str(os.environ[name]).lower()
if value in ("on", "true", "yes"):
value = True
elif value in ("off", "false", "no"):
value = False
else:
try:
value = bool(int(value))
except Exception:
return
setattr(self, attr, value)
process_envvar("static", "static_extension", True)
process_envvar("no_pkg_config", "use_pkgconfig", False)
process_envvar("no_wait", "wait", False)
process_envvar("use_pkg_config", "use_pkgconfig", True)
process_envvar("use_sanitizers", "use_sanitizers", False)
def replace_static_libraries(self, only=None, exclusions=None):
"""Replaces references to libraries with full paths to their static
versions if the static version is to be found on the library path."""
if exclusions is None:
exclusions = []
for library_name in set(self.libraries) - set(exclusions):
if only is not None and library_name not in only:
continue
static_lib = find_static_library(library_name, self.library_dirs)
if static_lib:
print(f"Found {library_name} as static library in {static_lib}.")
self.libraries.remove(library_name)
self.extra_objects.append(static_lib)
else:
print(f"Warning: could not find static library of {library_name}.")
def use_vendored_igraph(self) -> None:
"""Assumes that igraph is installed already in ``vendor/install/igraph`` and sets up
the include and library paths and the library names accordingly."""
building_on_windows = building_on_windows_msvc()
vendor_dir = Path("vendor") / "install" / "igraph"
buildcfg.include_dirs = [str(vendor_dir / "include" / "igraph")]
buildcfg.library_dirs = []
for candidate in ("lib", "lib64"):
candidate = vendor_dir / candidate
if candidate.exists():
buildcfg.library_dirs.append(str(candidate))
break
else:
raise RuntimeError(
"cannot detect igraph library dir within " + str(vendor_dir)
)
if not buildcfg.static_extension:
buildcfg.static_extension = "only_igraph"
if building_on_windows:
buildcfg.define_macros.append(("IGRAPH_STATIC", "1"))
buildcfg_file = vendor_dir / "build.cfg"
if buildcfg_file.exists():
buildcfg.libraries = eval(buildcfg_file.open("r").read())
def use_educated_guess(self) -> None:
"""Tries to guess the proper library names, include and library paths
if everything else failed."""
global LIBIGRAPH_FALLBACK_LIBRARIES
global LIBIGRAPH_FALLBACK_INCLUDE_DIRS
global LIBIGRAPH_FALLBACK_LIBRARY_DIRS
print("WARNING: we were not able to detect where igraph is installed on")
print("your machine (if it is installed at all). We will use the fallback")
print("library and include paths hardcoded in setup.py and hope that the")
print("C core of igraph is installed there.")
print("")
print("If the compilation fails and you are sure that igraph is installed")
print("on your machine, adjust the following two variables in setup.py")
print("accordingly and try again:")
print("")
print("- LIBIGRAPH_FALLBACK_INCLUDE_DIRS")
print("- LIBIGRAPH_FALLBACK_LIBRARY_DIRS")
print("")
if self.wait:
wait_for_keypress(seconds=10)
self.libraries = LIBIGRAPH_FALLBACK_LIBRARIES[:]
if self.static_extension:
self.libraries.extend(["xml2", "z", "m", "stdc++"])
self.include_dirs = LIBIGRAPH_FALLBACK_INCLUDE_DIRS[:]
self.library_dirs = LIBIGRAPH_FALLBACK_LIBRARY_DIRS[:]
###########################################################################
if bdist_wheel is not None:
class bdist_wheel_abi3(bdist_wheel):
def get_tag(self):
python, abi, plat = super().get_tag()
if python.startswith("cp"):
# on CPython, our wheels are abi3 and compatible back to 3.9
return "cp39", "abi3", plat
return python, abi, plat
else:
bdist_wheel_abi3 = None
# We are going to build an abi3 wheel if we are at least on CPython 3.9.
# This is because the C code contains conditionals for CPython 3.8 so we cannot
# use an abi3 wheel built with CPython 3.8 on CPython 3.9
should_build_abi3_wheel = (
bdist_wheel_abi3
and platform.python_implementation() == "CPython"
and sys.version_info >= (3, 9)
)
###########################################################################
# Import version number from version.py so we only need to change it in
# one place when a new release is created
__version__: str = ""
exec(open("src/igraph/version.py").read())
# Process command line options
buildcfg = BuildConfiguration()
buildcfg.process_environment_variables()
buildcfg.process_args_from_command_line()
# Define the extension
sources = glob.glob(os.path.join("src", "_igraph", "*.c"))
sources.append(os.path.join("src", "_igraph", "force_cpp_linker.cpp"))
macros = []
if should_build_abi3_wheel:
macros.append(("Py_LIMITED_API", "0x03090000"))
igraph_extension = Extension(
"igraph._igraph",
sources=sources,
py_limited_api=should_build_abi3_wheel,
define_macros=macros,
)
description = """Python interface to the igraph high performance graph
library, primarily aimed at complex network research and analysis.
Graph plotting functionality is provided by the Cairo library, so make
sure you install the Python bindings of Cairo if you want to generate
publication-quality graph plots. You can try either `pycairo
<http://cairographics.org/pycairo>`_ or `cairocffi <http://cairocffi.readthedocs.io>`_,
``cairocffi`` is recommended because there were bug reports affecting igraph
graph plots in Jupyter notebooks when using ``pycairo`` (but not with
``cairocffi``).
"""
headers = ["src/_igraph/igraphmodule_api.h"] if not SKIP_HEADER_INSTALL else []
cmdclass = {
"build_c_core": buildcfg.build_c_core, # used by CI
"build_ext": buildcfg.build_ext,
"sdist": buildcfg.sdist,
}
if should_build_abi3_wheel:
cmdclass["bdist_wheel"] = bdist_wheel_abi3
options = {
"name": "igraph",
"version": __version__,
"url": "https://igraph.org/python",
"description": "High performance graph data structures and algorithms",
"long_description": description,
"license": "GNU General Public License (GPL)",
"author": "Tamas Nepusz",
"author_email": "ntamas@gmail.com",
"project_urls": {
"Bug Tracker": "https://github.com/igraph/python-igraph/issues",
"Changelog": "https://github.com/igraph/python-igraph/blob/main/CHANGELOG.md",
"CI": "https://github.com/igraph/python-igraph/actions",
"Documentation": "https://igraph.readthedocs.io",
"Source Code": "https://github.com/igraph/python-igraph",
},
"ext_modules": [igraph_extension],
"package_dir": {
# make sure to use the next line and not the more logical and restrictive
# "igraph": "src/igraph" because that one breaks 'setup.py develop'.
# See: https://github.com/igraph/python-igraph/issues/464
"": "src"
},
"packages": find_packages(where="src"),
"install_requires": ["texttable>=1.6.2"],
## "entry_points": {"console_scripts": ["igraph=igraph.app.shell:main"]},
"extras_require": {
# Dependencies needed for plotting with Cairo
"cairo": ["cairocffi>=1.2.0"],
# Dependencies needed for plotting with Matplotlib
"matplotlib": [
"matplotlib>=3.6.0; platform_python_implementation != 'PyPy'"
],
# Dependencies needed for plotting with Plotly
"plotly": ["plotly>=5.3.0"],
# Compatibility alias to 'cairo' for python-igraph <= 0.9.6
"plotting": ["cairocffi>=1.2.0"],
# Dependencies needed for testing only
"test": [
"cairocffi>=1.2.0",
"networkx>=2.5",
"pytest>=7.0.1",
"pytest-timeout>=2.1.0",
"numpy>=1.19.0; platform_python_implementation != 'PyPy'",
"pandas>=1.1.0; platform_python_implementation != 'PyPy'",
"scipy>=1.5.0; platform_python_implementation != 'PyPy'",
"matplotlib>=3.6.0; platform_python_implementation != 'PyPy'",
"plotly>=5.3.0",
"Pillow>=9; platform_python_implementation != 'PyPy'",
],
# Dependencies needed for testing on musllinux; only those that are either
# pure Python or have musllinux wheels as we don't want to compile wheels
# in CI
"test-musl": [
"cairocffi>=1.2.0",
"networkx>=2.5",
"pytest>=7.0.1",
"pytest-timeout>=2.1.0",
],
# Dependencies needed for building the documentation
"doc": [
"Sphinx>=7.0.0",
"sphinx-rtd-theme>=1.3.0",
"sphinx-gallery>=0.14.0",
"pydoctor>=23.4.0",
],
},
"python_requires": ">=3.8",
"headers": headers,
"platforms": "ALL",
"keywords": [
"graph",
"network",
"mathematics",
"math",
"graph theory",
"discrete mathematics",
],
"classifiers": [
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"Operating System :: OS Independent",
"Programming Language :: C",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Scientific/Engineering",
"Topic :: Scientific/Engineering :: Information Analysis",
"Topic :: Scientific/Engineering :: Mathematics",
"Topic :: Scientific/Engineering :: Physics",
"Topic :: Scientific/Engineering :: Bio-Informatics",
"Topic :: Software Development :: Libraries :: Python Modules",
],
"cmdclass": cmdclass,
}
setup(**options)
|