import: pypi: Do not parse optional requirements from source.

* guix/import/pypi.scm: Export PARSE-REQUIRES.TXT.
(clean-requirement): Move procedure to the top level.
(guess-requirements): Move the READ-REQUIREMENTS procedure to the top level,
and rename it to PARSE-REQUIRES.TXT.  Move the CLEAN-REQUIREMENT procedure to
the top level.  Move the COMMENT? functions inside the PARSE-REQUIRES.TXT
procedure.
(parse-requires.txt): Add a SECTION-HEADER? predicate, and use it to prevent
parsing optional requirements.

* tests/pypi.scm (test-requires-with-sections): New variable.
("parse-requires.txt, with sections"): New test.
This commit is contained in:
Maxim Cournoyer 2019-03-28 00:26:00 -04:00
parent a853acebe1
commit c4797121be
No known key found for this signature in database
GPG key ID: 1260E46482E63562
2 changed files with 58 additions and 30 deletions

View file

@ -47,7 +47,8 @@ (define-module (guix import pypi)
#:use-module (guix upstream)
#:use-module ((guix licenses) #:prefix license:)
#:use-module (guix build-system python)
#:export (guix-package->pypi-name
#:export (parse-requires.txt
guix-package->pypi-name
pypi-recursive-import
pypi->guix-package
%pypi-updater))
@ -117,6 +118,47 @@ (define (maybe-inputs package-inputs)
((package-inputs ...)
`((propagated-inputs (,'quasiquote ,package-inputs))))))
(define (clean-requirement s)
;; Given a requirement LINE, as can be found in a setuptools requires.txt
;; file, remove everything other than the actual name of the required
;; package, and return it.
(cond
((string-index s (char-set #\space #\> #\= #\<)) => (cut string-take s <>))
(else s)))
(define (parse-requires.txt requires.txt)
"Given REQUIRES.TXT, a Setuptools requires.txt file, return a list of
requirement names."
;; This is a very incomplete parser, whose job is to select the non-optional
;; dependencies and strip them out of any version information.
;; Alternatively, we could implement a PEG parser with the (ice-9 peg)
;; library and the requirements grammar defined by PEP-0508
;; (https://www.python.org/dev/peps/pep-0508/).
(define (comment? line)
;; Return #t if the given LINE is a comment, #f otherwise.
(string-prefix? "#" (string-trim line)))
(define (section-header? line)
;; Return #t if the given LINE is a section header, #f otherwise.
(string-prefix? "[" (string-trim line)))
(call-with-input-file requires.txt
(lambda (port)
(let loop ((result '()))
(let ((line (read-line port)))
;; Stop when a section is encountered, as sections contain optional
;; (extra) requirements. Non-optional requirements must appear
;; before any section is defined.
(if (or (eof-object? line) (section-header? line))
(reverse result)
(cond
((or (string-null? line) (comment? line))
(loop result))
(else
(loop (cons (clean-requirement line)
result))))))))))
(define (guess-requirements source-url wheel-url tarball)
"Given SOURCE-URL, WHEEL-URL and a TARBALL of the package, return a list
of the required packages specified in the requirements.txt file. TARBALL will
@ -139,34 +181,6 @@ (define (tarball-directory url)
cannot determine package dependencies"))
#f)))))
(define (clean-requirement s)
;; Given a requirement LINE, as can be found in a Python requirements.txt
;; file, remove everything other than the actual name of the required
;; package, and return it.
(string-take s
(or (string-index s (lambda (chr) (member chr '(#\space #\> #\= #\<))))
(string-length s))))
(define (comment? line)
;; Return #t if the given LINE is a comment, #f otherwise.
(eq? (string-ref (string-trim line) 0) #\#))
(define (read-requirements requirements-file)
;; Given REQUIREMENTS-FILE, a Python requirements.txt file, return a list
;; of name/variable pairs describing the requirements.
(call-with-input-file requirements-file
(lambda (port)
(let loop ((result '()))
(let ((line (read-line port)))
(if (eof-object? line)
result
(cond
((or (string-null? line) (comment? line))
(loop result))
(else
(loop (cons (clean-requirement line)
result))))))))))
(define (read-wheel-metadata wheel-archive)
;; Given WHEEL-ARCHIVE, a ZIP Python wheel archive, return the package's
;; requirements.
@ -212,7 +226,7 @@ (define (guess-requirements-from-source)
(current-output-port (%make-void-port "rw+")))
(system* "tar" "xf" tarball "-C" dir requires.txt))))
(if (zero? exit-code)
(read-requirements (string-append dir "/" requires.txt))
(parse-requires.txt (string-append dir "/" requires.txt))
(begin
(warning
(G_ "Failed to extract file: ~a from source.~%")

View file

@ -62,6 +62,14 @@ (define test-requires.txt "\
baz > 13.37
")
(define test-requires-with-sections "\
foo ~= 3
bar != 2
[test]
pytest (>=2.5.0)
")
(define test-metadata
"{
\"run_requires\": [
@ -101,6 +109,12 @@ (define test-metadata
(uri (list "https://bitheap.org/cram/cram-0.7.tar.gz"
(pypi-uri "cram" "0.7"))))))))
(test-equal "parse-requires.txt, with sections"
'("foo" "bar")
(mock ((ice-9 ports) call-with-input-file
call-with-input-string)
(parse-requires.txt test-requires-with-sections)))
(test-assert "pypi->guix-package"
;; Replace network resources with sample data.
(mock ((guix import utils) url-fetch