Skip to content

Commit 7ac394a

Browse files
committed
hack/boilerplate/bolierplate.py: format python file according to PEP8 guidelines
1 parent 06dc8cf commit 7ac394a

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

hack/boilerplate/boilerplate.py

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848

4949
verbose_out = sys.stderr if args.verbose else open("/dev/null", "w")
5050

51+
5152
def get_refs():
5253
refs = {}
5354

@@ -61,6 +62,7 @@ def get_refs():
6162

6263
return refs
6364

65+
6466
def is_generated_file(filename, data, regexs):
6567
for d in skipped_ungenerated_files:
6668
if d in filename:
@@ -69,6 +71,7 @@ def is_generated_file(filename, data, regexs):
6971
p = regexs["generated"]
7072
return p.search(data)
7173

74+
7275
def file_passes(filename, refs, regexs):
7376
try:
7477
f = open(filename, 'r')
@@ -119,9 +122,11 @@ def file_passes(filename, refs, regexs):
119122
for d in data:
120123
if p.search(d):
121124
if generated:
122-
print('File %s has the YEAR field, but it should not be in generated file' % filename, file=verbose_out)
125+
print('File %s has the YEAR field, but it should not be in generated file' %
126+
filename, file=verbose_out)
123127
else:
124-
print('File %s has the YEAR field, but missing the year of date' % filename, file=verbose_out)
128+
print('File %s has the YEAR field, but missing the year of date' %
129+
filename, file=verbose_out)
125130
return False
126131

127132
if not generated:
@@ -134,7 +139,8 @@ def file_passes(filename, refs, regexs):
134139

135140
# if we don't match the reference at this point, fail
136141
if ref != data:
137-
print("Header in %s does not match reference, diff:" % filename, file=verbose_out)
142+
print("Header in %s does not match reference, diff:" %
143+
filename, file=verbose_out)
138144
if args.verbose:
139145
print(file=verbose_out)
140146
for line in difflib.unified_diff(ref, data, 'reference', filename, lineterm=''):
@@ -144,15 +150,19 @@ def file_passes(filename, refs, regexs):
144150

145151
return True
146152

153+
147154
def file_extension(filename):
148155
return os.path.splitext(filename)[1].split(".")[-1].lower()
149156

157+
150158
skipped_dirs = ['Godeps', 'third_party', '_gopath', '_output', '.git', 'cluster/env.sh',
151159
"vendor", "test/e2e/generated/bindata.go", "hack/boilerplate/test",
152160
"staging/src/k8s.io/kubectl/pkg/generated/bindata.go"]
153161

154162
# list all the files contain 'DO NOT EDIT', but are not generated
155-
skipped_ungenerated_files = ['hack/lib/swagger.sh', 'hack/boilerplate/boilerplate.py']
163+
skipped_ungenerated_files = [
164+
'hack/lib/swagger.sh', 'hack/boilerplate/boilerplate.py']
165+
156166

157167
def normalize_files(files):
158168
newfiles = []
@@ -165,6 +175,7 @@ def normalize_files(files):
165175
newfiles[i] = os.path.join(args.rootdir, pathname)
166176
return newfiles
167177

178+
168179
def get_files(extensions):
169180
files = []
170181
if len(args.filenames) > 0:
@@ -192,25 +203,29 @@ def get_files(extensions):
192203
outfiles.append(pathname)
193204
return outfiles
194205

206+
195207
def get_dates():
196208
years = datetime.datetime.now().year
197209
return '(%s)' % '|'.join((str(year) for year in range(2014, years+1)))
198210

211+
199212
def get_regexs():
200213
regexs = {}
201214
# Search for "YEAR" which exists in the boilerplate, but shouldn't in the real thing
202-
regexs["year"] = re.compile( 'YEAR' )
215+
regexs["year"] = re.compile('YEAR')
203216
# get_dates return 2014, 2015, 2016, 2017, or 2018 until the current year as a regex like: "(2014|2015|2016|2017|2018)";
204217
# company holder names can be anything
205218
regexs["date"] = re.compile(get_dates())
206219
# strip // +build \n\n build constraints
207-
regexs["go_build_constraints"] = re.compile(r"^(// \+build.*\n)+\n", re.MULTILINE)
220+
regexs["go_build_constraints"] = re.compile(
221+
r"^(// \+build.*\n)+\n", re.MULTILINE)
208222
# strip #!.* from scripts
209223
regexs["shebang"] = re.compile(r"^(#!.*\n)\n*", re.MULTILINE)
210224
# Search for generated files
211-
regexs["generated"] = re.compile( 'DO NOT EDIT' )
225+
regexs["generated"] = re.compile('DO NOT EDIT')
212226
return regexs
213227

228+
214229
def main():
215230
regexs = get_regexs()
216231
refs = get_refs()
@@ -222,5 +237,6 @@ def main():
222237

223238
return 0
224239

240+
225241
if __name__ == "__main__":
226-
sys.exit(main())
242+
sys.exit(main())

0 commit comments

Comments
 (0)