4 Check lesson files and their contents.
13 from optparse import OptionParser
15 from util import Reporter, read_markdown
19 # Where to look for source Markdown files.
20 SOURCE_DIRS = ['', '_episodes', '_extras']
22 # Required files: each entry is ('path': YAML_required).
23 # FIXME: We do not yet validate whether any files have the required
24 # YAML headers, but should in the future.
25 # The '%' is replaced with the source directory path for checking.
26 # Episodes are handled specially, and extra files in '_extras' are also handled specially.
27 # This list must include all the Markdown files listed in the 'bin/initialize' script.
30 '%/CONTRIBUTING.md': False,
33 '%/_extras/discuss.md': True,
34 '%/_extras/figures.md': True,
35 '%/_extras/guide.md': True,
37 '%/reference.md': True,
41 # Episode filename pattern.
42 P_EPISODE_FILENAME = re.compile(r'/_episodes/(\d\d)-[-\w]+.md$')
44 # What kinds of blockquotes are allowed?
58 # What kinds of code fragments are allowed?
70 # What fields are required in teaching episode metadata?
71 TEACHING_METADATA_FIELDS = {
80 # What fields are required in break episode metadata?
81 BREAK_METADATA_FIELDS = {
87 # How long are lines allowed to be?
94 args.reporter = Reporter()
95 check_config(args.reporter, args.source_dir)
96 docs = read_all_markdown(args.source_dir, args.parser)
97 check_fileset(args.source_dir, args.reporter, docs.keys())
98 for filename in docs.keys():
99 checker = create_checker(args, filename, docs[filename])
101 args.reporter.report()
105 """Parse command-line arguments."""
107 parser = OptionParser()
108 parser.add_option('-l', '--linelen',
111 help='Check line lengths')
112 parser.add_option('-p', '--parser',
115 help='path to Markdown parser')
116 parser.add_option('-s', '--source',
119 help='source directory')
121 args, extras = parser.parse_args()
122 require(args.parser is not None,
123 'Path to Markdown parser not provided')
125 'Unexpected trailing command-line arguments "{0}"'.format(extras))
130 def check_config(reporter, source_dir):
131 """Check configuration file."""
133 config_file = os.path.join(source_dir, '_config.yml')
134 with open(config_file, 'r') as reader:
135 config = yaml.load(reader)
136 reporter.check_field(config_file, 'configuration', config, 'kind', 'lesson')
139 def read_all_markdown(source_dir, parser):
140 """Read source files, returning
141 {path : {'metadata':yaml, 'metadata_len':N, 'text':text, 'lines':[(i, line, len)], 'doc':doc}}
144 all_dirs = [os.path.join(source_dir, d) for d in SOURCE_DIRS]
145 all_patterns = [os.path.join(d, '*.md') for d in all_dirs]
147 for pat in all_patterns:
148 for filename in glob.glob(pat):
149 data = read_markdown(parser, filename)
151 result[filename] = data
155 def check_fileset(source_dir, reporter, filenames_present):
156 """Are all required files present? Are extraneous files present?"""
158 # Check files with predictable names.
159 required = [p.replace('%', source_dir) for p in REQUIRED_FILES]
160 missing = set(required) - set(filenames_present)
162 reporter.add(None, 'Missing required file {0}', m)
164 # Check episode files' names.
166 for filename in filenames_present:
167 if '_episodes' not in filename:
169 m = P_EPISODE_FILENAME.search(filename)
171 seen.append(m.group(1))
173 reporter.add(None, 'Episode {0} has badly-formatted filename', filename)
175 # Check for duplicate episode numbers.
176 reporter.check(len(seen) == len(set(seen)),
178 'Duplicate episode numbers {0} vs {1}',
179 sorted(seen), sorted(set(seen)))
181 # Check that numbers are consecutive.
182 seen = [int(s) for s in seen]
185 for i in range(len(seen) - 1):
186 clean = clean and ((seen[i+1] - seen[i]) == 1)
187 reporter.check(clean,
189 'Missing or non-consecutive episode numbers {0}',
193 def create_checker(args, filename, info):
194 """Create appropriate checker for file."""
196 for (pat, cls) in CHECKERS:
197 if pat.search(filename):
198 return cls(args, filename, **info)
201 def require(condition, message):
202 """Fail if condition not met."""
205 print(message, file=sys.stderr)
209 class CheckBase(object):
210 """Base class for checking Markdown files."""
212 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
213 """Cache arguments for checking."""
215 super(CheckBase, self).__init__()
217 self.reporter = self.args.reporter # for convenience
218 self.filename = filename
219 self.metadata = metadata
220 self.metadata_len = metadata_len
229 """Run tests on metadata."""
231 self.check_metadata()
233 self.check_blockquote_classes()
234 self.check_codeblock_classes()
237 def check_metadata(self):
238 """Check the YAML metadata."""
240 self.reporter.check(self.metadata is not None,
242 'Missing metadata entirely')
244 if self.metadata and (self.layout is not None):
245 self.reporter.check_field(self.filename, 'metadata', self.metadata, 'layout', self.layout)
248 def check_text(self):
249 """Check the raw text of the lesson body."""
251 if self.args.line_len:
252 over = [i for (i, l, n) in self.lines if (n > MAX_LINE_LEN) and (not l.startswith('!'))]
253 self.reporter.check(not over,
255 'Line(s) are too long: {0}',
256 ', '.join([str(i) for i in over]))
259 def check_blockquote_classes(self):
260 """Check that all blockquotes have known classes."""
262 for node in self.find_all(self.doc, {'type' : 'blockquote'}):
263 cls = self.get_val(node, 'attr', 'class')
264 self.reporter.check(cls in KNOWN_BLOCKQUOTES,
265 (self.filename, self.get_loc(node)),
266 'Unknown or missing blockquote type {0}',
270 def check_codeblock_classes(self):
271 """Check that all code blocks have known classes."""
273 for node in self.find_all(self.doc, {'type' : 'codeblock'}):
274 cls = self.get_val(node, 'attr', 'class')
275 self.reporter.check(cls in KNOWN_CODEBLOCKS,
276 (self.filename, self.get_loc(node)),
277 'Unknown or missing code block type {0}',
281 def find_all(self, node, pattern, accum=None):
282 """Find all matches for a pattern."""
284 assert type(pattern) == dict, 'Patterns must be dictionaries'
287 if self.match(node, pattern):
289 for child in node.get('children', []):
290 self.find_all(child, pattern, accum)
294 def match(self, node, pattern):
295 """Does this node match the given pattern?"""
304 elif type(val) == dict:
305 if not self.match(node[key], val):
310 def get_val(self, node, *chain):
311 """Get value one or more levels down."""
314 for selector in chain:
315 curr = curr.get(selector, None)
321 def get_loc(self, node):
322 """Convenience method to get node's line number."""
324 result = self.get_val(node, 'options', 'location')
325 if self.metadata_len is not None:
326 result += self.metadata_len
330 class CheckNonJekyll(CheckBase):
331 """Check a file that isn't translated by Jekyll."""
333 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
334 super(CheckNonJekyll, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
337 def check_metadata(self):
338 self.reporter.check(self.metadata is None,
340 'Unexpected metadata')
343 class CheckIndex(CheckBase):
344 """Check the main index page."""
346 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
347 super(CheckIndex, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
348 self.layout = 'lesson'
351 class CheckEpisode(CheckBase):
352 """Check an episode page."""
354 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
355 super(CheckEpisode, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
357 def check_metadata(self):
358 super(CheckEpisode, self).check_metadata()
360 if 'layout' in self.metadata:
361 if self.metadata['layout'] == 'break':
362 self.check_metadata_fields(BREAK_METADATA_FIELDS)
364 self.reporter.add(self.filename,
365 'Unknown episode layout "{0}"',
366 self.metadata['layout'])
368 self.check_metadata_fields(TEACHING_METADATA_FIELDS)
371 def check_metadata_fields(self, expected):
372 for (name, type_) in expected:
373 if name not in self.metadata:
374 self.reporter.add(self.filename,
375 'Missing metadata field {0}',
377 elif type(self.metadata[name]) != type_:
378 self.reporter.add(self.filename,
379 '"{0}" has wrong type in metadata ({1} instead of {2})',
380 name, type(self.metadata[name]), type_)
383 class CheckReference(CheckBase):
384 """Check the reference page."""
386 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
387 super(CheckReference, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
388 self.layout = 'reference'
391 class CheckGeneric(CheckBase):
392 """Check a generic page."""
394 def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
395 super(CheckGeneric, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
400 (re.compile(r'CONTRIBUTING\.md'), CheckNonJekyll),
401 (re.compile(r'README\.md'), CheckNonJekyll),
402 (re.compile(r'index\.md'), CheckIndex),
403 (re.compile(r'reference\.md'), CheckReference),
404 (re.compile(r'_episodes/.*\.md'), CheckEpisode),
405 (re.compile(r'.*\.md'), CheckGeneric)
409 if __name__ == '__main__':