From 7ec8511995a5f5eec47766065d8aa9dba7d6b325 Mon Sep 17 00:00:00 2001
From: Mitzi Morris <mitzi@panix.com>
Date: Mon, 27 Apr 2020 19:27:34 -0400
Subject: [PATCH] scrape, format functions signatures from Rmd

---
 extract_function_sigs.py | 58 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 extract_function_sigs.py

diff --git a/extract_function_sigs.py b/extract_function_sigs.py
new file mode 100644
index 000000000..41f35b69b
--- /dev/null
+++ b/extract_function_sigs.py
@@ -0,0 +1,58 @@
+#!/usr/bin/env python
+"""
+Extract function signatures from html comments in markdown.
+"""
+
+import glob
+import os
+import os.path
+import sys
+import contextlib
+
+
+@contextlib.contextmanager
+def pushd(new_dir):
+    previous_dir = os.getcwd()
+    os.chdir(new_dir)
+    yield
+    os.chdir(previous_dir)
+
+
+def main():
+    if len(sys.argv) > 2:
+        stan_major = int(sys.argv[1])
+        stan_minor = int(sys.argv[2])
+    else:
+        print('Expecting 2 arguments <MAJOR> <MINOR> version numbers')
+        sys.exit(1)
+
+    sigs = set()
+    ref_dir = os.path.join('src', 'functions-reference')
+    with pushd(ref_dir):
+        for file in glob.glob('*.Rmd'):
+            print(file)
+            with open(file) as rmd_file:
+                lines = rmd_file.readlines()
+                for line in lines:
+                    if line.startswith('<!-- '):
+                        line = line.lstrip('<!- ')
+                        parts = [x.strip(' ~') for x in line.split(';')]
+                        if len(parts) == 3:
+                            parts[1] = parts[1]
+                            sigs.add('{}; ~; {}'.format(parts[1], parts[0]))
+                        elif len(parts) == 4:
+                            sigs.add('{}; {}; {}'.format(parts[1], parts[2], parts[0]))
+                        else:
+                            print('not a function sig: {}'.format(line))
+
+    outfile_name = 'stan-fuctions-{}_{}.txt'.format(str(stan_major), str(stan_minor))
+    with open(outfile_name, 'w') as outfile:
+        outfile.write('# This file is semicolon delimited\n')
+        outfile.write('StanFunction; Arguments; ReturnType\n')
+        for sig in sorted(sigs):
+            outfile.write(sig)
+            outfile.write('\n')
+
+
+if __name__ == '__main__':
+    main()