Generator for Python bindings.

Includes:
0. Command-line tool for generating Python bindings from YAML
specifications.
1. Uses Python's Construct library for flexible, declarative binary
parsing.
2. Basic syntax and schema validation on YAML specifications.

Closes swift-nav#3, swift-nav#9, swift-nav#16.

/cc @fnoble, @mfine

Author: mookerji

.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 *.*~
+limbo/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

generator/.coveragerc

@@ -0,0 +1,23 @@
+[run]
+branch = True
+include = sbp/*
+
+[report]
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+ignore_errors = True
+
+[omit]
+omit =
+    tests/*
+    limbo/*

generator/.gitignore

@@ -0,0 +1,57 @@
+.DS_Store
+*.*~
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/

generator/MANIFEST.in

@@ -0,0 +1,12 @@
+include *.cfg
+include *.md
+include *.py
+include .coveragerc
+include .gitignore
+include LICENSE
+include tox.ini
+recursive-include doc/ *
+recursive-include sbp/ *.html
+recursive-include sbp/ *.j2
+recursive-include sbp/ *.py
+recursive-include tests *.py

generator/README.md

@@ -0,0 +1,56 @@
+## SBP Generator
+
+A quite basic, template-based generator for generating SBP bindings in
+different languages.
+
+## Usage
+
+Courtesy of `argparse`:
+
+```
+usage: generator.py [-h] -i INPUT_FILE -o OUTPUT_DIR [--python] [--c] [--docs] [-v]
+
+Swift Navigation SBP generator.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -i INPUT_FILE, --input_file INPUT_FILE
+                        Input spec file or directory.
+  -o OUTPUT_DIR, --output_dir OUTPUT_DIR
+                        Output directory.
+  --python              Target language: Python.
+  --c                   Target language: C.
+  -v, --verbose         Print debugging info.
+```
+
+For example,
+
+```shell
+# Output C bindings:
+python sbp/generator.py -i ../spec/yaml/swift/sbp/ -o ../c/ --c
+
+# Output Python bindings:
+python sbp/generator.py -i ../spec/yaml/swift/sbp/ -o ../python/ --c
+python sbp/generator.py -i ../spec/yaml/swift/sbp/navigation.yaml -o ../python/ --c
+
+```
+
+## Testing and Deployment
+
+```shell
+# Install dependencies
+pip install -r requirements.txt
+
+# Running tests
+py.test -q -vv test/
+
+# Deploying to pypi
+
+
+```
+
+## LICENSE
+
+Copyright © 2015 Swift Navigation
+
+Distributed under LGPLv3.0.

generator/requirements.txt

@@ -0,0 +1,14 @@
+Jinja2
+PyYAML
+coverage
+docutils
+flake8
+mccabe
+pep8
+pyflakes
+pylint
+pytest
+tox
+voluptuous
+pytest-cov
+pytest-xdist

generator/sbp/__init__.py

@@ -0,0 +1,86 @@
+#!/usr/bin/python
+
+# Copyright (C) 2015 Swift Navigation Inc.
+# Contact: Bhaskar Mookerji <[email protected]>
+#
+# This source is subject to the license found in the file 'LICENSE' which must
+# be be distributed together with this source. All other rights reserved.
+#
+# THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
+# EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
+
+"""
+Main executable.
+"""
+
+import argparse
+import os
+import pprint
+import sbp.specs.yaml2 as yaml
+import sbp.targets.python as py
+import sbp.targets.c as c
+
+def get_args():
+  parser = argparse.ArgumentParser(description='Swift Navigation SBP generator.')
+  parser.add_argument('-i',
+                      '--input_file',
+                      nargs=1,
+                      required=True,
+                      help='Input spec file or directory.')
+  parser.add_argument('-o',
+                      '--output_dir',
+                      nargs=1,
+                      required=True,
+                      help='Output directory.')
+  parser.add_argument('--python',
+                      action="store_true",
+                      help='Target language: Python.')
+  parser.add_argument('--c',
+                      action="store_true",
+                      help='Target language: C.')
+  parser.add_argument('-v',
+                      '--verbose',
+                      action="store_true",
+                      help='Print debugging info.')
+  return parser
+
+
+# f = '../spec/yaml/swift/sbp/'
+# file_index = yaml.resolve_deps(*yaml.get_files(f))
+
+def main():
+  try:
+    # Parse and validate arguments.
+    args = get_args().parse_args()
+    verbose = args.verbose
+    assert args.python or args.c, "Please specify a target language."
+    input_file = os.path.abspath(args.input_file[0])
+    assert len(args.input_file) == 1
+    assert os.path.exists(input_file), \
+      "Invalid input file: %s. Exiting!" % input_file
+    output_dir = os.path.abspath(args.output_dir[0])
+    assert len(args.output_dir) == 1, "Only 1 output directory at a time."
+    assert os.path.exists(output_dir), \
+      "Invalid output directory: %s. Exiting!" % output_dir
+    # Ingest, parse, and validate.
+    file_index = yaml.resolve_deps(*yaml.get_files(input_file))
+    if verbose:
+      print "Reading files..."
+      pprint.pprint(file_index.keys())
+      print "Writing to %s" % output_dir
+    # for fname, spec in file_index.items():
+    #   print yaml.parse_spec(spec)
+    for fname, spec in file_index.items():
+      parsed = yaml.parse_spec(spec)
+      if not parsed.render_source:
+        continue
+      if args.python:
+        py.render_source(output_dir, parsed)
+      if args.c:
+        c.render_source(output_dir, parsed)
+  except KeyboardInterrupt:
+    pass
+
+if __name__ == '__main__':
+  main()