Merge pull request #771 from CitrineInformatics/maintain/remove-prints

Maintain/remove prints

Author: kroenlein

src/citrine/__version__.py

@@ -1 +1 @@
-__version__ = '1.35.0'
+__version__ = '1.35.1'

src/citrine/_rest/collection.py

@@ -1,4 +1,3 @@
-import warnings
 from abc import abstractmethod
 from logging import getLogger
 from typing import Optional, Union, Generic, TypeVar, Iterable, Iterator
@@ -137,5 +136,5 @@ def _build_collection_elements(self,
             except(KeyError, ValueError) as e:
                 # TODO(PLA-9109): This is a patch to handle deprecated predictors client side
                 # Remove when predictors are migrated
-                warnings.warn(f"Building element skipped due to error: {e}", UserWarning)
+                logger.warning(f"Building element skipped due to error: {e}")
                 pass

src/citrine/builders/auto_configure.py

@@ -1,6 +1,6 @@
+from logging import getLogger
 from uuid import UUID
 from typing import Union, Optional, List
-import warnings
 
 from gemd.entity.link_by_uid import LinkByUID
 from gemd.enumeration.base_enumeration import BaseEnumeration
@@ -24,6 +24,8 @@
 
 from citrine.builders.scores import create_default_score
 
+logger = getLogger(__name__)
+
 
 class AutoConfigureStatus(BaseEnumeration):
     """[ALPHA] The current status of the AutoConfigureWorkflow.
@@ -135,7 +137,7 @@ def __init__(self, *, project: Project, name: str):
 
     @staticmethod
     def _print_status(msg: str):
-        print(f"AutoConfigureWorkflow: {msg}")
+        logger.info(f"AutoConfigureWorkflow: {msg}")
 
     @property
     def project(self) -> Project:
@@ -229,17 +231,17 @@ def _update_assets(self):
             )
         else:
             self._table_config = self.project.table_configs.get(self.table_config.uid)
-            print("Found existing: {}".format(self.table_config))
+            logger.info("Found existing: {}".format(self.table_config))
 
         # Table
         if self.table is None:
             if self.table_config is not None:
                 self._table = next(self.project.tables.list_by_config(self.table_config.uid), None)
                 if self.table is not None:
-                    print("Found existing: {}".format(self.table))
+                    logger.info("Found existing: {}".format(self.table))
         else:
             self._table = self.project.tables.get(self.table.uid)
-            print("Found existing: {}".format(self.table))
+            logger.info("Found existing: {}".format(self.table))
 
         # Predictor
         if self.predictor is None:
@@ -249,7 +251,7 @@ def _update_assets(self):
             )
         else:
             self._predictor = self.project.predictors.get(self.predictor.uid)
-            print("Found existing: {}".format(self.predictor))
+            logger.info("Found existing: {}".format(self.predictor))
 
         # PEW
         if self.predictor_evaluation_workflow is None:
@@ -261,7 +263,7 @@ def _update_assets(self):
             self._predictor_evaluation_workflow = self.project.predictor_evaluation_workflows.get(
                 self.predictor_evaluation_workflow.uid
             )
-            print("Found existing: {}".format(self.predictor_evaluation_workflow))
+            logger.info("Found existing: {}".format(self.predictor_evaluation_workflow))
 
         # Design space
         if self.design_space is None:
@@ -271,7 +273,7 @@ def _update_assets(self):
             )
         else:
             self._design_space = self.project.design_spaces.get(self.design_space.uid)
-            print("Found existing: {}".format(self.design_space))
+            logger.info("Found existing: {}".format(self.design_space))
 
         # Design workflow
         if self.design_workflow is None:
@@ -281,7 +283,7 @@ def _update_assets(self):
             )
         else:
             self._design_workflow = self.project.design_workflows.get(self.design_workflow.uid)
-            print("Found existing: {}".format(self.design_workflow))
+            logger.info("Found existing: {}".format(self.design_workflow))
 
     def _update_status(self):
         """Update status info based on currently stored assets."""
@@ -659,7 +661,7 @@ def _predictor_evaluation_stage(
         if pew.failed():
             # Can proceed without raising error, but can't get PEE
             self._status = AutoConfigureStatus.PEW_FAILED
-            warnings.warn(
+            logger.warning(
                 "Predictor evaluation workflow failed -- unable to configure execution."
             )
         elif evaluator is not None:

src/citrine/builders/design_spaces.py

@@ -1,4 +1,5 @@
 import csv
+from logging import getLogger
 from uuid import UUID
 
 from citrine.exceptions import BadRequest
@@ -16,10 +17,11 @@
     raise ImportError('numpy is a requirement for the builders module')
 from itertools import product
 from typing import Mapping, Sequence, List, Optional
-from warnings import warn
 from citrine.informatics.design_spaces import EnumeratedDesignSpace, DataSourceDesignSpace
 from citrine.informatics.descriptors import Descriptor, RealDescriptor
 
+logger = getLogger(__name__)
+
 
 def enumerate_cartesian_product(
     *,
@@ -54,7 +56,7 @@ def enumerate_cartesian_product(
         [len(grid_points) for grid_points in design_grid.values()]
     ) * len(design_grid)
     if grid_size > 2E8:
-        warn(
+        logger.warning(
             "Product design grid contains {n} grid points. This may cause memory issues "
             "downstream.".format(n=grid_size)
         )
@@ -214,7 +216,7 @@ def cartesian_join_design_spaces(
     grid_size = np.prod([len(ds.data) for ds in subspaces]) \
         * np.sum([len(ds.data[0]) for ds in subspaces])
     if grid_size > 2E8:
-        warn(
+        logger.warning(
             "Product design grid contains {n} grid points. This may cause memory issues "
             "downstream.".format(n=grid_size)
         )
@@ -332,7 +334,7 @@ def migrate_enumerated_design_space(*,
         try:
             project.design_spaces.archive(enumerated_ds.uid)
         except BadRequest as err:
-            warn("Unable to archive design space with uid {}, received the following response: {}"
-                 .format(uid, err.response_text))
+            logger.warning(f"Unable to archive design space with uid {uid}, "
+                           f"received the following response: {err.response_text}")
 
     return data_source_ds

src/citrine/informatics/predictor_evaluation_metrics.py

@@ -1,6 +1,6 @@
+from logging import getLogger
 from math import isclose
 from typing import Type, Union, List
-from warnings import warn
 
 from citrine._serialization import properties
 from citrine._serialization.polymorphic_serializable import PolymorphicSerializable
@@ -16,6 +16,8 @@
            'AreaUnderROC',
            'CoverageProbability']
 
+logger = getLogger(__name__)
+
 
 class PredictorEvaluationMetric(PolymorphicSerializable["PredictorEvaluationMetric"]):
     """A metric computed during a Predictor Evaluation Workflow.
@@ -191,7 +193,7 @@ def __init__(self, *, coverage_level: Union[str, float] = "0.683"):
             raise ValueError("Coverage level must be between 0 and 1 (non-inclusive).")
         _level_float = round(raw_float, 3)
         if not isclose(_level_float, raw_float):
-            warn(
+            logger.warning(
                 "Coverage level can only be specified to 3 decimal places."
                 "Requested level '{requested_level}' will be rounded "
                 "to {rounded_level}.".format(

src/citrine/informatics/reports.py

@@ -2,7 +2,7 @@
 from typing import Type, Dict, TypeVar, Iterable
 from abc import abstractmethod
 from itertools import groupby
-import warnings
+from logging import getLogger
 
 from citrine._serialization import properties
 from citrine._serialization.polymorphic_serializable import PolymorphicSerializable
@@ -12,6 +12,8 @@
 
 SelfType = TypeVar('SelfType', bound='Report')
 
+logger = getLogger(__name__)
+
 
 class Report(PolymorphicSerializable['Report'], AsynchronousObject):
     """[ALPHA] A Citrine Report contains information related to a module.
@@ -162,9 +164,9 @@ def _get_sole_descriptor(it: Iterable):
         as_list = list(it)
         if len(as_list) > 1:
             serialized_descriptors = [d.dump() for d in as_list]
-            warnings.warn("Warning: found multiple descriptors with the key \'{}\', arbitrarily "
-                          "selecting the first one. The descriptors are: {}"
-                          .format(as_list[0].key, serialized_descriptors), RuntimeWarning)
+            logger.warning("Warning: found multiple descriptors with the key \'{}\', arbitrarily "
+                           "selecting the first one. The descriptors are: {}"
+                           .format(as_list[0].key, serialized_descriptors))
         return as_list[0]
 
     @staticmethod

src/citrine/seeding/find_or_create.py

@@ -1,5 +1,5 @@
 from copy import deepcopy
-
+from logging import getLogger
 from deprecation import deprecated
 
 from citrine.exceptions import NotFound
@@ -8,6 +8,8 @@
 from citrine.informatics.workflows.design_workflow import DesignWorkflow
 from citrine._rest.collection import CreationType, Collection
 
+logger = getLogger(__name__)
+
 
 def find_collection(*, collection, name):
     """
@@ -37,7 +39,7 @@ def find_collection(*, collection, name):
         raise ValueError("Found multiple collections with name '{}'".format(name))
     if len(matching_resources) == 1:
         result = matching_resources.pop()
-        print('Found existing: {}'.format(result))
+        logger.info('Found existing: {}'.format(result))
         return result
     else:
         return None
@@ -53,7 +55,7 @@ def get_by_name_or_create(*, collection, name, default_provider):
     if found:
         return found
     else:
-        print('Failed to find resource with name {}, creating one instead.'.format(name))
+        logger.info('Failed to find resource with name {}, creating one instead.'.format(name))
         return default_provider()
 
 
@@ -149,7 +151,7 @@ def create_or_update(*, collection: Collection[CreationType], resource: Creation
     """
     old_resource = find_collection(collection=collection, name=resource.name)
     if old_resource:
-        print("Updating module: {}".format(resource.name))
+        logger.info("Updating module: {}".format(resource.name))
         # Copy so that passed-in resource is unaffected
         new_resource = deepcopy(resource)
         new_resource.uid = old_resource.uid
@@ -159,5 +161,5 @@ def create_or_update(*, collection: Collection[CreationType], resource: Creation
             new_resource.branch_id = old_resource.branch_id
         return collection.update(new_resource)
     else:
-        print("Registering new module:  {}".format(resource.name))
+        logger.info("Registering new module:  {}".format(resource.name))
         return collection.register(resource)

tests/builders/test_auto_configure.py

@@ -1,3 +1,4 @@
+import logging
 from uuid import uuid4
 
 import pytest
@@ -292,7 +293,7 @@ def test_auto_configure_predictor_registration(project):
 
 
 @mock.patch("citrine.builders.auto_configure.PredictorEvaluationWorkflow", FakePredictorEvaluationWorkflow)
-def test_auto_configure_predictor_evaluation(project):
+def test_auto_configure_predictor_evaluation(project, caplog):
     """Test the predictor evaluation stage of auto configure."""
     config_name = "Test"
     resources = default_resources(config_name)
@@ -320,14 +321,16 @@ def test_auto_configure_predictor_evaluation(project):
 
     # Create default w/ an invalid response
     with mock.patch("citrine.builders.auto_configure.wait_while_validating", fake_wait_while_failed):
-        with pytest.warns(UserWarning):
+        caplog.clear()
+        with caplog.at_level(logging.WARNING):
             auto_config._predictor_evaluation_stage(
                 predictor=predictor,
                 evaluator=None,
                 print_status_info=False
             )
             assert len(auto_config.assets) == 4
             assert auto_config.status == "PREDICTOR EVALUATION WORKFLOW FAILED"
+            assert any(r.levelno == logging.WARNING for r in caplog.records)
 
     # Create manual w/ a valid response
     with mock.patch("citrine.builders.auto_configure.wait_while_validating", fake_wait_while_succeeded):
@@ -341,14 +344,16 @@ def test_auto_configure_predictor_evaluation(project):
 
     # Create manual w/ a failed response
     with mock.patch("citrine.builders.auto_configure.wait_while_validating", fake_wait_while_failed):
-        with pytest.warns(UserWarning):
+        caplog.clear()
+        with caplog.at_level(logging.WARNING):
             auto_config._predictor_evaluation_stage(
                 predictor=predictor,
                 evaluator=evaluator,
                 print_status_info=False
             )
         assert len(auto_config.assets) == 4
         assert auto_config.status == "PREDICTOR EVALUATION WORKFLOW FAILED"
+        assert any(r.levelno == logging.WARNING for r in caplog.records)
 
 
 def test_auto_configure_design_space_build(project):