U n5{i!@s8dZddlZddlZddlZddlZddlmZmZmZm Z ddl m Z m Z ddl mZddlmZddlmZddlmZGd d d e ZGd d d ZGd ddZddZz ejZWnek rdddZYnXddZejdddZe de dZd eeeejeedddZ e Z!ddZ"ddgZ#dS)!zL Plugin system for Twisted. @author: Jp Calderone @author: Glyph Lefkowitz N)IterableOptionalTypeTypeVar) Interface providedBy)log)getAdapterFactory) getModule)namedAnyc@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__rr2/tmp/pip-unpacked-wheel-mnhg7r0q/twisted/plugin.pyr sr c@s8eZdZddZedddZddZd d d ZeZdS) CachedPlugincCs*||_||_||_||_|jj|dSN)dropinname descriptionprovidedpluginsappend)selfrrrrrrr__init__'s zCachedPlugin.__init__returncCs&d|j|jjddd|jDS)Nz(z, cSsg|] }|jqSr)r ).0irrr 2sz)CachedPlugin.__repr__..)formatrr moduleNamejoinrrrrr__repr__.s zCachedPlugin.__repr__cCst|jjd|jS)N.)r rr#rr%rrrload5szCachedPlugin.loadNcCsH|jD]<}||r |St||ddk r|||Sq|Sr)rZ isOrExtendsr(r )r interfaceregistrydefaultZprovidedInterfacerrr __conform__8s    zCachedPlugin.__conform__)NN) r rrrstrr&r(r,Z getComponentrrrrr&s  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#rrrrrVszCachedDropin.__init__N)r rrrrrrrrr.Dsr.cCsPt|j|j}|jD]2\}}t|d}|dk rt|||jtt|q|Sr) r.r r__dict__itemsr rlistr)providerrkvpluginrrr_generateCacheEntry\s  r6cCsi}|D] }|||<q|Srr)keysvaluedr3rrrfromkeysjs r:c Csi}t|j}i}|D]0}|j}||kr8g||<||}||q|D]\}}|d}z,|} | d} t | } W5QRXWnt k ri} d} YnXd} i} |D]r}|j dd}d| |<|| ks|j| krd} z | }Wnt k rtYqXt|}|| |<qt| D]}|| kr>| |=d} q>| rz|t | WnXtk r}ztjd|j|jd W5d }~XYn"t k rtd 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)r"patherrnoNz)Unexpected error while writing cache file)r r Z iterModulesZfilePathparentrr0childZgetModificationTimeopenpickler( BaseExceptionrsplitrerrr6r1r7Z setContentdumpsOSErrormsgr=r>update)moduleZallCachesCombinedmodZbucketsZplugmodZfppZbucketZpseudoPackagePathZ dropinPathZ lastCachedfZdropinDotCacheZ needsWriteZ existingKeysZ pluginModuleZ pluginKeyr2entryerrrgetCacheqsd             rOrcCsddlm}|S)Nr)Ztwisted.pluginsrpackagerrr_pluginsPackages rR _TInterface)bound)r)rQrc csr|dkrt}t|}|D]N\}}|jD]>}z||d}Wntk rZtYq,X|dk r,|Vq,qdS)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. N)rRrOr0rrCrrE)r)rQZ allDropinskeyrr5Zadaptedrrr getPluginss rVcs|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)rxrPrrr!s z&pluginPackagePaths..)rDsysr=)rrrPrpluginPackagePathss r\)N)N)$rrWrBr[typestypingrrrrZzope.interfacerrZtwisted.pythonrZtwisted.python.componentsr Ztwisted.python.modulesr Ztwisted.python.reflectr r rr.r6dictr:AttributeErrorrO ModuleTyperRrSrVZ getPlugInsr\__all__rrrrs<       L