[bug#38228] Fwd: [PATCH] gnu: boost: Build with python3

[goodoldpaul@autistici.org]

[-- Attachment #1: Type: text/plain, Size: 6317 bytes --]

Hello Marius,
I apologize for taking so long: the end of the semester is near and my 
time is a little limited.

On 2019-11-20 00:01, Marius Bakke wrote:
> goodoldpaul@autistici.org writes:
> 
>> Hello I'm opening another thread ( old one was
>> http://issues.guix.gnu.org/issue/38128 ) to build boost in 
>> core-updates
>> with python3. The new patch also parameterizes python versions across
>> the package definition.
>> 
>> WDYT?
>> 
>> Bye,
>> 
>> Giacomo
>> 
>> -------- Original Message --------
>> Subject: Re: bug#38128: [PATCH] gnu: Add boost-with-python3
>> Date: 2019-11-12 00:06
>>  From: goodoldpaul@autistici.org
>> To: Efraim Flashner <efraim@flashner.co.il>
>> Cc: 38128@debbugs.gnu.org, mbakke@fastmail.com
>> 
>> On 2019-11-11 09:36, Efraim Flashner wrote:
>>> I'm going to re-open this one, sorry.
>>> 
>>> Can we replace the '--with-python-version=3.7' and
>>> 'libboost_python37.so'
>>> with parameterized python variables so we don't have to bump it when 
>>> we
>>> get a new python version?
>>> 
>>> Also, I've attached a package that I've never actually built that 
>>> uses
>>> boost built with python3 if you want something to test it out with :)
>> 
>> I'm not sure how to send a patch for core-updates, I never did it so I
>> attached it here. Please tell me if I should open another patch.
> 
> Excellent.  Here is fine.  :-)
> 
> Note that 'boost-with-python3' has already been merged to core-updates.
> What we need now is 1) a patch that makes these adjustments to
> 'boost-with-python3', and 2) a follow-up patch that removes
> boost-with-python3 and adjusts the original 'boost' package instead.
> 
> The latter will be applied to core-updates after the first patch gets
> merged, but you can make (and test :-)) both patches on a local 
> checkout
> of the 'master' branch.

I'm attaching the two patches. As you said the one that parameterizes 
the python version of boost-with-python3 must be applied to master, the 
other one to core-updates.

>> The patch builds boost with python3 and parameterizes the python
>> version, as Efraim suggested. I built it successfully on core updates.
>> When I tried building Epour on core-updates and saw that Guix was
>> starting to build Bash 5.0 I renounced (:D) and I built it on master
>> with boost-with-python3 .
> 
> In general, working on the 'core-updates' branch requires a fairly
> powerful computer (and lots of time), sorry about that!
> 
>> Libtorrent-rasterbar seems to build fine on master but some tests fail
>> to pass and they all seem to be network related but then again this is
>> torrent we are talking about. I didn't investigate further but I 
>> attach
>> the log.
> 
> Strange.  I suppose these tests are not run when using Boost + Python 
> 2?
> In any case we don't have to worry about that just yet ;-)

I gave another look at Libtorrent-rasterbar and I noticed that it 
depends directly on python2, so the answer to the failing tests could be 
that upgrading both boost and the python version ( as was done in 
Efraim's code that I used last time to test boost-with-python3 )  broke 
something that a closer look to the failing tests could figure out.

Right now I tested the upgraded version without problems by building the 
following ( randomly selected) packages: innoextract, swig, libarea, 
pbbam, cgal, openimageio. If you have a better idea of what must be 
tested please tell me and I'll do some more tests.

>> I also tried boost-with-python3 with Malmo (
>> https://github.com/microsoft/malmo ) and it seemed to compile fine 
>> just
>> but that package has other problems such as trying to start gradle so 
>> I
>> nerver managed to actually run it.
> 
> Cool.  Packaging 'gradle' should be a rewarding experience that makes
> many people very happy, if you would like a challenge.  ;-)
> 
> 
>> From 91a25fb143ad0e2e20e8ddadea0c0610849adf92 Mon Sep 17 00:00:00 2001
>> From: Giacomo Leidi <goodoldpaul@autistici.org>
>> Date: Tue, 12 Nov 2019 00:24:49 +0100
>> Subject: [PATCH] gnu: boost: Build with python3.
>> 
>> * gnu/packages/boost.scm (boost):
>> [arguments]: Parameterize python version.
>> [native-inputs]: Use python3.
> 
> [...]
> 
>>      (arguments
>> -     `(#:tests? #f
>> +     `(#:modules ((guix build gnu-build-system)
>> +                  (guix build utils)
>> +                  (srfi srfi-1))
> 
> If you add (guix build python-build-system) in there ...

[...]

>>           (replace 'configure
>>             (lambda* (#:key inputs outputs #:allow-other-keys)
>>               (let ((icu (assoc-ref inputs "icu4c"))
>> +                   (python (assoc-ref inputs "python"))
>> +                   (python-version
>> +                    (take (string-split ,(package-version python) 
>> #\.) 2))
> 
> ... then you can use (python-version (python-version python)) here and
> below.

I did add python-build-system to #:modules, but Guix kept complaining 
that python-build-system was not importable until I added

#:imported-modules ((guix build python-build-system)
                            ,@%gnu-build-system-modules)

Do you happen to have any idea of the differences from 
#:imported-modules and #:modules? And why was using only 
gnu-build-system possible also without adding it to #:imported-modules?

Or even better: is there any kind of documentation of the arguments and 
keywords and return values of Guix's functions? Something like this 
https://flask.palletsprojects.com/en/1.1.x/api/ .

I don't really like my solution mainly because now there's two lines 
containing 4 times the "python" word, so please if you have any further 
suggestions to how to get this more readable please tell me.

>> +               (substitute* "tools/build/src/tools/python.jam"
>> +                 (("include/python\\$\\(version\\)")
>> +                  "include/python$(version)m"))
> 
> I wonder why we have to add the 'm'?  Will that work with Python 2?

I'm not really sure but grepping for "include/python" inside 
gnu/packages returns some examples where with python3 this "m" seems to 
be standard practice. Maybe the Python team changed their directory 
schema between the two releases? Anyway it won't  work with python2 that 
(also shown by grep -nr "include/python" $GUIX_SOURCE/gnu/packages) 
doesn't use the "m".

Thank you for your review Marius,

Giacomo

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-boost-Build-with-python3.patch --]
[-- Type: text/x-diff; name=0001-gnu-boost-Build-with-python3.patch, Size: 8384 bytes --]

From dba94480865300d6bca7aa4022d3e781f80c0b4e Mon Sep 17 00:00:00 2001
From: Giacomo Leidi <goodoldpaul@autistici.org>
Date: Sun, 8 Dec 2019 22:18:35 +0100
Subject: [PATCH] gnu: boost: Build with python3.

* gnu/packages/boost.scm (boost)[native-inputs]: Use python3.
                                [arguments]: Parameterize python version.
                         (boost-with-python3): Remove variable.
---
 gnu/packages/boost.scm | 108 ++++++++++++-----------------------------
 1 file changed, 31 insertions(+), 77 deletions(-)

diff --git a/gnu/packages/boost.scm b/gnu/packages/boost.scm
index f436d5b688..130ff8b394 100644
--- a/gnu/packages/boost.scm
+++ b/gnu/packages/boost.scm
@@ -63,10 +63,15 @@
               ("zlib" ,zlib)))
     (native-inputs
      `(("perl" ,perl)
-       ("python" ,python-2)
+       ("python" ,python)
        ("tcsh" ,tcsh)))
     (arguments
-     `(#:tests? #f
+     `(#:imported-modules ((guix build python-build-system)
+                           ,@%gnu-build-system-modules)
+       #:modules ((guix build gnu-build-system)
+                  ((guix build python-build-system) #:prefix python:)
+                  (guix build utils))
+       #:tests? #f
        #:make-flags
        (list "threading=multi" "link=shared"
 
@@ -83,7 +88,9 @@
          (delete 'bootstrap)
          (replace 'configure
            (lambda* (#:key inputs outputs #:allow-other-keys)
-             (let ((icu (assoc-ref inputs "icu4c"))
+             (let* ((icu (assoc-ref inputs "icu4c"))
+                   (python (assoc-ref inputs "python"))
+                   (python-version (python:python-version python))
                    (out (assoc-ref outputs "out")))
                (substitute* '("libs/config/configure"
                               "libs/spirit/classic/phoenix/test/runtest.sh"
@@ -95,11 +102,18 @@
                (setenv "SHELL" (which "sh"))
                (setenv "CONFIG_SHELL" (which "sh"))
 
+               (substitute* "tools/build/src/tools/python.jam"
+                 (("include/python\\$\\(version\\)")
+                  "include/python$(version)m"))
+
                (invoke "./bootstrap.sh"
                        (string-append "--prefix=" out)
-                       ;; Auto-detection looks for ICU only in traditional
-                       ;; install locations.
+                       ;; Auto-detection looks for dependencies only
+                       ;; in traditional install locations.
                        (string-append "--with-icu=" icu)
+                       (string-append "--with-python=" python "/bin/python3")
+                       (string-append "--with-python-root=" python)
+                       (string-append "--with-python-version=" python-version)
                        "--with-toolset=gcc"))))
          (replace 'build
            (lambda* (#:key make-flags #:allow-other-keys)
@@ -110,15 +124,19 @@
            (lambda* (#:key make-flags #:allow-other-keys)
              (apply invoke "./b2" "install" make-flags)))
          (add-after 'install 'provide-libboost_python
-           (lambda* (#:key outputs #:allow-other-keys)
-             (let ((out (assoc-ref outputs "out")))
-               ;; Boost can build support for both Python 2 and Python 3 since
-               ;; version 1.67.0, and suffixes each library with the Python
-               ;; version.  Many consumers only check for libboost_python
-               ;; however, so we provide it here as suggested in
-               ;; <https://github.com/boostorg/python/issues/203>.
+           (lambda* (#:key inputs outputs #:allow-other-keys)
+             (let* ((out (assoc-ref outputs "out"))
+                    (python (assoc-ref inputs "python"))
+                    (python-version (python:python-version python))
+                    (libboost.so
+                     (string-append "libboost_python"
+                                    (string-join
+                                     (string-split python-version #\.) "")
+                                    ".so")))
                (with-directory-excursion (string-append out "/lib")
-                 (symlink "libboost_python27.so" "libboost_python.so"))
+                 (symlink libboost.so "libboost_python.so")
+                 ;; Some packages also look for libboost_python3.so
+                 (symlink libboost.so "libboost_python3.so"))
                #t))))))
 
     (home-page "https://www.boost.org")
@@ -129,70 +147,6 @@ across a broad spectrum of applications.")
     (license (license:x11-style "https://www.boost.org/LICENSE_1_0.txt"
                                 "Some components have other similar licences."))))
 
-;; TODO: Merge with 'Boost' in the next rebuild cycle.
-(define-public boost-with-python3
-  (package
-    (inherit boost)
-    (name "boost-python3")
-    (native-inputs
-     `(("perl" ,perl)
-       ("python" ,python)
-       ("tcsh" ,tcsh)))
-    (arguments (substitute-keyword-arguments (package-arguments boost)
-                 ((#:imported-modules _ '())
-                  `((guix build python-build-system)
-                    ,@%gnu-build-system-modules))
-                 ((#:modules _ '())
-                  '((guix build gnu-build-system)
-                    ((guix build python-build-system) #:prefix python:)
-                    (guix build utils)))
-                 ((#:phases phases)
-                  `(modify-phases ,phases
-                     (replace 'configure
-                       (lambda* (#:key inputs outputs #:allow-other-keys)
-                         (let* ((icu (assoc-ref inputs "icu4c"))
-                                (python (assoc-ref inputs "python"))
-                                (python-version (python:python-version python))
-                                (out (assoc-ref outputs "out")))
-                           (substitute* '("libs/config/configure"
-                                          "libs/spirit/classic/phoenix/test/runtest.sh"
-                                          "tools/build/src/engine/execunix.c"
-                                          "tools/build/src/engine/Jambase"
-                                          "tools/build/src/engine/jambase.c")
-                             (("/bin/sh") (which "sh")))
-
-                           (setenv "SHELL" (which "sh"))
-                           (setenv "CONFIG_SHELL" (which "sh"))
-
-                           (substitute* "tools/build/src/tools/python.jam"
-                             (("include/python\\$\\(version\\)")
-                              "include/python$(version)m"))
-
-                           (invoke "./bootstrap.sh"
-                                   (string-append "--prefix=" out)
-                                   ;; Auto-detection looks for dependencies only
-                                   ;; in traditional install locations.
-                                   (string-append "--with-icu=" icu)
-                                   (string-append "--with-python=" python "/bin/python3")
-                                   (string-append "--with-python-root=" python)
-                                   (string-append "--with-python-version=" python-version)
-                                   "--with-toolset=gcc"))))
-                     (replace 'provide-libboost_python
-                       (lambda* (#:key inputs outputs #:allow-other-keys)
-                         (let* ((out (assoc-ref outputs "out"))
-                                (python (assoc-ref inputs "python"))
-                                (python-version (python:python-version python))
-                                (libboost.so
-                                 (string-append "libboost_python"
-                                                (string-join
-                                                 (string-split python-version #\.) "")
-                                                ".so")))
-                           (with-directory-excursion (string-append out "/lib")
-                             (symlink libboost.so "libboost_python.so")
-                             ;; Some packages also look for libboost_python3.so
-                             (symlink libboost.so "libboost_python3.so"))
-                           #t)))))))))
-
 (define-public boost-static
   (package
     (inherit boost)
-- 
2.24.0


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0001-gnu-boost-with-python3-Parameterize-python-version.patch --]
[-- Type: text/x-diff; name=0001-gnu-boost-with-python3-Parameterize-python-version.patch, Size: 3937 bytes --]

From be296d145dbe712e9b84bf80bcefeb8e24418662 Mon Sep 17 00:00:00 2001
From: Giacomo Leidi <goodoldpaul@autistici.org>
Date: Sun, 8 Dec 2019 21:47:51 +0100
Subject: [PATCH 1/2] gnu: boost-with-python3: Parameterize python version.

* gnu/packages/boost.scm (boost-with-python3):
[arguments]: Parameterize python version.
---
 gnu/packages/boost.scm | 31 +++++++++++++++++++++++--------
 1 file changed, 23 insertions(+), 8 deletions(-)

diff --git a/gnu/packages/boost.scm b/gnu/packages/boost.scm
index 0a2a5c5c01..f436d5b688 100644
--- a/gnu/packages/boost.scm
+++ b/gnu/packages/boost.scm
@@ -139,13 +139,21 @@ across a broad spectrum of applications.")
        ("python" ,python)
        ("tcsh" ,tcsh)))
     (arguments (substitute-keyword-arguments (package-arguments boost)
+                 ((#:imported-modules _ '())
+                  `((guix build python-build-system)
+                    ,@%gnu-build-system-modules))
+                 ((#:modules _ '())
+                  '((guix build gnu-build-system)
+                    ((guix build python-build-system) #:prefix python:)
+                    (guix build utils)))
                  ((#:phases phases)
                   `(modify-phases ,phases
                      (replace 'configure
                        (lambda* (#:key inputs outputs #:allow-other-keys)
-                         (let ((icu (assoc-ref inputs "icu4c"))
-                               (python (assoc-ref inputs "python"))
-                               (out (assoc-ref outputs "out")))
+                         (let* ((icu (assoc-ref inputs "icu4c"))
+                                (python (assoc-ref inputs "python"))
+                                (python-version (python:python-version python))
+                                (out (assoc-ref outputs "out")))
                            (substitute* '("libs/config/configure"
                                           "libs/spirit/classic/phoenix/test/runtest.sh"
                                           "tools/build/src/engine/execunix.c"
@@ -167,15 +175,22 @@ across a broad spectrum of applications.")
                                    (string-append "--with-icu=" icu)
                                    (string-append "--with-python=" python "/bin/python3")
                                    (string-append "--with-python-root=" python)
-                                   "--with-python-version=3.7"
+                                   (string-append "--with-python-version=" python-version)
                                    "--with-toolset=gcc"))))
                      (replace 'provide-libboost_python
-                       (lambda* (#:key outputs #:allow-other-keys)
-                         (let ((out (assoc-ref outputs "out")))
+                       (lambda* (#:key inputs outputs #:allow-other-keys)
+                         (let* ((out (assoc-ref outputs "out"))
+                                (python (assoc-ref inputs "python"))
+                                (python-version (python:python-version python))
+                                (libboost.so
+                                 (string-append "libboost_python"
+                                                (string-join
+                                                 (string-split python-version #\.) "")
+                                                ".so")))
                            (with-directory-excursion (string-append out "/lib")
-                             (symlink "libboost_python37.so" "libboost_python.so")
+                             (symlink libboost.so "libboost_python.so")
                              ;; Some packages also look for libboost_python3.so
-                             (symlink "libboost_python37.so" "libboost_python3.so"))
+                             (symlink libboost.so "libboost_python3.so"))
                            #t)))))))))
 
 (define-public boost-static
-- 
2.24.0