chore: Remove print statements (canonical#326)

As a library, pycloudlib really shouldn't be printing anything ever.
Convert all non-test print statements to the appropriate log message.

Author: TheRealFalcon

VERSION

@@ -1 +1 @@
-1!5.9.0
+1!5.10.0

pycloudlib/cloud.py

@@ -17,7 +17,7 @@
 from pycloudlib.key import KeyPair
 from pycloudlib.util import (
     get_timestamped_tag,
-    print_exception_list,
+    log_exception_list,
     validate_tag,
 )
 
@@ -82,7 +82,7 @@ def __enter__(self):
     def __exit__(self, _type, _value, _trackback):
         """Cleanup context manager for this class."""
         exceptions = self.clean()
-        print_exception_list(exceptions)
+        log_exception_list(exceptions)
         if exceptions:
             raise CleanupError(exceptions)
 

pycloudlib/instance.py

@@ -19,7 +19,7 @@
 
 from pycloudlib.errors import CleanupError, PycloudlibTimeoutError
 from pycloudlib.result import Result
-from pycloudlib.util import print_exception_list, shell_pack, shell_quote
+from pycloudlib.util import log_exception_list, shell_pack, shell_quote
 
 
 class BaseInstance(ABC):
@@ -48,7 +48,7 @@ def __enter__(self):
     def __exit__(self, _type, _value, _traceback):
         """Exit context manager for this class."""
         exceptions = self.delete()
-        print_exception_list(exceptions)
+        log_exception_list(exceptions)
         if exceptions:
             raise CleanupError(exceptions)
 

pycloudlib/lxd/cloud.py

@@ -71,9 +71,8 @@ def create_profile(self, profile_name, profile_config, force=False):
         ]
 
         if profile_name in profile_list and not force:
-            msg = "The profile named {} already exists".format(profile_name)
+            msg = f"The profile named {profile_name} already exists"
             self._log.debug(msg)
-            print(msg)
             return
 
         if force:
@@ -250,7 +249,7 @@ def init(
             config_dict=config_dict,
         )
 
-        print(cmd)
+        self._log.info(cmd)
         result = subp(cmd)
 
         if not name:

pycloudlib/oci/utils.py

@@ -1,5 +1,6 @@
 # This file is part of pycloudlib. See LICENSE file for license information.
 """Utilities for OCI images and instances."""
+import logging
 import time
 from typing import TYPE_CHECKING, Optional
 
@@ -9,6 +10,9 @@
     import oci
 
 
+log = logging.getLogger(__name__)
+
+
 def wait_till_ready(func, current_data, desired_state, sleep_seconds=1000):
     """Wait until the results of function call reach a desired lifecycle state.
 
@@ -72,9 +76,9 @@ def get_subnet_id(
     subnet_id = None
     for subnet in subnets:
         if subnet.prohibit_internet_ingress:  # skip subnet if it's private
-            print("Ignoring private subnet: " + subnet.id)
+            log.debug("Ignoring private subnet: %s", subnet.id)
             continue
-        print("Using public subnet: " + subnet.id)
+        log.debug("Using public subnet: %s", subnet.id)
         if subnet.availability_domain == availability_domain:
             subnet_id = subnet.id
             break

pycloudlib/util.py

@@ -4,12 +4,12 @@
 import base64
 import collections.abc
 import datetime
+import logging
 import os
 import platform
 import re
 import shlex
 import subprocess
-import sys
 import tempfile
 import traceback
 from errno import ENOENT
@@ -32,6 +32,8 @@
 
 LTS_RELEASES = ["xenial", "bionic", "focal", "jammy"]
 
+log = logging.getLogger(__name__)
+
 
 def chmod(path, mode):
     """Run chmod on a file or directory.
@@ -398,11 +400,10 @@ def add_key_to_cloud_config(
     return "#cloud-config\n" + new_data
 
 
-def print_exception_list(exceptions: List[Exception]):
+def log_exception_list(exceptions: List[Exception]):
     """Print a list of exceptions (including traceback) to stderr."""
     if exceptions:
-        print("Encountered exception(s) during cleanup!\n", file=sys.stderr)
+        log.error("Encountered exception(s) during cleanup!")
         for i, e in enumerate(exceptions, start=1):
-            print(f"===== EXCEPTION {i} =====", file=sys.stderr)
-            traceback.print_exception(type(e), e, e.__traceback__)
-            print("", file=sys.stderr)
+            tb = traceback.format_exception(type(e), e, e.__traceback__)
+            log.error("===== EXCEPTION %s =====\n%s", i, "".join(tb))

tests/unit_tests/lxd/test_cloud.py

@@ -84,21 +84,19 @@ class TestProfileCreation:
     """Tests covering pycloudlib.lxd.cloud.create_profile method."""
 
     @mock.patch("pycloudlib.lxd.cloud.subp")
-    def test_create_profile_that_already_exists(self, m_subp):
+    def test_create_profile_that_already_exists(self, m_subp, caplog):
         """Tests creating a profile that already exists."""
         m_subp.return_value = """
             - name: test_profile
         """
         cloud = LXDContainer(tag="test", config_file=io.StringIO(CONFIG))
 
-        fake_stdout = io.StringIO()
-        with contextlib.redirect_stdout(fake_stdout):
-            cloud.create_profile(
-                profile_name="test_profile", profile_config="profile_config"
-            )
+        cloud.create_profile(
+            profile_name="test_profile", profile_config="profile_config"
+        )
 
         expected_msg = "The profile named test_profile already exists"
-        assert expected_msg in fake_stdout.getvalue().strip()
+        assert expected_msg in caplog.text
         assert m_subp.call_args_list == [
             mock.call(["lxc", "profile", "list", "--format", "yaml"])
         ]