Changeset 13168

Timestamp:

03/13/2005 05:15:41 AM (4 years ago)

Author:

exarkun

Message:

Merge 13145:HEAD of /b/e/newplugins/ into trunk - resolves 906

Files:

• trunk/admin/release-twisted (modified) (7 diffs)
• trunk/setup.py (modified) (1 diff)
• trunk/twisted/lore/scripts/lore.py (modified) (4 diffs)
• trunk/twisted/plugin.py (copied) (copied from branches/exarkun/newplugins/twisted/plugin.py)
• trunk/twisted/plugins (copied) (copied from branches/exarkun/newplugins/twisted/plugins)
• trunk/twisted/plugins.tml (deleted)
• trunk/twisted/python/dist.py (modified) (1 diff)
• trunk/twisted/python/plugin.py (modified) (14 diffs)
• trunk/twisted/scripts/mktap.py (modified) (5 diffs)
• trunk/twisted/scripts/trial.py (modified) (2 diffs)
• trunk/twisted/test/test_plugin.py (copied) (copied from branches/exarkun/newplugins/twisted/test/test_plugin.py)
• trunk/twisted/topfiles/setup.py (modified) (1 diff)
• trunk/twisted/words/botbot.py (modified) (3 diffs)

trunk/admin/release-twisted

@@ -123 +123 @@
     sh('tar cjhf %(tdir)s.tar.bz2 %(tdir)s' % locals())
 
-        
 
 ##
@@ -138 +137 @@
     sh('svn export %s Twisted.exp' % (opts['temptagurl'],))
 
-    
+
 def makeDocCore(opts):
     ver = opts['core-version']
@@ -195 +194 @@
     os.makedirs(os.path.join(tdir, 'twisted'))
     os.makedirs(os.path.join(tdir, 'bin'))
-    
+
     twisted_subprojects = ','.join(dist.twisted_subprojects)
 
@@ -234 +233 @@
     zig = glob.glob('ZopeInterface-*.tgz')
     if not zig:
-        raise Exception("Please download ZopeInterface from "
-                        "http://www.zope.org/Products/ZopeInterface")
+        raise Exception(
+            "Creating sumo distribution rquires a ZopeInterface tarball - "
+            "Please download one from <http://www.zope.org/Products/ZopeInterface>.")
     zi = zig[0]
     os.makedirs(tdir)
@@ -258 +258 @@
                             % subproj)
         sumoReplace['%s-SVN-Trunk' % subproj.capitalize()] = subver
-                                   
+
     replaceInFile(os.path.join(tdir, 'README'), sumoReplace)
     # replace versions for core
@@ -276 +276 @@
     sdir = 'Twisted%s-%s' % (proj.capitalize(), version)
     os.makedirs(sdir+'/twisted/%s' % (proj,))
+    os.makedirs(sdir+'/twisted/plugins')
+
     sh('''
     ln -s `pwd`/Twisted.exp/twisted/%(proj)s/* %(sdir)s/twisted/%(proj)s
@@ -283 +285 @@
     ln -s `pwd`/Twisted.exp/LICENSE %(sdir)s
     ln -s `pwd`/Twisted.exp/twisted/%(proj)s/topfiles/* %(sdir)s
+
+    # We want this project's plugin module
+    ln -s `pwd`/Twisted.exp/twisted/plugins/twisted_%(proj)s.py %(sdir)s/twisted/plugins
 
     # we want copies so we can replace versions

trunk/setup.py

@@ -43 +43 @@
 
     result = os.spawnv(os.P_WAIT, sys.executable,
-                   [sys.executable, setupPy] + args)
+                       [sys.executable, setupPy] + args)
     if result != 0:
         sys.stderr.write("Error: Subprocess exited with result %d for project %s\n" %

trunk/twisted/lore/scripts/lore.py

@@ -3 +3 @@
 
 import sys
+
+from zope.interface import Interface, Attribute
+
 from twisted.lore import process, default, indexer, numberer, htmlbook
-from twisted.python import usage, plugin, reflect
+
+from twisted.python import usage, plugin as oldplugin, reflect
+from twisted import plugin as newplugin
+
+class IProcessor(Interface):
+    """
+    """
+
+    factory = Attribute(
+        "")
 
 class Options(usage.Options):
@@ -40 +52 @@
 
 def getProcessor(input, output, config):
-    plugins = plugin.getPlugIns("lore", None, None)
+    plugins = oldplugin._getPlugIns("lore")
     for plug in plugins:
         if plug.tapname == input:
@@ -46 +58 @@
             break
     else:
-        # try treating it as a module name
-        try:
-            module = reflect.namedModule(input)
-        except ImportError:
-            print '%s: no such input: %s' % (sys.argv[0], input)
-            return
+        plugins = newplugin.getPlugIns(IProcessor)
+        for plug in plugins:
+            if plug.name == input:
+                module = reflect.namedModule(plug.moduleName)
+                break
+        else:
+            # try treating it as a module name
+            try:
+                module = reflect.namedModule(input)
+            except ImportError:
+                print '%s: no such input: %s' % (sys.argv[0], input)
+                return
     try:
         return process.getProcessor(module, output, config)
@@ -60 +78 @@
 def getWalker(df, opt):
     klass = process.Walker
-    if opt['plain']: 
+    if opt['plain']:
         klass = process.PlainReportingWalker
-    if opt['null']: 
+    if opt['null']:
         klass = process.NullReportingWalker
     return klass(df, opt['inputext'], opt['linkrel'])

trunk/twisted/python/dist.py

@@ -35 +35 @@
 
         kw['packages'] = getPackages(projdir, parent='twisted')
+
+        plugin = "twisted/plugins/twisted_" + projname + ".py"
+        if os.path.exists(plugin):
+            kw.setdefault('py_modules', []).append(plugin.replace("/", ".")[:-3])
+
         kw['data_files'] = getDataFiles(projdir, parent='twisted')
+
         del kw['twisted_subproject']
+    else:
+        if 'plugins' in kw:
+            py_modules = []
+            for plg in kw['plugins']:
+                py_modules.append("twisted.plugins." + plg)
+            kw.setdefault('py_modules', []).extend(py_modules)
+            del kw['plugins']
+
     if 'cmdclass' not in kw:
         kw['cmdclass'] = {

trunk/twisted/python/plugin.py

@@ -34 +34 @@
     def isLoaded(self):
         """Check to see if the module for this plugin has been imported yet.
-        
+
         @rtype: C{int}
         @return: A true value if the module for this plugin has been loaded,
@@ -43 +43 @@
     def load(self):
         """Load the module for this plugin.
-        
+
         @rtype: C{ModuleType}
         @return: The module object that is loaded.
@@ -66 +66 @@
         """Register a new plug-in.
         """
+        warnings.warn("The twisted.python.plugin system is deprecated.  "
+                      "See twisted.plugin for the revised edition.",
+                      DeprecationWarning, 2)
         self.plugins.append(PlugIn(name, module, **kw))
 
@@ -99 +102 @@
     debug information about the loading process.  If it is any other true value,
     this debug information is written to stdout (This behavior is deprecated).
-    
+
     @type showProgress: C{None} or a callable taking one argument.
     @param showProgress: If not None, this is invoked with floating point
-    values between 0 and 1 describing the progress of the loading process. 
+    values between 0 and 1 describing the progress of the loading process.
     If it is any other true value, this progress information is written to
     stdout.  (This behavior is deprecated).
@@ -127 +130 @@
     loaded = {}
     seenNames = {}
-    
+
     # XXX Some people claim to have found non-strings in sys.path (an empty
     # list, in particular).  Instead of tracking down the cause for their
@@ -133 +136 @@
     # without further investigation.  At some point, someone should track
     # down where non-strings are coming from and do something about them.
-    paths = [cacheTransform(p) for p in sys.path 
+    paths = [cacheTransform(p) for p in sys.path
              if isinstance(p, str) and os.path.isdir(p)]
 
@@ -194 +197 @@
     against the C{type} argument to the C{register} function in the
     plugin.tml files.
-    
+
     @type fileList: C{list} of C{str}
     @param fileList: A list of the files to attempt to load plugin
     information from.  One name is put in their scope, the C{register}
     function.
-    
+
     @type debugInspection: C{None} or a callable taking one argument
     @param debugInspection: If not None, this is invoked with strings containing
     debug information about the loading process.  If it is any other true value,
     this debug information is written to stdout (This behavior is deprecated).
-    
+
     @type showProgress: C{None} or a callable taking one argument.
     @param showProgress: If not None, this is invoked with floating point
-    values between 0 and 1 describing the progress of the loading process. 
+    values between 0 and 1 describing the progress of the loading process.
     If it is any other true value, this progress information is written to
     stdout.  (This behavior is deprecated).
@@ -218 +221 @@
             "int parameter for debugInspection is deprecated, pass None or "
             "a function that takes a single argument instead.",
-            DeprecationWarning, 2
+            DeprecationWarning, 4
         )
     if isinstance(showProgress, types.IntType):
@@ -224 +227 @@
             "int parameter for showProgress is deprecated, pass None or "
             "a function that takes a single argument instead.",
-            DeprecationWarning, 2
+            DeprecationWarning, 4
         )
     result = []
     debugInspection, showProgress = _prepCallbacks(debugInspection, showProgress)
-    
+
     if not fileList:
         raise ValueError("No plugins passed to loadPlugins")
@@ -240 +243 @@
         pname = os.path.split(os.path.abspath(tmlFile))[-2]
         dropin = DropIn(pname)
-        ns = {'register': dropin.register}
+        ns = {'register': dropin.register, '__name__': tmlFile}
         try:
             execfile(tmlFile, ns)
@@ -247 +250 @@
             debugInspection("Error loading: %s" % e)
             continue
-        
+
         ldp = len(dropin.plugins) or 1.0
         incr = increments * (1.0 / ldp)
@@ -266 +269 @@
 def getPlugIns(plugInType, debugInspection=None, showProgress=None):
     """Helper function to get all the plugins of a particular type.
-    
+
     @type plugInType: C{str}
     @param plugInType: The type of plugin to search for.  This is tested
     against the C{type} argument to the C{register} function in the
     plugin.tml files.
-    
+
     @type debugInspection: C{None} or a callable taking one argument
     @param debugInspection: If not None, this is invoked with strings containing
     debug information about the loading process.  If it is any other true value,
     this debug information is written to stdout (This behavior is deprecated).
-    
+
     @type showProgress: C{None} or a callable taking one argument.
     @param showProgress: If not None, this is invoked with floating point
-    values between 0 and 1 describing the progress of the loading process. 
+    values between 0 and 1 describing the progress of the loading process.
     If it is any other true value, this progress information is written to
     stdout.  (This behavior is deprecated).
@@ -286 +289 @@
     @return: A list of C{PlugIn} objects that were found.
     """
+    warnings.warn("The twisted.python.plugin system is deprecated.  "
+                  "See twisted.plugin for the revised edition.",
+                  DeprecationWarning, 2)
+    return _getPlugIns(plugInType, debugInspection, showProgress)
+
+def _getPlugIns(plugInType, debugInspection=None, showProgress=None):
     if isinstance(debugInspection, types.IntType):
         warnings.warn(
             "int parameter for debugInspection is deprecated, pass None or "
             "a function that takes a single argument instead.",
-            DeprecationWarning, 2
+            DeprecationWarning, 3
         )
     if isinstance(showProgress, types.IntType):
@@ -296 +305 @@
             "int parameter for showProgress is deprecated, pass None or "
             "a function that takes a single argument instead.",
-            DeprecationWarning, 2
+            DeprecationWarning, 3
         )
     debugInspection, showProgress = _prepCallbacks(debugInspection, showProgress)

trunk/twisted/scripts/mktap.py

@@ -1 @@
-
 # Copyright (c) 2001-2004 Twisted Matrix Laboratories.
 # See LICENSE for details.
 
-#
+import sys, os
+
+from zope.interface import Interface, Attribute, implements
+from twisted.python.components import backwardsCompatImplements
+
 from twisted.application import service, compat, app
 from twisted.persisted import sob
-from twisted.python import usage, util, plugin
-import sys, os
+from twisted.python import log, usage, util, plugin as oldplugin
+from twisted import plugin as newplugin
+
+class IServiceMaker(Interface):
+    name = Attribute(
+        "A brief string naming this TAP plugin, for example \"Mega Crusher 2000\".")
+
+    tapname = Attribute(
+        "A short string naming this TAP plugin, for example \"web\" or "
+        "\"pencil\".")
+
+    description = Attribute(
+        "A brief summary of the features provided by this TAP plugin.")
+
+    options = Attribute(
+        "A C{twisted.python.usage.Options} subclass defining the"
+        "configuration options for this application.")
+
+    def makeService(options):
+        """Create an object implementing C{twisted.application.service.IService}
+
+        Configure the object according to the specified options.
+
+        @param options: A mapping (typically a C{dict} or
+        C{twisted.python.usage.Options} instance) of configuration
+        options to desired configuration values.
+        """
+
 try:
     import pwd, grp
@@ -33 +62 @@
 
 def loadPlugins(debug = None, progress = None):
-    plugins = plugin.getPlugIns("tap", debug, progress)
     tapLookup = {}
+
+    plugins = oldplugin._getPlugIns("tap", debug, progress)
     for plug in plugins:
         if hasattr(plug, 'tapname'):
@@ -41 +71 @@
             shortTapName = plug.module.split('.')[-1]
         tapLookup[shortTapName] = plug
+
+    plugins = newplugin.getPlugIns(IServiceMaker)
+    for plug in plugins:
+        tapLookup[plug.tapname] = plug
+
     return tapLookup
 
@@ -95 +130 @@
 
     def init(self, tapLookup):
-        sc = [ [name, None, (lambda obj=module:obj.load().Options()),
-                getattr(module, 'description', '')]
-                                     for name, module in tapLookup.items()]
+        sc = []
+        for (name, module) in tapLookup.iteritems():
+            if IServiceMaker.providedBy(module):
+                sc.append((
+                    name, None, lambda m=module: m.options, module.description))
+            else:
+                sc.append((
+                    name, None, lambda obj=module: obj.load().Options(),
+                    getattr(module, 'description', '')))
+
         sc.sort()
         self.subCommands = sc
@@ -148 +190 @@
     except KeyboardInterrupt:
         sys.exit(1)
-    ser = makeService(options.tapLookup[options.subCommand].load(),
-                      options.subCommand,
-                      options.subOptions)
+
+    plg = options.tapLookup[options.subCommand]
+    if not IServiceMaker.providedBy(plg):
+        plg = plg.load()
+    ser = makeService(plg, options.subCommand, options.subOptions)
     addToApplication(ser,
                      options.subCommand, options['append'], options['appname'],
                      options['type'], options['encrypted'],
                      *getid(options['uid'], options['gid']))
+
+from twisted.python.reflect import namedAny
+from twisted.plugin import IPlugin
+
+class _tapHelper(object):
+    """
+    Internal utility class to simplify the definition of \"new-style\"
+    mktap plugins based on existing, \"classic\" mktap plugins.
+    """
+
+    implements(IPlugin, IServiceMaker)
+
+    def __init__(self, name, module, description, tapname):
+        self.name = name
+        self.module = module
+        self.description = description
+        self.tapname = tapname
+
+    def options():
+        def get(self):
+            return namedAny(self.module).Options
+        return get,
+    options = property(*options())
+
+    def makeService():
+        def get(self):
+            return namedAny(self.module).makeService
+        return get,
+    makeService = property(*makeService())
+backwardsCompatImplements(_tapHelper)

trunk/twisted/scripts/trial.py

@@ -15 +15 @@
 
 from twisted.application import app
-from twisted.python import usage, reflect, failure, log, plugin
+from twisted.python import usage, reflect, failure, log
+from twisted import plugin
 from twisted.python.util import spewer
 from twisted.spread import jelly
@@ -124 +125 @@
     def _loadReporters(self):
         self.pluginFlags, self.optToQual = [], {}
-        self.plugins = plugin.getPlugIns("trial_reporter", None, None)
+        self.plugins = plugin.getPlugIns(itrial.IReporter)
         for p in self.plugins:
             self.pluginFlags.append([p.longOpt, p.shortOpt, p.description])

trunk/twisted/topfiles/setup.py

@@ -94 +94 @@
 
     # build stuff
-    packages=dist.getPackages('twisted', ignore=dist.twisted_subprojects),
+    packages=dist.getPackages('twisted', ignore=dist.twisted_subprojects + ['plugins']),
+    plugins=['__init__', 'notestplugin', 'testplugin', 'twisted_ftp', 'twisted_inet',
+             'twisted_manhole', 'twisted_portforward', 'twisted_socks', 'twisted_telnet',
+             'twisted_trial'],
     data_files=dist.getDataFiles('twisted', ignore=dist.twisted_subprojects),
     detectExtensions=detectExtensions,

trunk/twisted/words/botbot.py

@@ -5 +5 @@
 # Twisted Imports
 from twisted.words.service import WordsClient
-from twisted.python.plugin import getPlugIns
 from twisted.python.failure import Failure
-from twisted.python import log
+from twisted.python import log, plugin as oldplugin
+from twisted import plugin as newplugin
+
+from zope.interface import Interface
+
+class IBotBot(Interface):
+    def createBot():
+        """Create a bot... bot.
+
+        No one uses this code, who cares what this method does.
+        """
 
 class BotBot(WordsClient):
@@ -48 +57 @@
 
     def loadBotList(self):
-        botTypeList = getPlugIns("twisted.words.bot")
         botTypes = {}
+
+        botTypeList = newplugin.getPlugIns(IBotBot)
         for bott in botTypeList:
             botTypes[bott.botType] = bott
+
+        botTypeList = oldplugin.getPlugIns("twisted.words.bot")
+        for bott in botTypeList:
+            botTypes[bott.botType] = bott.load()
+
         self.botTypes = botTypes
 
@@ -75 +90 @@
     def bot_new(self, sender, message, metadata):
         bottype, botname = string.split(message, ' ', 1)
-        self.voice.service.addBot(botname, self.botTypes[bottype].load().createBot())
+        self.voice.service.addBot(botname, self.botTypes[bottype].createBot())
         self.voice.directMessage(sender, "Bot Created!")