-
Notifications
You must be signed in to change notification settings - Fork 0
/
content_check.py
412 lines (350 loc) · 13.2 KB
/
content_check.py
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
import PySimpleGUI as sg
import string, sys, os, time, re
import subprocess, tempfile, shutil
######################### GLOBAL VARIABLES #########################
processing = False
folder_clicked = False
filepath=""
temp_dir = None
################################################################
######################### DEFINE GREP #########################
def grep(pattern, file):
with open(file, 'r') as f:
lines = f.readlines()
matched_lines = [line for line in lines if re.search(pattern, line)]
return matched_lines
################################################################
# ######################### DATA PARSING #########################
# VALIDATES THE CONFIG.YAML
def configYaml(filePath):
# print(os.path.abspath(filePath))
title = grep("title:", filePath)[0].split("'")[1]
contact = grep("contact:", filePath)[0].split("'")[1]
created = grep("created:", filePath)
source = grep("source:", filePath)[0].split("'")[1]
if "20" in created[0]:
created = created[0].split(":")[1]
created = created.split("\n")[0]
else:
created = ""
message =f"""Config.yaml Validation:
Title: {title if title != "Lesson Title" else "Missing"}
Contact: {contact if contact != "[email protected]" else "Invalid"}
Created: {created if created else "Invalid"}
Source: {source if source != "https://github.com/carpentries/workbench-template-md" else "Invalid"}
"""
return message
# CHECK EPISODE FOR COMPILE ERRORS
def episode_compile(filepath):
error = []
valid = True
stack = []
def grep_line(pattern, file):
matched_lines = []
with open(file, 'r') as f:
for line_number, line in enumerate(f, start=1):
if re.search(pattern, line):
matched_lines.append([line_number, line.strip()])
return matched_lines
callout = grep_line(":::", filepath)
for i in range(len(callout)):
callout_block = ""
for j in range(len(callout[i][1])):
if callout[i][1][j].isalpha():
callout_block += callout[i][1][j]
callout[i][1] = callout_block
for i in callout:
if i[1]:
stack.append(i)
else:
if not stack:
error.append(f"Extraneous closing :::, Line {i[0]}")
valid = False
continue
stack.pop()
if stack or not valid:
for i in stack:
error.append(f"{i[1].upper()} missing closing :::, Line {i[0]}")
return error
# SCANS THROUGH EPISODE
def singleEpisode(filepath, episodeName):
compile_error = episode_compile(filepath)
if compile_error:
message = f"""Episode: {episodeName}
COMPILE ERROR"""
for error in compile_error:
message += f"""
{error}"""
return message
solutions = grep(":::.*solution", filepath)
discussions = grep(":::.*discussion", filepath)
challenges = grep(":::.*challenge", filepath)
objectives = grep(":::.*objective", filepath)
questions = grep(":::.*question", filepath)
keypoints = grep(":::.*keypoint", filepath)
teaching_time = grep("teaching:", filepath)
time = ""
if teaching_time:
for i in teaching_time[0]:
if i.isdigit():
time += i
message=f"""Episode: {episodeName}
Teaching Time: {time if teaching_time else "Missing"}
Questions: {"Valid" if questions else "Invalid"}
Objectives: {"Valid" if objectives else "Invalid"}
Keypoints: {"Valid" if keypoints else "Invalid"}
Number of Challenges: {len(challenges)}
Number of Solutions: {len(solutions)}
Number of Discussions: {len(discussions)}
"""
return message
def entireFolder(filePath):
# print(filePath)
episode_dir = os.path.join(filePath, "episodes")
config = os.path.join(filePath, "config.yaml")
message =""
# print(f"Config Path: {config}")
# print(f"Episode Path: {episode_dir}")
try:
config_message = configYaml(config)
# print(config_message)
except:
# print("WTF 1")
return
episode_message = []
try:
file_list = os.listdir(episode_dir)
# print(file_list)
for file_name in file_list:
if ".md" in file_name or ".Rmd" in file_name:
fullPath = os.path.join(episode_dir, f"{file_name}")
episode_message.append(singleEpisode(fullPath, file_name))
message = config_message
for m in episode_message:
message += m
except:
# print("WTF 2")
return
return message
def episodeFolder(filePath):
episode_message = []
message = ""
try:
file_list = os.listdir(filePath)
# print(file_list)
for file_name in file_list:
if ".md" in file_name or ".Rmd" in file_name:
fullPath = os.path.join(filePath, f"{file_name}")
episode_message.append(singleEpisode(fullPath, file_name))
message = ""
for m in episode_message:
message += m
except:
# print("WTF 2")
return
return message
################################################################
######################### USER INTERFACE #########################
# First window that allows you to select your folder
file_list_column = [
[
sg.Text("Lesson Folder", font=(24)),
sg.In(size=(40, 1), enable_events=True, key="-ROOT FOLDER-"),
sg.FolderBrowse(font=(24)),
sg.Button("Remote Repo", enable_events=True, key="-REMOTE-", font=(24)),
],
[
sg.Listbox(values=[], enable_events=True, size=(60, 20), key="-FILE LIST-", font=(24))
],
[
sg.Column([
[
sg.Button("", enable_events=folder_clicked, key="-OPEN FOLDER-", font=(24), size=(9,1))
],]),
sg.Column([
[
sg.Button("Run", enable_events=True, key="-RUN-", font=(24))
],]),
sg.Column([
[
sg.Button("Clear", enable_events=True, key="-CLEAR-", font=(24))
],])
]
]
# Second Window Displaying Results
results_window = [[
sg.Frame("Results Window",
layout=[
[sg.Multiline("", background_color = "white",
text_color="black", key="-FRAME TEXT-", font=(20), size = (550,400)
)],
],
element_justification="left", size=(550, 400), background_color="white",
title_color="black", font=(40),
)],
]
# ----- Full layout -----
layout = [
[
sg.Column(file_list_column),
sg.VSeparator(),
sg.Column(results_window),
]
]
def repo_popup():
global temp_dir
# ----- Popup layout -----
layout_popup = [
[sg.Text("Enter the Repository's URL:", font=(24))],
[sg.In(size=(40, 1), enable_events=True, key="-REPO-", font=(24))],
[
sg.Column([
[sg.Button('Search', key="-SEARCH-", enable_events=True, font=(24))],
]),
sg.Column([
[sg.Button('Close', key="-CLOSE-", font=(24), enable_events=True)]
]),
]
]
window_popup = sg.Window('Repository Search', layout_popup)
while True:
event_popup, values_popup = window_popup.read()
if event_popup == sg.WIN_CLOSED or event_popup == 'Close Popup':
window_popup.close()
window_popup = None
break
elif event_popup == "-CLOSE-":
window_popup.close()
window_popup = None
break
elif event_popup == "-SEARCH-":
try:
# Create the Temporary Directory:
if temp_dir is None:
temp_dir = tempfile.mkdtemp()
print(temp_dir)
else:
shutil.rmtree(temp_dir)
temp_dir = None
temp_dir = tempfile.mkdtemp()
print(temp_dir)
repo_url = values_popup['-REPO-']
git_clone_command = ['git', 'clone', repo_url, temp_dir]
try:
subprocess.run(git_clone_command,
check=True, text=True)
print(f"Repository cloned to {temp_dir}")
filepath = temp_dir
window["-ROOT FOLDER-"].update(filepath)
try:
# Get list of files in folder
file_list = os.listdir(filepath)
file_list.insert(0, "..")
except:
file_list = []
fnames = [
f for f in file_list
]
window["-FILE LIST-"].update(fnames)
window_popup.close()
except subprocess.CalledProcessError as e:
print(f"Error: {e}")
sg.popup_error("This is an INVALID repository", title="Invalid Repository", font=(100))
except:
shutil.rmtree(temp_dir)
# ----- Create Windows -----
window = sg.Window("Lesson Checker", layout, size=(1000, 500))
# Run the Event Loop
while True:
event, values = window.read()
if event == "Exit" or event == sg.WIN_CLOSED:
break
# Folder name was filled in, make a list of files in the folder
if event == "-ROOT FOLDER-":
folder = values["-ROOT FOLDER-"]
try:
# Get list of files in folder
file_list = os.listdir(folder)
file_list.insert(0,"..")
except:
file_list = []
fnames = [
f for f in file_list
]
window["-FILE LIST-"].update(fnames)
elif event == "-FILE LIST-": # A file was chosen from the listbox
try:
# print(values["-FILE LIST-"])
# Gets the filepath to the file that you clicked on
filepath = os.path.join(
values["-ROOT FOLDER-"], values["-FILE LIST-"][0]
)
if os.path.isdir(filepath):
window["-OPEN FOLDER-"].update("Open Folder")
folder_clicked = True
else:
window["-OPEN FOLDER-"].update("")
folder_clicked = False
except:
pass
elif event == "-RUN-":
# processing = True
if not values["-FILE LIST-"]: # RUN IT ON THE ENTIRE DIRECTORY
if not os.path.isdir(values["-ROOT FOLDER-"]):
sg.popup_error("This is an INVALID directory", title="Invalid Directory", font=(100))
file_list = os.listdir(values["-ROOT FOLDER-"])
if "episodes" not in file_list or "config.yaml" not in file_list:
sg.popup_error("This is an INVALID directory", title="Invalid Directory", font=(100))
else:
# message =
window["-FRAME TEXT-"].update(entireFolder(values["-ROOT FOLDER-"]))
# print(values["-ROOT FOLDER-"])
else: # RUN IT ON THE FILE/FOLDER THAT WAS CLICKED
# print("FILE CLICKED") #FIXME
# if os.path.isdir()
# print(filepath)
# OPTION 1 Run Check on the entire Directory Highlighted
if os.path.isdir(filepath) and "/episodes" not in filepath:
file_list = os.listdir(filepath)
if "config.yaml" and "episodes" not in file_list:
sg.popup_error("This is an INVALID directory! Choose A different directory.",
title="Invalid Directory", font=(100))
else:
window["-FRAME TEXT-"].update(entireFolder(filepath))
# OPTION 2 Run Check on Config.yaml
elif "config.yaml" in filepath:
window["-FRAME TEXT-"].update(configYaml(filepath))
# OPTION 3 Run Check on a single Episode
elif "episodes/" in filepath:
window["-FRAME TEXT-"].update(singleEpisode(filepath, values["-FILE LIST-"][0]))
# OPTION 4 Run Check on the entire Episodes Folder
elif re.search("/episodes", filepath):
window["-FRAME TEXT-"].update(episodeFolder(filepath))
else:
sg.popup_error("This is an INVALID file/directory! Choose A different file/directory.",
title="Invalid File/Folder", font=(100))
# processing = False
elif event == "-OPEN FOLDER-":
if folder_clicked:
if ".." in filepath:
filepath = os.path.abspath(filepath)
window["-ROOT FOLDER-"].update(filepath)
try:
# Get list of files in folder
file_list = os.listdir(filepath)
file_list.insert(0, "..")
except:
file_list = []
fnames = [
f for f in file_list
]
window["-FILE LIST-"].update(fnames)
elif event == "-CLEAR-":
window["-FRAME TEXT-"].update("")
elif event == "-REMOTE-":
repo_popup()
# print(temp_dir)
if temp_dir is not None:
shutil.rmtree(temp_dir)
window.close()
################################################################