ENH: added api_rst_coverage.py

Author: seth-p

scripts/api_rst_coverage.py

@@ -0,0 +1,46 @@
+import pandas as pd
+import inspect
+import re
+
+def main():
+
+    # classes whose members to check
+    classes = [pd.Series, pd.DataFrame, pd.Panel, pd.Panel4D]
+
+    def class_name(cls):
+        return str(cls).rsplit('.')[-1][:-2]
+
+    def class_name_sort_key(x):
+        if x.startswith('Series'):
+            # make sure Series precedes DataFrame, Panel, and Panel4D
+            return ' ' + x
+        else:
+            return x
+
+    # class members
+    class_members = set()
+    for cls in classes:
+        class_members.update([class_name(cls) + '.' + x[0] for x in inspect.getmembers(cls)])
+
+    # class members referenced in api.rst
+    api_rst_members = set()
+    file_name = '../doc/source/api.rst'
+    with open(file_name, 'r') as f:
+        for line in f:
+            match = re.search('({})\.(\w+)'.format('|'.join([class_name(cls) for cls in classes])), line)
+            if match:
+                api_rst_members.add(match.group(0))
+
+    print()
+    print("Class members in api.rst that aren't actual members:")
+    for x in sorted(api_rst_members.difference(class_members), key=class_name_sort_key):
+            print(x)
+
+    print()
+    print("Class members (other than those beginning with '_') missing from api.rst:")
+    for x in sorted(class_members.difference(api_rst_members), key=class_name_sort_key):
+        if '._' not in x:
+            print(x)
+
+if __name__ == "__main__":
+    main()