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
|
#!/usr/lib/env python
#
# Module Documentation Override Check
#
# Verifies that any modules present in the _templates/overrides directory have all of their
# their exported functions included in the doc file.
import importlib
from pathlib import Path
import sys
modules_to_skip = ['metpy.xarray']
failed = False
for full_path in (Path('_templates') / 'overrides').glob('metpy.*.rst'):
module = full_path.with_suffix('').name
if module in modules_to_skip:
continue
# Get all functions in the module
i = importlib.import_module(module)
functions = set(i.__all__)
# Get all lines in the file
with open(full_path) as f:
lines = f.read().splitlines()
lines = {line.strip() for line in lines}
# Check for any missing functions
missing_functions = functions - lines
if missing_functions:
failed = True
print('ERROR - The following functions are missing from the override file ' +
str(full_path.name) + ': ' + ', '.join(missing_functions), file=sys.stderr)
# Report status
if failed:
sys.exit(1)
else:
print('Override check successful.')
|
