[trafficserver] branch master updated: Docs: Better python 2/3 compatibility.

[am...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

amc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/master by this push:
     new bd255fa  Docs: Better python 2/3 compatibility.
bd255fa is described below

commit bd255fa7c704f7b5bcb08f9ff633b86791c8534d
Author: Alan M. Carroll <am...@apache.org>
AuthorDate: Mon Jul 17 17:12:40 2017 -0500

    Docs: Better python 2/3 compatibility.
---
 doc/ext/traffic-server.py | 32 +++++++++++++++++++++++++-------
 doc/manpages.py           |  2 +-
 2 files changed, 26 insertions(+), 8 deletions(-)

diff --git a/doc/ext/traffic-server.py b/doc/ext/traffic-server.py
index aebbc0b..b5ef358 100644
--- a/doc/ext/traffic-server.py
+++ b/doc/ext/traffic-server.py
@@ -37,6 +37,14 @@ import sphinx
 import subprocess
 import re
 
+# 2/3 compat logic
+try :
+    basestring
+    def is_string_type(s) :
+        return isinstance(s, basestring)
+except NameError :
+    def is_string_type(s) :
+        return isinstance(s, str)
 
 class TSConfVar(std.Target):
     """
@@ -66,7 +74,7 @@ class TSConfVar(std.Target):
         field = nodes.field()
         field.append(nodes.field_name(text=tag))
         body = nodes.field_body()
-        if (isinstance(value, basestring)):
+        if is_string_type(value):
             body.append(sphinx.addnodes.compact_paragraph(text=value))
         else:
             body.append(value)
@@ -193,7 +201,7 @@ class TSStat(std.Target):
         field = nodes.field()
         field.append(nodes.field_name(text=tag))
         body = nodes.field_body()
-        if (isinstance(value, basestring)):
+        if is_string_type(value) :
             body.append(sphinx.addnodes.compact_paragraph(text=value))
         else:
             body.append(value)
@@ -346,11 +354,21 @@ class TrafficServerDomain(Domain):
         if (dst_doc):
             return sphinx.util.nodes.make_refnode(builder, src_doc, dst_doc, nodes.make_id(target), cont_node, 'records.config')
 
-    def get_objects(self):
-        for var, doc in self.data['cv'].iteritems():
-            yield var, var, 'cv', doc, var, 1
-        for var, doc in self.data['stat'].iteritems():
-            yield var, var, 'stat', doc, var, 1
+    # Python 2/3 compat - iteritems is 2, items is 3
+    # Although perhaps the lists are small enough items could be used in Python 2.
+    try :
+        {}.iteritems()
+        def get_objects(self):
+            for var, doc in self.data['cv'].iteritems():
+                yield var, var, 'cv', doc, var, 1
+            for var, doc in self.data['stat'].iteritems():
+                yield var, var, 'stat', doc, var, 1
+    except AttributeError :
+        def get_objects(self):
+            for var, doc in self.data['cv'].items():
+                yield var, var, 'cv', doc, var, 1
+            for var, doc in self.data['stat'].items():
+                yield var, var, 'stat', doc, var, 1
 
 
 # These types are ignored as missing references for the C++ domain.
diff --git a/doc/manpages.py b/doc/manpages.py
index 761a74c..7ab42d8 100644
--- a/doc/manpages.py
+++ b/doc/manpages.py
@@ -66,4 +66,4 @@ if __name__ == '__main__':
     # Print the names of the man pages for the requested manual section.
     for page in man_pages:
         if options.section == 0 or options.section == int(page[4][0]):
-            print page[1] + '.' + page[4]
+            print(page[1] + '.' + page[4])

-- 
To stop receiving notification emails like this one, please contact
['"commits@trafficserver.apache.org" <co...@trafficserver.apache.org>'].