def main(args=None):
if args is None:
args = sys.argv[1:]
import argparse
parser = ConfigBackedParser('hg-nbdiff', description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter,
)
add_diff_args(parser)
add_diff_cli_args(parser)
add_filename_args(parser, ('base', 'remote'))
opts = parser.parse_args(args)
# TODO: Filter base/remote: If directories, find all modified notebooks
# If files that are not notebooks, ensure a decent error is printed.
if not os.path.isfile(opts.base) or not os.path.isfile(opts.remote):
base, remote = opts.base, opts.remote
for a, b in diff_directories(base, remote):
opts.base, opts.remote = a, b
ret = nbdiffapp.main_diff(opts)
if ret != 0:
return ret
return ret
else:
return nbdiffapp.main_diff(opts)
def main(args=None):
if args is None:
args = sys.argv[1:]
import argparse
parser = ConfigBackedParser(
'hg-nbdiff',
description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter,
)
add_diff_args(parser)
add_diff_cli_args(parser)
add_prettyprint_args(parser)
add_filename_args(parser, ('base', 'remote'))
opts = parser.parse_args(args)
# TODO: Filter base/remote: If directories, find all modified notebooks
# If files that are not notebooks, ensure a decent error is printed.
if not os.path.isfile(opts.base) or not os.path.isfile(opts.remote):
base, remote = opts.base, opts.remote
for a, b in diff_directories(base, remote):
opts.base, opts.remote = a, b
ret = nbdiffapp.main_diff(opts)
if ret != 0:
return ret
return ret
else:
return nbdiffapp.main_diff(opts)
def test_nbdiff_app_null_file(filespath):
fn = os.path.join(filespath, "multilevel-test-base.ipynb")
args = nbdiffapp._build_arg_parser().parse_args([fn, EXPLICIT_MISSING_FILE])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args([EXPLICIT_MISSING_FILE, fn])
assert 0 == main_diff(args)
def test_nbdiff_app_null_file(filespath):
fn = os.path.join(filespath, "multilevel-test-base.ipynb")
args = nbdiffapp._build_arg_parser().parse_args([fn, EXPLICIT_MISSING_FILE])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args([EXPLICIT_MISSING_FILE, fn])
assert 0 == main_diff(args)
def test_nbdiff_app_color_words(filespath):
# Simply check that the --color-words argument is accepted, not behavior
afn = os.path.join(filespath, "multilevel-test-base.ipynb")
bfn = os.path.join(filespath, "multilevel-test-local.ipynb")
args = nbdiffapp._build_arg_parser().parse_args([afn, bfn, '--color-words'])
assert 0 == main_diff(args)
def test_nbdiff_app_flags_override_config_ignores(filespath, tmpdir,
reset_notebook_diff):
# This excercises current behavior, but should ideally (?) be different
tmpdir.join('nbdime_config.json').write_text(text_type(
json.dumps({
'Diff': {
'Ignore': {
'/cells/*/metadata': ['nbdime-dummy-field']
}
},
})),
encoding='utf-8')
afn = os.path.join(filespath, "single_cell_nb.ipynb")
bfn = os.path.join(filespath, "single_cell_nb--changed_metadata.ipynb")
dfn = os.path.join(tmpdir.dirname, "diff_output.json")
with tmpdir.as_cwd():
args = nbdiffapp._build_arg_parser('nbdiff').parse_args(
[afn, bfn, '--out', dfn, '-S'])
assert 0 == main_diff(args)
pprint(notebook_differs)
with io.open(dfn) as df:
diff = json.load(df)
pprint(diff)
assert len(diff) == 2
assert diff[0]['key'] == 'cells'
assert diff[1]['key'] == 'metadata'
def test_nbdiff_app():
p = filespath()
afn = os.path.join(p, "multilevel-test-base.ipynb")
bfn = os.path.join(p, "multilevel-test-local.ipynb")
# When filename is omitted, will print to console instead
dfn = "" # os.path.join(p, "multilevel-test-local-diff.json")
assert 0 == main_diff(afn, bfn, dfn)
def test_nbdiff_app_config_ignores(filespath, tmpdir, reset_notebook_diff):
tmpdir.join('nbdime_config.json').write_text(text_type(
json.dumps({
'Diff': {
'Ignore': {
'/cells/*/metadata': ['nbdime-dummy-field']
}
},
})),
encoding='utf-8')
afn = os.path.join(filespath, "single_cell_nb.ipynb")
bfn = os.path.join(filespath, "single_cell_nb--changed_metadata.ipynb")
dfn = os.path.join(tmpdir.dirname, "diff_output.json")
with tmpdir.as_cwd():
args = nbdiffapp._build_arg_parser('nbdiff').parse_args(
[afn, bfn, '--out', dfn])
assert 0 == main_diff(args)
pprint(notebook_differs)
with io.open(dfn) as df:
diff = json.load(df)
pprint(diff)
for key in ('metadata', 'language_info'):
assert len(diff) == 1
assert diff[0]['key'] == key
assert diff[0]['op'] == 'patch'
diff = diff[0]['diff']
assert len(diff) == 1
assert diff[0]['key'] == 'version'
assert diff[0]['op'] == 'patch'
def test_nbdiff_app_no_colors(filespath, capsys):
# Simply check that the --color-words argument is accepted, not behavior
# Behavior is covered elsewhere
afn = os.path.join(filespath, "multilevel-test-base.ipynb")
bfn = os.path.join(filespath, "multilevel-test-local.ipynb")
args = nbdiffapp._build_arg_parser().parse_args([afn, bfn, '--no-color'])
assert 0 == main_diff(args)
def test_nbdiff_app_color_words(filespath):
# Simply check that the --color-words argument is accepted, not behavior
afn = os.path.join(filespath, "multilevel-test-base.ipynb")
bfn = os.path.join(filespath, "multilevel-test-local.ipynb")
args = nbdiffapp._build_arg_parser().parse_args(
[afn, bfn, '--color-words'])
assert 0 == main_diff(args)
def test_nbdiff_app():
p = filespath()
afn = os.path.join(p, "multilevel-test-base.ipynb")
bfn = os.path.join(p, "multilevel-test-local.ipynb")
# When filename is omitted, will print to console instead
#dfn = "" # os.path.join(p, "multilevel-test-local-diff.json")
args = nbdime.nbdiffapp._build_arg_parser().parse_args([afn, bfn])
assert 0 == main_diff(args)
def test_nbdiff_app(filespath):
afn = os.path.join(filespath, "multilevel-test-base.ipynb")
bfn = os.path.join(filespath, "multilevel-test-local.ipynb")
# When filename is omitted, will print to console instead
# dfn = "" # os.path.join(filespath, "multilevel-test-local-diff.json")
args = nbdiffapp._build_arg_parser().parse_args([afn, bfn, '--log-level=WARN'])
assert 0 == main_diff(args)
assert args.log_level == 'WARN'
assert nbdime.log.logger.level == logging.WARN
def test_nbdiff_app(filespath):
afn = os.path.join(filespath, "multilevel-test-base.ipynb")
bfn = os.path.join(filespath, "multilevel-test-local.ipynb")
# When filename is omitted, will print to console instead
# dfn = "" # os.path.join(filespath, "multilevel-test-local-diff.json")
args = nbdiffapp._build_arg_parser().parse_args([afn, bfn, '--log-level=WARN'])
assert 0 == main_diff(args)
assert args.log_level == 'WARN'
assert nbdime.log.logger.level == logging.WARN
def test_nbdiff_app_ignore_source(filespath, tmpdir, reset_diff_targets):
afn = os.path.join(filespath, "multilevel-test-base.ipynb")
bfn = os.path.join(filespath, "multilevel-test-local.ipynb")
dfn = os.path.join(tmpdir.dirname, "diff_output.json")
args = nbdiffapp._build_arg_parser().parse_args([afn, bfn, '--out', dfn, '-S'])
assert 0 == main_diff(args)
with io.open(dfn) as df:
diff = json.load(df)
for key in ('cells', 2, 'outputs'):
assert len(diff) == 1
assert diff[0]['key'] == key
assert diff[0]['op'] == 'patch'
diff = diff[0]['diff']
def test_nbdiff_app_ignore_source(filespath, tmpdir, reset_diff_targets):
afn = os.path.join(filespath, "multilevel-test-base.ipynb")
bfn = os.path.join(filespath, "multilevel-test-local.ipynb")
dfn = os.path.join(tmpdir.dirname, "diff_output.json")
args = nbdiffapp._build_arg_parser().parse_args([afn, bfn, '--out', dfn, '-S'])
assert 0 == main_diff(args)
with io.open(dfn) as df:
diff = json.load(df)
for key in ('cells', 2, 'outputs'):
assert len(diff) == 1
assert diff[0]['key'] == key
assert diff[0]['op'] == 'patch'
diff = diff[0]['diff']
def test_nbdiff_app_only_details(filespath, tmpdir, reset_diff_targets):
afn = os.path.join(filespath, "single_cell_nb.ipynb")
bfn = os.path.join(filespath, "single_cell_nb--changed_source_output_ec.ipynb")
dfn = os.path.join(tmpdir.dirname, "diff_output.json")
args = nbdiffapp._build_arg_parser().parse_args([afn, bfn, '--out', dfn, '-d'])
assert 0 == main_diff(args)
with io.open(dfn) as df:
diff = json.load(df)
print(diff)
for key in ('cells', 0):
assert len(diff) == 1
assert diff[0]['key'] == key
assert diff[0]['op'] == 'patch'
diff = diff[0]['diff']
assert len(diff) == 1
assert diff[0]['key'] == 'execution_count'
assert diff[0]['op'] == 'replace'
assert diff[0]['value'] == 2
def main(args=None):
if args is None:
args = sys.argv[1:]
setup_std_streams()
parser = _build_arg_parser()
opts = parser.parse_args(args)
if opts.subcommand == 'diff':
from nbdime import nbdiffapp
return nbdiffapp.main_diff(opts)
elif opts.subcommand == 'webdiff':
from nbdime.webapp import nbdiffweb
return nbdiffweb.main_diff(opts)
elif opts.subcommand == 'config':
opts.config_func(opts.scope)
return 0
else:
parser.print_help()
return 1
def test_nbdiff_app_only_details(filespath, tmpdir, reset_diff_targets):
afn = os.path.join(filespath, "single_cell_nb.ipynb")
bfn = os.path.join(filespath,
"single_cell_nb--changed_source_output_ec.ipynb")
dfn = os.path.join(tmpdir.dirname, "diff_output.json")
args = nbdiffapp._build_arg_parser().parse_args(
[afn, bfn, '--out', dfn, '-d'])
assert 0 == main_diff(args)
with io.open(dfn) as df:
diff = json.load(df)
print(diff)
for key in ('cells', 0):
assert len(diff) == 1
assert diff[0]['key'] == key
assert diff[0]['op'] == 'patch'
diff = diff[0]['diff']
assert len(diff) == 1
assert diff[0]['key'] == 'execution_count'
assert diff[0]['op'] == 'replace'
assert diff[0]['value'] == 2
def test_nbdiff_app_ignore_details(filespath, tmpdir, reset_diff_targets):
afn = os.path.join(filespath, "single_cell_nb.ipynb")
bfn = os.path.join(filespath, "single_cell_nb--changed_source_output_ec.ipynb")
dfn = os.path.join(tmpdir.dirname, "diff_output.json")
args = nbdiffapp._build_arg_parser().parse_args([afn, bfn, '--out', dfn, '-D'])
assert 0 == main_diff(args)
with io.open(dfn) as df:
diff = json.load(df)
print(diff)
for key in ('cells', 0):
assert len(diff) == 1
assert diff[0]['key'] == key
assert diff[0]['op'] == 'patch'
diff = diff[0]['diff']
assert len(diff) == 2
assert diff[0]['key'] == 'outputs'
for subdiff in diff[0]['diff']:
assert subdiff['op'] != 'patch'
assert diff[1]['key'] == 'source'
def test_nbdiff_app_ignore_details(filespath, tmpdir, reset_diff_targets):
afn = os.path.join(filespath, "single_cell_nb.ipynb")
bfn = os.path.join(filespath,
"single_cell_nb--changed_source_output_ec.ipynb")
dfn = os.path.join(tmpdir.dirname, "diff_output.json")
args = nbdiffapp._build_arg_parser().parse_args(
[afn, bfn, '--out', dfn, '-D'])
assert 0 == main_diff(args)
with io.open(dfn) as df:
diff = json.load(df)
print(diff)
for key in ('cells', 0):
assert len(diff) == 1
assert diff[0]['key'] == key
assert diff[0]['op'] == 'patch'
diff = diff[0]['diff']
assert len(diff) == 2
assert diff[0]['key'] == 'outputs'
for subdiff in diff[0]['diff']:
assert subdiff['op'] != 'patch'
assert diff[1]['key'] == 'source'
def test_nbdiff_app_gitrefs(git_repo2):
args = nbdiffapp._build_arg_parser().parse_args(['local', 'remote'])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args(['local', 'remote', 'sub/subfile.ipynb'])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args(['local', 'remote', 'sub/subfile.ipynb', 'diff.ipynb'])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args(['local', 'sub/subfile.ipynb', 'diff.ipynb'])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args(['sub/subfile.ipynb'])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args([])
assert 0 == main_diff(args)
def test_nbdiff_app_gitrefs(git_repo2):
args = nbdiffapp._build_arg_parser().parse_args(['local', 'remote'])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args(['local', 'remote', 'sub/subfile.ipynb'])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args(['local', 'remote', 'sub/subfile.ipynb', 'diff.ipynb'])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args(['local', 'sub/subfile.ipynb', 'diff.ipynb'])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args(['sub/subfile.ipynb'])
assert 0 == main_diff(args)
args = nbdiffapp._build_arg_parser().parse_args([])
assert 0 == main_diff(args)
def main(args=None):
if args is None:
args = sys.argv[1:]
setup_std_streams()
parser = _build_arg_parser()
opts = parser.parse_args(args)
if opts.subcommand == 'diff':
from nbdime import nbdiffapp
if opts.use_filter and opts.remote:
opts.remote = apply_possible_filter(opts.path, opts.remote)
return nbdiffapp.main_diff(opts)
elif opts.subcommand == 'webdiff':
from nbdime.webapp import nbdiffweb
if opts.use_filter and opts.remote:
opts.remote = apply_possible_filter(opts.path, opts.remote)
return nbdiffweb.main_diff(opts)
elif opts.subcommand == 'config':
opts.config_func(opts.scope)
return 0
else:
parser.print_help()
return 1
