4 Check lesson files and their contents.
12 from optparse import OptionParser
14 from util import Reporter, read_markdown, load_yaml
18 # Where to look for source Markdown files.
19 SOURCE_DIRS = ['', '_episodes', '_extras']
21 # Required files: each entry is ('path': YAML_required).
22 # FIXME: We do not yet validate whether any files have the required
23 # YAML headers, but should in the future.
24 # The '%' is replaced with the source directory path for checking.
25 # Episodes are handled specially, and extra files in '_extras' are also handled specially.
26 # This list must include all the Markdown files listed in the 'bin/initialize' script.
29 '%/CONTRIBUTING.md': False,
32 '%/_extras/discuss.md': True,
33 '%/_extras/figures.md': True,
34 '%/_extras/guide.md': True,
36 '%/reference.md': True,
40 # Episode filename pattern.
41 P_EPISODE_FILENAME = re.compile(r'/_episodes/(\d\d)-[-\w]+.md$')
43 # Pattern to match lines ending with whitespace.
44 P_TRAILING_WHITESPACE = re.compile(r'\s+$')
46 # Pattern to match figure references in HTML.
47 P_FIGURE_REFS = re.compile(r'<img[^>]+src="([^"]+)"[^>]*>')
49 # What kinds of blockquotes are allowed?
63 # What kinds of code fragments are allowed?
75 # What fields are required in teaching episode metadata?
76 TEACHING_METADATA_FIELDS = {
85 # What fields are required in break episode metadata?
86 BREAK_METADATA_FIELDS = {
92 # How long are lines allowed to be?
99 args.reporter = Reporter()
100 check_config(args.reporter, args.source_dir)
101 docs = read_all_markdown(args.source_dir, args.parser)
102 check_fileset(args.source_dir, args.reporter, docs.keys())
103 for filename in docs.keys():
104 checker = create_checker(args, filename, docs[filename])
106 check_figures(args.source_dir, args.reporter)
107 args.reporter.report()
111 """Parse command-line arguments."""
113 parser = OptionParser()
114 parser.add_option('-l', '--linelen',
118 help='Check line lengths')
119 parser.add_option('-p', '--parser',
122 help='path to Markdown parser')
123 parser.add_option('-s', '--source',
126 help='source directory')
127 parser.add_option('-w', '--whitespace',
130 dest='trailing_whitespace',
131 help='Check for trailing whitespace')
133 args, extras = parser.parse_args()
134 require(args.parser is not None,
135 'Path to Markdown parser not provided')
137 'Unexpected trailing command-line arguments "{0}"'.format(extras))
142 def check_config(reporter, source_dir):
143 """Check configuration file."""
145 config_file = os.path.join(source_dir, '_config.yml')
146 config = load_yaml(config_file)
147 reporter.check_field(config_file, 'configuration', config, 'kind', 'lesson')
150 def read_all_markdown(source_dir, parser):
151 """Read source files, returning
152 {path : {'metadata':yaml, 'metadata_len':N, 'text':text, 'lines':[(i, line, len)], 'doc':doc}}
155 all_dirs = [os.path.join(source_dir, d) for d in SOURCE_DIRS]
156 all_patterns = [os.path.join(d, '*.md') for d in all_dirs]
158 for pat in all_patterns:
159 for filename in glob.glob(pat):
160 data = read_markdown(parser, filename)
162 result[filename] = data
166 def check_fileset(source_dir, reporter, filenames_present):
167 """Are all required files present? Are extraneous files present?"""
169 # Check files with predictable names.
170 required = [p.replace('%', source_dir) for p in REQUIRED_FILES]
171 missing = set(required) - set(filenames_present)
173 reporter.add(None, 'Missing required file {0}', m)
175 # Check episode files' names.
177 for filename in filenames_present:
178 if '_episodes' not in filename:
180 m = P_EPISODE_FILENAME.search(filename)
182 seen.append(m.group(1))
184 reporter.add(None, 'Episode {0} has badly-formatted filename', filename)
186 # Check for duplicate episode numbers.
187 reporter.check(len(seen) == len(set(seen)),
189 'Duplicate episode numbers {0} vs {1}',
190 sorted(seen), sorted(set(seen)))
192 # Check that numbers are consecutive.
193 seen = [int(s) for s in seen]
196 for i in range(len(seen) - 1):
197 clean = clean and ((seen[i+1] - seen[i]) == 1)
198 reporter.check(clean,
200 'Missing or non-consecutive episode numbers {0}',
204 def check_figures(source_dir, reporter):
205 """Check that all figures are present and referenced."""
209 all_figures_html = os.path.join(source_dir, '_includes', 'all_figures.html')
210 with open(all_figures_html, 'r') as reader:
212 figures = P_FIGURE_REFS.findall(text)
213 referenced = [os.path.split(f)[1] for f in figures if '/fig/' in f]
214 except FileNotFoundError as e:
215 reporter.add(all_figures_html,
220 fig_dir_path = os.path.join(source_dir, 'fig')
221 actual = [f for f in os.listdir(fig_dir_path) if not f.startswith('.')]
223 # Report differences.
224 unexpected = set(actual) - set(referenced)
225 reporter.check(not unexpected,
227 'Unexpected image files: {0}',
228 ', '.join(sorted(unexpected)))
229 missing = set(referenced) - set(actual)
230 reporter.check(not missing,
232 'Missing image files: {0}',
233 ', '.join(sorted(missing)))
236 def create_checker(args, filename, info):
237 """Create appropriate checker for file."""
239 for (pat, cls) in CHECKERS:
240 if pat.search(filename):
241 return cls(args, filename, **info)
244 def require(condition, message):
245 """Fail if condition not met."""
248 print(message, file=sys.stderr)
252 class CheckBase(object):
253 """Base class for checking Markdown files."""
255 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
256 """Cache arguments for checking."""
258 super(CheckBase, self).__init__()
260 self.reporter = self.args.reporter # for convenience
261 self.filename = filename
262 self.metadata = metadata
263 self.metadata_len = metadata_len
272 """Run tests on metadata."""
274 self.check_metadata()
275 self.check_line_lengths()
276 self.check_trailing_whitespace()
277 self.check_blockquote_classes()
278 self.check_codeblock_classes()
281 def check_metadata(self):
282 """Check the YAML metadata."""
284 self.reporter.check(self.metadata is not None,
286 'Missing metadata entirely')
288 if self.metadata and (self.layout is not None):
289 self.reporter.check_field(self.filename, 'metadata', self.metadata, 'layout', self.layout)
292 def check_line_lengths(self):
293 """Check the raw text of the lesson body."""
295 if self.args.line_lengths:
296 over = [i for (i, l, n) in self.lines if (n > MAX_LINE_LEN) and (not l.startswith('!'))]
297 self.reporter.check(not over,
299 'Line(s) are too long: {0}',
300 ', '.join([str(i) for i in over]))
303 def check_trailing_whitespace(self):
304 """Check for whitespace at the ends of lines."""
306 if self.args.trailing_whitespace:
307 trailing = [i for (i, l, n) in self.lines if P_TRAILING_WHITESPACE.match(l)]
308 self.reporter.check(not trailing,
310 'Line(s) end with whitespace: {0}',
311 ', '.join([str(i) for i in trailing]))
314 def check_blockquote_classes(self):
315 """Check that all blockquotes have known classes."""
317 for node in self.find_all(self.doc, {'type' : 'blockquote'}):
318 cls = self.get_val(node, 'attr', 'class')
319 self.reporter.check(cls in KNOWN_BLOCKQUOTES,
320 (self.filename, self.get_loc(node)),
321 'Unknown or missing blockquote type {0}',
325 def check_codeblock_classes(self):
326 """Check that all code blocks have known classes."""
328 for node in self.find_all(self.doc, {'type' : 'codeblock'}):
329 cls = self.get_val(node, 'attr', 'class')
330 self.reporter.check(cls in KNOWN_CODEBLOCKS,
331 (self.filename, self.get_loc(node)),
332 'Unknown or missing code block type {0}',
336 def find_all(self, node, pattern, accum=None):
337 """Find all matches for a pattern."""
339 assert type(pattern) == dict, 'Patterns must be dictionaries'
342 if self.match(node, pattern):
344 for child in node.get('children', []):
345 self.find_all(child, pattern, accum)
349 def match(self, node, pattern):
350 """Does this node match the given pattern?"""
359 elif type(val) == dict:
360 if not self.match(node[key], val):
365 def get_val(self, node, *chain):
366 """Get value one or more levels down."""
369 for selector in chain:
370 curr = curr.get(selector, None)
376 def get_loc(self, node):
377 """Convenience method to get node's line number."""
379 result = self.get_val(node, 'options', 'location')
380 if self.metadata_len is not None:
381 result += self.metadata_len
385 class CheckNonJekyll(CheckBase):
386 """Check a file that isn't translated by Jekyll."""
388 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
389 super(CheckNonJekyll, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
392 def check_metadata(self):
393 self.reporter.check(self.metadata is None,
395 'Unexpected metadata')
398 class CheckIndex(CheckBase):
399 """Check the main index page."""
401 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
402 super(CheckIndex, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
403 self.layout = 'lesson'
406 class CheckEpisode(CheckBase):
407 """Check an episode page."""
409 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
410 super(CheckEpisode, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
412 def check_metadata(self):
413 super(CheckEpisode, self).check_metadata()
415 if 'layout' in self.metadata:
416 if self.metadata['layout'] == 'break':
417 self.check_metadata_fields(BREAK_METADATA_FIELDS)
419 self.reporter.add(self.filename,
420 'Unknown episode layout "{0}"',
421 self.metadata['layout'])
423 self.check_metadata_fields(TEACHING_METADATA_FIELDS)
426 def check_metadata_fields(self, expected):
427 for (name, type_) in expected:
428 if name not in self.metadata:
429 self.reporter.add(self.filename,
430 'Missing metadata field {0}',
432 elif type(self.metadata[name]) != type_:
433 self.reporter.add(self.filename,
434 '"{0}" has wrong type in metadata ({1} instead of {2})',
435 name, type(self.metadata[name]), type_)
438 class CheckReference(CheckBase):
439 """Check the reference page."""
441 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
442 super(CheckReference, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
443 self.layout = 'reference'
446 class CheckGeneric(CheckBase):
447 """Check a generic page."""
449 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
450 super(CheckGeneric, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
455 (re.compile(r'CONTRIBUTING\.md'), CheckNonJekyll),
456 (re.compile(r'README\.md'), CheckNonJekyll),
457 (re.compile(r'index\.md'), CheckIndex),
458 (re.compile(r'reference\.md'), CheckReference),
459 (re.compile(r'_episodes/.*\.md'), CheckEpisode),
460 (re.compile(r'.*\.md'), CheckGeneric)
464 if __name__ == '__main__':