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
|
#!/usr/bin/env python
import inspect
import openturns as ot
import openturns.experimental as otexp
import openturns.testing as ott
from pathlib import Path
import re
ot.TESTPREAMBLE()
# find all rst files
rst_files = (
Path(__file__).parents[1].joinpath("doc").joinpath("user_manual").rglob("*.rst")
)
rst_lines = []
for rst_file in rst_files:
with open(rst_file) as f:
rst_lines += f.read().splitlines()
# find all instantiable classes
instantiables = []
for mod in [ot, otexp, ott]:
for name, obj in inspect.getmembers(mod):
if inspect.isclass(obj):
cn = obj.__name__
if (
cn.startswith("_")
or cn.endswith("Collection")
or cn.endswith("Implementation")
):
continue
try:
instance = obj()
instantiables.append(obj)
except Exception:
pass
# find missing docstrings
count_class = 0
count_class_undoc = 0
count_methods = 0
count_methods_undoc = 0
for class_ in instantiables:
cn = class_.__name__
count_class += 1
found = False
for line in rst_lines:
if re.search(rf"{cn}", line) is not None:
found = True
break
if not found:
count_class_undoc += 1
print(f"{cn} class")
# find all static functions
for name, mod in inspect.getmembers(ot):
if inspect.ismodule(mod):
modn = mod.__name__
if not modn.startswith("openturns") or modn == "openturns":
continue
if "_" in modn:
continue
for attr_name in dir(mod):
if "_" in attr_name:
continue
obj = getattr(mod, attr_name)
if not inspect.isclass(obj) and callable(obj):
symboln = f"{modn.split('.')[1]}.{attr_name}"
count_methods += 1
found = False
for line in rst_lines:
if re.search(rf"\b{symboln}\b", line) is not None:
found = True
break
if not found:
count_methods_undoc += 1
print(f"{symboln} method")
print(
f"-- undocumented classes: {count_class_undoc} ({100.0 * count_class_undoc / count_class:.2f}%) --"
)
print(
f"-- undocumented methods: {count_methods_undoc} ({100.0 * count_methods_undoc / count_methods:.2f}%) --"
)
if count_class_undoc + count_methods_undoc > 12:
raise ValueError("too much undocumented class/methods")
|
