\d[dZddlmZddlmZGddejZGddejZGdd ejZ Gd d ejZ Gd d ejZ GddejZ GddejZ GddejZGddejZGddejZGddejZGddejZGddejZGddejZGd d!ejZGd"d#ejZGd$d%ejZGd&d'ejZd(S))zK Tests for L{twisted.python.usage}, a command line option parsing library. )usage)unittestcFeZdZgdgdgdgdgZgdddggZdZd Zd S) WellBehaved)longwdefaultzand a docstring)anothernz no docstring)longonlyNnoshort) shortlessNexceptzthis one got docstring)aflagfzO flagallicious docstringness for this here floutocd|jd<dS)NPONY!myflagoptsselfs 7lib/python3.11/site-packages/twisted/test/test_usage.py opt_myflagzWellBehaved.opt_myflag!s% (c |d|jd<dS)Nz WITH A PONY!myparamrrvalues r opt_myparamzWellBehaved.opt_myparam$s"'666 )rN)__name__ __module__ __qualname__ optParametersoptFlagsrr"rrrr s|333(((%%%??? M    # H&&&77777rrc*eZdZdZdZdZdZdZdS)ParseCorrectnessTestszZ Test L{usage.Options.parseOptions} for correct values under good conditions. cd|_t|_|j|jdS)zL Instantiate and parseOptions a well-behaved Options class. A--long Alpha -n Beta --shortless Gamma -f --myflag --myparam TofuN)splitniceArgVrnice parseOptionsrs rsetUpzParseCorrectnessTests.setUp.sC V %''  MM  t}-----rc6||jjdd||jjdd||jjdd||jjddd S) z1 Parameters have correct values. rAlphar Betar r rGammaN assertEqualr/rrs rtest_checkParametersz*ParseCorrectnessTests.test_checkParameters;s /999  2F;;;  3Y???  4g>>>>>rc||jjdd||jjdddS)z, Flags have correct values. rrrNr6rs rtest_checkFlagsz%ParseCorrectnessTests.test_checkFlagsDsH 0!444 0!44444rc||jjdd||jjdddS)zB Custom flags and parameters have correct values. rrrzTofu WITH A PONY!Nr6rs rtest_checkCustomsz'ParseCorrectnessTests.test_checkCustomsKsI 17;;;  24GHHHHHrN)r#r$r%__doc__r1r8r;r=r(rrr*r*(s_ . . .???555IIIIIrr*cLeZdZddddegddddegdddd egd ddd eggZd ZeZdS) TypedOptionsfoointNzFoo intfoofloatQ@z Foo floateggintzEgg int without defaulteggfloatzEgg float without defaultc||_dS)zg This option has an underscore in its name to exercise the _ to - translation. N)underscoreValuer s ropt_under_scorezTypedOptions.opt_under_score[s %r)r#r$r%intfloatr&rIopt_ur(rrr@r@Sse 4i- T4e4 48#> T4!r1rVrYr]r`rdr(rrrNrNes$$$ 7 7 7 B B B<<<<<<KKKKKrrNceZdZgdgZdS)WrongTypedOptions)barwrongNNzBar with wrong coerceheN)r#r$r%r&r(rrrfrfsLLLMMMMrrfc6eZdZdZdZddddegddddeggZdS)WeirdCallableOptionsc td)NOuch) RuntimeErrorr!s r_barzWeirdCallableOptions._bars6"""rc td)NYay) ValueErrorrns r_foozWeirdCallableOptions._foosrrgNzBar with strange callablefoowrongzFoo with strange callable)r#r$r%rorsr&r(rrrjrjsS###    T4!>>>>rN)r#r$r%r>r{r}rr(rrrvrvsK<<< ? ? ? ? ?rrvceZdZdZdS) OutputTestsct}|tj|jdg}|t |ddS)zF Error output case adjustment does not mangle options z-Zzoption -Z not recognizedN)rrbrrcr0r7r)roptrs rtest_uppercasingzOutputTests.test_uppercasingsOmm   e.0@4& I I Q!;<<<<??? h/000 &67GGGGGrc~t}|gd||d||jd||jt||jd||jdddS)zA Flags and options of a subcommand are assigned. )r--expect--torture-device=featherrrrrfeatherN rr0rr7rrRrrrrs r"test_subcommandWithFlagsAndOptionsz2SubCommandTests.test_subcommandWithFlagsAndOptions s    NNNOOO -./// }555 al,>???  X./// &67CCCCCrc~t}|gd||d||jd||jt||jd||jdddS)zG Flags and options of a subcommand alias are assigned. )rrrrrrrrNrrs r'test_subcommandAliasWithFlagsAndOptionsz7SubCommandTests.test_subcommandAliasWithFlagsAndOptionss    JJJKKK -./// }555 al,>???  X./// &67CCCCCrc|t}|ddg||d||jd||jt||jd||jddS)zG Flags and options of another subcommand are assigned. rz --for-grailrrrN) rr0rr7rrRrrrrs r)test_anotherSubcommandWithFlagsAndOptionsz9SubCommandTests.test_anotherSubcommandWithFlagsAndOptions#s     ]3444 -./// {333 al,<=== k2333  [122222rct}|dg||d||j|t |ddS)z If no subcommand is specified and no default subcommand is assigned, a subcommand will not be implied. rrrN)rr0rrSrrhasattrrs rtest_noSubcommandz!SubCommandTests.test_noSubcommand/sw    ,-... ,-... !,''' L1122222rct}d|_|dg||d||jd||jt| |jd||jdddS) zK Flags and options in the default subcommand are assigned. rrrrrrrN) rdefaultSubCommandr0rr7rrRrrrrs rtest_defaultSubcommandz&SubCommandTests.test_defaultSubcommand:s   ' ,-... ,-... }555 al,>??? h/000 &67GGGGGrc<GddtjGfddtj}|}|dg|t |jd||jj|dS)zw The parseOptions method from the Options object specified for the given subcommand is called. ceZdZdZdS)DSubCommandTests.test_subCommandParseOptionsHasParent..SubOptcR|j|_tjj|g|Ri|dSrP)parent sawParentrOptionsr0)rakws rr0zQSubCommandTests.test_subCommandParseOptionsHasParent..SubOpt.parseOptionsNs4!% *4:!:::r:::::rN)r#r$r%r0r(rrSubOptrMs# ; ; ; ; ;rrceZdZdddfgZdS)ASubCommandTests.test_subCommandParseOptionsHasParent..Optr[rr_Nr#r$r%rrsrOptrRs"VU+KKKrrr[rN)rrr0rrrr7r)rrrrs @r$test_subCommandParseOptionsHasParentz4SubCommandTests.test_subCommandParseOptionsHasParentGs  ; ; ; ; ;U] ; ; ;        %-    CEE w  k::;;; /33333rc@GddtjGfddtj}Gfddtj}|}|dg|}|dg|t |jd |t |jd ||jj|||jj|d S) zh The .parent pointer is correct even when the same Options class is used twice. ceZdZdS):SubCommandTests.test_subCommandInTwoPlaces..SubOptN)r#r$r%r(rrrrbs DrrceZdZdddfgZdS):SubCommandTests.test_subCommandInTwoPlaces..OptFoor[rquuxNrrsrOptFoore"VV,KKKrrceZdZdddfgZdS):SubCommandTests.test_subCommandInTwoPlaces..OptBarr_brNrrsrOptBarrjrrrr[r_rN)rrr0rrrfailUnlessIdenticalr)rrroFoooBarrs @rtest_subCommandInTwoPlacesz*SubCommandTests.test_subCommandInTwoPlaces\sW      U]          U]           U]    vxx 5'"""vxx 5'""" ::;;; ::;;;   !7>>>   !7>>>>>rN) r#r$r%r>rrrrrrrrr(rrrrs H H H D D D D D D 3 3 3 3 3 3 H H H444*?????rrc$eZdZdZdZdZdZdS)HelpStringTestsz& Test generated help strings. c^d|_t|_dS)z; Instantiate a well-behaved Options class. r,N)r-r.rr/rs rr1zHelpStringTests.setUp~s) V %''  MM rc |jdS#t$r }||Yd}~dSd}~wwxYw)z, __str__ shouldn't go boom. N)r/__str__ Exceptionfail)rrs r test_noGoBoomzHelpStringTests.test_noGoBooms[  I           IIaLLLLLLLLL s AAAcdt|jD}|t |dk||dddkdS)zK Extra whitespace in flag and parameters docs is stripped. cDg|]}|ddk|S)rr)find).0ss r zJHelpStringTests.test_whitespaceStripFlagsAndParameters..s,PPPq166'??a;O;O;O;O;Orr flagalliciousN)rr/ splitlinesrlenr)rliness r&test_whitespaceStripFlagsAndParametersz6HelpStringTests.test_whitespaceStripFlagsAndParameterssu QPC NN5577PPP E Q''' a o66!;<<<<r1rrr(rrrrysK " " "=====rrceZdZdZdZdZdS)PortCoerceTestsz3 Test the behavior of L{usage.portCoerce}. c|dtjd|dtjd|dtjddS)z4 Test the answers with valid input. r0i 3210i65535N)r7r portCoercers rtest_validCoercez PortCoerceTests.test_validCoercesm E,S11222 u/77888  0 9 9:::::rc6|ttjd|ttjd|ttjd|ttjddS)z" Test error path. z-21212189r[N)rbrrrrrs rtest_errorCoercez PortCoerceTests.test_errorCoercesv *e&6;;; *e&6>>> *e&6AAA *e&6>>>>>rN)r#r$r%r>rrr(rrrrs<;;;?????rrcNeZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d S) ZshCompleterTestsz Test the behavior of the various L{twisted.usage.Completer} classes for producing output usable by zsh tab-completion system. c0tj}|dtj}||dtjdd}|dtj}||ddS)zX Completer produces zsh shell-code that produces no completion matches. some-optionz :some-option: some actionTdescrrepeat*:some action:N)r Completer _shellCode_ZSHr7rcgots rtest_completerz ZshCompleterTests.test_completers O  ll=%*55 o... O- = = =ll=%*55 ./////rctj}|dtj}||dtjd}|dtj}||dtjddd}|dtj}||dd S) zn CompleteFiles produces zsh shell-code that completes file names according to a glob. rz:some-option (*):_files -g "*"z*.pyz$:some-option (*.py):_files -g "*.py"rTrz%*:some action (*.py):_files -g "*.py"N)r CompleteFilesrrr7rs r test_fileszZshCompleterTests.test_filess   ! !ll=%*55 >???   ' 'll=%*55 DEEE  mD I I Ill=%*55 EFFFFFrc0tj}|dtj}||dtjdd}|dtj}||ddS)zV CompleteDirs produces zsh shell-code that completes directory names. rz:some-option:_directoriesrTrz*:some action:_directoriesN)r CompleteDirsrrr7rs r test_dirszZshCompleterTests.test_dirss   ll=%*55 9:::  ]4 @ @ @ll=%*55 :;;;;;rctjd}|dtj}||dtjgd}|dtj}||dtjgddd}|dtj}||d d S) zw CompleteList produces zsh shell-code that completes words from a fixed list of possibilities. ABCrz:some-option:(A B C)123z:some-option:(1 2 3)rTrz*:some action:(1 2 3)N)r CompleteListrrr7rs r test_listzZshCompleterTests.test_lists  u % %ll=%*55 4555   / /ll=%*55 4555  mD Q Q Qll=%*55 566666rctjd}|dtj}||dtjgd}|dtj}||dtjgddd}|dtj}d }|||d S) z CompleteMultiList produces zsh shell-code that completes multiple comma-separated words from a fixed list of possibilities. r rz-:some-option:_values -s , 'some-option' A B Cr z-:some-option:_values -s , 'some-option' 1 2 3rTrz.*:some action:_values -s , 'some action' 1 2 3N)rCompleteMultiListrrr7)rrrexpecteds rtest_multiListz ZshCompleterTests.test_multiLists  #E * *ll=%*55 MNNN  #OOO 4 4ll=%*55 MNNN  #OOO=QU V V Vll=%*55C h'''''rc0tj}|dtj}||dtjdd}|dtj}||ddS)zd CompleteUsernames produces zsh shell-code that completes system usernames. rz:some-option:_usersrTrz*:some action:_usersN)rCompleteUsernamesrrr7rrouts rtest_usernamesz ZshCompleterTests.test_usernamess  # % %ll=%*55 3444  #- E E Ell=%*55 455555rc0tj}|dtj}||dtjdd}|dtj}||ddS)zc CompleteGroups produces zsh shell-code that completes system group names. rz:group:_groupsrTrz*:some action:_groupsN)rCompleteGroupsrrr7rs r test_groupszZshCompleterTests.test_groupss  " "ll=%*55 .///  }T B B Bll=%*55 566666rc0tj}|dtj}||dtjdd}|dtj}||ddS)zU CompleteHostnames produces zsh shell-code that completes hostnames. rz:some-option:_hostsrTrz*:some action:_hostsN)rCompleteHostnamesrrr7rs rtest_hostnamesz ZshCompleterTests.test_hostnames s  # % %ll=%*55 3444  #- E E Ell=%*55 455555rcxtj}|dtj}||dtjdd}|dtj}||ddS)z CompleteUserAtHost produces zsh shell-code that completes hostnames or a word of the form @. rz:host | user@host:rTrrN)rCompleteUserAtHostrrr startswithrs rtest_userAtHostz!ZshCompleterTests.test_userAtHost,s  $ & &ll=%*55 ';<<===  $= F F Fll=%*55 '78899999rc0tj}|dtj}||dtjdd}|dtj}||ddS)zv CompleteNetInterfaces produces zsh shell-code that completes system network interface names. rz:some-option:_net_interfacesrTrz*:some action:_net_interfacesN)rCompleteNetInterfacesrrr7rs rtest_netInterfacesz$ZshCompleterTests.test_netInterfaces9s  ' ) )ll=%*55 <===  'mD I I Ill=%*55 =>>>>>rN)r#r$r%r>rrr rrrrr r$r'r(rrrrs 0 0 0GGG" < < <777"((($ 6 6 6 7 7 7 6 6 6 : : : ? ? ? ? ?rrceZdZdZdZdS)CompleterNotImplementedTestszs Using an unknown shell constant with the various Completer() classes should raise NotImplementedError c tjtjtjtjtjtjtjtjtj tj g }|D]K} |}n#t$r|d}YnwxYw| t|jddLdS)zM Using an unknown shellType should raise NotImplementedError Nbad_shell_type)rrrrrrrrrr"r& BaseExceptionrbNotImplementedErrorr)rclassesclsactions rtest_unknownShellz.CompleterNotImplementedTests.test_unknownShellMs O        #  #   #  $  '    C #  # # #T #   #V%6>N       s6 BBBN)r#r$r%r>r1r(rrr)r)Gs- rr)cDeZdZdZGddZdZdZdZdZdS) FlagFunctionTestsz* Tests for L{usage.flagFunction}. c$eZdZdZdZdZdZdS)FlagFunctionTests.SomeClassz> Dummy class for L{usage.flagFunction} tests. cdS)z A one argument method to be tested by L{usage.flagFunction}. @param a: a useless argument to satisfy the function's signature. Nr()rrs roneArgz"FlagFunctionTests.SomeClass.oneArgrrcdS)zU A no argument method to be tested by L{usage.flagFunction}. Nr(rs rnoArgz!FlagFunctionTests.SomeClass.noArgyr8rcdS)aG A multiple arguments method to be tested by L{usage.flagFunction}. @param a: a useless argument to satisfy the function's signature. @param b: a useless argument to satisfy the function's signature. @param c: a useless argument to satisfy the function's signature. Nr()rrrrs rmanyArgsz$FlagFunctionTests.SomeClass.manyArgs~r8rN)r#r$r%r>r7r:r<r(rr SomeClassr5msK              rr=c|dtj|jdS)zs L{usage.flagFunction} returns C{False} if the method checked allows exactly one argument. FN)assertIsr flagFunctionr=r7rs r test_hasArgzFlagFunctionTests.test_hasArgs6 eU/0@0@0GHHIIIIIrc|dtj|jdS)zq L{usage.flagFunction} returns C{True} if the method checked allows exactly no argument. TN)r?rr@r=r:rs r test_noArgzFlagFunctionTests.test_noArgs6 dE.t~~/?/?/EFFGGGGGrc|tjtj|j}|dt|dS)z L{usage.flagFunction} raises L{usage.UsageError} if the method checked allows more than one argument. z$Invalid Option function for manyArgsNrbrrcr@r=r<r7rrexcs rtest_tooManyArgumentsz'FlagFunctionTests.test_tooManyArgumentssX   e0$..2B2B2K   ?SJJJJJrc|tjtj|jd}|dt|dS)z L{usage.flagFunction} uses the given method name in the error message raised when the method allows too many arguments. flubudufz$Invalid Option function for flubudufNrErFs r,test_tooManyArgumentsAndSpecificErrorMessagez>FlagFunctionTests.test_tooManyArgumentsAndSpecificErrorMessagesZ   e0$..2B2B2KZ   ?SJJJJJrN) r#r$r%r>r=rArCrHrKr(rrr3r3hs4JJJHHHKKKKKKKKrr3ceZdZdZdZdS)OptionsInternalTestsz6 Tests internal behavior of C{usage.Options}. cGddtj}|}|tgdd|jd|jd|jdddS)zs Options which are synonyms to another option are aliases towards the longest option name. ceZdZdZeZeZdS);OptionsInternalTests.test_optionsAliasesOrder..OptscdS)z~ This is an option method with a very long name, that is going to be aliased. Nr(rs ropt_very_very_longzNOptionsInternalTests.test_optionsAliasesOrder..Opts.opt_very_very_longr8rN)r#r$r%rR opt_shortopt_sr(rrOptsrPs)    +I&EEErrU)rshortvery-very-longrWrrVN)rrr7dictfromkeyssynonyms)rrUrs rtest_optionsAliasesOrderz-OptionsInternalTests.test_optionsAliasesOrders  ' ' ' ' '5= ' ' 'tvv  MM:::r[r(rrrMrMs-     rrMN)r>twisted.pythonr twisted.trialrrrTestCaser*r@rNrfrjrvrrrrrrrrr)r3rMr(rrr_s ! """"""77777%-7776(I(I(I(I(IH-(I(I(IV5=$8K8K8K8K8K"8K8K8KvNNNNN NNN     5=   "?"?"?"?"?h'"?"?"?J=====(#===u} |?|?|?|?|?h'|?|?|?~!=!=!=!=!=h'!=!=!=H?????h'???.P?P?P?P?P?)P?P?P?f8#4B?K?K?K?K?K)?K?K?KD     8,     r