tribes/guix
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/guix.git synced 2026-04-06 21:20:33 +02:00
Code Activity

build: pyproject: set-version: Support more backends.

Browse Source 
hatch-vcs also uses the SETUPTOOLS_SCM_PRETEND_VERSION
environment variable, while poetry-dynamic-versioning uses
POETRY_DYNAMIC_VERSIONING_BYPASS.  versioneer, on the other hand,
read from the Python package's ._version.get_versions().

The version scheme for Python packaging is not the same as
(nor compatible with) that of semantic version,
hence stop mentioning the latter in the docstring and comments.

When no relevant Python build backend is detected, regardless
if the source has been obtained from a VCS checkout, it is confusing
to mention any of the backends as unnecessary as a native input.
Moreover, unlike the hatch-vcs, poetry-dynamic-versioning
and setuptools-scm that works transparently with the build backend,
pbr and versioneer are required for building.
The output of the set-version phase has been adjusted accordingly.

* guix/build/pyproject-build-system.scm (set-version):
  Add support for python-hatch-vcs.  Clarify docstring.
  Log the explicit reason for noop cases.

References: https://github.com/ofek/hatch-vcs#version-source-environment-variables
References: https://github.com/mtkennerly/poetry-dynamic-versioning#environment-variables
References: https://github.com/python-versioneer/python-versioneer
References: https://docs.openstack.org/pbr/latest/user/packagers.html#versioning
References: https://packaging.python.org/en/latest/specifications/version-specifiers

Change-Id: I8f499856cb6b026539c96fb828e450a40ba10b79
Reviewed-by: Nicolas Graves <ngraves@ngraves.fr>
Signed-off-by: Sharlatan Hellseher <sharlatanus@gmail.com>
This commit is contained in:
Nguyễn Gia Phong
2026-02-18 22:57:09 +09:00
committed by Sharlatan Hellseher
parent 44b1ef5971
commit cf95303a49
1 changed files with 67 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
guix/build/pyproject-build-system.scm
View File

@@ -1,6 +1,9 @@
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2021 Lars-Dominik Braun <lars@6xq.net>
;;; Copyright © 2021-2023 Lars-Dominik Braun <lars@6xq.net>
;;; Copyright © 2022 Marius Bakke <marius@gnu.org>
;;; Copyright © 2024-2025 Maxim Cournoyer <maxim@guixotic.coop>
;;; Copyright © 2024-2026 Nicolas Graves <ngraves@ngraves.fr>
;;; Copyright © 2026 Nguyễn Gia Phong <cnx@loang.net>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -32,6 +35,7 @@
#:use-module (srfi srfi-26)
#:use-module (srfi srfi-34)
#:use-module (srfi srfi-35)
#:use-module (srfi srfi-71)
#:export (%standard-phases
add-installed-pythonpath
ensure-no-mtimes-pre-1980
@@ -154,38 +158,70 @@ by Cython."
(find-files "." "\\.pyx$")))
(define* (set-version #:key name inputs #:allow-other-keys)
"Set the expect package version environment variable in Semantic Versioning
format when python-setuptools-scm or python-pbr is present."
"Provide the package version to Python build backend
that expects it to be derived from the version control information
that is not present in the source."
(define (extract-version name)
"Extract version from a name-version string."
;; Note: This fails if the package-name contains a dot.
(and-let* ((first-dot (or (string-index name #\.)
(string-length name)))
(prev-hyphen (string-rindex name #\- 0 first-dot)))
(substring name (+ prev-hyphen 1))))
;; The version scheme for public version identifiers of Python packages
;; is defined by PEP 440 and maintained by the Python Packaging Authority at
;; https://packaging.python.org/en/latest/specifications/version-specifiers
(define (public-version-identifier name)
"Extract the public version identifier from a name-version string."
(let ((_ version (package-name->name+version name)))
;; git-version et al suffix version with revision and commit.
(first (string-split version #\-))))
(let ((package (and=> (any (cute assoc <> inputs)
(list "python-setuptools-scm"
"python-setuptools-scm-bootstrap"
"python-pbr"))
car)))
;; Both git and hg use -checkout suffixes.
(if (and package (string-suffix? "-checkout" (assoc-ref inputs "source")))
(and-let* ((version (extract-version name))
;; version here can be semver-revision-commit.
(version (first (string-split version #\-))))
(match package
((or "python-setuptools-scm" "python-setuptools-scm-bootstrap")
(setenv "SETUPTOOLS_SCM_PRETEND_VERSION" version))
("python-pbr"
(setenv "PBR_VERSION" version))
(_ ;should never happen.
#f)))
;; Otherwise, it is probably from a wheel and doesn't require
;; the phase in the first place.
(format #t "The source doesn't seem to use version control, \
python-setuptools-scm is likely unnecessary as a native-input.~%"))))
(let ((version-backends (map (compose string->symbol car)
(filter-map
(cute assoc <> inputs)
'("python-hatch-vcs"
"python-hatch-vcs-bootstrap"
"python-pbr"
"python-poetry-dynamic-versioning"
"python-setuptools-scm"
"python-setuptools-scm-bootstrap"
"python-versioneer"))))
;; Both git and hg use -checkout suffixes.
(version (and (string-suffix? "-checkout" (assoc-ref inputs "source"))
(public-version-identifier name))))
(cond ((null? version-backends)
(format #t "Detected no Python build backend that expects")
(format #t " version control information, nothing to do.~%"))
(version
(for-each
(lambda (backend)
(case backend
((python-hatch-vcs python-hatch-vcs-bootstrap
python-setuptools-scm python-setuptools-scm-bootstrap)
(setenv "SETUPTOOLS_SCM_PRETEND_VERSION" version))
((python-pbr)
(setenv "PBR_VERSION" version))
((python-poetry-dynamic-versioning)
(setenv "POETRY_DYNAMIC_VERSIONING_BYPASS" version))
((python-versioneer)
(let ((bundled "versioneer.py"))
(when (file-exists? bundled)
(delete-file bundled)))
(setenv "GUIX_VERSIONEER_VERSION" version))
(else #f))) ;should never happen.
version-backends))
(else
(format #t "The source seems to be a Python package sdist")
(for-each
(lambda (backend)
(format #t (case backend
((python-hatch-vcs
python-hatch-vcs-bootstrap
python-poetry-dynamic-versioning
python-setuptools-scm
python-setuptools-scm-bootstrap)
", ~a is likely unnecessary as a native-input")
((python-pbr python-versioneer)
", nothing to do for ~a")
(else #f)) ;should never happen.
backend))
version-backends)
(format #t ".~%")))))
(define* (build #:key outputs build-backend backend-path configure-flags #:allow-other-keys)
"Build a given Python package."