Add logger to all modules

Author: remingtonc

src/cisco_gnmi/builder.py

@@ -31,6 +31,9 @@
 from .util import gen_target_netloc, get_cert_from_target, get_cn_from_cert
 
 
+LOGGER = logging.getLogger(__name__)
+
+
 class ClientBuilder(object):
     """Builder for the creation of a gNMI client.
     Supports construction of base Client and XRClient.
@@ -134,8 +137,8 @@ def set_os(self, name=None):
         if name not in self.os_class_map.keys():
             raise Exception("OS not supported!")
         else:
+            LOGGER.debug("Using %s wrapper.", name or "Client")
             self.__client_class = self.os_class_map[name]
-        logging.debug("Using %s wrapper.", name or "Client")
         return self
 
     def set_secure(
@@ -257,7 +260,7 @@ def set_channel_option(self, name, value):
                     found_index = index
                     break
             if found_index is not None:
-                logging.warning("Found existing channel option %s, overwriting!", name)
+                LOGGER.warning("Found existing channel option %s, overwriting!", name)
                 self.__channel_options[found_index] = new_option
             else:
                 self.__channel_options.append(new_option)
@@ -279,26 +282,26 @@ def construct(self):
             self.__root_certificates, self.__private_key, self.__certificate_chain
         )
         if self.__username and self.__password:
+            LOGGER.debug("Using username/password call authentication.")
             channel_metadata_creds = grpc.metadata_call_credentials(
                 CiscoAuthPlugin(self.__username, self.__password)
             )
-            logging.debug("Using username/password call authentication.")
         if channel_ssl_creds and channel_metadata_creds:
+            LOGGER.debug("Using SSL/metadata authentication composite credentials.")
             channel_creds = grpc.composite_channel_credentials(
                 channel_ssl_creds, channel_metadata_creds
             )
-            logging.debug("Using SSL/metadata authentication composite credentials.")
         else:
+            LOGGER.debug("Using SSL credentials, no metadata authentication.")
             channel_creds = channel_ssl_creds
-            logging.debug("Using SSL credentials, no metadata authentication.")
         if self.__ssl_target_name_override is not False:
             if self.__ssl_target_name_override is None:
                 if not self.__root_certificates:
                     raise Exception("Deriving override requires root certificate!")
                 self.__ssl_target_name_override = get_cn_from_cert(
                     self.__root_certificates
                 )
-                logging.warning(
+                LOGGER.warning(
                     "Overriding SSL option from certificate could increase MITM susceptibility!"
                 )
             self.set_channel_option(

src/cisco_gnmi/client.py

@@ -31,7 +31,7 @@
 from . import util
 
 
-logger = logging.getLogger(__name__)
+LOGGER = logging.getLogger(__name__)
 
 
 class Client(object):
@@ -112,7 +112,7 @@ def capabilities(self):
         proto.gnmi_pb2.CapabilityResponse
         """
         message = proto.gnmi_pb2.CapabilityRequest()
-        logger.debug(message)
+        LOGGER.debug(message)
         response = self.service.Capabilities(message)
         return response
 
@@ -168,7 +168,7 @@ def get(
         if extension:
             request.extension = extension
 
-        logger.debug(str(request))
+        LOGGER.debug(str(request))
 
         get_response = self.service.Get(request)
         return get_response
@@ -215,7 +215,7 @@ def set(
         if extensions:
             request.extension.extend(extensions)
 
-        logger.debug(str(request))
+        LOGGER.debug(str(request))
 
         response = self.service.Set(request)
         return response
@@ -255,7 +255,7 @@ def validate_request(request):
             if extensions:
                 subscribe_request.extensions.extend(extensions)
 
-            logger.debug(str(subscribe_request))
+            LOGGER.debug(str(subscribe_request))
 
             return subscribe_request
 

src/cisco_gnmi/nx.py

@@ -30,6 +30,9 @@
 from .client import Client, proto, util
 
 
+LOGGER = logging.getLogger(__name__)
+
+
 class NXClient(Client):
     """NX-OS-specific wrapper for gNMI functionality.
 

src/cisco_gnmi/util.py

@@ -37,6 +37,9 @@
     from urlparse import urlparse
 
 
+LOGGER = logging.getLogger(__name__)
+
+
 def gen_target_netloc(target, netloc_prefix="//", default_port=9339):
     """Parses and validates a supplied target URL for gRPC calls.
     Uses urllib to parse the netloc property from the URL.
@@ -51,11 +54,11 @@ def gen_target_netloc(target, netloc_prefix="//", default_port=9339):
     if not parsed_target.netloc:
         raise ValueError("Unable to parse netloc from target URL %s!" % target)
     if parsed_target.scheme:
-        logging.debug("Scheme identified in target, ignoring and using netloc.")
+        LOGGER.debug("Scheme identified in target, ignoring and using netloc.")
     target_netloc = parsed_target
     if parsed_target.port is None:
         ported_target = "%s:%i" % (parsed_target.hostname, default_port)
-        logging.debug("No target port detected, reassembled to %s.", ported_target)
+        LOGGER.debug("No target port detected, reassembled to %s.", ported_target)
         target_netloc = gen_target_netloc(ported_target)
     return target_netloc
 
@@ -120,11 +123,11 @@ def get_cn_from_cert(cert_pem):
     cert_cns = cert_parsed.subject.get_attributes_for_oid(x509.oid.NameOID.COMMON_NAME)
     if len(cert_cns) > 0:
         if len(cert_cns) > 1:
-            logging.warning(
+            LOGGER.warning(
                 "Multiple CNs found for certificate, defaulting to the first one."
             )
         cert_cn = cert_cns[0].value
-        logging.debug("Using %s as certificate CN.", cert_cn)
+        LOGGER.debug("Using %s as certificate CN.", cert_cn)
     else:
-        logging.warning("No CN found for certificate.")
+        LOGGER.warning("No CN found for certificate.")
     return cert_cn

src/cisco_gnmi/xe.py

@@ -30,7 +30,7 @@
 from .client import Client, proto, util
 
 
-logger = logging.getLogger(__name__)
+LOGGER = logging.getLogger(__name__)
 
 
 class XEClient(Client):
@@ -111,7 +111,13 @@ def delete_xpaths(self, xpaths, prefix=None):
             paths.append(self.parse_xpath_to_gnmi_path(xpath))
         return self.set(deletes=paths)
 
-    def set_json(self, update_json_configs=None, replace_json_configs=None, ietf=True, prefix=None):
+    def set_json(
+        self,
+        update_json_configs=None,
+        replace_json_configs=None,
+        ietf=True,
+        prefix=None,
+    ):
         """A convenience wrapper for set() which assumes JSON payloads and constructs desired messages.
         All parameters are optional, but at least one must be present.
 
@@ -136,14 +142,14 @@ def set_json(self, update_json_configs=None, replace_json_configs=None, ietf=Tru
 
         def check_configs(name, configs):
             if isinstance(configs, string_types):
-                logger.debug("Handling %s as JSON string.", name)
+                LOGGER.debug("Handling %s as JSON string.", name)
                 try:
                     configs = json.loads(configs)
                 except:
                     raise Exception("{name} is invalid JSON!".format(name=name))
                 configs = [configs]
             elif isinstance(configs, dict):
-                logger.debug("Handling %s as already serialized JSON object.", name)
+                LOGGER.debug("Handling %s as already serialized JSON object.", name)
                 configs = [configs]
             elif not isinstance(configs, (list, set)):
                 raise Exception(

src/cisco_gnmi/xr.py

@@ -30,6 +30,9 @@
 from .client import Client, proto, util
 
 
+LOGGER = logging.getLogger(__name__)
+
+
 class XRClient(Client):
     """IOS XR-specific wrapper for gNMI functionality.
 
@@ -130,14 +133,14 @@ def set_json(self, update_json_configs=None, replace_json_configs=None, ietf=Tru
 
         def check_configs(name, configs):
             if isinstance(name, string_types):
-                logging.debug("Handling %s as JSON string.", name)
+                LOGGER.debug("Handling %s as JSON string.", name)
                 try:
                     configs = json.loads(configs)
                 except:
                     raise Exception("{name} is invalid JSON!".format(name=name))
                 configs = [configs]
             elif isinstance(name, dict):
-                logging.debug("Handling %s as already serialized JSON object.", name)
+                LOGGER.debug("Handling %s as already serialized JSON object.", name)
                 configs = [configs]
             elif not isinstance(configs, (list, set)):
                 raise Exception(