def test_arguments_list_vs_tuple_irrelevant(self):
with_list = manager.cache_key(
working_directory="/home/me",
arguments=["--logdir", "something"],
configure_kwargs={},
)
with_tuple = manager.cache_key(
working_directory="/home/me",
arguments=("--logdir", "something"),
configure_kwargs={},
)
self.assertEqual(with_list, with_tuple)
def test_result_is_str(self):
result = manager.cache_key(
working_directory="/home/me",
arguments=["--logdir", "something"],
configure_kwargs={},
)
self.assertIsInstance(result, str)
def test_arguments_and_configure_kwargs_independent(self):
# This test documents current behavior; its existence shouldn't be
# interpreted as mandating the behavior. In fact, it would be nice
# for `arguments` and `configure_kwargs` to be semantically merged
# in the cache key computation, but we don't currently do that.
results = [
manager.cache_key(
working_directory="/home/me",
arguments=["--logdir", "something"],
configure_kwargs={},
),
manager.cache_key(
working_directory="/home/me",
arguments=[],
configure_kwargs={"logdir": "something"},
),
]
self.assertEqual(len(results), len(set(results)))
def test_depends_on_working_directory(self):
results = [
manager.cache_key(
working_directory=d,
arguments=["--logdir", "something"],
configure_kwargs={},
) for d in ("/home/me", "/home/you")
]
self.assertEqual(len(results), len(set(results)))
def configure(self, argv=('', ), **kwargs):
"""Configures TensorBoard behavior via flags.
This method will populate the "flags" property with an argparse.Namespace
representing flag values parsed from the provided argv list, overridden by
explicit flags from remaining keyword arguments.
Args:
argv: Can be set to CLI args equivalent to sys.argv; the first arg is
taken to be the name of the path being executed.
kwargs: Additional arguments will override what was parsed from
argv. They must be passed as Python data structures, e.g.
`foo=1` rather than `foo="1"`.
Returns:
Either argv[:1] if argv was non-empty, or [''] otherwise, as a mechanism
for absl.app.run() compatibility.
Raises:
ValueError: If flag values are invalid.
"""
parser = argparse_flags.ArgumentParser(
prog='tensorboard',
description=(
'TensorBoard is a suite of web applications for '
'inspecting and understanding your TensorFlow runs '
'and graphs. https://github.com/tensorflow/tensorboard '))
for loader in self.plugin_loaders:
loader.define_flags(parser)
arg0 = argv[0] if argv else ''
flags = parser.parse_args(argv[1:]) # Strip binary name from argv.
self.cache_key = manager.cache_key(
working_directory=os.getcwd(),
arguments=argv[1:],
configure_kwargs=kwargs,
)
if absl_flags and arg0:
# Only expose main module Abseil flags as TensorBoard native flags.
# This is the same logic Abseil's ArgumentParser uses for determining
# which Abseil flags to include in the short helpstring.
for flag in set(absl_flags.FLAGS.get_key_flags_for_module(arg0)):
if hasattr(flags, flag.name):
raise ValueError('Conflicting Abseil flag: %s' % flag.name)
setattr(flags, flag.name, flag.value)
for k, v in kwargs.items():
if not hasattr(flags, k):
raise ValueError('Unknown TensorBoard flag: %s' % k)
setattr(flags, k, v)
for loader in self.plugin_loaders:
loader.fix_flags(flags)
self.flags = flags
return [arg0]
def test_depends_on_arguments(self):
results = [
manager.cache_key(
working_directory="/home/me",
arguments=arguments,
configure_kwargs={},
) for arguments in (
["--logdir=something"],
["--logdir", "something"],
["--logdir", "", "something"],
["--logdir", "", "something", ""],
)
]
self.assertEqual(len(results), len(set(results)))
def test_depends_on_configure_kwargs(self):
results = [
manager.cache_key(
working_directory="/home/me",
arguments=[],
configure_kwargs=configure_kwargs,
)
for configure_kwargs in (
{"logdir": "something"},
{"logdir": "something_else"},
{"logdir": "something", "port": "6006"},
)
]
self.assertEqual(len(results), len(set(results)))
def configure(self, argv=("", ), **kwargs):
"""Configures TensorBoard behavior via flags.
This method will populate the "flags" property with an argparse.Namespace
representing flag values parsed from the provided argv list, overridden by
explicit flags from remaining keyword arguments.
Args:
argv: Can be set to CLI args equivalent to sys.argv; the first arg is
taken to be the name of the path being executed.
kwargs: Additional arguments will override what was parsed from
argv. They must be passed as Python data structures, e.g.
`foo=1` rather than `foo="1"`.
Returns:
Either argv[:1] if argv was non-empty, or [''] otherwise, as a mechanism
for absl.app.run() compatibility.
Raises:
ValueError: If flag values are invalid.
"""
base_parser = argparse_flags.ArgumentParser(
prog="tensorboard",
description=(
"TensorBoard is a suite of web applications for "
"inspecting and understanding your TensorFlow runs "
"and graphs. https://github.com/tensorflow/tensorboard "),
)
subparsers = base_parser.add_subparsers(
help="TensorBoard subcommand (defaults to %r)" %
_SERVE_SUBCOMMAND_NAME)
serve_subparser = subparsers.add_parser(
_SERVE_SUBCOMMAND_NAME,
help="start local TensorBoard server (default subcommand)",
)
serve_subparser.set_defaults(
**{_SUBCOMMAND_FLAG: _SERVE_SUBCOMMAND_NAME})
if len(argv) < 2 or argv[1].startswith("-"):
# This invocation, if valid, must not use any subcommands: we
# don't permit flags before the subcommand name.
serve_parser = base_parser
else:
# This invocation, if valid, must use a subcommand: we don't take
# any positional arguments to `serve`.
serve_parser = serve_subparser
for (name, subcommand) in self.subcommands.items():
subparser = subparsers.add_parser(
name,
help=subcommand.help(),
description=subcommand.description(),
)
subparser.set_defaults(**{_SUBCOMMAND_FLAG: name})
subcommand.define_flags(subparser)
for loader in self.plugin_loaders:
loader.define_flags(serve_parser)
arg0 = argv[0] if argv else ""
flags = base_parser.parse_args(
argv[1:]) # Strip binary name from argv.
if getattr(flags, _SUBCOMMAND_FLAG, None) is None:
# Manually assign default value rather than using `set_defaults`
# on the base parser to work around Python bug #9351 on old
# versions of `argparse`: <https://bugs.python.org/issue9351>
setattr(flags, _SUBCOMMAND_FLAG, _SERVE_SUBCOMMAND_NAME)
self.cache_key = manager.cache_key(
working_directory=os.getcwd(),
arguments=argv[1:],
configure_kwargs=kwargs,
)
if arg0:
# Only expose main module Abseil flags as TensorBoard native flags.
# This is the same logic Abseil's ArgumentParser uses for determining
# which Abseil flags to include in the short helpstring.
for flag in set(absl_flags.FLAGS.get_key_flags_for_module(arg0)):
if hasattr(flags, flag.name):
raise ValueError("Conflicting Abseil flag: %s" % flag.name)
setattr(flags, flag.name, flag.value)
for k, v in kwargs.items():
if not hasattr(flags, k):
raise ValueError("Unknown TensorBoard flag: %s" % k)
setattr(flags, k, v)
if getattr(flags, _SUBCOMMAND_FLAG) == _SERVE_SUBCOMMAND_NAME:
for loader in self.plugin_loaders:
loader.fix_flags(flags)
self.flags = flags
return [arg0]
