Fix linter and documentation errors

Author: Payton Staub

src/sagemaker/processing.py

@@ -449,10 +449,12 @@ def get_run_args(
         outputs=None,
         arguments=None,
     ):
-        """Returns a RunArgs object. For processors (:class:`~sagemaker.spark.processing.PySparkProcessor`,
-            :class:`~sagemaker.spark.processing.SparkJar`) that have special
-            run() arguments, this object contains the normalized arguments for passing to
-            :class:`~sagemaker.workflow.steps.ProcessingStep`.
+        """Returns a RunArgs object.
+
+        For processors (:class:`~sagemaker.spark.processing.PySparkProcessor`,
+        :class:`~sagemaker.spark.processing.SparkJar`) that have special
+        run() arguments, this object contains the normalized arguments for passing to
+        :class:`~sagemaker.workflow.steps.ProcessingStep`.
 
         Args:
             code (str): This can be an S3 URI or a local path to a file with the framework
@@ -1171,12 +1173,11 @@ def _to_request_dict(self):
 
 
 class RunArgs(object):
-    """Provides an object containing the standard run arguments needed by
-        :class:`~sagemaker.processing.ScriptProcessor`.
+    """Accepts parameters that correspond to ScriptProcessors.
 
     An instance of this class is returned from the ``get_run_args()`` method on processors,
-        and is used for normalizing the arguments so that they can be passed to
-        :class:`~sagemaker.workflow.steps.ProcessingStep`
+    and is used for normalizing the arguments so that they can be passed to
+    :class:`~sagemaker.workflow.steps.ProcessingStep`
     """
 
     def __init__(

src/sagemaker/spark/processing.py

@@ -178,7 +178,9 @@ def get_run_args(
         outputs=None,
         arguments=None,
     ):
-        """Returns a RunArgs object. For processors (:class:`~sagemaker.spark.processing.PySparkProcessor`,
+        """Returns a RunArgs object.
+
+        For processors (:class:`~sagemaker.spark.processing.PySparkProcessor`,
             :class:`~sagemaker.spark.processing.SparkJar`) that have special
             run() arguments, this object contains the normalized arguments for passing to
             :class:`~sagemaker.workflow.steps.ProcessingStep`.
@@ -729,8 +731,11 @@ def get_run_args(
         configuration=None,
         spark_event_logs_s3_uri=None,
     ):
-        """Returns a RunArgs object. This object contains the normalized inputs, outputs
-            and arguments needed when using a ``PySparkProcessor`` in a :class:`~sagemaker.workflow.steps.ProcessingStep`.
+        """Returns a RunArgs object.
+
+        This object contains the normalized inputs, outputs
+            and arguments needed when using a ``PySparkProcessor``
+            in a :class:`~sagemaker.workflow.steps.ProcessingStep`.
 
         Args:
             submit_app (str): Path (local or S3) to Python file to submit to Spark
@@ -974,8 +979,11 @@ def get_run_args(
         configuration=None,
         spark_event_logs_s3_uri=None,
     ):
-        """Returns a RunArgs object. This object contains the normalized inputs, outputs
-            and arguments needed when using a ``SparkJarProcessor`` in a :class:`~sagemaker.workflow.steps.ProcessingStep`.
+        """Returns a RunArgs object.
+
+        This object contains the normalized inputs, outputs
+            and arguments needed when using a ``SparkJarProcessor``
+            in a :class:`~sagemaker.workflow.steps.ProcessingStep`.
 
         Args:
             submit_app (str): Path (local or S3) to Python file to submit to Spark

tests/unit/sagemaker/spark/test_processing.py

@@ -246,7 +246,6 @@ def test_spark_processor_base_run(mock_super_run, spark_processor_base):
 )
 @patch("sagemaker.spark.processing.ProcessingOutput")
 @patch("sagemaker.spark.processing._SparkProcessorBase._stage_configuration")
-@patch("sagemaker.processing.ScriptProcessor.run")
 def test_spark_processor_base_extend_processing_args(
     mock_super_run,
     mock_stage_configuration,
@@ -270,13 +269,6 @@ def test_spark_processor_base_extend_processing_args(
     assert extended_outputs == expected["outputs"]
 
 
-@patch("sagemaker.processing.ScriptProcessor.run")
-def test_spark_processor_base_run(mock_super_run, spark_processor_base):
-    spark_processor_base.run(submit_app="app")
-
-    mock_super_run.assert_called_with("app", None, None, None, True, True, None, None, None)
-
-
 serialized_configuration = BytesIO("test".encode("utf-8"))
 
 
@@ -863,103 +855,6 @@ def test_py_spark_processor_get_run_args(
         )
 
 
-@pytest.mark.parametrize(
-    "config, expected",
-    [
-        (
-            {
-                "submit_app": None,
-                "files": ["test"],
-                "inputs": [],
-                "opt": None,
-                "arguments": ["arg1"],
-            },
-            ValueError,
-        ),
-        (
-            {
-                "submit_app": "test.py",
-                "files": None,
-                "inputs": [processing_input],
-                "opt": None,
-                "arguments": ["arg1"],
-            },
-            [processing_input],
-        ),
-        (
-            {
-                "submit_app": "test.py",
-                "files": ["test"],
-                "inputs": [processing_input],
-                "opt": None,
-                "arguments": ["arg1"],
-            },
-            [processing_input, processing_input, processing_input, processing_input],
-        ),
-        (
-            {
-                "submit_app": "test.py",
-                "files": ["test"],
-                "inputs": None,
-                "opt": None,
-                "arguments": ["arg1"],
-            },
-            [processing_input, processing_input, processing_input],
-        ),
-        (
-            {
-                "submit_app": "test.py",
-                "files": ["test"],
-                "inputs": None,
-                "opt": "opt",
-                "arguments": ["arg1"],
-            },
-            [processing_input, processing_input, processing_input],
-        ),
-    ],
-)
-@patch("sagemaker.spark.processing._SparkProcessorBase.get_run_args")
-@patch("sagemaker.spark.processing._SparkProcessorBase._stage_submit_deps")
-@patch("sagemaker.spark.processing._SparkProcessorBase._generate_current_job_name")
-def test_py_spark_processor_get_run_args(
-    mock_generate_current_job_name,
-    mock_stage_submit_deps,
-    mock_super_get_run_args,
-    py_spark_processor,
-    config,
-    expected,
-):
-    mock_stage_submit_deps.return_value = (processing_input, "opt")
-    mock_generate_current_job_name.return_value = "jobName"
-
-    if expected is ValueError:
-        with pytest.raises(expected):
-            py_spark_processor.get_run_args(
-                submit_app=config["submit_app"],
-                submit_py_files=config["files"],
-                submit_jars=config["files"],
-                submit_files=config["files"],
-                inputs=config["inputs"],
-                arguments=config["arguments"],
-            )
-    else:
-        py_spark_processor.get_run_args(
-            submit_app=config["submit_app"],
-            submit_py_files=config["files"],
-            submit_jars=config["files"],
-            submit_files=config["files"],
-            inputs=config["inputs"],
-            arguments=config["arguments"],
-        )
-
-        mock_super_get_run_args.assert_called_with(
-            code=config["submit_app"],
-            inputs=expected,
-            outputs=None,
-            arguments=config["arguments"],
-        )
-
-
 @patch("sagemaker.spark.processing._SparkProcessorBase.run")
 @patch("sagemaker.spark.processing._SparkProcessorBase._stage_submit_deps")
 @patch("sagemaker.spark.processing._SparkProcessorBase._generate_current_job_name")

tests/unit/test_processing.py

@@ -27,7 +27,6 @@
     Processor,
     ScriptProcessor,
     ProcessingJob,
-    RunArgs,
 )
 from sagemaker.sklearn.processing import SKLearnProcessor
 from sagemaker.network import NetworkConfig