aboutsummaryrefslogtreecommitdiff
path: root/pypi/requirement.scm
blob: fc1bb870a9bb83f1e83e0a659e070d7c64440448 (plain)
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
(define-module (pypi requirement)
  #:use-module (pyguile)
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-9)
  #:use-module (srfi srfi-9 gnu)
  #:use-module (srfi srfi-13)
  #:use-module (ice-9 pretty-print)
  #:use-module (guix records)
  #:use-module (guix combinators)
  #:use-module (pypi version)
  #:export (requirement
            requirement?
            requirement-name
            requirement-specifiers
            requirement-extras
            requirement-markers
            requirement-run-tests

            unsatisfied-requirements-error
            normalise-requirement-name
            requirement-satisfied-by?

            requirement->string

            get-quoted-requirement
            version-meets-requirement
            get-version-best-matching-requirement

            requirement-string->requirement
            requirement-tuple->quoted-requirement
            requirement-tuple->requirement
            requirement-string->quoted-requirement
            filter-requirements-by-extras))

(define unsatisfied-requirements-error 'unsatisfied-requirements-error)

(define-record-type* <requirement>
  requirement make-requirement
  requirement?
  (name  requirement-name)
  (specifiers  requirement-specifiers (default ""))
  (extras  requirement-extras (default '()))
  (markers  requirement-markers (default '()))
  (run-tests  requirement-run-tests (default #t)))

(set-record-type-printer! <requirement>
  (lambda (record port)
    (display (requirement->string record) port)))

(define (get-quoted-requirement r)
  (fold
    (lambda (f d) (f d))
    `(requirement
       (name ,(requirement-name r)))
    `(,(lambda
       (d)
       (if (string-null? (requirement-specifiers r))
           d
           (append d `((specifiers ,(requirement-specifiers r))))))
      ,(lambda
       (d)
       (if (null? (requirement-extras r))
           d
           (append d `((extras (quote ,(requirement-extras r)))))))
     ,(lambda
       (d)
       (if (null? (requirement-markers r))
           d
           (append d `((markers (quote ,(requirement-markers r))))))))))

(define (requirement-satisfied-by? r name version)
  (and
    (equal?
      (normalise-requirement-name name)
      (normalise-requirement-name (requirement-name r)))
    (version-meets-requirement r version)))

(define (version-meets-requirement r version)
  (begin
    (python-import "packaging.requirements")
    (python-import "packaging.version")
    (let* ((contains (python-eval "lambda r, v: r.specifier.contains(v)" #t))
           (pyr (python-apply '(packaging requirements Requirement)
                              (list
                                (string-append
                                  (requirement-name r)
                                  (requirement-specifiers r)))
                              '()))
           (pyv (python-apply '(packaging version parse)
                              (list version)
                              '()))
           (result
             (python-apply (list contains) (list pyr pyv) '())))
      result)))

(define (get-version-best-matching-requirement r versions)
  (find
    (lambda (v) (version-meets-requirement r v))
    (sort-versions versions)))

(define (filter-versions-by-requirement r versions)
  (filter
    (lambda (v) (version-meets-requirement r v))
    versions))

(define (filter-requirements-by-extras reqs extras)
  (filter (lambda (r)
                  (if (> (length (requirement-extras r)) 0)
                      ; If an extra is specified in the requirement, only
                      ; include the dependency if a matching extra is given
                      (> (length (lset-intersection equal?
                                                    extras
                                                    (requirement-extras r)))
                         0)
                      #t)) ; If the requirement does not specify extras, it is valid regardless
          reqs))

(define (requirement-tuple->quoted-requirement t)
  (requirement->quoted-requirement
    (requirement-tuple->requirement t)))

(define (validate-requirement r)
  (or
    (string? (requirement-name r))
    (error "requirement name is not a string " (requirement-name r)))
  (or
    (list? (requirement-markers r))
    (error "requirement markers are not a list " (requirement-markers r)))
  (or
    (list? (requirement-extras r))
    (error "requirement extras are not a list " (requirement-extras r)))
  r)

(define (requirement-tuple->requirement t)
  (validate-requirement
    (requirement
       (name (first t))
       (specifiers (second t))
       (extras (third t))
       (markers (fourth t)))))

(define (requirement->string r)
  (string-append
    (requirement-name r)
    (if (null? (requirement-extras r))
      ""
      (apply
        string-append
        (list
          "["
          (string-join
            (requirement-extras r)
            ",")
          "]")))
    (requirement-specifiers r)))

(define (requirement-string->quoted-requirement requirement-string)
  (requirement->quoted-requirement
    (requirement-string->requirement
      requirement-string)))

(define (requirement->quoted-requirement r)
  `(requirement
     (name ,(requirement-name r))
     (specifiers ,(requirement-specifiers r))
     (extras ,(requirement-extras r))
     (markers ,(requirement-markers r))))

(define (requirement-string->requirement requirement-string)
  (begin
    (python-import "packaging.requirements")
    (python-import "packaging.version")
    (let* ((pyr (python-apply '(packaging requirements Requirement)
                              (list requirement-string)
                              '()))
           (name (python-apply '("__builtin__" "getattr")
                               (list pyr "name")
                               '()))
           (specifier (python-apply '("__builtin__" "getattr")
                               (list pyr "specifier")
                               '()))
           (specifiers (python-apply '("__builtin__" "str")
                                     (list specifier)
                                     '()))
           (extras (let
                     ((f (python-eval "lambda pyr: list(pyr.extras)" #t)))
                     (python-apply
                       f
                       (list pyr)
                       '())))
           (markers (python-apply '("__builtin__" "getattr")
                               (list pyr "marker")
                               '())))
          (validate-requirement
            (requirement
              (name name)
              (specifiers specifiers)
              (extras extras)
              (markers markers))))))

(define normalise-requirement-name
  (memoize
    (lambda (name)
      (python-eval "from pkg_resources import to_filename, safe_name")
      (let*
        ((f (python-eval
              "lambda n: to_filename(safe_name(n))"
              #t)))
        (string-downcase
          (python-apply f (list name) '()))))))