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
|
#
# Copyright (c) 2016 - 2024 -- Lars Heuer
# All rights reserved.
#
# License: BSD License
#
"""\
Nox test runner configuration.
"""
import os
import sys
import re
from functools import partial
from itertools import chain
import shutil
import nox
_PY_VERSIONS = ('3.9', '3.10', '3.11', '3.12', '3.13', 'pypy3')
_PY_DEFAULT_VERSION = sys.version[:4]
nox.options.sessions = chain([f'test-{version}' for version in _PY_VERSIONS], ['coverage', 'lint'])
@nox.session(python=_PY_VERSIONS)
def test(session):
"""\
Run test suite.
"""
session.install('-Ur', 'tests/requirements.txt')
session.install('.')
if session.posargs:
session.run('pytest', *[f'tests/{test_file}' for test_file in session.posargs])
else:
session.run('pytest')
@nox.session(python=_PY_DEFAULT_VERSION)
def docs(session):
"""\
Build the documentation.
"""
session.install('-Ur', 'docs/requirements.txt')
output_dir = os.path.abspath(os.path.join(session.create_tmp(), 'output'))
shutil.rmtree(output_dir, ignore_errors=True)
doctrees, html, man = map(partial(os.path.join, output_dir), ['doctrees', 'html', 'man'])
session.install('.')
session.cd('docs')
sphinx_build = partial(session.run, 'sphinx-build', '-W', '-d', doctrees, '.')
sphinx_build('-b', 'html', html)
sphinx_build('-b', 'man', man)
sys.path.insert(0, os.path.abspath('..'))
import segno
if 'dev' not in segno.__version__:
shutil.copyfile(os.path.join(man, 'segno.1'),
os.path.abspath(os.path.join(os.path.dirname(__file__), 'data/share/man/man1/', 'segno.1')))
session.log("'man/segno.1' has been modified, don't forget to commit")
@nox.session(python=_PY_DEFAULT_VERSION)
def coverage(session):
"""\
Run coverage.
"""
session.install('-Ur', 'tests/requirements.txt')
session.install('.')
html_output_dir = os.path.abspath(os.path.join(session.create_tmp(), 'html'))
session.run('pytest', '--cov=segno', '--cov-report=term', f'--cov-report=html:{html_output_dir}')
@nox.session(python=_PY_DEFAULT_VERSION)
def lint(session):
"""\
Run linters.
"""
session.install('ruff', 'mypy')
session.run('mypy', 'segno')
session.run('ruff', 'check', '.')
@nox.session(python=_PY_DEFAULT_VERSION)
def benchmarks(session):
"""\
Run the benchmarks and create the charts.
"""
session.install('qrcode', 'Pillow', 'qrcodegen', 'pygal')
session.install('setuptools') # Required by pygal since it uses pkg_resources
session.install('.')
sandbox_dir = os.path.join(os.path.dirname(__file__), 'sandbox')
session.run('python', os.path.join(sandbox_dir, 'benchmarks.py'))
session.run('python', os.path.join(sandbox_dir, 'make_charts.py'))
#
# Release related tasks
# 1. nox -e start-release -- version-number
# 2. run tests, update docs, update changes
# 3. nox -e finish-release -- version-number
# 4. git push / git push origin --tags
# 5. nox -e build-release -- version-number
# 6. nox -e upload-release
#
@nox.session(name='start-release', python=_PY_DEFAULT_VERSION)
def start_release(session):
"""\
Prepares a release.
* Creates a new branch release-VERSION_NUMBER
* Changes the version number in segno.__version__ to VERSION_NUMBER
"""
session.install('packaging')
git = partial(session.run, 'git', external=True)
git('checkout', 'master')
prev_version = _get_current_version(session)
version = _validate_version(session)
valid_version = bool(int(session.run('python', '-c',
'from packaging.version import parse;'
f'prev_version = parse("{prev_version}");'
f'next_version = parse("{version}");'
'print(1 if prev_version < next_version else 0)',
silent=True)))
if not valid_version:
session.error('Invalid version')
release_branch = f'release-{version}'
git('checkout', '-b', release_branch, 'master')
_change_version(session, prev_version, version)
git('add', 'segno/__init__.py')
session.log(f'Now on branch "{release_branch}". Run the tests, run nox -e docs. Update and add CHANGES')
session.log('Commit any changes.')
session.log(f'When done, call nox -e finish-release -- {version}')
@nox.session(name='finish-release', python=_PY_DEFAULT_VERSION)
def finish_release(session):
"""\
Finishes the release.
* Merges the branch release-VERSION_NUMBER into master
* Creates a tag VERSION_NUMBER
* Increments the development version
"""
version = _validate_version(session)
release_branch = f'release-{version}'
git = partial(session.run, 'git', external=True)
git('checkout', 'master')
git('merge', '--no-ff', release_branch, '-m', f'Merge release branch {release_branch}')
git('tag', '-a', version, '-m', f'Release {version}')
git('branch', '-d', release_branch)
version_parts = version.split('.')
patch = str(int(version_parts[2]) + 1)
next_version = '.'.join(chain(version_parts[:2], patch)) + '.dev'
_change_version(session, version, next_version)
git('add', 'segno/__init__.py')
git('commit', '-m', 'Incremented development version')
session.log('Finished. Run git push / git push origin --tags and '
f'nox -e build-release -- {version} / nox -e upload-release')
@nox.session(name='build-release', python=_PY_DEFAULT_VERSION)
def build_release(session):
"""\
Builds a release: Creates sdist and wheel
"""
version = _validate_version(session)
session.install('flit-core')
git = partial(session.run, 'git', external=True)
git('fetch')
git('fetch', '--tags')
git('checkout', version)
shutil.rmtree('dist', ignore_errors=True)
session.run('flit', 'build', external=True)
git('checkout', 'master')
@nox.session(name='upload-release', python=_PY_DEFAULT_VERSION)
def upload_release(session):
"""\
Uploads a release to PyPI
"""
session.install('twine')
twine = partial(session.run, 'twine')
twine('check', 'dist/*')
twine('upload', 'dist/*')
def _validate_version(session):
if not session.posargs:
session.error('No release version provided')
elif len(session.posargs) > 1:
session.error('Too many arguments')
version = session.posargs[0]
if not re.match(r'^[0-9]+\.[0-9]+\.[0-9]+$', version):
session.error(f'Invalid version number: "{version}"')
return version
def _get_current_version(session):
"""\
Returns the current Segno version.
"""
fn = os.path.abspath(os.path.join(os.path.dirname(__file__), 'segno/__init__.py'))
with open(fn, encoding='utf-8') as f:
content = f.read()
m = re.search(r'^__version__ = ["\']([^"\']+)["\']$', content, flags=re.MULTILINE)
if m:
return m.group(1)
session.error('Cannot find any version information')
def _change_version(session, previous_version, next_version):
"""\
Changes the segno.__init__.__version__ from previous_version to next_version.
"""
fn = os.path.abspath(os.path.join(os.path.dirname(__file__), 'segno/__init__.py'))
with open(fn, encoding='utf-8') as f:
content = f.read()
new_content = re.sub(rf'^(__version__ = ["\'])({re.escape(previous_version)})(["\'])$',
rf'\g<1>{next_version}\g<3>', content,
flags=re.MULTILINE)
if content != new_content:
with open(fn, 'w', encoding='utf-8') as f:
f.write(new_content)
return
session.error(f'Cannot modify version. Provided: "{previous_version}" (previous) "{next_version}" (next)')
|
