2 # Copyright (c) 2016 Comcast Cable Communications Management, LLC.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # Filter for .siphon files that are generated by other filters.
17 # The idea is to siphon off certain initializers so that we can better
18 # auto-document the contents of that initializer.
20 import os, sys, argparse, logging
23 DEFAULT_LOGFILE = None
24 DEFAULT_LOGLEVEL = "info"
25 DEFAULT_SIPHON ="clicmd"
26 DEFAULT_FORMAT = "markdown"
28 DEFAULT_TEMPLATES = os.path.dirname(__file__) + "/siphon_templates"
30 ap = argparse.ArgumentParser()
31 ap.add_argument("--log-file", default=DEFAULT_LOGFILE,
32 help="Log file [%s]" % DEFAULT_LOGFILE)
33 ap.add_argument("--log-level", default=DEFAULT_LOGLEVEL,
34 choices=["debug", "info", "warning", "error", "critical"],
35 help="Logging level [%s]" % DEFAULT_LOGLEVEL)
37 ap.add_argument("--type", '-t', metavar="siphon_type", default=DEFAULT_SIPHON,
38 choices=siphon.process.siphons.keys(),
39 help="Siphon type to process [%s]" % DEFAULT_SIPHON)
40 ap.add_argument("--format", '-f', default=DEFAULT_FORMAT,
41 choices=siphon.process.formats.keys(),
42 help="Output format to generate [%s]" % DEFAULT_FORMAT)
43 ap.add_argument("--output", '-o', metavar="file", default=DEFAULT_OUTPUT,
44 help="Output file (uses stdout if not defined) [%s]" % DEFAULT_OUTPUT)
45 ap.add_argument("--templates", metavar="directory", default=DEFAULT_TEMPLATES,
46 help="Path to render templates directory [%s]" % DEFAULT_TEMPLATES)
47 ap.add_argument("input", nargs='+', metavar="input_file",
48 help="Input .siphon files")
49 args = ap.parse_args()
51 logging.basicConfig(filename=args.log_file,
52 level=getattr(logging, args.log_level.upper(), None))
53 log = logging.getLogger("siphon_process")
55 # Determine where to send the generated output
56 if args.output is None:
59 out = open(args.output, "w+")
62 klass = siphon.process.siphons[args.type]
63 processor = klass(template_directory=args.templates, format=args.format)
65 # Load the input files
66 processor.load_json(args.input)
69 processor.process(out=out)