warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Better document string

Browse Source
This commit is contained in:
Jason R. Jones 2020-07-24 10:16:45 -04:00
parent 028f295331
commit 3009a1725d
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/wireviz/wireviz.py
View File

@ -209,8 +209,14 @@ def parse_file(yaml_file: str, file_out: (str, Path) = None) -> None:
@click.command() @click.command()
@click.argument('input_file', required=True) @click.argument('input_file', required=True)
@click.option('--prepend', '-p', default=None, help='a YAML file containing a library of templates and parts that may be referenced in the `input_file`') @click.option('--prepend', '-p', default=None, help='a YAML file containing a library of templates and parts that may be referenced in the `input_file`')
@click.option('--out_types', '-o', multiple=True, default=['png'], help='the output formats to be generated') @click.option('--out', '-o', multiple=True, default=['png'], help='specify one or more output types to be generated; currently supports "png" "svg"')
def main(input_file, prepend, out_types): def main(input_file, prepend, out):
"""
Take a YAML file containing a harness specification and, utilizing GraphViz,
translate that specification into various output formats. Example:
$>wireviz my_input_file.yml -o png -o svg
"""
if not os.path.exists(input_file): if not os.path.exists(input_file):
print(f'Error: input file {input_file} inaccessible or does not exist, check path') print(f'Error: input file {input_file} inaccessible or does not exist, check path')
sys.exit(1) sys.exit(1)
@ -231,14 +237,14 @@ def main(input_file, prepend, out_types):
# the parse function may return a single instance or a tuple, thus, the # the parse function may return a single instance or a tuple, thus, the
# if/then determines if there is only one thing that must be saved or multiple # if/then determines if there is only one thing that must be saved or multiple
filedatas = parse(yaml_input, return_types=out_types) filedatas = parse(yaml_input, return_types=out)
if isinstance(filedatas, tuple): if isinstance(filedatas, tuple):
for ext, data in zip(out_types, filedatas): for ext, data in zip(out, filedatas):
fname = f'{base_file_name}.{ext}' fname = f'{base_file_name}.{ext}'
with open(fname, 'wb') as f: with open(fname, 'wb') as f:
f.write(data) f.write(data)
else: else:
ext = out_types[0] ext = out[0]
data = filedatas data = filedatas
fname = f'{base_file_name}.{ext}' fname = f'{base_file_name}.{ext}'
with open(fname, 'wb') as f: with open(fname, 'wb') as f: