Format & clean up imports via isort (instana#83)

* Format & clean up imports via isort

* Avoid importing self.

* More improvements:

* continued import cleanup
* Move Tracer and Sensor init to tracer and sensor packages respectively
* Use SkipTest for API client tests
* Use get_distribution to access version number from setup.py

Author: pglombardo

example/opentracing_vanilla.py

@@ -1,7 +1,9 @@
 # encoding=utf-8
+import time
+
 import opentracing
+
 import instana
-import time
 
 # Loop continuously with a 2 second sleep to generate traces
 while True:

example/simple.py

@@ -1,7 +1,8 @@
 # encoding=utf-8
 import sys
-import opentracing as ot
 import time
+
+import opentracing as ot
 import opentracing.ext.tags as ext
 
 SERVICE = "🦄 Stan ❤️s Python 🦄"

instana/__init__.py

@@ -1,9 +1,12 @@
 from __future__ import absolute_import
+
 import os
 import opentracing
-from .sensor import Sensor
-from .tracer import InstanaTracer
-from .options import Options
+from pkg_resources import get_distribution
+
+from . import sensor
+from . import tracer
+
 
 """
 The Instana package has two core components: the sensor and the tracer.
@@ -19,7 +22,7 @@
 __copyright__ = 'Copyright 2017 Instana Inc.'
 __credits__ = ['Pavlo Baron', 'Peter Giacomo Lombardo']
 __license__ = 'MIT'
-__version__ = '0.10.1'
+__version__ = get_distribution('instana').version
 __maintainer__ = 'Peter Giacomo Lombardo'
 __email__ = 'peter.lombardo@instana.com'
 
@@ -34,30 +37,6 @@ def load(module):
         print("Instana: Loading...")
         print("==========================================================")
 
-
-# For any given Python process, we only want one sensor as multiple would
-# collect/report metrics in duplicate, triplicate etc..
-#
-# Usage example:
-#
-# import instana
-# instana.global_sensor
-#
-global_sensor = Sensor(Options())
-
-# The global OpenTracing compatible tracer used internally by
-# this package.
-#
-# Usage example:
-#
-# import instana
-# instana.internal_tracer.start_span(...)
-#
-internal_tracer = InstanaTracer()
-
-# Set ourselves as the tracer.
-opentracing.tracer = internal_tracer
-
 # Optional application wide service name.
 # Can be configured via environment variable or via code:
 #

instana/agent.py

@@ -1,10 +1,11 @@
 import json
-from instana import log
-import instana.fsm as f
-import instana.agent_const as a
 import threading
 from datetime import datetime
 
+import instana.agent_const as a
+import instana.fsm as f
+from instana import log
+
 try:
     import urllib.request as urllib2
 except ImportError:

instana/flaskana.py

@@ -1,8 +1,11 @@
 from __future__ import print_function
-from instana import wsgi
-import wrapt
+
 import os
 
+import wrapt
+
+from instana import wsgi
+
 
 def wrapper(wrapped, instance, args, kwargs):
     rv = wrapped(*args, **kwargs)

instana/fsm.py

@@ -1,12 +1,16 @@
+from __future__ import absolute_import
+
 import os
-import sys
 import socket
 import subprocess
+import sys
 import threading as t
+
 import fysom as f
-import instana
-from instana import log
-import instana.agent_const as a
+from pkg_resources import get_distribution
+
+from . import agent_const as a
+from . import log
 
 
 class Discovery(object):
@@ -39,7 +43,7 @@ class Fsm(object):
     warnedPeriodic = False
 
     def __init__(self, agent):
-        log.info("Stan is on the scene.  Starting Instana instrumentation version", instana.__version__)
+        log.info("Stan is on the scene.  Starting Instana instrumentation version", get_distribution('instana').version)
         log.debug("initializing fsm")
 
         self.agent = agent

instana/helpers.py

@@ -1,6 +1,8 @@
 import os
 from string import Template
-from instana import internal_tracer, eum_api_key as global_eum_api_key
+
+from instana import eum_api_key as global_eum_api_key
+from instana.tracer import internal_tracer
 from instana.log import logger
 
 # Usage:

instana/http_propagator.py

@@ -1,8 +1,9 @@
 from __future__ import absolute_import
+
 import opentracing as ot
 from basictracer.context import SpanContext
-from instana import util, log
 
+from instana import log, util
 
 # The carrier can be a dict or a list.
 # Using the trace header as an example, it can be in the following forms

instana/instrumentation/django/middleware.py

@@ -1,12 +1,13 @@
 from __future__ import absolute_import
+
+import sys
+
 import opentracing as ot
 import opentracing.ext.tags as ext
 import wrapt
-import sys
-from ...log import logger
-from ... import internal_tracer
-
 
+from ...log import logger
+from ...tracer import internal_tracer
 
 DJ_INSTANA_MIDDLEWARE = 'instana.instrumentation.django.middleware.InstanaMiddleware'
 

instana/instrumentation/sudsjurko.py

@@ -1,11 +1,13 @@
 from __future__ import absolute_import
+
 from distutils.version import LooseVersion
+
 import opentracing
 import opentracing.ext.tags as ext
 import wrapt
-from ..log import logger
-from .. import internal_tracer
 
+from ..tracer import internal_tracer
+from ..log import logger
 
 try:
     import suds # noqa

instana/instrumentation/urllib3.py

@@ -1,10 +1,11 @@
 from __future__ import absolute_import
+
 import opentracing
 import opentracing.ext.tags as ext
 import wrapt
-from ..log import logger
-from .. import internal_tracer
 
+from ..tracer import internal_tracer
+from ..log import logger
 
 try:
     import urllib3 # noqa

instana/meter.py

@@ -4,12 +4,14 @@
 import platform
 import resource
 import sys
-import time
 import threading
+import time
 from types import ModuleType
+
 import instana
-from .log import logger as log
+
 from .agent_const import AGENT_DATA_URL
+from .log import logger as log
 
 
 class Snapshot(object):

instana/probe.py

@@ -1,5 +1,6 @@
 import opentracing as ot
-from instana import tracer, options
+
+from instana import options, tracer
 
 # This file is the hook for autoinstrumenation.
 # Here, we should:

instana/recorder.py

@@ -1,15 +1,17 @@
-import threading as t
+import os
 import socket
+import sys
+import threading as t
 import time
-import os
-import instana
 
 import opentracing.ext.tags as ext
 from basictracer import Sampler, SpanRecorder
-from .json_span import CustomData, Data, HttpData, SoapData, JsonSpan, SDKData
+
+import instana
+
 from .agent_const import AGENT_TRACES_URL
+from .json_span import CustomData, Data, HttpData, JsonSpan, SDKData, SoapData
 
-import sys
 if sys.version_info.major is 2:
     import Queue as queue
 else:
@@ -18,10 +20,10 @@
 
 class InstanaRecorder(SpanRecorder):
     sensor = None
-    registered_spans = ("django", "memcache", "rpc-client", "rpc-server",
-                        "soap", "urllib3", "wsgi")
+    registered_spans = ("django", "memcache", "rpc-client",
+                        "rpc-server", "soap", "urllib3", "wsgi")
     entry_kind = ["entry", "server", "consumer"]
-    exit_kind = ["exit", "client", "producer", "soap"]
+    exit_kind = ["exit", "client", "producer"]
     queue = queue.Queue()
 
     def __init__(self, sensor):

instana/sensor.py

@@ -1,8 +1,9 @@
 from __future__ import absolute_import
-from .options import Options
-from .meter import Meter
+
+from . import log
 from .agent import Agent
-import instana.log as log
+from .meter import Meter
+from .options import Options
 
 
 class Sensor(object):
@@ -26,3 +27,16 @@ def set_options(self, options):
     def handle_fork(self):
         self.agent = Agent(self)
         self.meter = Meter(self)
+
+def get_sensor():
+    return global_sensor
+
+# For any given Python process, we only want one sensor as multiple would
+# collect/report metrics in duplicate, triplicate etc..
+#
+# Usage example:
+#
+# import instana
+# instana.global_sensor
+#
+global_sensor = Sensor(Options())

instana/span.py

@@ -1,5 +1,5 @@
-from basictracer.span import BasicSpan
 from basictracer.context import SpanContext
+from basictracer.span import BasicSpan
 
 
 class InstanaSpan(BasicSpan):

instana/text_propagator.py

@@ -2,7 +2,8 @@
 
 import opentracing as ot
 from basictracer.context import SpanContext
-from instana import util, log
+
+from instana import log, util
 
 prefix_tracer_state = 'X-INSTANA-'
 prefix_baggage = 'X-INSTANA-BAGGAGE-'

instana/tracer.py

@@ -1,23 +1,26 @@
+from __future__ import absolute_import
+
 import time
-from basictracer import BasicTracer
-import instana.recorder as r
-import opentracing as ot
-import instana
-import instana.options as o
 
-from instana.util import generate_id
-from instana.span import InstanaSpan
+import opentracing as ot
+from basictracer import BasicTracer
 from basictracer.context import SpanContext
-from instana.http_propagator import HTTPPropagator
-from instana.text_propagator import TextPropagator
+
+from . import sensor
+from . import options as o
+from . import recorder as r
+from .http_propagator import HTTPPropagator
+from .span import InstanaSpan
+from .text_propagator import TextPropagator
+from .util import generate_id
 
 
 class InstanaTracer(BasicTracer):
     sensor = None
     cur_ctx = None
 
     def __init__(self, options=o.Options()):
-        self.sensor = instana.global_sensor
+        self.sensor = sensor.get_sensor()
         super(InstanaTracer, self).__init__(
             r.InstanaRecorder(self.sensor), r.InstanaSampler())
 
@@ -98,4 +101,21 @@ def init(options):
         No longer in use.
         To be removed in next major release.
     """
-    return instana.internal_tracer
+    return internal_tracer
+
+def get_tracer():
+    return internal_tracer
+
+
+# The global OpenTracing compatible tracer used internally by
+# this package.
+#
+# Usage example:
+#
+# import instana
+# instana.internal_tracer.start_span(...)
+#
+internal_tracer = InstanaTracer()
+
+# Set ourselves as the tracer.
+ot.tracer = internal_tracer

instana/util.py

@@ -1,12 +1,13 @@
-import random
-import os
+import binascii
 import json
-import time
+import os
+import random
 import struct
-import binascii
+import sys
+import time
+
 from instana import log
 
-import sys
 if sys.version_info.major is 2:
     string_types = basestring
 else: