Futurize for Py3 (#57)

* [py3] futurize(stage1): modernized py2 code w/o dependencies

Tests are passing.

* [py3] futurize(stage2): builtins, and utilities from `future`

This is to introduce more safe changes to support Python 3.
It is likely to result in tests failures.

* [py3] futurize(stage2): fix broken tests

* [py3] fix `TypeError: a bytes-like object is required, not 'str'`

Use `six.PY3` to force non-unicode strings in Python 2.

* [py3] Add `future` as a dependency

* [py3] Replace unnecessary `old_div` usage with `/`

* [py3] Replace `iteritems()` / `iterkeys()` -> `six.iteritems()` / `six.iterkeys()`

This is in response to CR feedback as using `items()`, and `keys()`
in Py2 will result in the creation of new arrays. Thus, this commit
will use proxy methods from `six` instead.

* [py3] fix linting errors due to import order

* [py3] remove unused `urllib` dependencies from `codecs.py`, and fix tests

* [py3] revert uses of `old_div` in favour of standard `/` divisor

* [py3] Revert change from `long` -> `int`

Use `long` for py2, and `int` for py3. Otherwise we will get an
integer overflow for py2 32bit.

Author: MrSaints

jaeger_client/codecs.py

@@ -20,19 +20,26 @@
 
 from __future__ import absolute_import
 
-import urllib
+from future import standard_library
+standard_library.install_aliases()  # noqa
+
+from builtins import object
+from past.builtins import basestring
 
 from opentracing import (
     InvalidCarrierException,
     SpanContextCorruptedException,
 )
 from .constants import (
-    TRACE_ID_HEADER,
     BAGGAGE_HEADER_PREFIX,
     DEBUG_ID_HEADER_KEY,
+    TRACE_ID_HEADER,
 )
 from .span_context import SpanContext
 
+import six
+import urllib.parse
+
 
 class Codec(object):
     def inject(self, span_context, carrier):
@@ -64,9 +71,9 @@ def inject(self, span_context, carrier):
             parent_id=span_context.parent_id, flags=span_context.flags)
         baggage = span_context.baggage
         if baggage:
-            for key, value in baggage.iteritems():
+            for key, value in six.iteritems(baggage):
                 if self.url_encoding:
-                    encoded_value = urllib.quote(value)
+                    encoded_value = urllib.parse.quote(value)
                 else:
                     encoded_value = value
                 carrier['%s%s' % (self.baggage_prefix, key)] = encoded_value
@@ -77,24 +84,24 @@ def extract(self, carrier):
         trace_id, span_id, parent_id, flags = None, None, None, None
         baggage = None
         debug_id = None
-        for key, value in carrier.iteritems():
+        for key, value in six.iteritems(carrier):
             uc_key = key.lower()
             if uc_key == self.trace_id_header:
                 if self.url_encoding:
-                    value = urllib.unquote(value)
+                    value = urllib.parse.unquote(value)
                 trace_id, span_id, parent_id, flags = \
                     span_context_from_string(value)
             elif uc_key.startswith(self.baggage_prefix):
                 if self.url_encoding:
-                    value = urllib.unquote(value)
+                    value = urllib.parse.unquote(value)
                 attr_key = key[self.prefix_length:]
                 if baggage is None:
                     baggage = {attr_key.lower(): value}
                 else:
                     baggage[attr_key.lower()] = value
             elif uc_key == self.debug_id_header:
                 if self.url_encoding:
-                    value = urllib.unquote(value)
+                    value = urllib.parse.unquote(value)
                 debug_id = value
         if not trace_id and baggage:
             raise SpanContextCorruptedException('baggage without trace ctx')
@@ -137,7 +144,7 @@ def span_context_to_string(trace_id, span_id, parent_id, flags):
     :param parent_id:
     :param flags:
     """
-    parent_id = parent_id or 0L
+    parent_id = parent_id or 0
     return '{:x}:{:x}:{:x}:{:x}'.format(trace_id, span_id, parent_id, flags)
 
 
@@ -162,9 +169,9 @@ def span_context_from_string(value):
         raise SpanContextCorruptedException(
             'malformed trace context "%s"' % value)
     try:
-        trace_id = long(parts[0], 16)
-        span_id = long(parts[1], 16)
-        parent_id = long(parts[2], 16)
+        trace_id = int(parts[0], 16)
+        span_id = int(parts[1], 16)
+        parent_id = int(parts[2], 16)
         flags = int(parts[3], 16)
         if trace_id < 1 or span_id < 1 or parent_id < 0 or flags < 0:
             raise SpanContextCorruptedException(

jaeger_client/config.py

@@ -20,6 +20,7 @@
 
 from __future__ import absolute_import
 
+from builtins import object
 import logging
 import threading
 

jaeger_client/constants.py

@@ -22,6 +22,7 @@
 
 from . import __version__
 
+import six
 
 # Max number of bits to use when generating random ID
 MAX_ID_BITS = 64
@@ -33,10 +34,10 @@
 DEFAULT_FLUSH_INTERVAL = 1
 
 # Name of the HTTP header used to encode trace ID
-TRACE_ID_HEADER = b'uber-trace-id'
+TRACE_ID_HEADER = 'uber-trace-id' if six.PY3 else b'uber-trace-id'
 
 # Prefix for HTTP headers used to record baggage items
-BAGGAGE_HEADER_PREFIX = b'uberctx-'
+BAGGAGE_HEADER_PREFIX = 'uberctx-' if six.PY3 else b'uberctx-'
 
 # The name of HTTP header or a TextMap carrier key which, if found in the
 # carrier, forces the trace to be sampled as "debug" trace. The value of the

jaeger_client/local_agent_net.py

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 from __future__ import absolute_import
+from builtins import object
 from threadloop import ThreadLoop
 import tornado
 import tornado.httpclient

jaeger_client/metrics.py

@@ -19,6 +19,12 @@
 # THE SOFTWARE.
 
 from __future__ import absolute_import
+from __future__ import division
+
+from builtins import str
+from builtins import object
+
+import six
 
 
 class MetricsFactory(object):
@@ -93,7 +99,7 @@ def _get_key(self, name, tags=None):
         if not tags:
             return name
         key = name
-        for k in sorted(tags.iterkeys()):
+        for k in sorted(six.iterkeys(tags)):
             key = key + '.' + str(k) + '_' + str(tags[k])
         return key
 

jaeger_client/rate_limiter.py

@@ -18,6 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+from builtins import object
 import time
 
 

jaeger_client/reporter.py

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 from __future__ import absolute_import
+from builtins import object
 import logging
 import threading
 
@@ -225,7 +226,7 @@ def _flush(self):
         yield self.queue.join()
 
 
-class ReporterMetrics:
+class ReporterMetrics(object):
     def __init__(self, metrics_factory):
         self.reporter_success = \
             metrics_factory.create_counter(name='jaeger.spans', tags={'reported': 'true'})

jaeger_client/sampler.py

@@ -19,9 +19,12 @@
 # THE SOFTWARE.
 
 from __future__ import absolute_import
+from __future__ import division
+from builtins import object
+import json
 import logging
 import random
-import json
+import six
 
 from threading import Lock
 from tornado.ioloop import PeriodicCallback
@@ -306,7 +309,7 @@ def update(self, strategies):
                 ProbabilisticSampler(self.default_sampling_probability)
 
     def close(self):
-        for _, sampler in self.samplers.iteritems():
+        for _, sampler in six.iteritems(self.samplers):
             sampler.close()
 
     def __str__(self):

jaeger_client/span.py

@@ -20,7 +20,9 @@
 
 from __future__ import absolute_import
 
+from builtins import str
 import json
+import six
 import threading
 import time
 
@@ -54,7 +56,7 @@ def __init__(self, context, tracer, operation_name,
         self.tags = []
         self.logs = []
         if tags:
-            for k, v in tags.iteritems():
+            for k, v in six.iteritems(tags):
                 self.set_tag(k, v)
 
     def set_operation_name(self, operation_name):

jaeger_client/thrift.py

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+from past.builtins import basestring
+import six
 import socket
 import struct
 
@@ -30,8 +32,11 @@
 
 _max_signed_port = (1 << 15) - 1
 _max_unsigned_port = (1 << 16)
-_max_signed_id = (1L << 63) - 1
-_max_unsigned_id = (1L << 64)
+_max_signed_id = (1 << 63) - 1
+_max_unsigned_id = (1 << 64)
+
+if six.PY3:
+    long = int
 
 
 def ipv4_to_int(ipv4):

jaeger_client/tracer.py

@@ -20,12 +20,14 @@
 
 from __future__ import absolute_import
 
+from builtins import object
 import socket
 
-import os
-import time
 import logging
+import os
 import random
+import time
+import six
 import opentracing
 from opentracing import Format, UnsupportedFormatException
 from opentracing.ext import tags as ext_tags
@@ -137,7 +139,7 @@ def start_span(self,
                 if sampled:
                     flags = SAMPLED_FLAG
                     tags = tags or {}
-                    for k, v in sampler_tags.iteritems():
+                    for k, v in six.iteritems(sampler_tags):
                         tags[k] = v
             else:  # have debug id
                 flags = SAMPLED_FLAG | DEBUG_FLAG
@@ -164,7 +166,7 @@ def start_span(self,
 
         if (rpc_server or not parent_id) and (flags & SAMPLED_FLAG):
             # this is a first-in-process span, and is sampled
-            for k, v in self.tags.iteritems():
+            for k, v in six.iteritems(self.tags):
                 span.set_tag(k, v)
 
         self._emit_span_metrics(span=span, join=rpc_server)
@@ -225,7 +227,7 @@ def random_id(self):
         return self.random.getrandbits(constants.MAX_ID_BITS)
 
 
-class TracerMetrics:
+class TracerMetrics(object):
     """Tracer specific metrics."""
 
     def __init__(self, metrics_factory):

jaeger_client/utils.py

@@ -17,6 +17,9 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
+from builtins import bytes
+from builtins import range
+from builtins import object
 import fcntl
 import socket
 import struct
@@ -70,7 +73,7 @@ def local_ip():
     if ip.startswith('127.'):
         # Check eth0, eth1, eth2, en0, ...
         interfaces = [
-            i + str(n) for i in ('eth', 'en', 'wlan') for n in xrange(3)
+            i + bytes(n) for i in (b'eth', b'en', b'wlan') for n in range(3)
         ]  # :(
         for interface in interfaces:
             try:

setup.py

@@ -41,6 +41,7 @@
         'thrift',
         'tornado>=4.3,<5',
         'opentracing>=1.2.2,<1.3',
+        "future",
     ],
     # Uncomment below if need to test with unreleased version of opentracing
     # dependency_links=[

tests/test_TUDPTransport.py

@@ -39,7 +39,7 @@ def test_constructor_nonblocking(self):
         assert t.transport_sock.gettimeout() == 0
 
     def test_write(self):
-        self.t.write('hello')
+        self.t.write(b'hello')
 
     def test_isopen_when_open(self):
         assert self.t.isOpen() == True
@@ -52,4 +52,4 @@ def test_close(self):
         self.t.close()
         with self.assertRaises(Exception):
             # Something bad should happen if we send on a closed socket..
-            self.t.write('hello')
+            self.t.write(b'hello')

tests/test_codecs.py

@@ -84,8 +84,8 @@ def test_trace_context_from_to_string(self):
         from_string = span_context_from_string
 
         tests = [
-            [(256L, 127L, None, 1), '100:7f:0:1'],
-            [(256L, 127L, 256L, 0), '100:7f:100:0'],
+            [(256, 127, None, 1), '100:7f:0:1'],
+            [(256, 127, 256, 0), '100:7f:100:0'],
         ]
         for test in tests:
             ctx = test[0]
@@ -95,13 +95,13 @@ def test_trace_context_from_to_string(self):
             self.assertEqual(ctx_rev, ctx)
 
         ctx_rev = from_string(['100:7f:100:0'])
-        assert ctx_rev == (256L, 127L, 256L, 0), 'Array is acceptable'
+        assert ctx_rev == (256, 127, 256, 0), 'Array is acceptable'
 
         with self.assertRaises(SpanContextCorruptedException):
             from_string(['100:7f:100:0', 'garbage'])
 
         ctx_rev = from_string(u'100:7f:100:0')
-        assert ctx_rev == (256L, 127L, 256L, 0), 'Unicode is acceptable'
+        assert ctx_rev == (256, 127, 256, 0), 'Unicode is acceptable'
 
     def test_context_to_readable_headers(self):
         for url_encoding in [False, True]:
@@ -215,14 +215,14 @@ def test_context_from_large_ids(self):
             'Trace-ID': 'FFFFFFFFFFFFFFFF:FFFFFFFFFFFFFFFF:FFFFFFFFFFFFFFFF:1',
         }
         context = codec.extract(headers)
-        assert context.trace_id == 0xFFFFFFFFFFFFFFFFL
-        assert context.trace_id == (1L << 64) - 1
+        assert context.trace_id == 0xFFFFFFFFFFFFFFFF
+        assert context.trace_id == (1 << 64) - 1
         assert context.trace_id > 0
-        assert context.span_id == 0xFFFFFFFFFFFFFFFFL
-        assert context.span_id == (1L << 64) - 1
+        assert context.span_id == 0xFFFFFFFFFFFFFFFF
+        assert context.span_id == (1 << 64) - 1
         assert context.span_id > 0
-        assert context.parent_id == 0xFFFFFFFFFFFFFFFFL
-        assert context.parent_id == (1L << 64) - 1
+        assert context.parent_id == 0xFFFFFFFFFFFFFFFF
+        assert context.parent_id == (1 << 64) - 1
         assert context.parent_id > 0
 
     def test_zipkin_codec_extract(self):
@@ -322,6 +322,6 @@ def test_debug_id():
     span = tracer.start_span('test', child_of=context)
     assert span.is_debug()
     assert span.is_sampled()
-    tags = filter(lambda t: t.key == debug_header, span.tags)
+    tags = [t for t in span.tags if t.key == debug_header]
     assert len(tags) == 1
     assert tags[0].value == 'Coraline'

tests/test_crossdock.py

@@ -20,6 +20,7 @@
 
 from __future__ import absolute_import
 
+from builtins import str
 import mock
 import json
 import pytest