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
|
#!/usr/bin/env python
import importlib.util
import os
import pkgutil
import re
import runpy
import subprocess
import sys
import docutils.nodes
import docutils.parsers.rst
import docutils.utils
import docutils.frontend
CHANGELOG_PATTERN = re.compile(r"^Version (\S+)((?: \(.+\)))?$")
def parse_rst(text: str) -> docutils.nodes.document:
parser = docutils.parsers.rst.Parser()
components = (docutils.parsers.rst.Parser,)
settings = docutils.frontend.OptionParser(
components=components
).get_default_values()
document = docutils.utils.new_document("<rst-doc>", settings=settings)
parser.parse(text, document)
return document
class SectionVisitor(docutils.nodes.NodeVisitor):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.sectiontitles_found = []
def visit_section(self, node: docutils.nodes.section) -> None:
"""Called for "section" nodes."""
title = node[0]
assert isinstance(title, docutils.nodes.title)
self.sectiontitles_found.append(title.astext())
def unknown_visit(self, node: docutils.nodes.Node) -> None:
"""Called for all other node types."""
pass
def get_sphinxchangelog_version(rootdir):
with open(os.path.join(rootdir, "docs", "changelog.rst"), mode="r") as f:
doc = parse_rst(f.read())
visitor = SectionVisitor(doc)
doc.walk(visitor)
unique_sectiontitles = set(visitor.sectiontitles_found)
assert len(visitor.sectiontitles_found) == len(unique_sectiontitles)
assert visitor.sectiontitles_found[0] == "Changelog"
matchobj = CHANGELOG_PATTERN.match(visitor.sectiontitles_found[1])
assert matchobj
version = matchobj.group(1)
version_date = matchobj.group(2)
matchobj = CHANGELOG_PATTERN.match(visitor.sectiontitles_found[2])
assert matchobj
release = matchobj.group(1)
release_date = matchobj.group(2)
if version_date:
assert version_date == release_date
return version, release
def get_sphinxconfpy_version(rootdir):
"""Get version from Sphinx' conf.py."""
sphinx_conf = runpy.run_path(os.path.join(rootdir, "docs", "conf.py"))
version, sep, bugfix = sphinx_conf["release"].rpartition(".")
assert sep == "."
assert bugfix
assert version == sphinx_conf["version"]
return sphinx_conf["version"], sphinx_conf["release"]
def get_setuppy_version(rootdir):
"""Get version from setup.py."""
setupfile = os.path.join(rootdir, "setup.py")
cmd = (sys.executable, setupfile, "--version")
release = subprocess.check_output(cmd).decode().rstrip(os.linesep)
version = release.rpartition(".")[0]
return version, release
def get_package_version(rootdir):
"""Get version from package __init__.py."""
sys.path.insert(0, os.path.join(rootdir))
for modinfo in pkgutil.walk_packages(path=[rootdir]):
if modinfo.ispkg and modinfo.name == "sphinx_multiversion":
break
else:
raise FileNotFoundError("package not found")
spec = modinfo.module_finder.find_spec(modinfo.name)
mod = importlib.util.module_from_spec(spec)
spec.loader.exec_module(mod)
release = mod.__version__
version = release.rpartition(".")[0]
return version, release
def main():
rootdir = os.path.join(os.path.dirname(__file__), "..")
setuppy_version, setuppy_release = get_setuppy_version(rootdir)
package_version, package_release = get_package_version(rootdir)
confpy_version, confpy_release = get_sphinxconfpy_version(rootdir)
changelog_version, changelog_release = get_sphinxchangelog_version(rootdir)
version_head = "Version"
version_width = max(
(
len(repr(x))
for x in (
version_head,
setuppy_version,
package_version,
confpy_version,
changelog_version,
)
)
)
release_head = "Release"
release_width = max(
(
len(repr(x))
for x in (
release_head,
setuppy_release,
package_release,
confpy_release,
changelog_release,
)
)
)
print(
f"File {version_head} {release_head}\n"
f"------------------------------- {'-' * version_width}"
f" {'-' * release_width}\n"
f"setup.py "
f" {setuppy_version!r:>{version_width}}"
f" {setuppy_release!r:>{release_width}}\n"
f"sphinx_multiversion/__init__.py"
f" {package_version!r:>{version_width}}"
f" {package_release!r:>{release_width}}\n"
f"docs/conf.py "
f" {confpy_version!r:>{version_width}}"
f" {confpy_release!r:>{release_width}}\n"
f"docs/changelog.rst "
f" {changelog_version!r:>{version_width}}"
f" {changelog_release!r:>{release_width}}\n"
)
assert setuppy_version == confpy_version
assert setuppy_version == package_version
assert setuppy_version == changelog_version
assert setuppy_release == confpy_release
assert setuppy_release == package_release
assert setuppy_release == changelog_release
if __name__ == "__main__":
main()
|
