464e5e0bfe
The 'make doxygen' component has this cool vpp specific customization called siphon. This updates the siphon component so that 'make doxygen' works with python3. Needed-By: https://gerrit.fd.io/r/23159 Type: docs Change-Id: Ie29f1602bf3460b637058acbb0a2f19b128a8824 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
78 lines
2.8 KiB
Python
Executable File
78 lines
2.8 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at:
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
# Filter for .siphon files that are generated by other filters.
|
|
# The idea is to siphon off certain initializers so that we can better
|
|
# auto-document the contents of that initializer.
|
|
|
|
import argparse
|
|
import logging
|
|
import os
|
|
import sys
|
|
|
|
import siphon
|
|
|
|
DEFAULT_LOGFILE = None
|
|
DEFAULT_LOGLEVEL = "info"
|
|
DEFAULT_SIPHON = "clicmd"
|
|
DEFAULT_FORMAT = "markdown"
|
|
DEFAULT_OUTPUT = None
|
|
DEFAULT_TEMPLATES = os.path.dirname(__file__) + "/siphon_templates"
|
|
|
|
ap = argparse.ArgumentParser()
|
|
ap.add_argument("--log-file", default=DEFAULT_LOGFILE,
|
|
help="Log file [%s]" % DEFAULT_LOGFILE)
|
|
ap.add_argument("--log-level", default=DEFAULT_LOGLEVEL,
|
|
choices=["debug", "info", "warning", "error", "critical"],
|
|
help="Logging level [%s]" % DEFAULT_LOGLEVEL)
|
|
|
|
ap.add_argument("--type", '-t', metavar="siphon_type", default=DEFAULT_SIPHON,
|
|
choices=siphon.process.siphons.keys(),
|
|
help="Siphon type to process [%s]" % DEFAULT_SIPHON)
|
|
ap.add_argument("--format", '-f', default=DEFAULT_FORMAT,
|
|
choices=siphon.process.formats.keys(),
|
|
help="Output format to generate [%s]" % DEFAULT_FORMAT)
|
|
ap.add_argument("--output", '-o', metavar="file", default=DEFAULT_OUTPUT,
|
|
help="Output file (uses stdout if not defined) [%s]" %
|
|
DEFAULT_OUTPUT)
|
|
ap.add_argument("--templates", metavar="directory", default=DEFAULT_TEMPLATES,
|
|
help="Path to render templates directory [%s]" %
|
|
DEFAULT_TEMPLATES)
|
|
ap.add_argument("input", nargs='+', metavar="input_file",
|
|
help="Input .siphon files")
|
|
args = ap.parse_args()
|
|
|
|
logging.basicConfig(filename=args.log_file,
|
|
level=getattr(logging, args.log_level.upper(), None))
|
|
log = logging.getLogger("siphon_process")
|
|
|
|
# Determine where to send the generated output
|
|
if args.output is None:
|
|
out = sys.stdout
|
|
else:
|
|
out = open(args.output, "w+")
|
|
|
|
# Get our processor
|
|
klass = siphon.process.siphons[args.type]
|
|
processor = klass(template_directory=args.templates, format=args.format)
|
|
|
|
# Load the input files
|
|
processor.load_json(args.input)
|
|
|
|
# Process the data
|
|
processor.process(out=out)
|
|
|
|
# All done
|