fix: Added additional test cases for config helper methods. Also made minor documentation updates.

Author: Balaji Sankar

src/sagemaker/config/config.py

@@ -52,20 +52,20 @@
 
 
 class SageMakerConfig(object):
-    """SageMakerConfig class encapsulates the Config for SageMaker Python SDK.
+    """A class that encapsulates the configuration for the SageMaker Python SDK.
 
-    Usages:
-    This class will be integrated with sagemaker.session.Session. Users of SageMaker Python SDK
-    will have the ability to pass a SageMakerConfig object to sagemaker.session.Session. If
-    SageMakerConfig object is not provided by the user, then sagemaker.session.Session will
-    create its own SageMakerConfig object.
+    This class is used to define default values provided by the user.
 
-    Note: Once sagemaker.session.Session is initialized, it will operate with the configuration
-    values at that instant. If the users wish to alter config files/file paths after
-    sagemaker.session.Session is initialized, then that will not be reflected in
-    sagemaker.session.Session. They would have to re-initialize sagemaker.session.Session to
-    pick the latest changes.
+    This class is integrated with sagemaker.session.Session. Users of the SageMaker Python SDK
+    have the ability to pass a SageMakerConfig object to sagemaker.session.Session. If a
+    SageMakerConfig object is not provided by the user, then sagemaker.session.Session
+    creates its own SageMakerConfig object.
 
+    Note: After sagemaker.session.Session is initialized, it operates with the configuration
+    values defined at that instant. If you modify the configuration files or file paths after
+    sagemaker.session.Session is initialized, those changes are not reflected in
+    sagemaker.session.Session. To incorporate the changes in the configuration files,
+    initialize sagemaker.session.Session again.
     """
 
     def __init__(self, additional_config_paths: List[str] = None, s3_resource=_DEFAULT_S3_RESOURCE):

tests/unit/test_utils.py

@@ -226,6 +226,73 @@ def test_update_list_of_dicts_with_values_from_config():
         {"a": 1, "b": 2, "c": 3},
         {"a": 5, "c": 6, "d": 8},
     ]
+    # Same happy case with different order of items in union_key_paths
+    input_list = [{"a": 1, "b": 2}, {"a": 5, "c": 6}]
+    input_config_list = [
+        {
+            "a": 4,  # This should not be used. Use values from Input.
+            "c": 3,
+        },
+        {
+            "a": 7,  # This should not be used. Use values from Input.
+            "d": 8,
+        },
+    ]
+    ss.sagemaker_config.config = {"DUMMY": {"CONFIG": {"PATH": input_config_list}}}
+    update_list_of_dicts_with_values_from_config(
+        input_list, config_path, union_key_paths=[["d", "e"], ["c", "e"]], sagemaker_session=ss
+    )
+    assert input_list == [
+        {"a": 1, "b": 2, "c": 3},
+        {"a": 5, "c": 6, "d": 8},
+    ]
+    # Testing the combination of union parameter and required parameter. i.e. A parameter is both
+    # required and part of Union.
+    input_list = [{"a": 1, "b": 2}, {"a": 5, "c": 6}]
+    input_config_list = [
+        {
+            "a": 4,  # This should not be used. Use values from Input.
+            "c": 3,
+        },
+        {
+            "a": 7,  # This should not be used. Use values from Input.
+            "d": 8,
+        },
+    ]
+    ss.sagemaker_config.config = {"DUMMY": {"CONFIG": {"PATH": input_config_list}}}
+    update_list_of_dicts_with_values_from_config(
+        input_list,
+        config_path,
+        required_key_paths=["e"],
+        union_key_paths=[["d", "e"], ["c", "e"]],
+        sagemaker_session=ss,
+    )
+    # No merge should happen since 'e' is not present, even though union is obeyed.
+    assert input_list == [{"a": 1, "b": 2}, {"a": 5, "c": 6}]
+    # Same test but the required parameter is present.
+    input_list = [{"a": 1, "e": 2}, {"a": 5, "e": 6}]
+    input_config_list = [
+        {
+            "a": 4,  # This should not be used. Use values from Input.
+            "f": 3,
+        },
+        {
+            "a": 7,  # This should not be used. Use values from Input.
+            "g": 8,
+        },
+    ]
+    ss.sagemaker_config.config = {"DUMMY": {"CONFIG": {"PATH": input_config_list}}}
+    update_list_of_dicts_with_values_from_config(
+        input_list,
+        config_path,
+        required_key_paths=["e"],
+        union_key_paths=[["d", "e"], ["c", "e"]],
+        sagemaker_session=ss,
+    )
+    assert input_list == [
+        {"a": 1, "e": 2, "f": 3},
+        {"a": 5, "e": 6, "g": 8},
+    ]
 
 
 def test_set_nested_value():