Merge pull request #81 from bluescarni/pr/build_improv

Modernise the CMake support

Author: bluescarni

CMakeLists.txt

@@ -1,7 +1,6 @@
-cmake_minimum_required(VERSION 3.8.0)
-# NOTE: policy for using the CheckIPOSupported module:
-# https://cmake.org/cmake/help/latest/policy/CMP0069.html
-cmake_policy(SET CMP0069 NEW)
+# NOTE: FindPython3 supported since CMake 3.12.0, but we use
+# options that appear in 3.17.
+cmake_minimum_required(VERSION 3.17.0)
 
 # Set default build type to "Release".
 # NOTE: this should be done before the project command since the latter can set
@@ -19,34 +18,12 @@ list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" "${CMAKE_CURRE
 message(STATUS "System name: ${CMAKE_SYSTEM_NAME}")
 message(STATUS "pygmo version: ${pygmo_VERSION}")
 
-option(PYGMO_ENABLE_IPO "Enable IPO (requires CMake >= 3.9 and compiler support)." OFF)
+option(PYGMO_ENABLE_IPO "Enable IPO (requires compiler support)." OFF)
 mark_as_advanced(PYGMO_ENABLE_IPO)
 
 # Run the YACMA compiler setup.
 include(YACMACompilerLinkerSettings)
 
-# NOTE: on Unix systems, the correct library installation path
-# could be something other than just "lib", such as "lib64",
-# "lib32", etc., depending on platform/configuration. Apparently,
-# CMake provides this information via the GNUInstallDirs module.
-# Let's enable this for now on all Unixes except OSX.
-# NOTE: potentially, this could be applicable to Cygwin as well.
-#
-# https://cmake.org/cmake/help/v3.15/module/GNUInstallDirs.html
-# https://cmake.org/pipermail/cmake/2013-July/055375.html
-if(UNIX AND NOT APPLE)
-    include(GNUInstallDirs)
-    set(_PYGMO_INSTALL_LIBDIR_DEFAULT "${CMAKE_INSTALL_LIBDIR}")
-else()
-    set(_PYGMO_INSTALL_LIBDIR_DEFAULT "lib")
-endif()
-if(NOT PYGMO_INSTALL_LIBDIR)
-    set(PYGMO_INSTALL_LIBDIR "${_PYGMO_INSTALL_LIBDIR_DEFAULT}" CACHE STRING
-        "Library installation directory." FORCE)
-endif()
-mark_as_advanced(PYGMO_INSTALL_LIBDIR)
-message(STATUS "Library installation directory: ${PYGMO_INSTALL_LIBDIR}")
-
 # Assemble the flags.
 set(PYGMO_CXX_FLAGS_DEBUG ${YACMA_CXX_FLAGS} ${YACMA_CXX_FLAGS_DEBUG})
 set(PYGMO_CXX_FLAGS_RELEASE ${YACMA_CXX_FLAGS})
@@ -160,16 +137,15 @@ if(${pagmo_VERSION} VERSION_LESS ${_PYGMO_MIN_PAGMO_VERSION})
 endif()
 
 # python.
-include(YACMAPythonSetup)
+find_package(Python3 REQUIRED COMPONENTS Interpreter Development)
+message(STATUS "Python3 interpreter: ${Python3_EXECUTABLE}")
+message(STATUS "Python3 installation directory: ${Python3_SITEARCH}")
+set(PYGMO_INSTALL_PATH "" CACHE STRING "pygmo module installation path")
+mark_as_advanced(PYGMO_INSTALL_PATH)
 
 # Boost setup.
 include(PygmoFindBoost)
 
-# python version check.
-if(${PYTHON_VERSION_MAJOR} LESS 3 OR (${PYTHON_VERSION_MAJOR} EQUAL 3 AND ${PYTHON_VERSION_MINOR} LESS 4))
-    message(FATAL_ERROR "Minimum supported python version is 3.4.")
-endif()
-
 # pybind11.
 find_package(pybind11 REQUIRED)
 if(${pybind11_VERSION} VERSION_LESS "2.6")

doc/changelog.rst

@@ -9,6 +9,8 @@ Changelog
 Changes
 ~~~~~~~
 
+- pygmo now requires CMake >= 3.17
+  (`#81 <https://github.com/esa/pygmo2/pull/81>`__).
 - Various internal changes to the pickling implementation
   (`#79 <https://github.com/esa/pygmo2/pull/79>`__).
 - pygmo now requires pagmo >= 2.18

doc/conf.py.in

@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'pygmo'
-copyright = '2020, pagmo development team'
+copyright = '2021, pagmo development team'
 author = 'pagmo development team'
 
 # The version info for the project you're documenting, acts as replacement for

doc/install.rst

@@ -126,7 +126,7 @@ In order to install pygmo from source, you will need:
 * `pybind11 <https://github.com/pybind/pybind11>`__ (version >= 2.6),
 * the `pagmo C++ library <https://esa.github.io/pagmo2/>`__,
 * the `Boost libraries <https://www.boost.org/>`__,
-* `CMake <https://cmake.org/>`__, version 3.8 or later.
+* `CMake <https://cmake.org/>`__, version 3.17 or later.
 
 After making sure the dependencies are installed on your system, you can
 download the pygmo source code from the
@@ -158,51 +158,24 @@ such as:
 
 * ``CMAKE_BUILD_TYPE``: the build type (``Release``, ``Debug``, etc.),
   defaults to ``Release``.
-* ``CMAKE_INSTALL_PREFIX``: the path into which pygmo will be installed
-  (e.g., this defaults to ``/usr/local`` on Unix-like platforms).
 * ``CMAKE_PREFIX_PATH``: additional paths that will be searched by CMake
   when looking for dependencies.
+* ``PYGMO_INSTALL_PATH``: the path into which the pygmo module
+  will be installed. If left empty (the default), pygmo will be installed
+  in the global modules directory of your Python installation.
+* ``PYGMO_ENABLE_IPO``: set this flag to ``ON`` to compile pygmo
+  with link-time optimisations. Requires compiler support,
+  defaults to ``OFF``.
 
 Please consult `CMake's documentation <https://cmake.org/cmake/help/latest/>`_
 for more details about CMake's variables and options.
 
-A critical setting for a pygmo installation is the
-value of the ``CMAKE_INSTALL_PREFIX`` variable. The pygmo
-build system will attempt to construct an appropriate
-installation path for the Python module by combining
-the value of ``CMAKE_INSTALL_PREFIX`` with the directory
-paths of the Python installation in use in a platform-dependent
-manner.
-
-For instance, on a typical Linux installation
-of Python 3.6,
-``CMAKE_INSTALL_PREFIX`` will be set by default to
-``/usr/local``, and the pygmo build system will
-append ``lib/python3.6/site-packages`` to the install prefix.
-Thus, the overall install path for the pygmo module will be
-``/usr/local/lib/python3.6/site-packages``. If you want
-to avoid system-wide installations (which require root
-privileges), on Unix-like system it is possible to set
-the ``CMAKE_INSTALL_PREFIX`` variable to the directory
-``.local`` in your ``$HOME`` (e.g., ``/home/username/.local``).
-The pygmo install path will then be, in this case,
-``/home/username/.local/lib/python3.6/site-packages``,
-a path which is normally recognised by Python installations
-without the need to modify the ``PYTHONPATH`` variable.
-If you install pygmo in non-standard prefixes, you may
-have to tweak your Python installation in order for the
-Python interpreter to find the pygmo module.
-
-A typical CMake invocation for pygmo may then
-look something like this:
+The ``PYGMO_INSTALL_PATH`` option is particularly important. If you
+want to install pygmo locally instead of globally (which is in general
+a good idea), you can set this variable to the output of
+``python -m site --user-site``.
 
-.. code-block:: console
-
-   $ cmake ../ -DCMAKE_INSTALL_PREFIX=~/.local
-
-That is, we will be installing pygmo into our home
-directory into the ``.local``
-subdirectory. If CMake runs without errors, we can then proceed to actually
+After configuring the build with CMake, we can then proceed to actually
 building pygmo:
 
 .. code-block:: console

pygmo/CMakeLists.txt

@@ -52,7 +52,7 @@ foreach(PYGMO_PYTHON_FILE ${PYGMO_PYTHON_FILES})
 endforeach()
 
 # Core module.
-YACMA_PYTHON_MODULE(core
+Python3_add_library(core MODULE WITH_SOABI
     core.cpp
     common_utils.cpp
     common_base.cpp
@@ -95,33 +95,39 @@ target_compile_features(core PRIVATE cxx_std_17)
 # Enforce vanilla C++ when compiling.
 set_property(TARGET core PROPERTY CXX_EXTENSIONS NO)
 
-if(${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.9.0")
-    if (PYGMO_ENABLE_IPO)
-        include(CheckIPOSupported)
-        check_ipo_supported(RESULT _PYGMO_IPO_RESULT OUTPUT _PYGMO_IPO_OUTPUT)
-        if (_PYGMO_IPO_RESULT)
-            message(STATUS "IPO requested and supported, enabling.")
-            set_property(TARGET core PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
-        else()
-            message(STATUS "IPO requested, but it is not supported by the compiler:\n${_PYGMO_IPO_OUTPUT}")
-        endif()
-        unset(_PYGMO_IPO_RESULT)
-        unset(_PYGMO_IPO_OUTPUT)
+if (PYGMO_ENABLE_IPO)
+    include(CheckIPOSupported)
+    check_ipo_supported(RESULT _PYGMO_IPO_RESULT OUTPUT _PYGMO_IPO_OUTPUT)
+    if (_PYGMO_IPO_RESULT)
+        message(STATUS "IPO requested and supported, enabling.")
+        set_property(TARGET core PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
+    else()
+        message(STATUS "IPO requested, but it is not supported by the compiler:\n${_PYGMO_IPO_OUTPUT}")
     endif()
+    unset(_PYGMO_IPO_RESULT)
+    unset(_PYGMO_IPO_OUTPUT)
 endif()
 
-# Setup the installation path.
-set(PYGMO_INSTALL_PATH "${YACMA_PYTHON_MODULES_INSTALL_PATH}/pygmo")
+# Installation setup.
+if(PYGMO_INSTALL_PATH STREQUAL "")
+    message(STATUS "pygmo will be installed in the default location: ${Python3_SITEARCH}")
+    set(_PYGMO_INSTALL_DIR "${Python3_SITEARCH}/pygmo")
+else()
+    message(STATUS "pygmo will be installed in the custom location: ${PYGMO_INSTALL_PATH}")
+    set(_PYGMO_INSTALL_DIR "${PYGMO_INSTALL_PATH}/pygmo")
+endif()
 
 # Add submodules directories
 add_subdirectory(plotting)
 
 # Install the core module.
 install(TARGETS core
-    RUNTIME DESTINATION ${PYGMO_INSTALL_PATH}
-    LIBRARY DESTINATION ${PYGMO_INSTALL_PATH}
+    RUNTIME DESTINATION ${_PYGMO_INSTALL_DIR}
+    LIBRARY DESTINATION ${_PYGMO_INSTALL_DIR}
 )
 
 # Install the Python files.
 install(FILES ${PYGMO_PYTHON_FILES} "${CMAKE_CURRENT_BINARY_DIR}/_version.py"
-    DESTINATION ${PYGMO_INSTALL_PATH})
+    DESTINATION ${_PYGMO_INSTALL_DIR})
+
+unset(_PYGMO_INSTALL_DIR)

pygmo/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2020 PaGMO development team
+# Copyright 2020, 2021 PaGMO development team
 #
 # This file is part of the pygmo library.
 #
@@ -11,7 +11,6 @@
 from ._version import __version__
 # We import the sub-modules into the root namespace
 from .core import *
-from .core import _pagmo_version_major, _pagmo_version_minor, _pagmo_version_patch
 from .plotting import *
 from ._py_islands import *
 from ._py_problems import *
@@ -656,38 +655,39 @@ def _archi_set_topology(self, t):
 setattr(archipelago, "set_topology", _archi_set_topology)
 
 
-if _pagmo_version_major > 2 or (_pagmo_version_major == 2 and _pagmo_version_minor >= 15):
-    # Override of the free_form constructor.
-    __original_free_form_init = free_form.__init__
-
-    def _free_form_init(self, t=None):
-        """
-        Args:
-            t: the object that will be used for construction
-
-        Raises:
-            ValueError: if the edges of the input :class:`networkx.DiGraph`
-              do not all have a ``weight`` attribute, or if any edge weight
-              is outside the :math:`\\left[ 0, 1 \\right]` range
-            unspecified: any exception thrown by :func:`pygmo.topology.to_networkx()`, or by
-              the construction of a :class:`~pygmo.topology` from a UDT
-
-        """
-        import networkx as nx
-
-        if t is None:
-            # Default ctor.
-            __original_free_form_init(self)
-        elif type(t) == topology or isinstance(t, nx.DiGraph):
-            # Ctors from topology or DiGraph are exposed
-            # directly.
-            __original_free_form_init(self, t)
-        else:
-            # If t is neither a topology, nor a DiGraph,
-            # assume that it is a UDT.
-            __original_free_form_init(self, topology(t))
-
-    setattr(free_form, "__init__", _free_form_init)
+# Override of the free_form constructor.
+__original_free_form_init = free_form.__init__
+
+
+def _free_form_init(self, t=None):
+    """
+    Args:
+        t: the object that will be used for construction
+
+    Raises:
+        ValueError: if the edges of the input :class:`networkx.DiGraph`
+            do not all have a ``weight`` attribute, or if any edge weight
+            is outside the :math:`\\left[ 0, 1 \\right]` range
+        unspecified: any exception thrown by :func:`pygmo.topology.to_networkx()`, or by
+            the construction of a :class:`~pygmo.topology` from a UDT
+
+    """
+    import networkx as nx
+
+    if t is None:
+        # Default ctor.
+        __original_free_form_init(self)
+    elif type(t) == topology or isinstance(t, nx.DiGraph):
+        # Ctors from topology or DiGraph are exposed
+        # directly.
+        __original_free_form_init(self, t)
+    else:
+        # If t is neither a topology, nor a DiGraph,
+        # assume that it is a UDT.
+        __original_free_form_init(self, topology(t))
+
+
+setattr(free_form, "__init__", _free_form_init)
 
 
 def set_serialization_backend(name):

pygmo/_algorithm_test.py

@@ -1,4 +1,4 @@
-# Copyright 2020 PaGMO development team
+# Copyright 2020, 2021 PaGMO development team
 #
 # This file is part of the pygmo library.
 #
@@ -41,7 +41,8 @@ def run_basic_tests(self):
 
         # First a few non-algos.
         self.assertRaises(NotImplementedError, lambda: algorithm(1))
-        self.assertRaises(NotImplementedError, lambda: algorithm("hello world"))
+        self.assertRaises(NotImplementedError,
+                          lambda: algorithm("hello world"))
         self.assertRaises(NotImplementedError, lambda: algorithm([]))
         self.assertRaises(TypeError, lambda: algorithm(int))
         # Some algorithms missing methods, wrong arity, etc.
@@ -549,7 +550,6 @@ def run_scipy_wrapper_tests(self):
             scp.get_name()
             scp.set_verbosity(0)
 
-
         # testing constrained problem on incompatible methods
         prob = problem(luksan_vlcek1(10))
         pop = population(prob=prob, size=1, seed=0)
@@ -576,7 +576,8 @@ def run_scipy_wrapper_tests(self):
         # testing invalid selection policy
         prob = problem(luksan_vlcek1(10))
         pop = population(prob=prob, size=10, seed=0)
-        scp = algorithm(scipy_optimize(selection = s_policy(select_best(rate=2))))
+        scp = algorithm(scipy_optimize(
+            selection=s_policy(select_best(rate=2))))
         self.assertRaises(ValueError, lambda: scp.evolve(pop))
 
         # testing callback
@@ -590,7 +591,7 @@ def increment(self, *args, **kwargs):
         prob = problem(luksan_vlcek1(10))
         pop = population(prob=prob, size=10, seed=0)
         counter = callback_counter()
-        scp = algorithm(scipy_optimize(callback = counter.increment))
+        scp = algorithm(scipy_optimize(callback=counter.increment))
         scp.evolve(pop)
         self.assertTrue(counter.value > 0)
 
@@ -620,7 +621,8 @@ def increment(self, *args, **kwargs):
 
         # testing hessian wrapper generator
         prob = problem(rastrigin(10))
-        f = scipy_optimize._fitness_wrapper(prob)._generate_hessian_sparsity_wrapper(0)
+        f = scipy_optimize._fitness_wrapper(
+            prob)._generate_hessian_sparsity_wrapper(0)
         hessian = f(array([0] * prob.get_nx()))
         self.assertEqual(len(hessian), prob.get_nx())
         self.assertEqual(len(hessian[0]), prob.get_nx())

pygmo/_bfe_test.py

@@ -1,4 +1,4 @@
-# Copyright 2020 PaGMO development team
+# Copyright 2020, 2021 PaGMO development team
 #
 # This file is part of the pygmo library.
 #

pygmo/_check_deps.py

@@ -1,4 +1,4 @@
-# Copyright 2020 PaGMO development team
+# Copyright 2020, 2021 PaGMO development team
 #
 # This file is part of the pygmo library.
 #

pygmo/_ipyparallel_utils.py

@@ -1,4 +1,4 @@
-# Copyright 2020 PaGMO development team
+# Copyright 2020, 2021 PaGMO development team
 #
 # This file is part of the pygmo library.
 #