1
-
2
1
# This file helps to compute a version number in source trees obtained from
3
2
# git-archive tarball (such as those provided by githubs download-from-tag
4
3
# feature). Distribution tarballs (built by setup.py sdist) and build
@@ -58,28 +57,32 @@ class NotThisMethod(Exception):
58
57
59
58
def register_vcs_handler (vcs , method ): # decorator
60
59
"""Decorator to mark a method as the handler for a particular VCS."""
60
+
61
61
def decorate (f ):
62
62
"""Store f in HANDLERS[vcs][method]."""
63
63
if vcs not in HANDLERS :
64
64
HANDLERS [vcs ] = {}
65
65
HANDLERS [vcs ][method ] = f
66
66
return f
67
+
67
68
return decorate
68
69
69
70
70
- def run_command (commands , args , cwd = None , verbose = False , hide_stderr = False ,
71
- env = None ):
71
+ def run_command (commands , args , cwd = None , verbose = False , hide_stderr = False , env = None ):
72
72
"""Call the given command(s)."""
73
73
assert isinstance (commands , list )
74
74
p = None
75
75
for c in commands :
76
76
try :
77
77
dispcmd = str ([c ] + args )
78
78
# remember shell=False, so use git.cmd on windows, not just git
79
- p = subprocess .Popen ([c ] + args , cwd = cwd , env = env ,
80
- stdout = subprocess .PIPE ,
81
- stderr = (subprocess .PIPE if hide_stderr
82
- else None ))
79
+ p = subprocess .Popen (
80
+ [c ] + args ,
81
+ cwd = cwd ,
82
+ env = env ,
83
+ stdout = subprocess .PIPE ,
84
+ stderr = (subprocess .PIPE if hide_stderr else None ),
85
+ )
83
86
break
84
87
except EnvironmentError :
85
88
e = sys .exc_info ()[1 ]
@@ -116,16 +119,19 @@ def versions_from_parentdir(parentdir_prefix, root, verbose):
116
119
for i in range (3 ):
117
120
dirname = os .path .basename (root )
118
121
if dirname .startswith (parentdir_prefix ):
119
- return {"version" : dirname [len (parentdir_prefix ):],
120
- "full-revisionid" : None ,
121
- "dirty" : False , "error" : None , "date" : None }
122
+ return {
123
+ "version" : dirname [len (parentdir_prefix ) :],
124
+ "full-revisionid" : None ,
125
+ "dirty" : False ,
126
+ "error" : None ,
127
+ "date" : None ,
128
+ }
122
129
else :
123
130
rootdirs .append (root )
124
131
root = os .path .dirname (root ) # up a level
125
132
126
133
if verbose :
127
- print ("Tried directories %s but none started with prefix %s" %
128
- (str (rootdirs ), parentdir_prefix ))
134
+ print ("Tried directories %s but none started with prefix %s" % (str (rootdirs ), parentdir_prefix ))
129
135
raise NotThisMethod ("rootdir doesn't start with parentdir_prefix" )
130
136
131
137
@@ -181,7 +187,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
181
187
# starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
182
188
# just "foo-1.0". If we see a "tag: " prefix, prefer those.
183
189
TAG = "tag: "
184
- tags = set ([r [len (TAG ):] for r in refs if r .startswith (TAG )])
190
+ tags = set ([r [len (TAG ) :] for r in refs if r .startswith (TAG )])
185
191
if not tags :
186
192
# Either we're using git < 1.8.3, or there really are no tags. We use
187
193
# a heuristic: assume all version tags have a digit. The old git %d
@@ -190,27 +196,34 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
190
196
# between branches and tags. By ignoring refnames without digits, we
191
197
# filter out many common branch names like "release" and
192
198
# "stabilization", as well as "HEAD" and "master".
193
- tags = set ([r for r in refs if re .search (r'\d' , r )])
199
+ tags = set ([r for r in refs if re .search (r"\d" , r )])
194
200
if verbose :
195
201
print ("discarding '%s', no digits" % "," .join (refs - tags ))
196
202
if verbose :
197
203
print ("likely tags: %s" % "," .join (sorted (tags )))
198
204
for ref in sorted (tags ):
199
205
# sorting will prefer e.g. "2.0" over "2.0rc1"
200
206
if ref .startswith (tag_prefix ):
201
- r = ref [len (tag_prefix ):]
207
+ r = ref [len (tag_prefix ) :]
202
208
if verbose :
203
209
print ("picking %s" % r )
204
- return {"version" : r ,
205
- "full-revisionid" : keywords ["full" ].strip (),
206
- "dirty" : False , "error" : None ,
207
- "date" : date }
210
+ return {
211
+ "version" : r ,
212
+ "full-revisionid" : keywords ["full" ].strip (),
213
+ "dirty" : False ,
214
+ "error" : None ,
215
+ "date" : date ,
216
+ }
208
217
# no suitable tags, so version is "0+unknown", but full hex is still there
209
218
if verbose :
210
219
print ("no suitable tags, using unknown + full revision id" )
211
- return {"version" : "0+unknown" ,
212
- "full-revisionid" : keywords ["full" ].strip (),
213
- "dirty" : False , "error" : "no suitable tags" , "date" : None }
220
+ return {
221
+ "version" : "0+unknown" ,
222
+ "full-revisionid" : keywords ["full" ].strip (),
223
+ "dirty" : False ,
224
+ "error" : "no suitable tags" ,
225
+ "date" : None ,
226
+ }
214
227
215
228
216
229
@register_vcs_handler ("git" , "pieces_from_vcs" )
@@ -225,19 +238,17 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
225
238
if sys .platform == "win32" :
226
239
GITS = ["git.cmd" , "git.exe" ]
227
240
228
- out , rc = run_command (GITS , ["rev-parse" , "--git-dir" ], cwd = root ,
229
- hide_stderr = True )
241
+ out , rc = run_command (GITS , ["rev-parse" , "--git-dir" ], cwd = root , hide_stderr = True )
230
242
if rc != 0 :
231
243
if verbose :
232
244
print ("Directory %s not under git control" % root )
233
245
raise NotThisMethod ("'git rev-parse --git-dir' returned error" )
234
246
235
247
# if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty]
236
248
# if there isn't one, this yields HEX[-dirty] (no NUM)
237
- describe_out , rc = run_command (GITS , ["describe" , "--tags" , "--dirty" ,
238
- "--always" , "--long" ,
239
- "--match" , "%s*" % tag_prefix ],
240
- cwd = root )
249
+ describe_out , rc = run_command (
250
+ GITS , ["describe" , "--tags" , "--dirty" , "--always" , "--long" , "--match" , "%s*" % tag_prefix ], cwd = root
251
+ )
241
252
# --long was added in git-1.5.5
242
253
if describe_out is None :
243
254
raise NotThisMethod ("'git describe' failed" )
@@ -260,17 +271,16 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
260
271
dirty = git_describe .endswith ("-dirty" )
261
272
pieces ["dirty" ] = dirty
262
273
if dirty :
263
- git_describe = git_describe [:git_describe .rindex ("-dirty" )]
274
+ git_describe = git_describe [: git_describe .rindex ("-dirty" )]
264
275
265
276
# now we have TAG-NUM-gHEX or HEX
266
277
267
278
if "-" in git_describe :
268
279
# TAG-NUM-gHEX
269
- mo = re .search (r' ^(.+)-(\d+)-g([0-9a-f]+)$' , git_describe )
280
+ mo = re .search (r" ^(.+)-(\d+)-g([0-9a-f]+)$" , git_describe )
270
281
if not mo :
271
282
# unparseable. Maybe git-describe is misbehaving?
272
- pieces ["error" ] = ("unable to parse git-describe output: '%s'"
273
- % describe_out )
283
+ pieces ["error" ] = "unable to parse git-describe output: '%s'" % describe_out
274
284
return pieces
275
285
276
286
# tag
@@ -279,10 +289,9 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
279
289
if verbose :
280
290
fmt = "tag '%s' doesn't start with prefix '%s'"
281
291
print (fmt % (full_tag , tag_prefix ))
282
- pieces ["error" ] = ("tag '%s' doesn't start with prefix '%s'"
283
- % (full_tag , tag_prefix ))
292
+ pieces ["error" ] = "tag '%s' doesn't start with prefix '%s'" % (full_tag , tag_prefix )
284
293
return pieces
285
- pieces ["closest-tag" ] = full_tag [len (tag_prefix ):]
294
+ pieces ["closest-tag" ] = full_tag [len (tag_prefix ) :]
286
295
287
296
# distance: number of commits since tag
288
297
pieces ["distance" ] = int (mo .group (2 ))
@@ -293,13 +302,11 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
293
302
else :
294
303
# HEX: no tags
295
304
pieces ["closest-tag" ] = None
296
- count_out , rc = run_command (GITS , ["rev-list" , "HEAD" , "--count" ],
297
- cwd = root )
305
+ count_out , rc = run_command (GITS , ["rev-list" , "HEAD" , "--count" ], cwd = root )
298
306
pieces ["distance" ] = int (count_out ) # total number of commits
299
307
300
308
# commit date: see ISO-8601 comment in git_versions_from_keywords()
301
- date = run_command (GITS , ["show" , "-s" , "--format=%ci" , "HEAD" ],
302
- cwd = root )[0 ].strip ()
309
+ date = run_command (GITS , ["show" , "-s" , "--format=%ci" , "HEAD" ], cwd = root )[0 ].strip ()
303
310
pieces ["date" ] = date .strip ().replace (" " , "T" , 1 ).replace (" " , "" , 1 )
304
311
305
312
return pieces
@@ -330,8 +337,7 @@ def render_pep440(pieces):
330
337
rendered += ".dirty"
331
338
else :
332
339
# exception #1
333
- rendered = "0+untagged.%d.g%s" % (pieces ["distance" ],
334
- pieces ["short" ])
340
+ rendered = "0+untagged.%d.g%s" % (pieces ["distance" ], pieces ["short" ])
335
341
if pieces ["dirty" ]:
336
342
rendered += ".dirty"
337
343
return rendered
@@ -445,11 +451,13 @@ def render_git_describe_long(pieces):
445
451
def render (pieces , style ):
446
452
"""Render the given version pieces into the requested style."""
447
453
if pieces ["error" ]:
448
- return {"version" : "unknown" ,
449
- "full-revisionid" : pieces .get ("long" ),
450
- "dirty" : None ,
451
- "error" : pieces ["error" ],
452
- "date" : None }
454
+ return {
455
+ "version" : "unknown" ,
456
+ "full-revisionid" : pieces .get ("long" ),
457
+ "dirty" : None ,
458
+ "error" : pieces ["error" ],
459
+ "date" : None ,
460
+ }
453
461
454
462
if not style or style == "default" :
455
463
style = "pep440" # the default
@@ -469,9 +477,13 @@ def render(pieces, style):
469
477
else :
470
478
raise ValueError ("unknown style '%s'" % style )
471
479
472
- return {"version" : rendered , "full-revisionid" : pieces ["long" ],
473
- "dirty" : pieces ["dirty" ], "error" : None ,
474
- "date" : pieces .get ("date" )}
480
+ return {
481
+ "version" : rendered ,
482
+ "full-revisionid" : pieces ["long" ],
483
+ "dirty" : pieces ["dirty" ],
484
+ "error" : None ,
485
+ "date" : pieces .get ("date" ),
486
+ }
475
487
476
488
477
489
def get_versions ():
@@ -485,8 +497,7 @@ def get_versions():
485
497
verbose = cfg .verbose
486
498
487
499
try :
488
- return git_versions_from_keywords (get_keywords (), cfg .tag_prefix ,
489
- verbose )
500
+ return git_versions_from_keywords (get_keywords (), cfg .tag_prefix , verbose )
490
501
except NotThisMethod :
491
502
pass
492
503
@@ -495,13 +506,16 @@ def get_versions():
495
506
# versionfile_source is the relative path from the top of the source
496
507
# tree (where the .git directory might live) to this file. Invert
497
508
# this to find the root from __file__.
498
- for i in cfg .versionfile_source .split ('/' ):
509
+ for i in cfg .versionfile_source .split ("/" ):
499
510
root = os .path .dirname (root )
500
511
except NameError :
501
- return {"version" : "0+unknown" , "full-revisionid" : None ,
502
- "dirty" : None ,
503
- "error" : "unable to find root of source tree" ,
504
- "date" : None }
512
+ return {
513
+ "version" : "0+unknown" ,
514
+ "full-revisionid" : None ,
515
+ "dirty" : None ,
516
+ "error" : "unable to find root of source tree" ,
517
+ "date" : None ,
518
+ }
505
519
506
520
try :
507
521
pieces = git_pieces_from_vcs (cfg .tag_prefix , root , verbose )
@@ -515,6 +529,10 @@ def get_versions():
515
529
except NotThisMethod :
516
530
pass
517
531
518
- return {"version" : "0+unknown" , "full-revisionid" : None ,
519
- "dirty" : None ,
520
- "error" : "unable to compute version" , "date" : None }
532
+ return {
533
+ "version" : "0+unknown" ,
534
+ "full-revisionid" : None ,
535
+ "dirty" : None ,
536
+ "error" : "unable to compute version" ,
537
+ "date" : None ,
538
+ }
0 commit comments