Pylint Cleanup and Fixes (#163)

* Pylint Run

* Remove redundant parens

Author: pglombardo

instana/__init__.py

@@ -78,7 +78,7 @@ def boot_agent():
         print("Instana: activated via AutoTrace")
 else:
     if ("INSTANA_DEBUG" in os.environ) and ("AUTOWRAPT_BOOTSTRAP" not in os.environ):
-            print("Instana: activated via manual import")
+        print("Instana: activated via manual import")
 
 # User configurable EUM API key for instana.helpers.eum_snippet()
 # pylint: disable=invalid-name

instana/agent.py

@@ -54,7 +54,7 @@ def __init__(self):
         self.sensor = Sensor(self)
         self.machine = TheMachine(self)
 
-    def start(self, e):
+    def start(self, _):
         """
         Starts the agent and required threads
 
@@ -92,7 +92,7 @@ def extractor(o):
 
         try:
             return json.dumps(o, default=extractor, sort_keys=False, separators=(',', ':')).encode()
-        except:
+        except Exception:
             logger.debug("to_json", exc_info=True)
 
     def is_timed_out(self):
@@ -145,13 +145,13 @@ def is_agent_listening(self, host, port):
 
             server_header = response.headers["Server"]
             if server_header == AGENT_HEADER:
-                logger.debug("Host agent found on %s:%d" % (host, port))
+                logger.debug("Host agent found on %s:%d", host, port)
                 rv = True
             else:
-                logger.debug("...something is listening on %s:%d but it's not the Instana Host Agent: %s"
-                             % (host, port, server_header))
+                logger.debug("...something is listening on %s:%d but it's not the Instana Host Agent: %s",
+                             host, port, server_header)
         except (requests.ConnectTimeout, requests.ConnectionError):
-            logger.debug("Instana Host Agent not found on %s:%d" % (host, port))
+            logger.debug("Instana Host Agent not found on %s:%d", host, port)
             rv = False
         finally:
             return rv
@@ -162,7 +162,7 @@ def announce(self, discovery):
         """
         try:
             url = self.__discovery_url()
-            logger.debug("making announce request to %s" % (url))
+            logger.debug("making announce request to %s", url)
             response = None
             response = self.client.put(url,
                                        data=self.to_json(discovery),
@@ -238,7 +238,7 @@ def task_response(self, message_id, data):
             response = None
             payload = json.dumps(data)
 
-            logger.debug("Task response is %s: %s" % (self.__response_url(message_id), payload))
+            logger.debug("Task response is %s: %s", self.__response_url(message_id), payload)
 
             response = self.client.post(self.__response_url(message_id),
                                         data=payload,

instana/api.py

@@ -246,7 +246,7 @@ def upsert_rule_binding(self, rule_binding_config):
         return self.put(path, rule_binding_config)
 
     def delete_rule_binding(self, rule_binding_id):
-        return self.detel('/api/ruleBindings/%s' % rule_binding_id)
+        return self.delete('/api/ruleBindings/%s' % rule_binding_id)
 
     def rules(self):
         return self.get('/api/rules')

instana/flaskana.py

@@ -13,7 +13,7 @@ def wrapper(wrapped, instance, args, kwargs):
     return rv
 
 
-def hook(module):
+def hook(_):
     """ Hook method to install the Instana middleware into Flask """
     if "INSTANA_DEBUG" in os.environ:
         print("==============================================================")

instana/fsm.py

@@ -52,7 +52,7 @@ def __init__(self, agent):
         except pkg_resources.DistributionNotFound:
             pass
 
-        logger.info("Stan is on the scene.  Starting Instana instrumentation version: %s" % package_version)
+        logger.info("Stan is on the scene.  Starting Instana instrumentation version: %s", package_version)
         logger.debug("initializing fsm")
 
         self.agent = agent
@@ -77,8 +77,8 @@ def __init__(self, agent):
 
     @staticmethod
     def print_state_change(e):
-        logger.debug('========= (%i#%s) FSM event: %s, src: %s, dst: %s ==========' %
-                     (os.getpid(), t.current_thread().name, e.event, e.src, e.dst))
+        logger.debug('========= (%i#%s) FSM event: %s, src: %s, dst: %s ==========',
+                     os.getpid(), t.current_thread().name, e.event, e.src, e.dst)
 
     def reset(self):
         """
@@ -163,7 +163,7 @@ def announce_sensor(self, e):
         if response and (response.status_code is 200) and (len(response.content) > 2):
             self.agent.set_from(response.content)
             self.fsm.pending()
-            logger.debug("Announced pid: %s (true pid: %s).  Waiting for Agent Ready..." % (str(pid), str(self.agent.from_.pid)))
+            logger.debug("Announced pid: %s (true pid: %s).  Waiting for Agent Ready...", str(pid), str(self.agent.from_.pid))
             return True
         else:
             logger.debug("Cannot announce sensor. Scheduling retry.")
@@ -176,9 +176,9 @@ def schedule_retry(self, fun, e, name):
         self.timer.name = name
         self.timer.start()
 
-    def on_ready(self, e):
-        logger.info("Host agent available. We're in business. Announced pid: %s (true pid: %s)" %
-                    (str(os.getpid()), str(self.agent.from_.pid)))
+    def on_ready(self, _):
+        logger.info("Host agent available. We're in business. Announced pid: %s (true pid: %s)",
+                    str(os.getpid()), str(self.agent.from_.pid))
 
     def __get_real_pid(self):
         """
@@ -200,7 +200,6 @@ def __get_real_pid(self):
                         pid = int(g.groups()[0])
                 except Exception:
                     logger.debug("parsing sched file failed", exc_info=True)
-                    pass
 
         if pid is None:
             pid = os.getpid()

instana/helpers.py

@@ -12,7 +12,7 @@
 # eum_snippet(meta=meta_kvs)
 
 
-def eum_snippet(trace_id=None, eum_api_key=None, meta={}):
+def eum_snippet(trace_id=None, eum_api_key=None, meta=None):
     """
     Return an EUM snippet for use in views, templates and layouts that reports
     client side metrics to Instana that will automagically be linked to the
@@ -30,7 +30,7 @@ def eum_snippet(trace_id=None, eum_api_key=None, meta={}):
         eum_src = Template(eum_file.read())
 
         # Prepare the standard required IDs
-        ids = {}
+        ids = dict()
         ids['meta_kvs'] = ''
 
         parent_span = tracer.active_span
@@ -48,15 +48,17 @@ def eum_snippet(trace_id=None, eum_api_key=None, meta={}):
             ids['eum_api_key'] = global_eum_api_key
 
         # Process passed in EUM 'meta' key/values
-        for key, value in meta.items():
-            ids['meta_kvs'] += ("'ineum('meta', '%s', '%s');'" % (key, value))
+        if meta is not None:
+            for key, value in meta.items():
+                ids['meta_kvs'] += ("'ineum('meta', '%s', '%s');'" % (key, value))
 
         return eum_src.substitute(ids)
-    except Exception as e:
-        logger.debug(e)
+    except Exception:
+        logger.debug("eum_snippet: ", exc_info=True)
         return ''
 
-def eum_test_snippet(trace_id=None, eum_api_key=None, meta={}):
+
+def eum_test_snippet(trace_id=None, eum_api_key=None, meta=None):
     """
     Return an EUM snippet for use in views, templates and layouts that reports
     client side metrics to Instana that will automagically be linked to the
@@ -92,10 +94,11 @@ def eum_test_snippet(trace_id=None, eum_api_key=None, meta={}):
             ids['eum_api_key'] = global_eum_api_key
 
         # Process passed in EUM 'meta' key/values
-        for key, value in meta.items():
-            ids['meta_kvs'] += ("'ineum('meta', '%s', '%s');'" % (key, value))
+        if meta is not None:
+            for key, value in meta.items():
+                ids['meta_kvs'] += ("'ineum('meta', '%s', '%s');'" % (key, value))
 
         return eum_src.substitute(ids)
-    except Exception as e:
-        logger.debug(e)
+    except Exception:
+        logger.debug("eum_snippet: ", exc_info=True)
         return ''

instana/http_propagator.py

@@ -56,7 +56,7 @@ def inject(self, span_context, carrier):
             else:
                 raise Exception("Unsupported carrier type", type(carrier))
 
-        except:
+        except Exception:
             logger.debug("inject error:", exc_info=True)
 
     def extract(self, carrier):  # noqa
@@ -96,5 +96,5 @@ def extract(self, carrier):  # noqa
                                   sampled=True)
             return ctx
 
-        except Exception as e:
+        except Exception:
             logger.debug("extract error:", exc_info=True)

instana/instrumentation/aiohttp/client.py

@@ -32,7 +32,7 @@ async def stan_request_start(session, trace_config_ctx, params):
                 scope.span.set_tag("http.params", cleaned_qp)
             scope.span.set_tag("http.url", parts[0])
             scope.span.set_tag('http.method', params.method)
-        except:
+        except Exception:
             logger.debug("stan_request_start", exc_info=True)
 
     async def stan_request_end(session, trace_config_ctx, params):
@@ -48,7 +48,7 @@ async def stan_request_end(session, trace_config_ctx, params):
                     scope.span.set_tag("ec", ec + 1)
 
                 scope.close()
-        except:
+        except Exception:
             logger.debug("stan_request_end", exc_info=True)
 
     async def stan_request_exception(session, trace_config_ctx, params):
@@ -58,7 +58,7 @@ async def stan_request_exception(session, trace_config_ctx, params):
                 scope.span.log_exception(params.exception)
                 scope.span.set_tag("http.error", str(params.exception))
                 scope.close()
-        except:
+        except Exception:
             logger.debug("stan_request_exception", exc_info=True)
 
     @wrapt.patch_function_wrapper('aiohttp.client','ClientSession.__init__')

instana/instrumentation/aiohttp/server.py

@@ -52,7 +52,7 @@ async def stan_middleware(request, handler):
                 response.headers['Server-Timing'] = "intid;desc=%s" % scope.span.context.trace_id
 
             return response
-        except:
+        except Exception:
             logger.debug("aiohttp stan_middleware", exc_info=True)
         finally:
             if scope is not None:

instana/instrumentation/django/middleware.py

@@ -22,7 +22,6 @@ class InstanaMiddleware(MiddlewareMixin):
     """ Django Middleware to provide request tracing for Instana """
     def __init__(self, get_response=None):
         self.get_response = get_response
-        self
 
     def process_request(self, request):
         try:
@@ -118,7 +117,7 @@ def load_middleware_wrapper(wrapped, instance, args, kwargs):
 
         return wrapped(*args, **kwargs)
     except Exception:
-            logger.warn("Instana: Couldn't add InstanaMiddleware to Django: ", exc_info=True)
+        logger.warn("Instana: Couldn't add InstanaMiddleware to Django: ", exc_info=True)
 
 
 try: