U W[ @s dZddlmZmZddlZddlZddlmZmZddZ e Z ddl m Z ddl mZdd lmZdd lmZdd lmZGd d d eZGdddeZGdddeZddZz ejZWnek rdddZYnXddZdddZeZddZ ddgZ!dS)zL Plugin system for Twisted. @author: Jp Calderone @author: Glyph Lefkowitz )absolute_importdivisionN) Interface providedBycCs4zddl}|WStk r.ddl}|YSXdS)z5 Determine which 'pickle' API module to use. rN)cPickle ImportErrorpickle)rrr 0/usr/lib/python3/dist-packages/twisted/plugin.py_determinePickleModules r )getAdapterFactory)namedAny)log) getModule) iteritemsc@seZdZdZdS)IPluginz Interface that must be implemented by all plugins. Only objects which implement this interface will be considered for return by C{getPlugins}. To be useful, plugins should also implement some other application-specific interface. N)__name__ __module__ __qualname____doc__r r r r r)src@s2eZdZddZddZddZd dd ZeZdS) CachedPlugincCs*||_||_||_||_|jj|dSN)dropinname descriptionprovidedpluginsappend)selfrrrrr r r __init__5s zCachedPlugin.__init__cCs&d|j|jjddd|jDfS)Nz"z, cSsg|] }|jqSr )r).0ir r r ?sz)CachedPlugin.__repr__..)rr moduleNamejoinrrr r r __repr__<s zCachedPlugin.__repr__cCst|jjd|jS)N.)r rr#rr%r r r loadAszCachedPlugin.loadNcCsH|jD]<}||r |St||ddk r|||Sq|Sr)rZ isOrExtendsr(r )r interfaceregistrydefaultZprovidedInterfacer r r __conform__Ds    zCachedPlugin.__conform__)NN)rrrrr&r(r,Z getComponentr r r r r4s  rc@seZdZdZddZdS) CachedDropina A collection of L{CachedPlugin} instances from a particular module in a plugin package. @type moduleName: C{str} @ivar moduleName: The fully qualified name of the plugin module this represents. @type description: C{str} or L{None} @ivar description: A brief explanation of this collection of plugins (probably the plugin module's docstring). @type plugins: C{list} @ivar plugins: The L{CachedPlugin} instances which were loaded from this dropin. cCs||_||_g|_dSr)r#rr)rr#rr r r rbszCachedDropin.__init__N)rrrrrr r r r r-Qsr-cCsPt|j|j}t|jD]2\}}t|d}|dk rt|||jtt|q|Sr) r-rrr__dict__rrlistr)providerrkvpluginr r r _generateCacheEntryis r4cCsi}|D] }|||<q|Srr )keysvaluedr1r r r fromkeysvs r8c Csi}t|j}i}|D]0}|j}||kr8g||<||}||qt|D]f\}}|d}z,|} | d} t | } W5QRXWni} d} YnXd} i} |D]h}|j dd}d| |<|| ks|j| krd} z | }WntYqXt|}|| |<qt| D]}|| kr,| |=d} q,| rz|t | WnNtk r}ztjd|j|jd W5d }~XYntd d YnX|| qT|S) a; Compute all the possible loadable plugins, while loading as few as possible and hitting the filesystem as little as possible. @param module: a Python module object. This represents a package to search for plugins. @return: a dictionary mapping module names to L{CachedDropin} instances. z dropin.cacherrFr'Tz@Unable to write to plugin cache %(path)s: error number %(errno)d)formatpatherrnoNz)Unexpected error while writing cache file)rrZ iterModulesZfilePathparentrrZchildZgetModificationTimeopenrr(rsplitrerrr4r/r5Z setContentdumpsOSErrormsgr<r=update)moduleZallCachesCombinedmodZbucketsZplugmodZfppZbucketZpseudoPackagePathZ dropinPathZ lastCachedfZdropinDotCacheZ needsWriteZ existingKeysZ pluginModuleZ pluginKeyr0entryer r r getCache~sd             rKccsp|dkrddlm}t|}t|D]F\}}|jD]6}z||d}WntYq2X|dk r2|Vq2q$dS)ac Retrieve all plugins implementing the given interface beneath the given module. @param interface: An interface class. Only plugins which implement this interface will be returned. @param package: A package beneath which plugins are installed. For most uses, the default value is correct. @return: An iterator of plugins. Nr)Ztwisted.pluginsrrKrrrA)r)packageZ allDropinskeyrr3Zadaptedr r r getPluginss   rNcs|dfddtjDS)a Return a list of additional directories which should be searched for modules to be included as part of the named plugin package. @type name: C{str} @param name: The fully-qualified Python name of a plugin package, eg C{'twisted.plugins'}. @rtype: C{list} of C{str} @return: The absolute paths to other directories which may contain plugin modules for the named plugin package. r'csFg|]>}tjtjj|fdgstjtjj|fqS)z __init__.py)osr<existsr$abspath)r xrLr r r"s z&pluginPackagePaths..)r@sysr<)rr rSr pluginPackagePathss rU)N)N)"rZ __future__rrrOrTZzope.interfacerrr rZtwisted.python.componentsr Ztwisted.python.reflectr Ztwisted.pythonrZtwisted.python.modulesrZtwisted.python.compatrrobjectrr-r4dictr8AttributeErrorrKrNZ getPlugInsrU__all__r r r r s0         I