Skip to content

Commit 2dc64f7

Browse files
authored
rename --version flag to --version_tb to avoid conflict (#2153)
1 parent 6878b25 commit 2dc64f7

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

tensorboard/plugins/core/core_plugin.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -376,9 +376,12 @@ def define_flags(self, parser):
376376
377377
See tensorboard/backend/event_processing/event_file_inspector.py for more info.\
378378
''')
379-
379+
380+
# This flag has a "_tb" suffix to avoid conflicting with an internal flag
381+
# named --version. Note that due to argparse auto-expansion of unambiguous
382+
# flag prefixes, you can still invoke this as `tensorboard --version`.
380383
parser.add_argument(
381-
'--version',
384+
'--version_tb',
382385
action='store_true',
383386
help='Prints the version of Tensorboard')
384387

@@ -464,8 +467,8 @@ def define_flags(self, parser):
464467
def fix_flags(self, flags):
465468
"""Fixes standard TensorBoard CLI flags to parser."""
466469
FlagsError = base_plugin.FlagsError
467-
if flags.version:
468-
pass
470+
if flags.version_tb:
471+
pass
469472
elif flags.inspect:
470473
if flags.logdir and flags.event_file:
471474
raise FlagsError(

tensorboard/plugins/core/core_plugin_test.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ class FakeFlags(object):
4747
def __init__(
4848
self,
4949
inspect=False,
50-
version=False,
50+
version_tb=False,
5151
logdir='',
5252
event_file='',
5353
db='',
5454
path_prefix=''):
5555
self.inspect = inspect
56-
self.version = version
56+
self.version_tb = version_tb
5757
self.logdir = logdir
5858
self.event_file = event_file
5959
self.db = db
@@ -81,8 +81,8 @@ def testRoutesProvided(self):
8181

8282
def testFlag(self):
8383
loader = core_plugin.CorePluginLoader()
84+
loader.fix_flags(FakeFlags(version_tb=True))
8485
loader.fix_flags(FakeFlags(inspect=True, logdir='/tmp'))
85-
loader.fix_flags(FakeFlags(version=True))
8686
loader.fix_flags(FakeFlags(inspect=True, event_file='/tmp/event.out'))
8787
loader.fix_flags(FakeFlags(inspect=False, logdir='/tmp'))
8888
loader.fix_flags(FakeFlags(inspect=False, db='sqlite:foo'))

tensorboard/program.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ def main(self, ignored_argv=('',)):
221221
event_file = os.path.expanduser(self.flags.event_file)
222222
efi.inspect(self.flags.logdir, event_file, self.flags.tag)
223223
return 0
224-
if self.flags.version:
224+
if self.flags.version_tb:
225225
print(version.VERSION)
226226
return 0
227227
try:

0 commit comments

Comments
 (0)