כhhSrSSKJr SSKrSSKrSSKrSSKrSSKrSSKrSSK J r SSK J r SSKJrJrJr SSKJr SSKJr SS KJr SS KJrJrJrJr SS KJr \"S 5r"S S\5r "SS\5r!"SS\RD5r#Sr$SSjr%SSjr&"SS\5r'"SS\RD5r("SS\RD5r)"SS\RD5r*g) z" Tests for Twisted plugin system. ) annotationsN)invalidate_caches) ModuleType)Callable TypedDictTypeVar) Interface)plugin)FilePath) EventDict addObserverremoveObservertextFromEventDict)unittest_Tc\rSrSrSrSrg) ITestPluginzG A plugin for use by the plugin system's unit tests. Do not use this. N__name__ __module__ __qualname____firstlineno____doc____static_attributes__r\C:\Users\psant\Downloads\Noiseback\school\venv\Lib\site-packages\twisted/test/test_plugin.pyrrsrrc\rSrSrSrSrg) ITestPlugin2&z See L{ITestPlugin}. rNrrrrr r &srr c\rSrSrSrSSjrSSjrSSSjjrSSjrSSjr \ SSj5r SS jr \ SS j5r \ SS j5r \ SS j5r\ SS j5r\ SSj5r\ SSj5rSSjrSrg) PluginTests,zS Tests which verify the behavior of the current, active Twisted plugins directory. c[RSSUl[RR 5Ul[ UR55UlURR5 URRS5Ul URR5 URRS5RS5 [ [5RS5RURRS55 SUl[RR#SURR5 SSKnXlg) zF Save C{sys.path} and C{sys.modules}, and create a package for tests. N mypackage __init__.pyrzplugin_basic.pyz testplugin.py testpluginr)syspath originalPathmodulescopy savedModulesr mktemprootcreateDirectorychildpackage setContent__file__siblingcopyTooriginalPlugininsertr&module)selfr&s rsetUpPluginTests.setUp2s HHQKKK,,.T[[]+  !!#yy{3  $$& =)44S9""#45<< LL   / + 499>>* rcUR[RSS&[RR 5 [RR UR 5 gzB Restore C{sys.path} and C{sys.modules} to their original values. Nr+r)r*r,clearupdater.r;s rtearDownPluginTests.tearDownJ?''   4,,-rcURceURRS5nSRUSS5nUSn[ [ R UU5 [ R UR SS/U=(a S/=(d /-H'n[R"URU-5 M) g![a M9f=f)N.co) r5rsplitjoindelattrr)r,osremoveFileNotFoundError)r;r: deleteSource modulePath packageName moduleNameexts r_unimportPythonModule!PluginTests._unimportPythonModuleRs***__**3/ hhz#2/ ^  K(*5 KK (:!62$!<"=C  &//C/0>%  s#C CCcVURRS5R5 g)z+ Remove the plugins B{droping.cache} file. dropin.cacheN)r3r2rQrCs r _clearCachePluginTests._clearCachebs >*113rcJ^[R"T5SU4Sjj5nU$)z This is a paranoid test wrapper, that calls C{meth} 2 times, clear the cache, and calls it 2 other times. It's supposed to ensure that the plugin system behaves correctly no matter what the state of the cache is. cf>T"U5 T"U5 UR5 T"U5 T"U5 g)N)r\)r;meths rwrapped+PluginTests._withCacheness..wrappedrs+ J J     J Jr)r;r#returnNone) functoolswraps)r`ras` r_withCachenessPluginTests._withCachenesshs'     rcZ[R"UR5nXRnUR UR SUR35 UR SUR5 URVs/sHn[UR;dMUPM snSnURURU5 UR URS5 UR URR5S5 UR UR[[R/5 UR!5nURU["R$SUR3R&5 SSKJn URXVR&5 gs snf)z Check that the cache returned by L{plugin.getCache} hold the plugin B{testplugin}, and that this plugin has the properties we expect: provide L{TestPlugin}, has the good name and description, and can be loaded successfully. z mypackage.zI'm a test drop-in.r TestPluginz*A plugin used solely for testing purposes.N)r getCacher:r8 assertEqualrVassertIn descriptionpluginsrprovidedassertIsdropinnamestripIPluginloadr)r,rjmypackage.testpluginr()r;cacherrpp1 realPlugintps r test_cachePluginTests.test_cache|sD ,**+ **j9L9L8M,NO +V-?-?@  EA;!**+Da Ea H bii( ,/  NN "$P  {FNN&CDWWY   KK*T%8%8$9: ; F F * j--0)Fs F(F(c[R"UR5URn[ SUR 55SnUR [U5S5 g)zU L{CachedPlugin} has a helpful C{repr} which contains relevant information about it. c3H# UHoRS:XdMUv M g7f)rjNrs).0rys r -PluginTests.test_cacheRepr..sV';!vv?UAA';s" "rzTN)r rkr:r8listrorlrepr)r; cachedDropin cachedPlugins rtest_cacheReprPluginTests.test_cacheReprs\ t{{3D4G4GH V|';';VV      1 rc[[R"[UR55nUR [ U5S5 SS/nUH.nURUR5 UR5 M0 g)z L{plugin.getPlugins} should return the list of plugins matching the specified interface (here, L{ITestPlugin2}), and these plugins should be instances of classes with a C{test} method, to be sure L{plugin.getPlugins} load classes correctly. AnotherTestPluginThirdTestPluginN) rr getPluginsr r:rllenrQrtest)r;ronamesrys r test_pluginsPluginTests.test_pluginssav((t{{CD Wq)$&78A LL $ FFHrc[[5RS5RURR S55 UR S[R5 UR[[RSS5S5 [[R"[UR55nUR![#U5S5 SS /nUH.nUR%UR&5 UR)5 M0 UR+[RSS 5 g !UR+[RSS 5 f=f) zM Check that L{plugin.getPlugins} is able to detect plugins added at runtime. plugin_extra1.pypluginextra.pymypackage.pluginextrar& pluginextraz&mypackage still has pluginextra modulerrjFourthTestPluginTN)r r5r6r7r3r2failIfInr)r, assertFalsehasattrrr rrr:rlrrQrtest1rXr;plgsrrys rtest_detectNewFilesPluginTests.test_detectNewFiless  ""#56== LL  / 0  S MM13;; ?    K0-@8  ))+t{{CDD   SY *!#56E QZZ(   & &s{{3J'KT RD & &s{{3J'KT Rs CD::%Ec[[5RS5RURR S55 [ [R"[UR55nUR[U5S5 [[5RS5RURR S55 UR[RS5 [ [R"[UR55nUR[U5S5 /SQnUH.nUR!UR"5 UR%5 M0 UR[RSS5 g !UR[RSS5 f=f) zm Check that if the content of a plugin change, L{plugin.getPlugins} is able to detect the new plugins added. rrrzplugin_extra2.pyr)rjrFifthTestPluginTN)r r5r6r7r3r2rr rrr:rlrrXr)r,rQrrrs rtest_detectFilesChanged#PluginTests.test_detectFilesChangedsG ""#56== LL  / 0  S))+t{{CDD   SY * X  & &'9 : A A ""#34   & &s{{3J'K L))+t{{CDD   SY *IE QZZ(   & &s{{3J'KT RD & &s{{3J'KT Rs D2F%Gc[[5RS5RURR S55 [ [R"[UR55 UR[RSS5 [ [R"[UR55nURS[U55 g!UR[RSS5 f=f)z[ Check that when a dropin file is removed, L{plugin.getPlugins} doesn't return it anymore. rrrTN)r r5r6r7r3r2rr rrr:rXr)r,rlr)r;rs rtest_detectFilesRemoved#PluginTests.test_detectFilesRemoveds ""#56== LL  / 0  S ""; < =  & &s{{3J'KT RF%%k4;;?@ CI&  & &s{{3J'KT Rs .C##%DcUR5nUR[RR U55 UR R RU5 [[R"[UR 55nUR[U5S5 UR R RU5 g!UR R RU5 f=f)za Test that getCache skips over any entries in a plugin package's C{__path__} which do not exist. rN)r/rrPr*existsr:__path__appendrr rrrlrrQ)r;r*rs rtest_nonexistentPathEntry%PluginTests.test_nonexistentPathEntrys {{} -. ##D) .))+t{{CDD   SY * KK ' ' -DKK ' ' -s %A C'C;cF[UR55nURUR55 UR 5 UR S5R nURRRU5 [[R"[UR55nUR[U5S5 URRR!U5 g!URRR!U5 f=f)z Test that getCache skips over any entries in a plugin package's C{__path__} which refer to children of paths which are not directories. test_packagerN)r r/rrtouchr2r*r:rrrr rrrlrrQ)r;r*r2rs rtest_nonDirectoryChildEntry'PluginTests.test_nonDirectoryChildEntry"s  & '  >*// ##E* /))+t{{CDD   SY * KK ' ' .DKK ' ' .s A C99'D c$[R"UR5 URR S5n[ [ 5RS5RURR S55 [5 [R"URRS5 [R"URS5 UR[RURRS5 UR[RURS5 /n[UR5 UR[ UR5 [R"UR5nUR#SU5 UR#UR$U5 SUR[&R(4-nUHn[+U5nUceXF;dM g UR-S U<35 g ) z The C{dropin.cache} file may not be writable: the cache should still be attainable, but an error should be logged to show that the cache couldn't be updated. r[rri@ir3Unable to write to plugin cache %s: error number %dN9Did not observe unwriteable cache warning in log events: )r rkr:r3r2r r5r6r7invalidateImportCachesrPchmodr* addCleanupr rrrmr8errnoEPERMrfail)r; cachepatheventsrxexpectedevent maybeTexts rtest_deployedModePluginTests.test_deployedMode3s  $LL&&~6  ""#56== LL  / 0    ""E* ' $,,"3"3U; )..%8#%FMM"  6 , mU+ d))51I NN KKL  E)%0I( (($  II &) r)r:r+r8r3r0r.Nrcrd)F)r:rrSboolrcrd)r`zCallable[[PluginTests], object]rczCallable[[PluginTests], None])rrrrrr<rDrXr\rgr}rrrrrrrrrrrrr#r#,s  0.8= 04  4 - &("1"1H   SS:SS@''" . .// /rr#sj from twisted.plugin import pluginPackagePaths __path__.extend(pluginPackagePaths(__name__)) __all__ = [] cBSRU5RS5$)Nzfrom zope.interface import provider from twisted.plugin import IPlugin from twisted.test.test_plugin import ITestPlugin @provider(IPlugin, ITestPlugin) class {}: pass ascii)formatencoders rpluginFileContentsrms     rcUR5 URS5nUR5 U(a URS5RS5 URS5nUR5 U(a$URS5R[5 URUS-5RU5 U$)z Create a plugindummy package. plugindummyr'rro.py)r1r2r4pluginInitFile) entrypath pluginContentreal pluginModulepkgplugss r_createPluginDummyr}s  //- (C  - ++C0 IIi E   M"--n= KK u$%00? Lrc \rSrSr%S\S'Srg)_HasBoolLegacyKeyirlegacyrN)rrrr__annotations__rrrrrrs Lrrc|\rSrSrSrSSjrSSjrSSjrSSjrSSjr SSjr SS jr SS jr SS jr SS jrS rg)DeveloperSetupTestsiz These tests verify things about the plugin system without actually interacting with the deployed 'twisted.plugins' package, instead creating a temporary package. cD[RSSUl[RR 5Ul[ UR55UlURR5 URRS5Ul URRS5Ul URRS5Ul [UR[S5SS5Ul[UR[S5SS5Ul[UR[S 5S S 5Ul[RR'URUR4Vs/sHoRPM sn5 UR)5 URRS 5RS 5UlUR*RS5Ul[.R."5n[0R2"UR*RS5RUS- 4S-5 [0R2"UR,RUS- 4S-5 UR55 UR75 gs snf)a Create a complex environment with multiple entries on sys.path, akin to a developer's environment who has a development (trunk) checkout of Twisted, a system installed version of Twisted (for their operating system's tools) and a project which provides Twisted plugins. N system_pathdevelopment_pathapplication_pathsystemTplugindummy_builtindevappFplugindummy_apprror[zplugindummy_builtin.pyiri)r)r* savedPathr,r-r.r r/fakeRootr1r2 systemPathdevPathappPathrr systemPackage devPackage appPackageextend getAllPluginssysplugsyscachetimerPutime lockSystemresetEnvironment)r;xnows rr<DeveloperSetupTests.setUps!KK,,. /  %%'----m<}}**+=> }}**+=> / OO/94AV - LL,U3T;P - LL,U3U: iik ##$<=BBS4ZMTUDUV ##cDj]Q%67  Js9Jc[R"URRS5 [R"URRS5 g)zG Lock the system directories, as if they were unwritable by this user. imNrPrrr*rrCs rrDeveloperSetupTests.lockSystem4 ""E* ##U+rc[R"URRS5 [R"URRS5 g)zG Unlock the system directories, as if they were writable by this user. iNrrCs r unlockSystem DeveloperSetupTests.unlockSystemrrcSSKn[[R"[UR 55nUVs/sHo3R PM sn$s snf)zT Get all the plugins loadable from our dummy package, and return their short names. rN)plugindummy.pluginsrr rrror)r;rrplugs rr!DeveloperSetupTests.getAllPluginss> # ""; 0C0CD E*+,!$ !,,,sAcUR5 [RRURUR UR 4Vs/sHoRPM sn5 gs snf)zK Change the environment to what it should be just as the test is starting. N)unsetEnvironmentr)r*rrrr)r;rs rr$DeveloperSetupTests.resetEnvironmentsI  $,,)VW)VA)VWXWsA,c[5 [RR5 [RR UR 5 UR [RSS&g)zP Change the Python environment back to what it was before the test was started. N)rr)r,rArBr.rr*rCs rr$DeveloperSetupTests.unsetEnvironmentsC    4,,-nn rcDUR5 UR5 g)z Reset the Python environment to what it was before this test ran, and restore permissions on files which were marked read-only so that the directory may be cleanly cleaned up. N)rrrCs rrDDeveloperSetupTests.tearDowns  rc[S5H7nUR5nUR5 URUSS/5 M9 g)z Plugins added in the development path should be loadable, even when the (now non-importable) system path contains its own idea of the list of plugins for a package. Inversely, plugins added in the system path should not be available. rrrN)rangersortrl)r;rrs r"test_developmentPluginAvailability6DeveloperSetupTests.test_developmentPluginAvailabilitys=qA&&(E JJL   UUEN 3rcHURRS5nUR[S55 [R"5S- n[ R "URX"45 URS5n[SS9n[R"URR4SS0UD6 [ R "URX"45 UR5 UR5 URSUR55 UR!S UR55 UR5 UR[S 55 UR!SUR55 URS UR55 g ) z Verify that if a stale .pyc file on the PYTHONPATH is replaced by a fresh .py file, the plugins in the new .py are picked up rather than the stale .pyc, even if the .pyc is still around. zstale.pyoneiz stale.pycT)rquietrtwoN)rr2r4rrrPrr*r6r compileall compile_dirrQrrmrr)r;mypathrpycextras rtest_freshPyReplacesStalePyc0DeveloperSetupTests.test_freshPyReplacesStalePyc s1 &&z2,U34 IIK$  qf%nn[) ".t33F1FF A6"   eT//12 eT//12 ,U34 eT//12 eT//12rczUR5 URRS5R[ S55 UR 5 [ RRURR5 /n[UR5 UR[UR5 URSUR55 SUR R["R$4-nUHn['U5nUceX$;dM g UR)SU<35 g)a Verify that a failure to write the dropin.cache file on a read-only path will not affect the list of plugins returned. Note: this test should pass on both Linux and Windows, but may not provide useful coverage on Windows due to the different meaning of "read-only directory". z newstuff.pyrrNr)rrr2r4rrr)r*rQrr rrrrmrrrrrr)r;rrrrs rtest_newPluginsOnReadOnlyPath1DeveloperSetupTests.test_newPluginsOnReadOnlyPath,s  =)445G5NO   ))*#%FMM"  6 eT//12I MM   KKL  E)%0I( (($  II &) r) rrrrrr.rrrrrNr)rcz list[str])rrrrrr<rrrrrrDrrrrrrrrrs< ( T,, -Y%  43@&rrcZ\rSrSrSrS SjrS SjrS SjrS SjrS Sjr Sr g ) AdjacentPackageTestsiUz Tests for the behavior of the plugin system when there are multiple installed copies of the package containing the plugins being loaded. cz[RSSUl[RR 5Ulg)zC Save the elements of C{sys.path} and the items of C{sys.modules}. N)r)r*r+r,r-r.rCs rr<AdjacentPackageTests.setUp[s) HHQKKK,,.rcUR[RSS&[RR 5 [RR UR 5 gr?r@rCs rrDAdjacentPackageTests.tearDownbrFrcURU5nURS5nUR5 URS5RS5 URS5nUR5 URS5R[5 URUS-5nUR[ U55 U$)a Create a directory containing a Python package named I{dummy} with a I{plugins} subpackage. @type root: L{FilePath} @param root: The directory in which to create the hierarchy. @type name: C{str} @param name: The name of the directory to create which will contain the package. @type pluginName: C{str} @param pluginName: The name of a module to create in the I{dummy.plugins} package. @rtype: L{FilePath} @return: The directory which was created to contain the I{dummy} package. dummyr'rror)r2makedirsr4rr)r;r0rs pluginName directoryr3rors rcreateDummyPackage'AdjacentPackageTests.createDummyPackagejs,JJt$ //'* m$//4-- * m$//?}}Z%%78  24 89rc[UR55nUR5 URUSS5nURUSS5n[R R UR 5 [R R UR 5 SSKn[[R"[UR55nURS/UVs/sHofRPM sn5 gs snf)z Only plugins from the first package in sys.path should be returned by getPlugins in the case where there are two Python packages by the same name installed, each with a plugin module by a single name. first somepluginsecondrNr r/r)r,r)r*r dummy.pluginsrr rrrorlrr;r0firstDirectorysecondDirectoryr(rorys r.test_hiddenPackageSamePluginModuleNameObscuredCAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscured  & 00w M11$,O ++, ,,-v((emmDE '$AAZZ$AB$A%D c[UR55nUR5 URUSS5nURUSS5n[R R UR 5 [R R UR 5 SSKn[[R"[UR55nURS/UVs/sHofRPM sn5 gs snf)z Plugins from the first package in sys.path should be returned by getPlugins in the case where there are two Python packages by the same name installed, each with a plugin module by a different name. r/ thispluginr1 thatpluginrNr2r4s r3test_hiddenPackageDifferentPluginModuleNameObscuredHAdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscuredr9r:)r+r.Nr)r0 FilePath[str]rsstrr*rArcr@) rrrrrr<rDr,r7r>rrrrr"r"UsC /.!),:= BC(Crr"c@\rSrSrSrS SjrS SjrS SjrS SjrSr g) PackagePathTestsiz[ Tests for L{plugin.pluginPackagePaths} which constructs search paths for plugin packages. c4[RSSUlg)z# Save the elements of C{sys.path}. N)r)r*r+rCs rr<PackagePathTests.setUps HHQKrc>UR[RSS&g)z, Restore C{sys.path} to its original value. N)r+r)r*rCs rrDPackagePathTests.tearDowns'' rcb[S5n[S5nURUR/[lUR[R "S5UR S5R S5RUR S5R S5R/5 g)z L{plugin.pluginPackagePaths} should return a list containing each directory in C{sys.path} with a suffix based on the supplied package name. foobar dummy.pluginsr(roN)r r*r)rlr pluginPackagePathsr2)r;rIrJs rtest_pluginDirectories'PackagePathTests.test_pluginDirectoriess uouoHHchh'   % %o 6 '"((388 '"((388  rc.[UR55nURS5RS5RS5nUR5 URS5R S5 URS5R URS5R /[ lUR[R"S5URS5RS5RS5R /5 g) aa L{plugin.pluginPackagePaths} should exclude directories which are Python packages. The only allowed plugin package (the only one associated with a I{dummy} package which Python will allow to be imported) will already be known to the caller of L{plugin.pluginPackagePaths} and will most commonly already be in the C{__path__} they are about to mutate. rIr(ror'rrJrKN) r r/r2r)r4r*r)rlr rL)r;r0rIs rtest_pluginPackagesExcluded,PackagePathTests.test_pluginPackagesExcludeds &jj%%g.44Y?  - ++C0JJu%**DJJu,=,B,BC   % %o 6 ZZ  $ $W - 3 3I > C C D r)r+Nr) rrrrrr<rDrMrPrrrrrCrCs ( (  " rrC)rsrArcbytes) rr@rrRrrrrArcr@)+r __future__rrrrerPr)r importlibrrtypesrtypingrrrzope.interfacer twistedr twisted.python.filepathr twisted.python.logr r rr twisted.trialrrrr TestCaser#rrrrrr"rCrrrr]s #  A//$,XX" T])9 v(##vt   -2:>NQ& ~(++~B\C8,,\C~4 x((4 r