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

Add -b BRANCH argument to the compare and restore commands

Browse Source 
Adding an optional -b BRANCH argument to build_examples.py to enable
comparing to and restoring from any branch or commit. That will help
when e.g. reversing an unfortunate commit of generated files.

This solves part 2 of issue #167.
This commit is contained in:
KV 2020-09-13 06:09:32 +02:00 committed by Daniel Rojas
parent df90d8326a
commit b14f5cba19
1 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/wireviz/build_examples.py
View File

@ -13,22 +13,23 @@ from wireviz import wireviz
from wv_helper import open_file_write, open_file_read, open_file_append from wv_helper import open_file_write, open_file_read, open_file_append
dir = script_path.parent.parent.parent
readme = 'readme.md' readme = 'readme.md'
groups = { groups = {
'examples': { 'examples': {
'path': Path(script_path).parent.parent.parent / 'examples', 'path': dir / 'examples',
'prefix': 'ex', 'prefix': 'ex',
readme: [], # Include no files readme: [], # Include no files
'title': 'Example Gallery', 'title': 'Example Gallery',
}, },
'tutorial' : { 'tutorial' : {
'path': Path(script_path).parent.parent.parent / 'tutorial', 'path': dir / 'tutorial',
'prefix': 'tutorial', 'prefix': 'tutorial',
readme: ['md', 'yml'], # Include .md and .yml files readme: ['md', 'yml'], # Include .md and .yml files
'title': 'WireViz Tutorial', 'title': 'WireViz Tutorial',
}, },
'demos' : { 'demos' : {
'path': Path(script_path).parent.parent.parent / 'examples', 'path': dir / 'examples',
'prefix': 'demo', 'prefix': 'demo',
}, },
} }
@ -96,17 +97,21 @@ def clean_generated(groupkeys):
os.remove(filename) os.remove(filename)
def compare_generated(groupkeys, include_graphviz_output = False): def compare_generated(groupkeys, branch = '', include_graphviz_output = False):
if branch:
branch = f' {branch.strip()}'
compare_extensions = generated_extensions if include_graphviz_output else extensions_not_containing_graphviz_output compare_extensions = generated_extensions if include_graphviz_output else extensions_not_containing_graphviz_output
for key in groupkeys: for key in groupkeys:
# collect and compare files # collect and compare files
for filename in collect_filenames('Comparing', key, compare_extensions): for filename in collect_filenames('Comparing', key, compare_extensions):
cmd = f'git --no-pager diff "{filename}"' cmd = f'git --no-pager diff{branch} -- "{filename}"'
print(f' {cmd}') print(f' {cmd}')
os.system(cmd) os.system(cmd)
def restore_generated(groupkeys): def restore_generated(groupkeys, branch = ''):
if branch:
branch = f' {branch.strip()}'
for key in groupkeys: for key in groupkeys:
# collect input YAML files # collect input YAML files
filename_list = collect_filenames('Restoring', key, input_extensions) filename_list = collect_filenames('Restoring', key, input_extensions)
@ -116,7 +121,7 @@ def restore_generated(groupkeys):
filename_list.append(groups[key]['path'] / readme) filename_list.append(groups[key]['path'] / readme)
# restore files # restore files
for filename in filename_list: for filename in filename_list:
cmd = f'git checkout -- "{filename}"' cmd = f'git checkout{branch} -- "{filename}"'
print(f' {cmd}') print(f' {cmd}')
os.system(cmd) os.system(cmd)
@ -128,6 +133,8 @@ def parse_args():
help='what to do with the generated files (default: build)') help='what to do with the generated files (default: build)')
parser.add_argument('-c', '--compare-graphviz-output', action='store_true', parser.add_argument('-c', '--compare-graphviz-output', action='store_true',
help='the Graphviz output is also compared (default: False)') help='the Graphviz output is also compared (default: False)')
parser.add_argument('-b', '--branch', action='store', default='',
help='branch or commit to compare with or restore from')
parser.add_argument('-g', '--groups', nargs='+', parser.add_argument('-g', '--groups', nargs='+',
choices=groups.keys(), default=groups.keys(), choices=groups.keys(), default=groups.keys(),
help='the groups of generated files (default: all)') help='the groups of generated files (default: all)')
@ -141,9 +148,9 @@ def main():
elif args.action == 'clean': elif args.action == 'clean':
clean_generated(args.groups) clean_generated(args.groups)
elif args.action == 'compare': elif args.action == 'compare':
compare_generated(args.groups, args.compare_graphviz_output) compare_generated(args.groups, args.branch, args.compare_graphviz_output)
elif args.action == 'restore': elif args.action == 'restore':
restore_generated(args.groups) restore_generated(args.groups, args.branch)
if __name__ == '__main__': if __name__ == '__main__':