Using logging instead of prints

Author: martinRenou

src/sagemaker/base_predictor.py

@@ -14,6 +14,7 @@
 from __future__ import print_function, absolute_import
 
 import abc
+import logging
 from typing import Any, Tuple
 
 from sagemaker.deprecations import (
@@ -54,6 +55,9 @@
 from sagemaker.lineage.context import EndpointContext
 
 
+logger = logging.getLogger(__name__)
+
+
 class PredictorBase(abc.ABC):
     """An object that encapsulates a deployed model."""
 
@@ -452,7 +456,7 @@ def list_monitors(self):
             endpoint_name=self.endpoint_name
         )
         if len(monitoring_schedules_dict["MonitoringScheduleSummaries"]) == 0:
-            print("No monitors found for endpoint. endpoint: {}".format(self.endpoint_name))
+            logger.debug("No monitors found for endpoint. endpoint: {}".format(self.endpoint_name))
             return []
 
         monitors = []

src/sagemaker/cli/compatibility/v2/files.py

@@ -22,7 +22,8 @@
 
 from sagemaker.cli.compatibility.v2.ast_transformer import ASTTransformer
 
-LOGGER = logging.getLogger(__name__)
+# Setting LOGGER for backward compatibility, in case users import this...
+logger = LOGGER = logging.getLogger(__name__)
 
 
 class FileUpdater(object):
@@ -59,7 +60,7 @@ def _make_output_dirs_if_needed(self):
             os.makedirs(output_dir)
 
         if os.path.exists(self.output_path):
-            LOGGER.warning("Overwriting file %s", self.output_path)
+            logger.warning("Overwriting file %s", self.output_path)
 
 
 class PyFileUpdater(FileUpdater):

src/sagemaker/fw_utils.py

@@ -473,7 +473,7 @@ def tar_and_upload_dir(
         if s3_resource is None:
             s3_resource = session.resource("s3", region_name=session.region_name)
         else:
-            print("Using provided s3_resource")
+            logger.debug("Using provided s3_resource")
 
         s3_resource.Object(bucket, key).upload_file(tar_file, ExtraArgs=extra_args)
     finally:

src/sagemaker/local/entities.py

@@ -669,7 +669,7 @@ def start(self, **kwargs):
         execution = _LocalPipelineExecution(execution_id, self.pipeline, **kwargs)
 
         self._executions[execution_id] = execution
-        print(
+        logger.info(
             f"Starting execution for pipeline {self.pipeline.name}. Execution ID is {execution_id}"
         )
         self.last_modified_time = datetime.datetime.now().timestamp()
@@ -733,31 +733,31 @@ def update_execution_success(self):
         """Mark execution as succeeded."""
         self.status = _LocalExecutionStatus.SUCCEEDED.value
         self.last_modified_time = datetime.datetime.now().timestamp()
-        print(f"Pipeline execution {self.pipeline_execution_name} SUCCEEDED")
+        logger.info(f"Pipeline execution {self.pipeline_execution_name} SUCCEEDED")
 
     def update_execution_failure(self, step_name, failure_message):
         """Mark execution as failed."""
         self.status = _LocalExecutionStatus.FAILED.value
         self.failure_reason = f"Step '{step_name}' failed with message: {failure_message}"
         self.last_modified_time = datetime.datetime.now().timestamp()
-        print(
+        logger.info(
             f"Pipeline execution {self.pipeline_execution_name} FAILED because step "
             f"'{step_name}' failed."
         )
 
     def update_step_properties(self, step_name, step_properties):
         """Update pipeline step execution output properties."""
         self.step_execution.get(step_name).update_step_properties(step_properties)
-        print(f"Pipeline step '{step_name}' SUCCEEDED.")
+        logger.info(f"Pipeline step '{step_name}' SUCCEEDED.")
 
     def update_step_failure(self, step_name, failure_message):
         """Mark step_name as failed."""
-        print(f"Pipeline step '{step_name}' FAILED. Failure message is: {failure_message}")
+        logger.info(f"Pipeline step '{step_name}' FAILED. Failure message is: {failure_message}")
         self.step_execution.get(step_name).update_step_failure(failure_message)
 
     def mark_step_executing(self, step_name):
         """Update pipelines step's status to EXECUTING and start_time to now."""
-        print(f"Starting pipeline step: '{step_name}'")
+        logger.info(f"Starting pipeline step: '{step_name}'")
         self.step_execution.get(step_name).mark_step_executing()
 
     def _initialize_step_execution(self, steps):

src/sagemaker/local/image.py

@@ -189,7 +189,7 @@ def process(
 
         # Print our Job Complete line to have a similar experience to training on SageMaker where
         # you see this line at the end.
-        print("===== Job Complete =====")
+        logger.info("===== Job Complete =====")
 
     def train(self, input_data_config, output_data_config, hyperparameters, environment, job_name):
         """Run a training job locally using docker-compose.
@@ -269,7 +269,7 @@ def train(self, input_data_config, output_data_config, hyperparameters, environm
 
         # Print our Job Complete line to have a similar experience to training on SageMaker where
         # you see this line at the end.
-        print("===== Job Complete =====")
+        logger.info("===== Job Complete =====")
         return artifacts
 
     def serve(self, model_dir, environment):

src/sagemaker/model_monitor/clarify_model_monitoring.py

@@ -29,7 +29,8 @@
 from sagemaker.clarify import SageMakerClarifyProcessor, ModelPredictedLabelConfig
 from sagemaker.lineage._utils import get_resource_name_from_arn
 
-_LOGGER = logging.getLogger(__name__)
+# Setting _LOGGER for backward compatibility, in case users import it...
+logger = _LOGGER = logging.getLogger(__name__)
 
 
 class ClarifyModelMonitor(mm.ModelMonitor):
@@ -223,7 +224,7 @@ def _upload_analysis_config(self, analysis_config, output_s3_uri, job_definition
             str(uuid.uuid4()),
             "analysis_config.json",
         )
-        _LOGGER.info("Uploading analysis config to {s3_uri}.")
+        logger.info("Uploading analysis config to {s3_uri}.")
         return s3.S3Uploader.upload_string_as_file_body(
             json.dumps(analysis_config),
             desired_s3_uri=s3_uri,
@@ -598,7 +599,7 @@ def create_monitoring_schedule(
                 "Monitoring Schedule. To create another, first delete the existing one "
                 "using my_monitor.delete_monitoring_schedule()."
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         if (batch_transform_input is not None) ^ (endpoint_input is None):
@@ -607,7 +608,7 @@ def create_monitoring_schedule(
                 "Amazon Model Monitoring Schedule. "
                 "Please provide only one of the above required inputs"
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         # create job definition
@@ -653,15 +654,15 @@ def create_monitoring_schedule(
             self.job_definition_name = new_job_definition_name
             self.monitoring_schedule_name = monitor_schedule_name
         except Exception:
-            _LOGGER.exception("Failed to create monitoring schedule.")
+            logger.exception("Failed to create monitoring schedule.")
             # noinspection PyBroadException
             try:
                 self.sagemaker_session.sagemaker_client.delete_model_bias_job_definition(
                     JobDefinitionName=new_job_definition_name
                 )
             except Exception:  # pylint: disable=W0703
                 message = "Failed to delete job definition {}.".format(new_job_definition_name)
-                _LOGGER.exception(message)
+                logger.exception(message)
             raise
 
     # noinspection PyMethodOverriding
@@ -740,7 +741,7 @@ def update_monitoring_schedule(
                 "Amazon Model Monitoring Schedule. "
                 "Please provide only one of the above required inputs"
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         # Only need to update schedule expression
@@ -799,15 +800,15 @@ def update_monitoring_schedule(
             if network_config is not None:
                 self.network_config = network_config
         except Exception:
-            _LOGGER.exception("Failed to update monitoring schedule.")
+            logger.exception("Failed to update monitoring schedule.")
             # noinspection PyBroadException
             try:
                 self.sagemaker_session.sagemaker_client.delete_model_bias_job_definition(
                     JobDefinitionName=new_job_definition_name
                 )
             except Exception:  # pylint: disable=W0703
                 message = "Failed to delete job definition {}.".format(new_job_definition_name)
-                _LOGGER.exception(message)
+                logger.exception(message)
             raise
 
     def delete_monitoring_schedule(self):
@@ -817,7 +818,7 @@ def delete_monitoring_schedule(self):
         message = "Deleting Model Bias Job Definition with name: {}".format(
             self.job_definition_name
         )
-        _LOGGER.info(message)
+        logger.info(message)
         self.sagemaker_session.sagemaker_client.delete_model_bias_job_definition(
             JobDefinitionName=self.job_definition_name
         )
@@ -1018,7 +1019,7 @@ def create_monitoring_schedule(
                 "Monitoring Schedule. To create another, first delete the existing one "
                 "using my_monitor.delete_monitoring_schedule()."
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         if (batch_transform_input is not None) ^ (endpoint_input is None):
@@ -1027,7 +1028,7 @@ def create_monitoring_schedule(
                 "Amazon Model Monitoring Schedule."
                 "Please provide only one of the above required inputs"
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         # create job definition
@@ -1074,15 +1075,15 @@ def create_monitoring_schedule(
             self.job_definition_name = new_job_definition_name
             self.monitoring_schedule_name = monitor_schedule_name
         except Exception:
-            _LOGGER.exception("Failed to create monitoring schedule.")
+            logger.exception("Failed to create monitoring schedule.")
             # noinspection PyBroadException
             try:
                 self.sagemaker_session.sagemaker_client.delete_model_explainability_job_definition(
                     JobDefinitionName=new_job_definition_name
                 )
             except Exception:  # pylint: disable=W0703
                 message = "Failed to delete job definition {}.".format(new_job_definition_name)
-                _LOGGER.exception(message)
+                logger.exception(message)
             raise
 
     # noinspection PyMethodOverriding
@@ -1159,7 +1160,7 @@ def update_monitoring_schedule(
                 "Amazon Model Monitoring Schedule. "
                 "Please provide only one of the above required inputs"
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         # Only need to update schedule expression
@@ -1221,15 +1222,15 @@ def update_monitoring_schedule(
             if network_config is not None:
                 self.network_config = network_config
         except Exception:
-            _LOGGER.exception("Failed to update monitoring schedule.")
+            logger.exception("Failed to update monitoring schedule.")
             # noinspection PyBroadException
             try:
                 self.sagemaker_session.sagemaker_client.delete_model_explainability_job_definition(
                     JobDefinitionName=new_job_definition_name
                 )
             except Exception:  # pylint: disable=W0703
                 message = "Failed to delete job definition {}.".format(new_job_definition_name)
-                _LOGGER.exception(message)
+                logger.exception(message)
             raise
 
     def delete_monitoring_schedule(self):
@@ -1239,7 +1240,7 @@ def delete_monitoring_schedule(self):
         message = "Deleting Model Explainability Job Definition with name: {}".format(
             self.job_definition_name
         )
-        _LOGGER.info(message)
+        logger.info(message)
         self.sagemaker_session.sagemaker_client.delete_model_explainability_job_definition(
             JobDefinitionName=self.job_definition_name
         )