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
|
#!/usr/bin/env python3
# version_identifier_parsing.py: parse and sort Docutils version indentifiers
# ===========================================================================
# Parse a Docutils version identifier
# (adapted from the `PEP 440 example regexp`__)
#
# __https://peps.python.org/pep-0440/#appendix-b-parsing-version-strings-with-regular-expressions
import re, argparse
from docutils import VersionInfo, __version__, __version_info__
_version_regexp = re.compile(r"""
(?P<release>
(?P<major>[0-9]+)
\.(?P<minor>[0-9]+)
(\.(?P<micro>[0-9]+))?
)
(?P<pre> # pre-release segment
(?P<pre_l>(a|b|rc))
(?P<pre_n>[0-9]+)?
)?
(\.(?P<dev>dev))? # dev segment
$
""", re.VERBOSE)
def parse_version_identifier(identifier):
"""Parse a Docutils version identifier according to PEP 440."""
return _version_regexp.match(identifier).groupdict()
releaselevels = {'a': 'alpha',
'b': 'beta',
'rc': 'candidate',
'': 'final',
}
def identifier2version_info(identifier):
"""Convert Docutils version identifier to a `VersionInfo` instance.
"""
try:
segments = _version_regexp.match(identifier).groupdict()
except AttributeError:
raise ValueError('non-supported version identifier "%s"' % identifier)
return VersionInfo(
major=int(segments['major']),
minor=int(segments['minor']),
micro=int(segments['micro']) if segments['micro'] else 0,
releaselevel=releaselevels[segments['pre_l'] or ''],
serial=segments['pre_n'] and int(segments['pre_n']) or 0,
release=not segments['dev'])
def version_info2identifier(version_info):
"""Return version identifier matching the given `VersionInfo` instance.
"""
release_level_abbreviations = dict((level, abbr)
for abbr, level in releaselevels.items())
identifier = '%s.%s%s' % (version_info.major, version_info.minor,
'.%s' % version_info.micro if version_info.micro else '')
try:
identifier += release_level_abbreviations[version_info.releaselevel]
except KeyError:
if version_info.releaselevel is not None or version_info.release:
raise ValueError('releaselevel "%s" not supported. '
'Must be one of %s'
% (version_info.releaselevel,
', '.join(releaselevels.values())))
if version_info.releaselevel and version_info.serial:
identifier += str(version_info.serial)
if not version_info.release:
identifier += '.dev'
return identifier
version_info_def_template = """\
__version_info__ = VersionInfo(
major=%d,
minor=%d,
micro=%d,
releaselevel='%s', # one of 'alpha', 'beta', 'candidate', 'final'
serial=%d, # pre-release number (0 for final releases and snapshots)
release=%s # True for official releases and pre-releases
)
"""
version_info_def_pattern = version_info_def_template.replace('%d', '[0-9]+')
version_info_def_pattern = version_info_def_pattern.replace('%s', '.*')
version_info_def_pattern = version_info_def_pattern.replace('(', r'\(')
version_info_def_pattern = version_info_def_pattern.replace(')', r'\)')
def version_info_definition(version_identifier):
"""Return __version_info__ definition code matching `version_identifier`.
"""
versioninfo = identifier2version_info(version_identifier)
return version_info_def_template % versioninfo
def change_version_info_definition(version, source):
"""Replace the __version_info__ definition in file "source" with
a version matching the version identifer `version`."""
version_info_def = version_info_definition(version)
with open(source) as sourcefile:
old = sourcefile.read()
if not re.search(version_info_def_pattern, old):
return 'No matching "version_info" definition found.'
new = re.sub(version_info_def_pattern, version_info_def, old)
if old == new:
return 'Nothing to change.'
with open(source, 'w') as sourcefile:
sourcefile.write(new)
return f'Changed "{source}".'
# -----------------------------------------------------------------------
def test_parse(identifier):
segments = parse_version_identifier(identifier)
print(identifier)
print('release:', segments['release'])
print(' major:', segments['major'])
print(' minor:', segments['minor'])
print(' micro:', segments['micro'])
print(' pre:', segments['pre'])
print(' pre_l:', segments['pre_l'])
print(' pre_n:', segments['pre_n'])
print(' dev:', segments['dev'])
print('')
def selftest(version=__version__):
"""Run a test on version identification parsing and transforming."""
# example: series of release identifiers in version-order
# cf. https://peps.python.org/pep-0440/#summary-of-permitted-suffixes-and-relative-ordering # noqa
identifiers = ['0.13.1',
#'0.14.dev', # invalid (wrong sorting)
'0.14a.dev',
'0.14b.dev',
'0.14b',
'0.14rc1',
'0.14rc2.dev',
'0.14rc2',
'0.14',
'0.14.1rc1.dev',
'0.14.1rc1',
#'0.14.1.dev', # invalid (wrong sorting)
'0.14.1',
]
for identifier in identifiers:
test_parse(identifier)
version_infos = [identifier2version_info(identifier)
for identifier in identifiers]
for vi in version_infos:
print(vi)
print('')
# test sort order:
sorted_version_infos = sorted(version_infos)
if sorted_version_infos == version_infos:
print("Version order preserved by sorting.")
else:
print("Version order changed by sorting.")
for vi in sorted_version_infos:
print(vi)
print('')
# (re)convert version_info to PEP 440 version identifier:
ids = [version_info2identifier(vi) for vi in version_infos]
if ids == identifiers:
print("Round trip conversion OK.")
else:
print(ids)
print(version_info_definition(version))
if __name__ == '__main__':
parser = argparse.ArgumentParser()
parser.add_argument('-i', '--version-info',
help='print version-info definition',
action='store_true')
parser.add_argument('--change-version-info',
dest='source', metavar='SOURCE',
help='change version-info def in file "source"')
parser.add_argument('-v', '--version',
help='version identifier '
'(default docutils.__version__)')
parser.add_argument('-t', '--test',
help='test version indentification conversion',
action='store_true')
parser.add_argument('--debug',
help='print result of version identifier parsing',
action='store_true')
args = parser.parse_args()
version_identifier = args.version or __version__
if args.test:
selftest(version_identifier)
elif args.debug:
from pprint import pprint
pprint(_version_regexp.match(version_identifier).groupdict())
elif args.version_info:
print(version_info_definition(version_identifier))
elif args.source:
print(change_version_info_definition(version_identifier, args.source))
|
