Spaces:
Paused
Paused
File size: 11,350 Bytes
2f5127c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
# Copyright 2020-2025 The HuggingFace Team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import unittest
from dataclasses import dataclass
from unittest.mock import mock_open, patch
from trl import TrlParser
@dataclass
class MyDataclass:
arg1: int
arg2: str = "default"
@dataclass
class InvalidDataclass:
config: str # This should raise an error in the TrlParser
class TestTrlParser(unittest.TestCase):
def test_init_without_config_field(self):
"""Test initialization without 'config' field in the dataclasses."""
parser = TrlParser(dataclass_types=[MyDataclass])
self.assertIsInstance(parser, TrlParser)
def test_init_with_config_field(self):
"""Test initialization with a 'config' field in the dataclass (should raise ValueError)."""
with self.assertRaises(ValueError) as context:
TrlParser(dataclass_types=[InvalidDataclass])
self.assertTrue("has a field named 'config'" in str(context.exception))
@patch("builtins.open", mock_open(read_data="env:\n VAR1: value1\n VAR2: value2\narg1: 2"))
@patch("yaml.safe_load")
@patch("os.environ", new_callable=dict) # Mock os.environ as a dictionary
def test_parse_args_and_config_with_valid_config(self, mock_environ, mock_yaml_load):
"""Test parse_args_and_config method with valid arguments and config."""
mock_yaml_load.return_value = {"env": {"VAR1": "value1", "VAR2": "value2"}, "arg1": 2}
parser = TrlParser(dataclass_types=[MyDataclass])
args = ["--arg2", "value", "--config", "config.yaml"] # don't set arg1 to test default value
# Simulate the config being loaded and environment variables being set
result_args = parser.parse_args_and_config(args)
# Set the environment variables using the mock
mock_environ["VAR1"] = "value1"
mock_environ["VAR2"] = "value2"
# Ensure that the environment variables were set correctly
self.assertEqual(mock_environ.get("VAR1"), "value1")
self.assertEqual(mock_environ.get("VAR2"), "value2")
# Check the parsed arguments
self.assertEqual(len(result_args), 1)
self.assertIsInstance(result_args[0], MyDataclass)
self.assertEqual(result_args[0].arg1, 2)
self.assertEqual(result_args[0].arg2, "value")
@patch("builtins.open", mock_open(read_data="arg1: 2"))
@patch("yaml.safe_load")
def test_parse_args_and_arg_override_config(self, mock_yaml_load):
"""Test parse_args_and_config method and check that arguments override the config."""
mock_yaml_load.return_value = {"arg1": 2} # this arg is meant to be overridden
parser = TrlParser(dataclass_types=[MyDataclass])
args = ["--arg1", "3", "--config", "config.yaml"] # override arg1 default with 3
# Simulate the config being loaded and arguments being passed
result_args = parser.parse_args_and_config(args)
# Check the parsed arguments
self.assertEqual(len(result_args), 1)
self.assertIsInstance(result_args[0], MyDataclass)
self.assertEqual(result_args[0].arg1, 3)
@patch("builtins.open", mock_open(read_data="env: not_a_dict"))
@patch("yaml.safe_load")
def test_parse_args_and_config_with_invalid_env(self, mock_yaml_load):
"""Test parse_args_and_config method when the 'env' field is not a dictionary."""
mock_yaml_load.return_value = {"env": "not_a_dict"}
parser = TrlParser(dataclass_types=[MyDataclass])
args = ["--arg1", "2", "--arg2", "value", "--config", "config.yaml"]
with self.assertRaises(ValueError) as context:
parser.parse_args_and_config(args)
self.assertEqual(str(context.exception), "`env` field should be a dict in the YAML file.")
def test_parse_args_and_config_without_config(self):
"""Test parse_args_and_config without the `--config` argument."""
parser = TrlParser(dataclass_types=[MyDataclass])
args = ["--arg1", "2", "--arg2", "value"]
# Simulate no config, just parse args normally
result_args = parser.parse_args_and_config(args)
# Check that the arguments are parsed as is
self.assertEqual(len(result_args), 1)
self.assertIsInstance(result_args[0], MyDataclass)
self.assertEqual(result_args[0].arg1, 2)
self.assertEqual(result_args[0].arg2, "value")
def test_set_defaults_with_config(self):
"""Test set_defaults_with_config updates the defaults."""
parser = TrlParser(dataclass_types=[MyDataclass])
# Update defaults
parser.set_defaults_with_config(arg1=42)
# Ensure the default value is updated
result_args = parser.parse_args_and_config([])
self.assertEqual(len(result_args), 1)
self.assertIsInstance(result_args[0], MyDataclass)
self.assertEqual(result_args[0].arg1, 42)
def test_parse_args_and_config_with_remaining_strings(self):
parser = TrlParser(dataclass_types=[MyDataclass])
args = ["--arg1", "2", "--arg2", "value", "remaining"]
# Simulate no config, just parse args normally
result_args = parser.parse_args_and_config(args, return_remaining_strings=True)
# Check that the arguments are parsed as is
self.assertEqual(len(result_args), 2)
self.assertIsInstance(result_args[0], MyDataclass)
self.assertEqual(result_args[0].arg1, 2)
self.assertEqual(result_args[0].arg2, "value")
self.assertEqual(result_args[1], ["remaining"])
@patch("builtins.open", mock_open(read_data="remaining_string_in_config: abc"))
@patch("yaml.safe_load")
def test_parse_args_and_config_with_remaining_strings_in_config_and_args(self, mock_yaml_load):
mock_yaml_load.return_value = {"remaining_string_in_config": "abc"}
parser = TrlParser(dataclass_types=[MyDataclass])
args = ["--arg1", "2", "--remaining_string_in_args", "def", "--config", "config.yaml"]
# Simulate the config being loaded and arguments being passed
result_args = parser.parse_args_and_config(args, return_remaining_strings=True)
# Check that the arguments are parsed as is
self.assertEqual(len(result_args), 2)
self.assertIsInstance(result_args[0], MyDataclass)
self.assertEqual(result_args[0].arg1, 2)
self.assertEqual(result_args[1], ["--remaining_string_in_config", "abc", "--remaining_string_in_args", "def"])
@patch("builtins.open", mock_open(read_data="arg1: 2\narg2: config_value"))
@patch("yaml.safe_load")
def test_subparsers_with_config_defaults(self, mock_yaml_load):
"""Test that config defaults are applied to all subparsers."""
mock_yaml_load.return_value = {"arg1": 2, "arg2": "config_value"}
# Create the main parser
parser = TrlParser()
# Add subparsers
subparsers = parser.add_subparsers(dest="command", parser_class=TrlParser)
# Create a subparser for a specific command
subparsers.add_parser("subcommand", dataclass_types=[MyDataclass])
# Parse with config file
args = ["subcommand", "--config", "config.yaml"]
result_args = parser.parse_args_and_config(args)
# Check main parser arguments
self.assertEqual(len(result_args), 1)
# Check that config values were applied to the subparser
self.assertEqual(result_args[0].arg1, 2) # Default from config
self.assertEqual(result_args[0].arg2, "config_value") # Default from config
@patch("builtins.open", mock_open(read_data="arg1: 2\narg2: config_value"))
@patch("yaml.safe_load")
def test_subparsers_with_config_defaults_and_arg_override(self, mock_yaml_load):
"""Test that config defaults are applied to all subparsers."""
mock_yaml_load.return_value = {"arg1": 2, "arg2": "config_value"}
# Create the main parser
parser = TrlParser()
# Add subparsers
subparsers = parser.add_subparsers(dest="command", parser_class=TrlParser)
# Create a subparser for a specific command
subparsers.add_parser("subcommand", dataclass_types=[MyDataclass])
# Test with command line arguments overriding config
args = ["subcommand", "--arg1", "3", "--config", "config.yaml"]
result_args = parser.parse_args_and_config(args)
# Command line arguments should override config
self.assertEqual(result_args[0].arg1, 3)
self.assertEqual(result_args[0].arg2, "config_value") # Still from config
@patch("builtins.open", mock_open(read_data="arg1: 2\nthis_arg_does_not_exist: config_value"))
@patch("yaml.safe_load")
def test_subparsers_with_config_defaults_and_arg_override_wrong_name(self, mock_yaml_load):
"""Test that config defaults are applied to all subparsers."""
mock_yaml_load.return_value = {"arg1": 2, "this_arg_does_not_exist": "config_value"}
# Create the main parser
parser = TrlParser()
# Add subparsers
subparsers = parser.add_subparsers(dest="command", parser_class=TrlParser)
# Create a subparser for a specific command
subparsers.add_parser("subcommand", dataclass_types=[MyDataclass])
# Test with command line arguments overriding config
args = ["subcommand", "--arg1", "3", "--config", "config.yaml"]
with self.assertRaises(ValueError):
parser.parse_args_and_config(args)
parser.parse_args_and_config(args, fail_with_unknown_args=False)
@patch("builtins.open", mock_open(read_data="arg1: 2\narg2: config_value"))
@patch("yaml.safe_load")
def test_subparsers_multiple_with_config_defaults(self, mock_yaml_load):
"""Test that config defaults are applied to all subparsers."""
mock_yaml_load.return_value = {"arg1": 2, "arg2": "config_value"}
# Create the main parser
parser = TrlParser()
# Add subparsers
subparsers = parser.add_subparsers(dest="command", parser_class=TrlParser)
# Create a subparser for a specific command
subparsers.add_parser("subcommand0", dataclass_types=[MyDataclass])
subparsers.add_parser("subcommand1", dataclass_types=[MyDataclass])
for idx in range(2):
# Parse with config file
args = [f"subcommand{idx}", "--config", "config.yaml"]
result_args = parser.parse_args_and_config(args)
# Check main parser arguments
self.assertEqual(len(result_args), 1)
# Check that config values were applied to the subparser
self.assertEqual(result_args[0].arg1, 2) # Default from config
self.assertEqual(result_args[0].arg2, "config_value") # Default from config
|