Ticket #5129: compat3k.execfile.4.diff

setup.py

@@ -16 +16 @@
 import sys, os
 
 
-def getExtensions():
-    """
-    Get all extensions from core and all subprojects.
-    """
-    extensions = []
-
-    if not sys.platform.startswith('java'):
-        for dir in os.listdir("twisted") + [""]:
-            topfiles = os.path.join("twisted", dir, "topfiles")
-            if os.path.isdir(topfiles):
-                ns = {}
-                setup_py = os.path.join(topfiles, "setup.py")
-                execfile(setup_py, ns, ns)
-                if "extensions" in ns:
-                    extensions.extend(ns["extensions"])
-
-    return extensions
-
-
 def main(args):
     """
     Invoke twisted.python.dist with the appropriate metadata about the
@@ -43 +24 @@
     if os.path.exists('twisted'):
         sys.path.insert(0, '.')
     from twisted import copyright
-    from twisted.python.dist import getDataFiles, getScripts, getPackages, \
-                                    setup, twisted_subprojects
+    from twisted.python.dist import getDataFiles, getExtensions, getScripts, \
+        getPackages, setup, twisted_subprojects
 
     # "" is included because core scripts are directly in bin/
     projects = [''] + [x for x in os.listdir('bin')

twisted/lore/htmlbook.py

@@ -1 +1 @@
 # Copyright (c) Twisted Matrix Laboratories.
 # See LICENSE for details.
 
+from twisted.python.compat import execfile
+
 
 def getNumber(filename):
     return None
@@ -24 +26 @@
         Index = self.Index
 
         if filename:
-            execfile(filename)
+            execfile(filename, globals())
 
     def getFiles(self):
         return [c[0] for c in self.chapters]

twisted/names/authority.py

@@ -12 +12 @@
 from twisted.names import dns
 from twisted.internet import defer
 from twisted.python import failure
+from twisted.python.compat import execfile
 
 import common
 

twisted/python/_release.py

@@ -25 +25 @@
 from twisted.python.versions import Version
 from twisted.python.filepath import FilePath
 from twisted.python.dist import twisted_subprojects
+from twisted.python.compat import execfile
 
 # This import is an example of why you shouldn't use this module unless you're
 # radix

twisted/python/compat.py

@@ -139 +139 @@
                   'set_connect_state', 'set_accept_state',
                   'connect_ex', 'sendall'):
 
-            exec """def %s(self, *args):
+            exec("""def %s(self, *args):
                 self._lock.acquire()
                 try:
                     return apply(self._ssl_conn.%s, args)
                 finally:
-                    self._lock.release()\n""" % (f, f)
+                    self._lock.release()\n""" % (f, f))
 sys.modules['OpenSSL.tsafe'] = tsafe
 
 import operator
@@ -175 +175 @@
     from functools import reduce
 except ImportError:
     reduce = reduce
+
+
+try:
+    _execfile = execfile
+except NameError:
+    _execfile = None
+
+
+def execfile(filename, globals, locals=None):
+    """Execute a Python script in the given namespaces.
+
+    Similar to the execfile builtin, but a namespace is mandatory, partly
+    because that's a sensible thing to require, and because otherwise we'd
+    have to do some frame hacking.
+
+    This is a compatibility wrapper for Python 3 porting.
+    """
+    if locals is None:
+        locals = globals
+    if _execfile is None:
+        fin = open(filename, "rb")
+        try:
+            source = fin.read()
+        finally:
+            fin.close()
+        code = compile(source, filename, "exec")
+        exec(code, globals, locals)
+    else:
+        _execfile(filename, globals, locals)
+
+
+__all__ = [
+    "execfile",
+    "frozenset",
+    "reduce",
+    "set",
+    ]

twisted/python/dist.py

@@ -15 +15 @@
 import platform
 import sys
 
+from twisted.python.compat import execfile
+
 
 twisted_subprojects = ["conch", "lore", "mail", "names",
                        "news", "pair", "runner", "web",
@@ -208 +210 @@
     return result
 
 
+def getExtensions():
+    """
+    Get all extensions from core and all subprojects.
+    """
+    extensions = []
+
+    if not sys.platform.startswith('java'):
+        for dir in os.listdir("twisted") + [""]:
+            topfiles = os.path.join("twisted", dir, "topfiles")
+            if os.path.isdir(topfiles):
+                ns = {}
+                setup_py = os.path.join(topfiles, "setup.py")
+                execfile(setup_py, ns, ns)
+                if "extensions" in ns:
+                    extensions.extend(ns["extensions"])
+
+    return extensions
+
+
 def getPackages(dname, pkgname=None, results=None, ignore=None, parent=None):
     """
     Get all packages which are under dname. This is necessary for

twisted/python/test/test_dist.py

@@ -7 +7 @@
 
 
 import os
+import shutil
 
 from distutils.core import Distribution
 
@@ -55 +56 @@
         self.assertEqual(ext.define_macros, [("whatever", 2), ("WIN32", 1)])
 
 
+class GetExtensionsTest(TestCase):
+    """
+    Tests for L{dist.getExtensions}.
+    """
+
+    setup_template = (
+        "from twisted.python.dist import ConditionalExtension\n"
+        "extensions = [\n"
+        "    ConditionalExtension(\n"
+        "        '%s', ['twisted/some/thing.c'],\n"
+        "        condition=lambda builder: True)\n"
+        "    ]\n")
+
+    def setUp(self):
+        super(GetExtensionsTest, self).setUp()
+        self.basedir = os.path.abspath("twisted")
+        # The following will fail if this is is executed with a test runner
+        # that does not chdir to a test-specific temporary working directory.
+        os.mkdir(self.basedir)
+        self.addCleanup(shutil.rmtree, self.basedir)
+
+    def writeSetup(self, name, *path):
+        """
+        Write out a C{setup.py} file to a location determined by
+        L{self.basedir} and L{path}. L{self.setup_template} is used to
+        generate its contents.
+        """
+        outdir = os.path.join(self.basedir, *path)
+        os.makedirs(outdir)
+        open(os.path.join(outdir, "setup.py"), "wb").write(
+            self.setup_template % name)
+
+    def assertExtensions(self, expected):
+        """
+        Assert that the given names match the (sorted) names of discovered
+        extensions.
+        """
+        extensions = dist.getExtensions()
+        extension_names = [extension.name for extension in extensions]
+        self.assertEqual(sorted(extension_names), expected)
+
+    def test_getExtensions(self):
+        """
+        Files named C{setup.py} in C{twisted/topfiles} and
+        C{twisted/*/topfiles} are L{execfile}ed in order to discover the
+        extensions they declare.
+        """
+        self.writeSetup("twisted.transmutate", "topfiles")
+        self.writeSetup("twisted.tele.port", "tele", "topfiles")
+        self.assertExtensions(["twisted.tele.port", "twisted.transmutate"])
+
+    def test_getExtensions_too_deep(self):
+        """
+        Files named C{setup.py} in C{topfiles} directories are not considered
+        if they are too deep in the directory hierarchy.
+        """
+        self.writeSetup("twisted.trans.mog.rify", "trans", "mog", "topfiles")
+        self.assertExtensions([])
+
+    def test_getExtensions_not_topfiles(self):
+        """
+        The folder in which C{setup.py} is discovered must be called
+        C{topfiles} otherwise it is ignored.
+        """
+        self.writeSetup("twisted.metamorphosis", "notfiles")
+        self.assertExtensions([])
+
 
 class GetVersionTest(TestCase):
     """

twisted/python/test/test_release.py

@@ -20 +20 @@
 
 from twisted.trial.unittest import TestCase
 
-from twisted.python.compat import set
+from twisted.python.compat import execfile, set
 from twisted.python.procutils import which
 from twisted.python import release
 from twisted.python.filepath import FilePath

twisted/test/test_compat.py

@@ -6 +6 @@
 Tests for L{twisted.python.compat}.
 """
 
-import types, socket
+import os, tempfile, types, socket
 
 from twisted.trial import unittest
 
-from twisted.python.compat import set, frozenset, reduce
+from twisted.python.compat import set, frozenset, reduce, execfile
 
 
 
@@ -197 +197 @@
         """
         self.assertEqual(15, reduce(lambda x, y: x + y, [1, 2, 3, 4, 5]))
         self.assertEqual(16, reduce(lambda x, y: x + y, [1, 2, 3, 4, 5], 1))
+
+
+class ExecfileCompatTestCase(unittest.TestCase):
+    """Tests for the L{execfile} compatibility wrapper."""
+
+    def setUp(self):
+        super(ExecfileCompatTestCase, self).setUp()
+        fd, self.script = tempfile.mkstemp(".py")
+        fout = os.fdopen(fd, "wb")
+        try:
+            fout.write("foo += 1\n".encode("ascii"))
+        finally:
+            fout.close()
+
+    def tearDown(self):
+        super(ExecfileCompatTestCase, self).tearDown()
+        os.unlink(self.script)
+
+    def test_execfileGlobals(self):
+        """
+        L{execfile} executes the specified file in the given global namespace.
+        """
+        ns_global = {"foo": 1}
+        execfile(self.script, ns_global)
+        self.assertEqual(2, ns_global["foo"])
+
+    def test_execfileGlobalsAndLocals(self):
+        """
+        L{execfile} executes the specified file in the given global and local
+        namespaces.
+        """
+        ns_global, ns_local = {"foo": 10}, {"foo": 20}
+        execfile(self.script, ns_global, ns_local)
+        self.assertEqual(10, ns_global["foo"])
+        self.assertEqual(21, ns_local["foo"])

twisted/topfiles/5129.misc

@@ +1 @@
+Replace usage of execfile() with t.p.compat.execfile(), a new function
+that wraps execfile() on Python 2.x and provides equivalent
+functionality on Python 3.x.

twisted/web/script.py

@@ -14 +14 @@
     import StringIO
 
 from twisted import copyright
+from twisted.python.compat import execfile
 from twisted.web import http, server, static, resource, html