hGP dZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddlZ e jj j#dggggdZiZiZe jj*j-dddZej0dd Ze j4j7r Gd d eZne j<j:Zdd Zdd Z dZ!dZ"Gdde#Z$Gddej0dgdZ%Gdde jLZ'dZ(dZ)dZ*dZ+d dZ,dZ-dZ.dZ/e,Z0e-Z1e+Z2y)!aD Helper functions for testing. Our **stylistic_issues**, **pyflakes_issues**, and **type_check_issues** respect a 'exclude_paths' in our test config, excluding any absolute paths matching those regexes. Issue strings can start or end with an asterisk to match just against the prefix or suffix. For instance... :: exclude_paths .*/stem/test/data/.* .. versionadded:: 1.2.0 :: TimedTestRunner - test runner that tracks test runtimes test_runtimes - provides runtime of tests excuted through TimedTestRunners clean_orphaned_pyc - delete *.pyc files without corresponding *.py is_pyflakes_available - checks if pyflakes is available is_pycodestyle_available - checks if pycodestyle is available pyflakes_issues - static checks for problems via pyflakes stylistic_issues - checks for PEP8 and other stylistic issues Ntest) pep8.ignorepycodestyle.ignorepyflakes.ignore exclude_pathsPENDINGRUNNINGFINISHED AsyncResultztype msgceZdZdZy)SkipTestz Notes that the test was skipped.N__name__ __module__ __qualname____doc__^/var/www/betterdocs.net/sherlock_api/venv/lib/python3.12/site-packages/stem/util/test_tools.pyr r ?s&rr cB||k7rt| d|d|d|y)z Function form of a TestCase's assertEqual. .. versionadded:: 1.6.0 :param object expected: expected value :param object actual: actual value :param str msg: message if assertion fails :raises: **AssertionError** if values aren't equal N Expected 'z ' but was ''AssertionErrorexpectedactualmsgs r assert_equalrEs. ck6J cc_b ccrc@||vrt| d|d|d|y)a Asserts that a given value is within this content. .. versionadded:: 1.6.0 :param object expected: expected value :param object actual: actual value :param str msg: message if assertion fails :raises: **AssertionError** if the expected value isn't in the actual Nrz' to be within 'rrrs r assert_inr!Vs0V SVS^hO hhdg hhrct|)z Function form of a TestCase's skipTest. .. versionadded:: 1.6.0 :param str msg: reason test is being skipped :raises: **unittest.case.SkipTest** for this reason )r )rs rskipr#gs  rctjjj|}|t|j <|j SN)stemutil test_tools AsyncTest ASYNC_TESTSnamemethod)funcrs r asynchronousr.us4    ' ' -$+dii rc0eZdZdZddZdZdZdZdZy) r)a Test that's run asychronously. These are functions (no self reference) performed like the following... :: class MyTest(unittest.TestCase): @staticmethod def run_tests(): MyTest.test_addition = stem.util.test_tools.AsyncTest(MyTest.test_addition).method @staticmethod def test_addition(): if 1 + 1 != 2: raise AssertionError('tisk, tisk') MyTest.run() .. versionadded:: 1.6.0 Nc |jd|j_|_|_|_fd_d_d_tj_ d_ tj_y)N.c&j|Sr%result)rselfs rz$AsyncTest.__init__..st{{40r)rrr+_runner _runner_args _threadedr,_process _process_pipe threadingRLock _process_lock_result AsyncStatusr_status)r5runnerargsthreadeds` r__init__zAsyncTest.__init__sh!,,foo>DIDLDDN0DKDMD"*DDL&&DLrctjjryd}|j5|jt j k(r|r||_d|vr |d|_tj\|_ }|jr]tj|||j|jfd|jz|_|j j#dn3tj$|||j|jf|_|j j't j(|_dddy#1swYyxYw)Nc tjd |r||n||jtdd|jy#t$r.}|jtdt |Yd}~Cd}~wt $r.}|jtdt |Yd}~xd}~w|jtdtjYxYw#|jwxYw)N successfailureskippederror) osnicesendr rstrr traceback format_excclose)connrBrCexcs r_wrapperzAsyncTest.run.._wrappersggbk  68 +i./ 4 +iS233 4 +iS233@ +gy';';'=>? s;)A C,$B>C/ C,$B83C/82C,*C//DrDzBackground test of %s)targetrCr+T)rWrC)r&prereq _is_python_26r>rAr@rr8r9multiprocessingPiper;r<Threadr7r+r: setDaemonProcessstartr )r5 runner_argskwargsrV child_pipes rrunz AsyncTest.runs {{  "     + ,, , )$   !*-$.)8)=)=)?&J >>#** d.?.?@*TYY6 $- -- ! !$ ')118ZY]YeYegkgxgxLyz$- "** -+++s DEEc|j5|jr"|js|jjndcdddS#1swYyxYwr%)r>r:r9pidr5s rrez AsyncTest.pids?  S#'==T]]  dSSSs 0AAc&|jdyr%r3rfs rjoinzAsyncTest.joinsKKrc8tjjry|j5|jt j k(r|j|jt jk(rN|jj|_ |jjt j|_|r?|jjdk(r&|j!|jj"n|r?|jjdk(r&|j!|jj"n@|r>|jjdk(r%|j%|jj"dddy#1swYyxYw)NrJrLrK)r&rXrYr>rAr@rrcr r;recvr?r:rhr typefailrskipTest)r5rs rr4zAsyncTest.results {{  "  ( ,, ,  ,, ,))..0  "++ $,,##y0 $,,""# DLL%%0 $,,""# DLL%%2 dll&&'(((s EFF)NF) rrrrrErcrerhr4rrrr)r){s"*' )+VS(rr)ceZdZdZy)Issuez Issue encountered by pyflakes or pycodestyle. :var int line_number: line number the issue occured on :var str message: description of the issue :var str line: content of the line the issue is about Nrrrrrorosrro) line_numbermessagelinec"eZdZdZfdZxZS)TimedTestRunnerz Test runner that tracks the runtime of individual tests. When tests are run with this their runtimes are made available through :func:`stem.util.test_tools.test_runtimes`. .. versionadded:: 1.6.0 c|jD]!}t|Gfdd}||_#tt||S)Nc`eZdZdfd ZfdZfdZdZfdZfdZfdZ xZ S) )TimedTestRunner.run.._TestWrapperctj}tt|||}tj|z t|j <|Sr%)timesuperrkrc TEST_RUNTIMESid)r5r4 start_time __class__s rrcz-TimedTestRunner.run.._TestWrapper.runsCyy{*dT.v6&%)YY[:%=- "-rc`tjjst||Syr%)r&rXrYrzrm)r5rqr~ original_types rrmz2TimedTestRunner.run.._TestWrapper.skipTest s***,6w? ?-rctjjr%|jt |t |yt |||Sr%)r&rXrY assertEqualsetrzassertItemsEqual)r5rrr~rs rrz:TimedTestRunner.run.._TestWrapper.assertItemsEquals? [[ & & (   S]CK 8>xP Prc^|j|dtj|z|g|i|S)a Asserts the given invokation raises the expected excepiton. This is similar to unittest's assertRaises and assertRaisesRegexp, but checks for an exact match. This method is **not** being vended to external users and may be changed without notice. If you want this method to be part of our vended API then please let us know. z^%s$)assertRaisesRegexpreescape)r5exc_typeexc_msgr-rCras rassertRaisesWithz:TimedTestRunner.run.._TestWrapper.assertRaisesWiths6)((6BIIg._TestWrapper.assertRaisesRegexp"s [[ & & ( JD#F#iiDxOP@7TXj[_jcij j JoobiiS2<<HII JsAB=BBcTjdjd|jS)Nr1)rr_testMethodNamer5rs rr|z,TimedTestRunner.run.._TestWrapper.id,s#,779O9OQUQeQef frcV|jdjdjdS)Nz (r1))rrrrs r__str__z1TimedTestRunner.run.._TestWrapper.__str__/s#!%!5!5}7O7OQ^QgQgh hrr%) rrrrcrmrrrr|r __classcell__)r~rs@r _TestWrapperrws2  @  Q g k g i irr)_testsrkr~rzrtrc)r5rtrrr~s @rrczTimedTestRunner.runsM [[6!1gm1i1if!akm6!p $ +D 11r)rrrrrcr)r~s@rrtrts9292rrtc ttS)z Provides the runtimes of tests executed through TimedTestRunners. :returns: **dict** of fully qualified test names to floats for the runtime in seconds .. versionadded:: 1.6.0 )dictr{rrr test_runtimesr7s m rc>g}|D]}tjjj|dD]}|dd}tj j dtj j }||vr\|j|d\}}|jdsjtj j||jdddz}tj j|r|j|t j||S) as Deletes any file with a \*.pyc extention without a corresponding \*.py. This helps to address a common gotcha when deleting python files... * You delete module 'foo.py' and run the tests to ensure that you haven't broken anything. They pass, however there *are* still some 'import foo' statements that still work because the bytecode (foo.pyc) is still around. * You push your change. * Another developer clones our repository and is confused because we have a bunch of ImportErrors. :param list paths: paths to search for orphaned pyc files :returns: list of absolute paths that were deleted z.pycN __pycache__r1r.py) r&r'systemfiles_with_suffixrMpathsepsplitendswithrhexistsappendremove)paths orphaned_pycrpyc_pathpy_pathpycache directorypycache_filenames rclean_orphaned_pycrDs&,dII$$66tVD" g &(WW[["''++>g H &.nnWa&@# #((0 '',,y*:*@*@*Ea*H5*PQ WW^^G $H% (%* rc2tdxr tdS)zk Checks if pyflakes is availalbe. :returns: **True** if we can use pyflakes and **False** otherwise z pyflakes.apizpyflakes.reporter)_module_existsrrris_pyflakes_availablerqs  ' ON;N,OOrc\tdrddl}ntdrddl}nyt|dS)zq Checks if pycodestyle is availalbe. :returns: **True** if we can use pycodestyle and **False** otherwise pycodestylerNpep8F BaseReport)rrrhasattr)rs ris_pycodestyle_availabler{s*M"f  l ++rc  ig}g g tdtdzD]}d|vr|jdd\}}d|vrT|jdd\}} j|j|j|jft|jdk(s j|j|j| fdt rgt drd d l} nd d l} G  fd d | j | j| } | jtt|S)a Checks for stylistic issues that are an issue according to the parts of PEP8 we conform to. You can suppress pycodestyle issues by making a 'test' configuration that sets 'pycodestyle.ignore'. For example, with a 'test/settings.cfg' of... :: # pycodestyle compliance issues that we're ignoreing... # # * E111 and E121 four space indentations # * E501 line is over 79 characters pycodestyle.ignore E111 pycodestyle.ignore E121 pycodestyle.ignore E501 pycodestyle.ignore run_tests.py => E402: import stem.util.enum ... you can then run tests with... :: import stem.util.conf test_config = stem.util.conf.get_config('test') test_config.load('test/settings.cfg') issues = stylistic_issues('my_project') .. versionchanged:: 1.3.0 Renamed from get_stylistic_issues() to stylistic_issues(). The old name still works as an alias, but will be dropped in Stem version 2.0.0. .. versionchanged:: 1.4.0 Changing tuples in return value to be namedtuple instances, and adding the line that had the issue. .. versionchanged:: 1.4.0 Added the prefer_single_quotes option. .. versionchanged:: 1.6.0 Changed 'pycodestyle.ignore' code snippets to only need to match against the prefix. :param list paths: paths to search for stylistic issues :param bool check_newlines: check that we have standard newlines (\n), not windows (\r\n) nor classic mac (\r) :param bool check_exception_keyword: checks that we're using 'as' for exceptions rather than a comma :param bool prefer_single_quotes: standardize on using single rather than double quotes for strings, when reasonable :returns: dict of paths list of :class:`stem.util.test_tools.Issue` instances rr=>r:*cD]?\}}}|j|s||k(s|jj|s?yD]}|j|syy)NTF)rstrip startswith)rrulecode ignored_path ignored_rule ignored_codeignore_all_for_filesignore_for_files r is_ignoredz$stylistic_issues..is_ignoredsh4C0 lL | $)=$**,BYBYZfBg- | $ rrrNc<eZdZfdZfdZxZS)%stylistic_issues..StyleReportct ||||| s ssyd}D]}|j|syt|D]\}}|j dddj } r3d|vr/j |gjt|dzd|| sbd| vr| } rQ| jdr@| jd r/j |gjt|dzd |s|rd | vsd | vsd| vs| jd rj |gjt|dzd|y)NF#rr zcontains a windows newlinez"""exceptz, exc:z(except clause should use 'as', not comma"r\z$use single rather than double quotes) rz init_filer enumeraterr setdefaultrror)r5filenamelinesr line_offsetis_block_commentrindexrrcontent StyleReportr~check_exception_keywordcheck_newlinesrissuesprefer_single_quotess rrz/stylistic_issues..StyleReport.init_fileso k4*8UHkR&=FZ  0 L   | ,  %U+" uKE4JJsA&q)//1'    h + 2 25D`bf3g h  g #33  $););H)E'JZJZ[cJd   h + 2 25Dnpt3u v !*:g~#W"4g9MV]VfVfgkVl "-44U519Flnr5stE" urct|||||}|rltj|j|} |j||s7 j |jgj t|||yyyr%)rzrL linecachegetlinerrrro) r5rpoffsettextcheckrrrrr~rrs rrLz+stylistic_issues..StyleReport.errorsv[$-k64O ""4==+>$DMM46   dmmR 0 7 7k4QU8V W7 r)rrrrrLr)r~rrrrrrrs@rrrs.u.u`XXrr)ignorereporter) CONFIGrrrrrrrr StyleGuide check_fileslist _python_files)rrrr ignore_rulesrr rule_entryrr style_checkerrrrrrs ``` @@@@@rstylistic_issuesrs8t &,/)*VM-BB  d t|D!,dJ %%c1- d djjlDJJLIJ     $##DJJL1$   f 8X8Xk,,8Xt **L[*YMd=#789 -rcitr\ddl}ddl}Gfdd|jj}|}t |D]}|j j|| S)aP Performs static checks via pyflakes. False positives can be ignored via 'pyflakes.ignore' entries in our 'test' config. For instance... :: pyflakes.ignore stem/util/test_tools.py => 'pyflakes' imported but unused pyflakes.ignore stem/util/test_tools.py => 'pycodestyle' imported but unused .. versionchanged:: 1.3.0 Renamed from get_pyflakes_issues() to pyflakes_issues(). The old name still works as an alias, but will be dropped in Stem version 2.0.0. .. versionchanged:: 1.4.0 Changing tuples in return value to be namedtuple instances, and adding the line that had the issue. .. versionchanged:: 1.5.0 Support matching against prefix or suffix issue strings. :param list paths: paths to search for problems :returns: dict of paths list of :class:`stem.util.test_tools.Issue` instances rNc6eZdZdZdZdZdZdZfdZy)!pyflakes_issues..Reporterci|_tdD]]}|jd\}}|jj|j gj |j _y)Nrr)_ignored_issuesrrrrr)r5rrrissues rrEz*pyflakes_issues..Reporter.__init__Js`!,- RD 4(+$    ) )$**, ; B B5;;= Q Rrc,|j|d|dyr%_register_issue)r5rrs runexpectedErrorz1pyflakes_issues..Reporter.unexpectedErrorQs XtS$7rc,|j||||yr%r)r5rrlinenorrs r syntaxErrorz-pyflakes_issues..Reporter.syntaxErrorTs XvsD9rc|j|j|j|j|jzdyr%)rrrrq message_args)r5rs rflakez'pyflakes_issues..Reporter.flakeWs. S\\3::s{{SEUEU7UW[\rc|jjD]\}}|j|s||vry|Dcgc]}|jds|ddc}D]}|j|sy|Dcgc]}|jds|ddc}D]}|j|syycc}wcc}w)NTrrF)ritemsrr)r5rrrignored_issuesiprefixsuffixs r _is_ignoredz-pyflakes_issues..Reporter._is_ignoredZs-1,@,@,F,F,H  (L. ]]< (&*8LQAJJsO1Ra5L !!&) +9NQALL.Reporter._register_issuems^e, k$$$T;7==?D   D" % , ,U;t-L M -rN) rrrrErrrrr)rsrReporterrIs$R8:]&Nrr )r pyflakes.apipyflakes.reporterrr rapi checkPath)rpyflakesr rrrs @rpyflakes_issuesr)si4 &)N8$$--)NVzHe$-llT8,- -rc: t|y#t$rYywxYw)z Checks if a module exists. :param str module_name: module to check existance of :returns: **True** if module exists and **False** otherwise TF) __import__ ImportError) module_names rrr|s${   s  c#K|D]b}tjjj|dD]3}d}tdD]}t j ||sd}n|r0|5dyw)NrFrT)r&r'rrrrmatch)rr file_pathr# exclude_paths rrrst dYY%%77eD  d 1, 88L) ,$    sAA+A+" A+r%)FFF)3r collectionsrrZrMrr<ryrQunittest stem.prereqr&stem.util.confstem.util.enumstem.util.systemr'conf config_dictrr{r*enum UppercaseEnumr@ namedtupler rXrY Exceptionr caserr!r#r.objectr)roTextTestRunnerrtrrrrrrrrget_stylistic_issuesget_pyflakes_issuesis_pep8_availablerrrr+sb6    # #F -   iinn**9iL $k$$]J? ;;'']] # #(d"i"  j(j(Z "K " "7,N OB2h--B2J *ZP,"ZzPf  &(%,r