change: make collect_parameters decorator as private (#1289)

Co-authored-by: Edward Sun <[email protected]>

Author: 2 people

src/sagemaker/workflow/notebook_job_step.py

@@ -40,7 +40,7 @@
     RequestType,
     PipelineVariable,
 )
-from sagemaker.workflow.utilities import collect_parameters, load_step_compilation_context
+from sagemaker.workflow.utilities import _collect_parameters, load_step_compilation_context
 from sagemaker.session import get_execution_role
 
 from sagemaker.s3_utils import s3_path_join
@@ -67,7 +67,7 @@ class NotebookJobStep(ConfigurableRetryStep):
     <https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-auto-run.html>`_.
     """
 
-    @collect_parameters
+    @_collect_parameters
     def __init__(
         self,
         # Following parameters will set by @collect_parameters

src/sagemaker/workflow/utilities.py

@@ -463,7 +463,7 @@ def trim_request_dict(request_dict, job_key, config):
     return request_dict
 
 
-def collect_parameters(func):
+def _collect_parameters(func):
     """The decorator function is to collect all the params passed into an invoked function of class.
 
     These parameters are set as properties of the class instance. The use case is to simplify

tests/unit/sagemaker/workflow/test_utilities.py

@@ -21,7 +21,7 @@
     hash_file,
     hash_files_or_dirs,
     trim_request_dict,
-    collect_parameters,
+    _collect_parameters,
 )
 from pathlib import Path
 import unittest
@@ -149,12 +149,12 @@ def __init__(self, param1):
                 self.param1 = param1
 
         class SampleClass(BaseClass):
-            @collect_parameters
+            @_collect_parameters
             def __init__(self, param1, param2, param3="default_value"):
                 super(SampleClass, self).__init__(param1)
                 pass
 
-            @collect_parameters
+            @_collect_parameters
             def abc(self, param2, param4="default_value", param5=None):
                 pass