[py3-compat] Added py3 compatibility 🎉

Hybrid py2/py3 on a single codebase is achieved by
using the `six` library here and there (mostly for
imports) and a few `if six.PY2` conditionals.

CI will test all currently supported versions of Python
(that means 3.8 -> 3.12), plus 2.7 and 3.7 (supported
in Ubuntu 20.04)

Author: bmispelon

.github/workflows/runtests.yml

@@ -14,14 +14,23 @@ jobs:
     - run: git config --global user.email runtest@localhost
     - run: nox --non-interactive --error-on-missing-interpreter --session runtests -- --git-default-branch=master
 
-#  runtests-py3:
-#    runs-on: ubuntu-latest
-#    steps:
-#    - uses: wntrblm/[email protected]
-#      with:
-#        python-versions: "3.7"
-#    - uses: actions/checkout@v4
-#    - run: git config --global user.name runtest
-#    - run: git config --global user.email runtest@localhost
-#    - run: git config --global init.defaultBranch main
-#    - run: nox --non-interactive --error-on-missing-interpreter --session runtests
+  runtests-py3:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+        - "3.7"
+        - "3.8"
+        - "3.9"
+        - "3.10"
+        - "3.11"
+        - "3.12"
+    steps:
+    - uses: wntrblm/[email protected]
+      with:
+        python-versions: ${{ matrix.python-version }}
+    - uses: actions/checkout@v4
+    - run: git config --global user.name runtest
+    - run: git config --global user.email runtest@localhost
+    - run: git config --global init.defaultBranch main
+    - run: nox --non-interactive --error-on-missing-interpreter --session runtests

runtests.py

@@ -10,9 +10,10 @@
 """
 from __future__ import print_function
 
+# Python3 imports are commented out, six is used to offer py2+py3 compatibility
 import argparse
-import BaseHTTPServer
-import ConfigParser
+# from configparser import ConfigParser
+# from http.server import BaseHTTPRequestHandler, HTTPServer
 import json
 import os
 import random
@@ -26,7 +27,12 @@
 import time
 import traceback
 import unittest
-import urlparse
+# from urllib.parse import parse_qs, urlparse
+
+
+from six.moves.BaseHTTPServer import BaseHTTPRequestHandler, HTTPServer
+from six.moves.configparser import ConfigParser
+from six.moves.urllib.parse import parse_qs, urlparse
 
 from lxml import html
 
@@ -35,6 +41,7 @@
 from trac.util.translation import _
 
 import requests
+import six
 
 
 GIT = 'test-git-foo'
@@ -83,6 +90,9 @@ def git_check_output(*args, **kwargs):
     as a string.
     """
     repo = kwargs.pop('repo', None)
+    kwargs.setdefault('text', True)
+    if six.PY2:
+        del kwargs['text']
 
     if repo is None:
         cmdargs = ["git"] + list(args)
@@ -136,9 +146,12 @@ def createTracEnvironment(cls, **kwargs):
         subprocess.check_output([TRAC_ADMIN_BIN, d(ENV), 'permission',
                 'add', 'anonymous', 'TRAC_ADMIN'])
 
-        conf = ConfigParser.ConfigParser()
-        with open(d(CONF), 'rb') as fp:
-            conf.readfp(fp)
+        conf = ConfigParser()
+        with open(d(CONF), 'r') as fp:
+            if six.PY2:
+                conf.readfp(fp)
+            else:
+                conf.read_file(fp)
 
         conf.add_section('components')
         conf.set('components', 'trac.versioncontrol.web_ui.browser.BrowserModule', 'disabled')
@@ -210,7 +223,7 @@ def createTracEnvironment(cls, **kwargs):
             conf.set('trac', 'permission_policies',
                      'GitHubPolicy, %s' % old_permission_policies)
 
-        with open(d(CONF), 'wb') as fp:
+        with open(d(CONF), 'w') as fp:
             conf.write(fp)
 
         with open(d(HTDIGEST), 'w') as fp:
@@ -269,7 +282,7 @@ def makeGitCommit(repo, path, content, message='edit', branch=None):
 
         if branch != GIT_DEFAULT_BRANCH:
             git_check_output('checkout', branch, repo=repo)
-        with open(d(repo, path), 'wb') as fp:
+        with open(d(repo, path), 'w') as fp:
             fp.write(content)
         git_check_output('add', path, repo=repo)
         git_check_output('commit', '-m', message, repo=repo)
@@ -406,11 +419,11 @@ def testLogin(self):
         response = requests.get(u('github/login'), allow_redirects=False)
         self.assertEqual(response.status_code, 302)
 
-        redirect_url = urlparse.urlparse(response.headers['Location'])
+        redirect_url = urlparse(response.headers['Location'])
         self.assertEqual(redirect_url.scheme, 'https')
         self.assertEqual(redirect_url.netloc, 'github.com')
         self.assertEqual(redirect_url.path, '/login/oauth/authorize')
-        params = urlparse.parse_qs(redirect_url.query, keep_blank_values=True)
+        params = parse_qs(redirect_url.query, keep_blank_values=True)
         state = params['state'][0]  # this is a random value
         self.assertEqual(params, {
             'client_id': ['01234567890123456789'],
@@ -490,7 +503,7 @@ def setUpClass(cls):
         cls.trac_env_broken = trac_env_broken
         cls.trac_env_broken_api = trac_env_broken_api
 
-        with open(d(SECRET), 'wb') as fp:
+        with open(d(SECRET), 'w') as fp:
             fp.write('98765432109876543210')
 
 
@@ -505,11 +518,11 @@ def testLoginWithReqEmail(self):
             response = requests.get(u('github/login'), allow_redirects=False)
             self.assertEqual(response.status_code, 302)
 
-            redirect_url = urlparse.urlparse(response.headers['Location'])
+            redirect_url = urlparse(response.headers['Location'])
             self.assertEqual(redirect_url.scheme, 'https')
             self.assertEqual(redirect_url.netloc, 'github.com')
             self.assertEqual(redirect_url.path, '/login/oauth/authorize')
-            params = urlparse.parse_qs(redirect_url.query, keep_blank_values=True)
+            params = parse_qs(redirect_url.query, keep_blank_values=True)
             state = params['state'][0]  # this is a random value
             self.assertEqual(params, {
                 'client_id': ['01234567890123456789'],
@@ -527,11 +540,11 @@ def loginAndVerifyClientId(self, expected_client_id):
         response = requests.get(u('github/login'), allow_redirects=False)
         self.assertEqual(response.status_code, 302)
 
-        redirect_url = urlparse.urlparse(response.headers['Location'])
+        redirect_url = urlparse(response.headers['Location'])
         self.assertEqual(redirect_url.scheme, 'https')
         self.assertEqual(redirect_url.netloc, 'github.com')
         self.assertEqual(redirect_url.path, '/login/oauth/authorize')
-        params = urlparse.parse_qs(redirect_url.query, keep_blank_values=True)
+        params = parse_qs(redirect_url.query, keep_blank_values=True)
         state = params['state'][0]  # this is a random value
         self.assertEqual(params, {
             'client_id': [expected_client_id],
@@ -636,8 +649,8 @@ def attemptValidOauth(self, testenv, callback, **kwargs):
                 self.assertEqual(response.status_code, 302)
 
                 # Extract the state from the redirect
-                redirect_url = urlparse.urlparse(response.headers['Location'])
-                params = urlparse.parse_qs(redirect_url.query, keep_blank_values=True)
+                redirect_url = urlparse(response.headers['Location'])
+                params = parse_qs(redirect_url.query, keep_blank_values=True)
                 state = params['state'][0]  # this is a random value
                 response = session.get(
                     u('github/oauth'),
@@ -1095,13 +1108,13 @@ class GitHubPostCommitHookWithUpdateHookTests(TracGitHubTests):
 
     @classmethod
     def createUpdateHook(cls):
-        with open(d(UPDATEHOOK), 'wb') as fp:
+        with open(d(UPDATEHOOK), 'w') as fp:
             # simple shell script to echo back all input
             fp.write("""#!/bin/sh\nexec cat""")
             os.fchmod(fp.fileno(), 0o755)
 
     def createFailingUpdateHook(cls):
-        with open(d(UPDATEHOOK), 'wb') as fp:
+        with open(d(UPDATEHOOK), 'w') as fp:
             fp.write("""#!/bin/sh\nexit 1""")
             os.fchmod(fp.fileno(), 0o755)
 
@@ -1160,7 +1173,7 @@ class GitHubPostCommitHookWithCacheTests(GitHubPostCommitHookTests):
     cached_git = True
 
 
-class GitHubAPIMock(BaseHTTPServer.BaseHTTPRequestHandler):
+class GitHubAPIMock(BaseHTTPRequestHandler):
     def log_message(self, format, *args):
         # Visibly differentiate GitHub API mock logging from tracd logs
         sys.stderr.write("%s [%s] %s\n" %
@@ -1221,7 +1234,7 @@ def do_GET(self):
         self.send_header("Content-Type", contenttype)
         self.end_headers()
 
-        self.wfile.write(json.dumps(answer))
+        self.wfile.write(json.dumps(answer, ensure_ascii=True).encode('ascii'))
 
     def do_POST(self):
         md = self.server.mockdata
@@ -1239,9 +1252,9 @@ def do_POST(self):
             chunk = self.rfile.read(chunk_size)
             if not chunk:
                 break
-            L.append(chunk)
+            L.append(chunk.decode('ascii'))
             size_remaining -= len(L[-1])
-        args = urlparse.parse_qs(''.join(L))
+        args = parse_qs(''.join(L))
 
         retcode = 404
         answer = {}
@@ -1255,7 +1268,7 @@ def do_POST(self):
         self.send_response(retcode)
         self.send_header("Content-Type", contenttype)
         self.end_headers()
-        self.wfile.write(json.dumps(answer))
+        self.wfile.write(json.dumps(answer, ensure_ascii=True).encode('ascii'))
 
 
 class TracContext(object):
@@ -1836,7 +1849,7 @@ def test_014_hook_membership_event_add_team(self):
             self.assertGreater(len(data), 0, "No groups returned after update")
             self.assertIn(users[0]["login"], data,
                           "User %s expected after update, but not present" % users[0]["login"])
-            self.assertItemsEqual(
+            six.assertCountEqual(self,
                 data[users[0]["login"]],
                 (u"github-%s-justice-league" % self.organization, u"github-%s" % self.organization),
                 "User %s does not have expected groups after update" % users[0]["login"])
@@ -1901,7 +1914,7 @@ def test_015_hook_membership_event_add_member(self):
             self.assertGreater(len(data), 0, "No groups returned after update")
             self.assertIn(users[1]["login"], data,
                           "User %s expected after update, but not present" % users[1]["login"])
-            self.assertItemsEqual(
+            six.assertCountEqual(self,
                 data[users[1]["login"]],
                 (u"github-%s-justice-league" % self.organization, u"github-%s" % self.organization),
                 "User %s does not have expected groups after update" % users[1]["login"])
@@ -2113,7 +2126,7 @@ def updateMockData(md, retcode=None, contenttype=None, answers=None,
                     JSON-encoded and returned for requests to the paths.
     :param postcallback: A callback function called for the next POST requests.
                          Arguments are the requested path and a dict of POST
-                         data as returned by `urlparse.parse_qs()`. The
+                         data as returned by `parse_qs()`. The
                          callback should return a tuple `(retcode, answer)`
                          where `retcode` is the HTTP return code and `answer`
                          will be JSON-encoded and sent to the client. Note that
@@ -2148,7 +2161,7 @@ def apiMockServer(port, mockdata):
                      be JSON-encoded and returned. Use `updateMockData()` to
                      update the contents of the mockdata dict.
     """
-    httpd = BaseHTTPServer.HTTPServer(('127.0.0.1', port), GitHubAPIMock)
+    httpd = HTTPServer(('127.0.0.1', port), GitHubAPIMock)
     # Make mockdata available to server
     httpd.mockdata = mockdata
     httpd.serve_forever()

setup.py

@@ -18,6 +18,9 @@
     namespace_packages=['tracext'],
     platforms='all',
     license='BSD',
+    install_requires=[
+        'six==1.16.0',
+    ],
     extras_require={'oauth': ['requests_oauthlib >= 0.5']},
     entry_points={'trac.plugins': [
         'github.browser = tracext.github:GitHubBrowser',

tracext/github/__init__.py

@@ -29,6 +29,8 @@
 from trac.web.auth import LoginModule
 from trac.web.chrome import add_warning
 
+import six
+
 def _config_secret(value):
     if re.match(r'[A-Z_]+', value):
         return os.environ.get(value, '')
@@ -330,9 +332,11 @@ def __init__(self, api, env, fullname):
         self.api = api
         self.env = env
         self.name = fullname
-        # _fullname needs to be a string, not a unicode string, otherwise the
-        # cache object won't convert it into a hash.
-        self._fullname = fullname.encode('utf-8')
+        self._fullname = fullname
+        if six.PY2:
+            # Trac's @cached for py2 does an isinstance(..., str) so we need a native
+            # string type
+            self._fullname = fullname.encode('utf-8')
         # next try: immediately
         self._next_update = datetime.now() - timedelta(seconds=10)
         self._cached_result = self._apiresult_error()
@@ -656,10 +660,10 @@ def github_api(self, url, *args):
                     additional positional arguments.
         """
         import requests
-        import urllib
+        from six.moves.urllib.parse import quote
 
         github_api_url = os.environ.get("TRAC_GITHUB_API_URL", "https://api.github.com/")
-        formatted_url = github_api_url + url.format(*(urllib.quote(str(x)) for x in args))
+        formatted_url = github_api_url + url.format(*(quote(str(x)) for x in args))
         access_token = _config_secret(self.access_token)
         self.log.debug("Hitting GitHub API endpoint %s with user %s", formatted_url, self.username) # pylint: disable=no-member
         results = []