Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for --flagfile to DEFINE_config_* #29

Merged
merged 1 commit into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions ml_collections/config_flags/config_flags.py
Original file line number Diff line number Diff line change
Expand Up @@ -703,6 +703,12 @@ def __init__(
self._sys_argv = sys_argv
super(_ConfigFlag, self).__init__(**kwargs)

def _GetArgv(self):
"""Lazily fetches sys.argv and expands any potential --flagfile=... arguments."""
argv = sys.argv if self._sys_argv is None else self._sys_argv
argv = flags.FLAGS.read_flags_from_files(argv, force_gnu=False)
return argv

def _GetOverrides(self, argv):
"""Parses the command line arguments for the overrides."""
overrides = []
Expand Down Expand Up @@ -735,8 +741,7 @@ def _IsConfigSpecified(self, argv):
return self._FindConfigSpecified(argv) >= 0

def _set_default(self, default):
if self._IsConfigSpecified(
sys.argv if self._sys_argv is None else self._sys_argv):
if self._IsConfigSpecified(self._GetArgv()):
self.default = default
else:
super(_ConfigFlag, self)._set_default(default) # pytype: disable=attribute-error
Expand Down Expand Up @@ -766,8 +771,7 @@ def _parse(self, argument):
config = super(_ConfigFlag, self)._parse(argument)

# Get list or overrides
overrides = self._GetOverrides(
sys.argv if self._sys_argv is None else self._sys_argv)
overrides = self._GetOverrides(self._GetArgv())
# Iterate over overridden fields and create valid parsers
self._override_values = {}
self._initialize_missing_parent_fields(config, overrides)
Expand Down
13 changes: 13 additions & 0 deletions ml_collections/config_flags/tests/config_overriding_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import enum
import shlex
import sys
import tempfile

from absl import flags
from absl.testing import absltest
Expand Down Expand Up @@ -830,6 +831,18 @@ def testOverridesSerialize(self):
serialize_parse('test_config.type_tuple',
values.test_config.type_tuple))

def testFlagfile(self):
config = config_dict.ConfigDict()
config.foo = 3
config.bar = 4

with tempfile.NamedTemporaryFile(mode='w', delete=False) as f:
f.write('--test_config.foo=7\n')
f.flush()
f.close()
values = _parse_flags(f'./program --flagfile={f.name}', config=config)
self.assertEqual(values.test_config.foo, 7)
self.assertEqual(values.test_config.bar, 4)

def main():
absltest.main()
Expand Down