forked from altitudenetworks/newversion
-
Notifications
You must be signed in to change notification settings - Fork 2
/
version.py
464 lines (389 loc) · 13.5 KB
/
version.py
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
"""
Extended `packaging.version.Version` implementation.
"""
from typing import Any, Dict, Optional, Tuple, Type, TypeVar, Union
import packaging.version
from newversion.constants import VersionParts
from newversion.type_defs import (
BaseVersion,
PrereleaseLooseTypeDef,
PrereleaseTypeDef,
ReleaseMainPostTypeDef,
ReleaseMainTypeDef,
)
_R = TypeVar("_R", bound="Version")
class VersionError(packaging.version.InvalidVersion):
"""
Wrapper for InvalidVersion error.
"""
class Version(packaging.version.Version):
"""
Extended `packaging.version.Version` implementation.
"""
def __init__(self, version: str) -> None:
try:
super().__init__(version)
except packaging.version.InvalidVersion as e:
raise VersionError(e)
@classmethod
def zero(cls: Type[_R]) -> _R:
"""
Get zero version `0.0.0`
"""
return cls("0.0.0")
def dumps(self) -> str:
"""
Render to string.
"""
return str(self)
@property
def prerelease_type(self) -> Optional[PrereleaseTypeDef]:
if not self.pre:
return None
letter = self.pre[0]
if letter == "rc":
return VersionParts.RC
if letter == "a":
return VersionParts.ALPHA
if letter == "b":
return VersionParts.BETA
return None
@property
def base(self) -> BaseVersion:
"""
Underlying version NamedTuple.
"""
return self._version
@base.setter
def base(self, base: BaseVersion) -> None:
self._version = base
def copy(self: _R) -> _R:
"""
Create a copy of a current version instance.
"""
return self.__class__(self.dumps())
def _replace(self: _R, base: BaseVersion) -> _R:
new_version = self.copy()
new_version.base = base
return new_version.copy()
def bump_release(
self: _R,
release_type: ReleaseMainTypeDef = "micro",
inc: int = 1,
) -> _R:
"""
Get next release version.
Arguments:
release_type -- Release type: major, minor, micro.
inc -- Increment for major version.
Examples:
```python
Version("1.2.3").bump_release() # "1.2.4"
Version("1.2.3").bump_release("major") # "2.0.0"
Version("1.2.3.dev14").bump_release("minor", 2) # "1.4.0"
```
Returns:
A new copy.
"""
if release_type == VersionParts.MAJOR:
return self.bump_major(inc)
if release_type == VersionParts.MINOR:
return self.bump_minor(inc)
return self.bump_micro(inc)
def bump_major(self: _R, inc: int = 1) -> _R:
"""
Get next major version.
Arguments:
inc -- Increment for major version.
Examples:
```python
Version("1.2.3").bump_major() # "2.0.0"
Version("1.2.3.dev14").bump_major() # "2.0.0"
Version("1.2.3a5").bump_major() # "2.0.0"
Version("1.2.3rc3").bump_major(2) # "3.0.0"
Version("1.2.3rc3").bump_major(0) # "1.0.0"
```
Returns:
A new copy.
"""
if not self.is_stable and self.minor == 0 and self.micro == 0:
return self.get_stable().bump_major(inc - 1)
return self._replace(
BaseVersion(
epoch=0,
release=(self.major + inc, 0, 0),
pre=None,
post=None,
dev=None,
local=None,
)
)
def bump_minor(self: _R, inc: int = 1) -> _R:
"""
Get next minor version.
Arguments:
inc -- Increment for minor version.
Examples:
```python
Version("1.2.3").bump_minor() # "1.3.0"
Version("1.2.3.dev14").bump_minor() # "1.3.0"
Version("1.2.3a5").bump_minor() # "1.3.0"
Version("1.2.3rc3").bump_minor(2) # "1.4.0"
Version("1.2.3rc3").bump_minor(0) # "1.2.0"
Version("1.3.0rc3").bump_minor() # "1.3.0"
Version("1.3.0rc3").bump_minor(2) # "1.4.0"
```
Returns:
A new copy.
"""
if not self.is_stable and self.micro == 0:
return self.get_stable().bump_minor(inc - 1)
return self._replace(
BaseVersion(
epoch=0,
release=(self.major, self.minor + inc, 0),
pre=None,
post=None,
dev=None,
local=None,
)
)
def bump_micro(self: _R, inc: int = 1) -> _R:
"""
Get next micro version.
Arguments:
inc -- Increment for micro version.
Examples:
```python
Version("1.2.3").bump_micro() # "1.2.4"
Version("1.2.3.dev14").bump_micro() # "1.2.4"
Version("1.2.3a5").bump_micro() # "1.2.4"
Version("1.2.3rc3").bump_micro(2) # "1.2.5"
Version("1.2.3rc3").bump_micro(0) # "1.2.3"
```
Returns:
A new copy.
"""
if not self.is_stable:
return self.get_stable().bump_micro(inc - 1)
return self._replace(
BaseVersion(
epoch=0,
release=(self.major, self.minor, self.micro + inc),
pre=None,
post=None,
dev=None,
local=None,
)
)
def bump_dev(
self: _R,
inc: int = 1,
bump_release: ReleaseMainPostTypeDef = "micro",
) -> _R:
"""
Get next dev version.
If version is stable - bump release for proper versioning as well.
Defaults to bumping `micro`, falls back automatically to `post`
Arguments:
inc -- Increment for dev version.
bump_release -- Release number to bump if version is stable.
Examples:
```python
Version("1.2.3").bump_dev() # "1.2.4.dev0"
Version("1.2.3").bump_dev(1, 'minor') # "1.3.0.dev0"
Version("1.2.3.dev14").bump_dev() # "1.2.3.dev15"
Version("1.2.3a4).bump_dev() # "1.2.3a4.dev0"
Version("1.2.3b5.dev9").bump_dev() # "1.2.3b5.dev10"
Version("1.2.3.dev3").bump_dev(2) # "1.2.3.dev5"
Version("1.2.3.post4").bump_dev() # "1.2.3.post5.dev0"
```
Returns:
A new copy.
"""
if self.is_devrelease:
# this is a dev release already, increment the dev value
dev_version = self.dev or 0
return self.replace(dev=(dev_version + inc))
if bump_release == "post" or self.is_postrelease:
# this is a postrelease or we want to create one
return self.bump_postrelease().replace(dev=(inc - 1))
if self.is_stable:
# this is a stable release and we want to bump the release and add dev
return self.bump_release(bump_release).replace(dev=(inc - 1))
return self.replace(dev=(inc - 1))
def bump_prerelease(
self: _R,
inc: int = 1,
release_type: Optional[PrereleaseLooseTypeDef] = None,
bump_release: ReleaseMainTypeDef = "micro",
) -> _R:
"""
Get next prerelease version.
If version is stable - bump `micro` for proper versioning as well.
Defaults to `rc` pre-releases.
Arguments:
inc -- Increment for micro version.
release_type -- Prerelease type: alpha, beta, rc.
bump_release -- Release number to bump if version is stable.
Examples:
```python
Version("1.2.3").bump_prerelease() # "1.2.4rc1"
Version("1.2.3").bump_prerelease(bump_release="major") # "2.0.0rc1"
Version("1.2.3.dev14").bump_prerelease() # "1.2.3rc1"
Version("1.2.3a5").bump_prerelease() # "1.2.3a6"
Version("1.2.3rc3").bump_prerelease(2, "beta") # "1.2.3rc5"
```
Returns:
A new copy.
"""
prerelease_type = release_type or self.prerelease_type or VersionParts.RC
increment = inc if not self.base.pre else (max(self.base.pre[-1], 1) + inc)
pre = (prerelease_type, increment)
new_version = self._replace(self._copy_base(pre=pre))
if new_version < self:
prerelease_type = release_type or VersionParts.RC
new_version = self.get_stable().bump_release(bump_release)
if prerelease_type != self.prerelease_type:
increment = inc
base = BaseVersion(
epoch=0,
release=new_version.base.release,
pre=(prerelease_type, increment),
post=None,
dev=None,
local=None,
)
return self._replace(base)
def bump_postrelease(self: _R, inc: int = 1) -> _R:
"""
Get next postrelease version.
Arguments:
inc -- Increment for micro version.
Examples:
```python
Version("1.2.3").bump_postrelease() # "1.2.3.post1"
Version("1.2.3.post3").bump_postrelease() # "1.2.3.post4"
Version("1.2.3a5").bump_postrelease() # "1.2.3.post1"
Version("1.2.3.post4").bump_postrelease(2) # "1.2.3.post6"
```
Returns:
A new copy.
"""
post = (VersionParts.POST, max(inc, 1))
base_post: Optional[Tuple[str, int]] = self._version.post
if base_post:
post = (VersionParts.POST, max(base_post[1], 1) + inc)
base = BaseVersion(
epoch=0,
release=self._version.release,
pre=None,
post=post,
dev=None,
local=None,
)
return self._replace(base)
def replace(
self: _R,
major: Optional[int] = None,
minor: Optional[int] = None,
micro: Optional[int] = None,
alpha: Optional[int] = None,
beta: Optional[int] = None,
rc: Optional[int] = None,
dev: Optional[int] = None,
post: Optional[int] = None,
epoch: Optional[int] = None,
local: Optional[str] = None,
) -> _R:
"""
Modify version parts.
Examples:
```python
Version("1.2.3").replace(dev=24) # "1.2.3.dev24"
Version("1.2.3rc5").replace(17) # "1.2.3.dev17"
```
Arguments:
major -- Major release number.
minor -- Minor release number.
micro -- Micro release number.
alpha -- Alpha pre-release number.
beta -- Beta pre-release number.
rc -- RC pre-release number.
dev -- Dev release number.
post -- Post release number.
epoch -- Release epoch.
local -- Local release identifier.
Returns:
A new instance.
"""
kwargs: Dict[str, Any] = dict(
release=(
major if major is not None else self.major,
minor if minor is not None else self.minor,
micro if micro is not None else self.micro,
)
)
if alpha is not None:
kwargs[VersionParts.PRE] = (VersionParts.ALPHA, alpha)
if beta is not None:
kwargs[VersionParts.PRE] = (VersionParts.BETA, beta)
if rc is not None:
kwargs[VersionParts.PRE] = (VersionParts.RC, rc)
if dev is not None:
kwargs[VersionParts.DEV] = (VersionParts.DEV, dev)
if post is not None:
kwargs[VersionParts.POST] = (VersionParts.POST, post)
if epoch is not None:
kwargs[VersionParts.EPOCH] = epoch
if local is not None:
kwargs[VersionParts.LOCAL] = [local]
return self._replace(self._copy_base(**kwargs))
@property
def is_stable(self) -> bool:
"""
Whether version is not prerelease or devrelease.
Returns:
True if it is stable.
"""
return not self.is_prerelease
def get_stable(self: _R) -> _R:
"""
Get stable version from pre- or post- release.
Examples:
```python
Version("1.2.3").get_stable() # "1.2.3"
Version("2.1.0a2").get_stable() # "2.1.0"
Version("1.2.5.post3").get_stable() # "1.2.5"
```
Returns:
A new instance.
"""
return self._replace(
BaseVersion(
epoch=0,
release=(self.major, self.minor, self.micro),
pre=None,
post=None,
dev=None,
local=None,
)
)
def _copy_base(
self,
*,
epoch: Optional[int] = None,
release: Optional[Tuple[int, ...]] = None,
dev: Optional[Tuple[str, int]] = None,
pre: Optional[Tuple[str, int]] = None,
post: Optional[Tuple[str, int]] = None,
local: Optional[Tuple[Union[int, str], ...]] = None,
) -> BaseVersion:
return BaseVersion(
epoch=epoch if epoch is not None else self.base.epoch,
release=release if release is not None else self.base.release,
pre=pre if pre is not None else self.base.pre,
post=post if post is not None else self.base.post,
dev=dev if dev is not None else self.base.dev,
local=local if local is not None else self.base.local,
)