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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
# -*- coding: utf-8 -*-
"""
Sage Packages
"""
# ****************************************************************************
# Copyright (C) 2015 Volker Braun <vbraun.name@gmail.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
# http://www.gnu.org/licenses/
# ****************************************************************************
import re
import os
import logging
from sage_bootstrap.env import SAGE_ROOT
log = logging.getLogger()
class Package(object):
def __init__(self, package_name):
"""
Sage Package
A package is defined by a subdirectory of
``SAGE_ROOT/build/pkgs/``. The name of the package is the name
of the subdirectory; The metadata of the package is contained
in various files in the package directory. This class provides
an abstraction to the metadata, you should never need to
access the package directory directly.
INPUT:
-- ``package_name`` -- string. Name of the package. The Sage
convention is that all package names are lower case.
"""
self.__name = package_name
self.__tarball = None
self._init_checksum()
self._init_version()
self._init_type()
def __repr__(self):
return 'Package {0}'.format(self.name)
@property
def name(self):
"""
Return the package name
A package is defined by a subdirectory of
``SAGE_ROOT/build/pkgs/``. The name of the package is the name
of the subdirectory.
OUTPUT:
String.
"""
return self.__name
@property
def md5(self):
"""
Return the MD5 checksum
Do not use, this is ancient! Use :meth:`sha1` instead.
OUTPUT:
String.
"""
return self.__md5
@property
def sha1(self):
"""
Return the SHA1 checksum
OUTPUT:
String.
"""
return self.__sha1
@property
def cksum(self):
"""
Return the Ck sum checksum
Do not use, this is ancient! Use :meth:`sha1` instead.
OUTPUT:
String.
"""
return self.__cksum
@property
def tarball(self):
"""
Return the (primary) tarball
If there are multiple tarballs (currently unsupported), this
property returns the one that is unpacked automatically.
OUTPUT:
Instance of :class:`sage_bootstrap.tarball.Tarball`
"""
if self.__tarball is None:
from sage_bootstrap.tarball import Tarball
self.__tarball = Tarball(self.tarball_filename, package=self)
return self.__tarball
@property
def tarball_pattern(self):
"""
Return the (primary) tarball file pattern
If there are multiple tarballs (currently unsupported), this
property returns the one that is unpacked automatically.
OUTPUT:
String. The full-qualified tarball filename, but with
``VERSION`` instead of the actual tarball filename.
"""
return self.__tarball_pattern
@property
def tarball_filename(self):
"""
Return the (primary) tarball filename
If there are multiple tarballs (currently unsupported), this
property returns the one that is unpacked automatically.
OUTPUT:
String. The full-qualified tarball filename.
"""
pattern = self.tarball_pattern
if pattern:
return pattern.replace('VERSION', self.version)
else:
return None
@property
def tarball_upstream_url_pattern(self):
"""
Return the tarball upstream URL pattern
OUTPUT:
String. The tarball upstream URL, but with the placeholder
``VERSION``.
"""
return self.__tarball_upstream_url_pattern
@property
def tarball_upstream_url(self):
"""
Return the tarball upstream URL or ``None`` if none is recorded
OUTPUT:
String. The URL.
"""
pattern = self.tarball_upstream_url_pattern
if pattern:
return pattern.replace('VERSION', self.version)
else:
return None
@property
def tarball_package(self):
"""
Return the canonical package for the tarball
This is almost always equal to ``self`` except if the package
or the ``checksums.ini`` file is a symbolic link. In that case,
the package of the symbolic link is returned.
OUTPUT:
A ``Package`` instance
"""
n = self.__tarball_package_name
if n == self.name:
return self
else:
return type(self)(n)
@property
def version(self):
"""
Return the version
OUTPUT:
String. The package version. Excludes the Sage-specific
patchlevel.
"""
return self.__version
@property
def patchlevel(self):
"""
Return the patchlevel
OUTPUT:
Integer. The patchlevel of the package. Excludes the "p"
prefix.
"""
return self.__patchlevel
@property
def type(self):
"""
Return the package type
"""
return self.__type
def __eq__(self, other):
return self.tarball == other.tarball
@classmethod
def all(cls):
"""
Return all packages
"""
base = os.path.join(SAGE_ROOT, 'build', 'pkgs')
for subdir in os.listdir(base):
path = os.path.join(base, subdir)
if not os.path.isfile(os.path.join(path, "type")):
log.debug('%s has no type', subdir)
continue
try:
yield cls(subdir)
except BaseException:
log.error('Failed to open %s', subdir)
raise
@property
def path(self):
"""
Return the package directory
"""
return os.path.join(SAGE_ROOT, 'build', 'pkgs', self.name)
def has_file(self, filename):
"""
Return whether the file exists in the package directory
"""
return os.path.exists(os.path.join(self.path, filename))
def _init_checksum(self):
"""
Load the checksums from the appropriate ``checksums.ini`` file
"""
checksums_ini = os.path.join(self.path, 'checksums.ini')
assignment = re.compile('(?P<var>[a-zA-Z0-9_]*)=(?P<value>.*)')
result = dict()
try:
with open(checksums_ini, 'rt') as f:
for line in f.readlines():
match = assignment.match(line)
if match is None:
continue
var, value = match.groups()
result[var] = value
except IOError:
pass
self.__md5 = result.get('md5', None)
self.__sha1 = result.get('sha1', None)
self.__cksum = result.get('cksum', None)
self.__tarball_pattern = result.get('tarball', None)
self.__tarball_upstream_url_pattern = result.get('upstream_url', None)
# Name of the directory containing the checksums.ini file
self.__tarball_package_name = os.path.realpath(checksums_ini).split(os.sep)[-2]
VERSION_PATCHLEVEL = re.compile('(?P<version>.*)\.p(?P<patchlevel>[0-9]+)')
def _init_version(self):
try:
with open(os.path.join(self.path, 'package-version.txt')) as f:
package_version = f.read().strip()
except IOError:
self.__version = None
self.__patchlevel = None
else:
match = self.VERSION_PATCHLEVEL.match(package_version)
if match is None:
self.__version = package_version
self.__patchlevel = -1
else:
self.__version = match.group('version')
self.__patchlevel = int(match.group('patchlevel'))
def _init_type(self):
with open(os.path.join(self.path, 'type')) as f:
package_type = f.read().strip()
assert package_type in [
'base', 'standard', 'optional', 'experimental'
]
self.__type = package_type
|
