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
|
#!/usr/bin/env python3
#-----------------------------------------------------------------------------
# Copyright (c) 2016-2023, PyInstaller Development Team.
#
# Distributed under the terms of the GNU General Public License (version 2
# or later) with exception for distributing the bootloader.
#
# The full license is in the file COPYING.txt, distributed with this software.
#
# SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)
#-----------------------------------------------------------------------------
"""
This script updates the copyright year to the current year.
It checks all non-binary files tracked by git. It also lists all non-binary files tracked missing our copyright header.
Run this at the beginning of each new year.
"""
__copyright__ = "Copyright (c) 2016-2023, PyInstaller Development Team."
__author__ = "Hartmut Goebel <h.goebel@crazy-compilers.com>"
import os, sys, re
import subprocess
import time
import fnmatch
YEAR = str(time.localtime().tm_year)
LAST_YEAR = str(time.localtime().tm_year - 1)
EXCLUDE = {
'.gitattributes',
'.gitignore',
'.dockerignore',
'.pylintrc',
'MANIFEST.in',
'bootloader/uncrustify.cfg',
'bootloader/src/msvc_stdint.h',
'bootloader/waf',
'bootloader/windows/run.rc',
'bootloader/windows/runw.rc',
'doc/CHANGES.rst',
'doc/CREDITS.rst',
'doc/source/tools/rst2newlatex.py',
'doc/source/tools/rst2xml.py',
'old/examples/file_version_info.txt',
'PyInstaller/lib/pefile.py',
'tests/functional/data/sphinx/conf.py',
'tests/old_suite/basic/test_pkg_structures-version.txt',
'tests/scripts/eggs4testing/unzipped_egg/data/datafile.txt',
'tests/scripts/eggs4testing/zipped_egg/data/datafile.txt',
'tests/functional/data/requests/openssl.conf',
'tests/functional/data/requests/server.pem',
}
EXCLUDE_GLOBS = {
'bootloader/.waf-*',
'bootloader/.waf3-*',
'bootloader/waf-*',
'bootloader/waf3-*',
'doc/*.1',
'doc/*.rst',
'doc/*/*.rst',
'news/*.rst',
'*/EGG-INFO/*',
'*/*.egg-info/*',
'*.egg',
'*.yml',
'*.svg',
'tests/functional/logs/*.toc',
'tests/functional/modules/nspkg*-pkg/*',
'tests/old_suite/multipackage/*.toc',
'.github/ISSUE_TEMPLATE/*.md',
'.github/CONTRIBUTING.md',
'.github/SECURITY.md',
}
EXCLUDE_DIRS = (
'bootloader/zlib/',
'tests/unit/test_altgraph/',
'tests/unit/test_modulegraph/',
)
script_dir = os.path.dirname(os.path.abspath(sys.argv[0]))
base_dir = os.path.dirname(script_dir)
os.chdir(base_dir)
def get_file_list():
def chunks(l, n):
"""
Yield successive n-sized chunks from l.
"""
for i in range(0, len(l), n):
yield l[i:i + n]
text = subprocess.check_output(
'git ls-tree -rz --name-only --full-tree HEAD | git check-attr text -z --stdin', shell=True
)
text = text.rstrip(b'\0') # strip trailing NULL-byte
for entry in chunks(text.split(b'\0'), 3):
assert len(entry) == 3, entry
assert entry[1] == b"text", entry
path, dummy, typ = entry
assert typ in (b'auto', b'unset', b'set'), entry
if typ == b'unset':
# binary file
continue
yield path.decode()
def ignore(filename):
if filename in EXCLUDE or os.path.basename(filename) in EXCLUDE:
return True
if filename.startswith(EXCLUDE_DIRS):
return True
for pat in EXCLUDE_GLOBS:
if fnmatch.fnmatch(filename, pat):
return True
return False
P1 = re.compile(r'(Copyright[: ].* 2[0-9]{3})-(2[0-9]{3})(,? PyInstaller Development Team)', flags=re.IGNORECASE)
P2 = re.compile(r'(Copyright[: ].*) (2[0-9]{3})(,? PyInstaller Development Team)', flags=re.IGNORECASE)
def transform(text):
"""
Transform text or return None if no change.
"""
orig_text = text
text = P1.sub(r'\1-' + YEAR + r'\3', text)
text = P2.sub(r'\1 \2-' + YEAR + r'\3', text)
if text != orig_text:
return text
OLD_HEADER = """\
# Distributed under the terms of the GNU General Public License (version 2
# or later) with exception for distributing the bootloader.
#
# The full license is in the file COPYING.txt, distributed with this software.
#
# SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)
""".strip()
NEW_HEADER = """\
# Distributed under the terms of the GNU General Public License (version 2
# or later) with exception for distributing the bootloader.
#
# The full license is in the file COPYING.txt, distributed with this software.
#
# SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)
""".strip()
def replace_header_content(text):
"""
Transform text or return None if no change.
"""
orig_text = text
text = text.replace(OLD_HEADER, NEW_HEADER)
if text != orig_text:
return text
def has_our_copyright(text):
if len(text) <= 30:
# ignore short files
return True
found = P1.search(text) or P2.search(text)
return found
missing_copyright = []
files = get_file_list()
for filename in files:
with open(filename, 'r', encoding='utf-8') as f:
try:
text = f.read()
except UnicodeDecodeError as e:
raise SystemExit("%s in file %r" % (e, filename))
newtext = transform(text)
if newtext:
with open(filename, 'w', encoding='utf-8') as f:
f.write(newtext)
elif ignore(filename):
continue
elif not has_our_copyright(text):
missing_copyright.append(filename)
else:
# Report all files which do not have a current copyright year
# This is to find those files missing our copyright header.
text = text.lower()
if 'copyright' in text and YEAR not in text:
print('unchanged:', filename)
elif 'copyright' in text and "spdx-license-identifier" not in text:
print('SPDX-License-Identifier missing:', filename)
if missing_copyright:
print('File missing our copyright:')
for f in missing_copyright:
print(f)
print(
"""
You may now run
git diff develop # verify changes
git add -u # batch-commit all these changes
git grep %s # grep for remaining years
""" % LAST_YEAR
)
|
