hcSrSSKrSSKrSSKrSSKJr SSKJrJrJ r SSK J r J r J r SSKJr Sr"SS \ R"5r"S S 5r"S S \5r"SS5rSrSrg)a No public APIs are provided by this module. Internal use only. This module implements dynamic tab-completion for any command that uses twisted.python.usage. Currently, only zsh is supported. Bash support may be added in the future. Maintainer: Eric P. Mangold - twisted AT teratorn DOT org In order for zsh completion to take place the shell must be able to find an appropriate "stub" file ("completion function") that invokes this code and displays the results to the user. The stub used for Twisted commands is in the file C{twisted-completion.zsh}, which is also included in the official Zsh distribution at C{Completion/Unix/Command/_twisted}. Use this file as a basis for completion functions for your own commands. You should only need to change the first line to something like C{#compdef mycommand}. The main public documentation exists in the L{twisted.python.usage.Options} docstring, the L{twisted.python.usage.Completions} docstring, and the Options howto. N) MethodType)DictListSet)reflectusageutil)ioTypec"U(a[U5[:Xa URnUSRS5upE[ U5nUS-nX%nUS:a*X%S- R S5(aUS-nOOUS:aM*USUn[ USS5nU(aSn[R"X RUR5upU(aSURHCuppUSU :Xd USU :XdMU "5nXl [XX5nUR5 g S nUR S5(aS n[XU5nURUS 9 g[XU5nUR5 g![Ra Nf=f) a Perform shell completion. A completion function (shell script) is generated for the requested shell and written to C{shellCompFile}, typically C{stdout}. The result is then eval'd by the shell to produce the desired completions. @type config: L{twisted.python.usage.Options} @param config: The L{twisted.python.usage.Options} instance to generate completions for. @type cmdName: C{str} @param cmdName: The name of the command we're generating completions for. In the case of zsh, this is used to print an appropriate "#compdef $CMD" line at the top of the output. This is not necessary for the functionality of the system, but it helps in debugging, since the output we produce is properly formed and may be saved in a file and used as a stand-alone completion function. @type words: C{list} of C{str} @param words: The raw command-line words passed to use by the shell stub function. argv[0] has already been stripped off. @type shellCompFile: C{file} @param shellCompFile: The file to write completion data to. :-N subCommandsrTF)genSubs)r strbuffersplitint startswithgetattrgetoptshortOptlongOpterrorrparentZshSubcommandBuilderwrite ZshBuilder)configcmdNamewords shellCompFile shellNamepositioncWordrargsoptscmdshortparserdoc subOptionsgenrs `/root/1688_scrapy/alibaba-scraper/venv/lib/python3.13/site-packages/twisted/python/_shellcomp.py shellCompleter1's> .#5%,,  )//#.I8}H MH OE a- A  ) )# . . MH  a- )8 E&-6K uoov~~NJD +1+=+='F7c>T!W%5!'J(.%&:"G'CIIK,>   C G-8 ' "-8 7||   s-E77F Fc\rSrSrSrSrg)SubcommandActioncJU[R:Xag[SU<35e)Nz*::subcmd:->subcmdzUnknown shellType )r_ZSHNotImplementedError)selfoptName shellTypes r0 _shellCodeSubcommandAction._shellCodes$  "'!$6ym"DEEN)__name__ __module__ __qualname____firstlineno__r;__static_attributes__r>r=r0r3r3sFr=r3c(\rSrSrSrSrSSjrSrg)r a Constructs zsh code that will complete options for a given usage.Options instance, possibly including a list of subcommand names. Completions for options to subcommands won't be generated because this class will never be used if the user is completing options for a specific subcommand. (See L{ZshSubcommandBuilder} below) @type options: L{twisted.python.usage.Options} @ivar options: The L{twisted.python.usage.Options} instance defined for this command. @type cmdName: C{str} @ivar cmdName: The name of the command we're generating completions for. @type file: C{file} @ivar file: The C{file} to write the completion function to. The C{file} must have L{bytes} I/O semantics. c(XlX lX0lgN)optionsr"file)r8rHr"rIs r0__init__ZshBuilder.__init__s   r=cU(Ga/[URSS5Gb[URURUR5nUR R S[55 UR5 URRS5 URRHKup4pVURRSURS5-S-URS5-S-5 MM URRS 5 URRS 5 g[URURUR5nUR5 g) aW Generate the completion function and write it to the output file @return: L{None} @type genSubs: C{bool} @param genSubs: Flag indicating whether or not completions for the list of subcommand should be generated. Only has an effect if the C{subCommands} attribute has been defined on the L{twisted.python.usage.Options} instance. rNrs.local _zsh_subcmds_array _zsh_subcmds_array=( "utf-8:s" s) s+_describe "sub-command" _zsh_subcmds_array ) rrHZshArgumentsGeneratorr"rI extraActionsinsertr3rrencode)r8rr/r*r+r,descs r0rZshBuilder.writes wt||]DAM' dllDIINC    # #A'7'9 : IIK IIOOO P,0LL,D,D(F 3::g..5 G8LLvU-E IIOOH % IIOOK L' dllDIINC IIKr=)r"rIrHN)Tr?r@rArB__doc__rJrrCr>r=r0r r s( r=r c$\rSrSrSrSrSrSrg)ram Constructs zsh code that will complete options for a given usage.Options instance, and also for a single sub-command. This will only be used in the case where the user is completing options for a specific subcommand. @type subOptions: L{twisted.python.usage.Options} @ivar subOptions: The L{twisted.python.usage.Options} instance defined for the sub command. c>Xl[R"U/UQ76 grG)r.r rJ)r8r.r(s r0rJZshSubcommandBuilder.__init__s$D(4(r=c8[URURUR5nURR S[ 55 UR5 [URURUR5nUR5 g)zS Generate the completion function and write it to the output file @return: L{None} rN) rPrHr"rIrQrRr3rr.)r8r/s r0rZshSubcommandBuilder.writesd $DLL$,, J #3#56 #DOOT\\499M r=)r.NrVr>r=r0rrs) r=rc\rSrSrSrSrSrSrSrSr Sr S r SS jr S \ \\\44S jrS rSrSrSrSSjrSrg)rPa Generate a call to the zsh _arguments completion function based on data in a usage.Options instance The first three instance variables are populated based on constructor arguments. The remaining non-constructor variables are populated by this class with data gathered from the C{Options} instance passed in, and its base classes. @type options: L{twisted.python.usage.Options} @ivar options: The L{twisted.python.usage.Options} instance to generate for @type cmdName: C{str} @ivar cmdName: The name of the command we're generating completions for. @type file: C{file} @ivar file: The C{file} to write the completion function to. The C{file} must have L{bytes} I/O semantics. @type descriptions: C{dict} @ivar descriptions: A dict mapping long option names to alternate descriptions. When this variable is defined, the descriptions contained here will override those descriptions provided in the optFlags and optParameters variables. @type multiUse: C{list} @ivar multiUse: An iterable containing those long option names which may appear on the command line more than once. By default, options will only be completed one time. @type mutuallyExclusive: C{list} of C{tuple} @ivar mutuallyExclusive: A sequence of sequences, with each sub-sequence containing those long option names that are mutually exclusive. That is, those options that cannot appear on the command line together. @type optActions: C{dict} @ivar optActions: A dict mapping long option names to shell "actions". These actions define what may be completed as the argument to the given option, and should be given as instances of L{twisted.python.usage.Completer}. Callables may instead be given for the values in this dict. The callable should accept no arguments, and return a C{Completer} instance used as the action. @type extraActions: C{list} of C{twisted.python.usage.Completer} @ivar extraActions: Extra arguments are those arguments typically appearing at the end of the command-line, which are not associated with any particular named option. That is, the arguments that are given to the parseArgs() method of your usage.Options subclass. c,XlX lX0l0Ul[ 5Ul/Ul0Ul/Ul[[R"UR55Hn[USS5nU(dMURRUR5 URRUR5 UR RUR 5 UR RUR 5 UR(dMURUlM [ R"n/n/nU"URSU5 U"URSU5 [%U5H/up['U 5S:wdM[(R*"SU 5Xy'M1 [%U5H/up['U 5S:wdM[(R*"SU 5X'M1 XplXl0n UH n U SSXS'M Xl0n UH n U SSXS'M Xl0n U RU 5 U RU 5 XlUR75 UR95 UR;5Ulg)NcompDataoptFlags optParametersrr)rHr"rI descriptionssetmultiUsemutuallyExclusive optActionsrQreversedinspectgetmro __class__rupdateextendraccumulateClassList enumeratelenr padTorb optParamsparamNameToDefinitionflagNameToDefinitionallOptionsNameToDefinitionaddAdditionalOptionsverifyZshNamesmakeExcludesDictexcludes)r8rHr"rIclsdataaCLrbruioptListrvrwrxs r0rJZshArgumentsGenerator.__init__s3    !#GNN7+<+<=>C3 D1Dt!!(():):;&&t7 $$T]]3&&--d.D.DE $$$(,(9(9D%?))')(*  G  z84 G   :#H-JA7|q "jjG4 .$I.JA7|q #zz!W5 /! " " G07 !!* -!%:"!G/6qr{  , $8!%'""))*?@"))*>?*D' !!# --/ r=cUR5 UR5 UR5 UR5 g)zN Write the zsh completion code to the file given to __init__ @return: L{None} N) writeHeader writeExtras writeOptions writeFooterr8s r0rZshArgumentsGenerator.write\s4    r=cxURRSURRS5-S-5 g)zF This is the start of the code that calls _arguments @return: L{None} s #compdef rNs _arguments -s -A "-*" \ N)rIrr"rSrs r0r!ZshArgumentsGenerator.writeHeaderfs5  4<<..w7 7;* * r=c[URR55nUR5 UHnUR U5 M g)zE Write out zsh code for each option in this command @return: L{None} N)listrxkeyssortwriteOpt)r8optNameslongnames r0r"ZshArgumentsGenerator.writeOptionsps< 77<<>?  H MM( #!r=c [UR5HupUR(a'U[UR5S- :wa [ S5eUR R [URS[R55RS55 UR R S5 M g)ag Write out completion information for extra arguments appearing on the command-line. These are extra positional arguments not associated with a named option. That is, the stuff that gets passed to Options.parseArgs(). @return: L{None} @raise ValueError: If C{Completer} with C{repeat=True} is found and is not the last item in the C{extraActions} list. rzDCompleter with repeat=True must be last item in Options.extraActionsrN \ N) rrrQ_repeatrs ValueErrorrIrescaper;rr6rS)r8ractions r0r!ZshArgumentsGenerator.writeExtraszs#4#4#45IA~~!s4+<+<'='A"A 8 IIOOF6#4#4R#DELLWU V IIOOH %6r=c:URRS5 g)zR Write the last bit of code that finishes the call to _arguments @return: L{None} s && return 0 N)rIrrs r0r!ZshArgumentsGenerator.writeFooters ()r=c,^U4Sjn[R"TRTRTR5HnUTR ;dMU"U5 M TR H&nUHnUTR ;dMU"U5 M M( g)z Ensure that none of the option names given in the metadata are typoed @return: L{None} @raise ValueError: If unknown option names have been found. c>>[SU<STR<35e)NzUnknown option name "z1" found while examining Completions instances on )rrH)namer8s r0err1ZshArgumentsGenerator.verifyZshNames..errs;?O r=N) itertoolschainrfrjrhrxri)r8rrseqs` r0rz$ZshArgumentsGenerator.verifyZshNamessv  OOD$5$5t VD4:::D W))Ct>>>I*r=cXR;aURUR5nO [5nXR;a<USLa&UR U5nUbUR U5 OUR U5 U(dg/nUH<n[ U5S:XaURSU-5 M(URSU-5 M> UR5 SSRU5-$)a[ Generate an "exclusion string" for the given option @type longname: C{str} @param longname: The long option name (e.g. "verbose" instead of "v") @type buildShort: C{bool} @param buildShort: May be True to indicate we're building an excludes string for the short option that corresponds to the given long opt. @return: The generated C{str} Frrrz--z(%s) ) r|copyrgrhgetShortOptionaddrsappendrjoin)r8r buildShort exclusionsr+stringsr9s r0 excludeStr ZshArgumentsGenerator.excludeStrs }} $x0557JJ == (U"++H5$NN5)x(!G7|q sW}-tg~. "  )))r=returnc0n[R"URUR5HnUSS:wdMUSXS'M 0nURH~n[ U5HlupV[ USUXES-S-5nUR5HnX;dM URX5 M Xc;aX6RU5X6'MhXsU'Mn M U$)z @return: A C{dict} that maps each option name appearing in self.mutuallyExclusive to a set of those option names that is it mutually exclusive with (can't appear on the cmd line with). rNr) rrrurbrirrrgrrunion) r8 longToShortrr|lstrrtmprs r0r{&ZshArgumentsGenerator.makeExcludesDicts  t~~t}}EGqzT!*1!* AJ'F)+))C(~ #bq'CAL01HHJD* 12'')1);)A)A#)FH&),X& .*r=c XR;aSU-nOSU-nURU5nUS:waSU-nOSnURU5nURSS5nURSS 5nS U-nUR U5nXR ;aS nOSnUR U5n U(amUR US S 9n URR[U <U<U<U<U<35RS55 URRS5 URR[U <U<U<U<U<35RS55 URRS5 g)z Write out the zsh code for the given argument. This is just part of the one big call to _arguments @type longname: C{str} @param longname: The long option name (e.g. "verbose" instead of "v") @return: L{None} z--%sz--%s=Nrr[z\[]z\]z[%s]*T)rrNr) rwrgetDescriptionreplace getActionrhrrIrrrS) r8r longFieldr+ shortFielddescrdescriptionField actionField multiFieldlongExclusionsFieldshortExclusionsFields r0rZshArgumentsGenerator.writeOptsf 00 0)I(*I##H- D=uJJ##H- ==e4+33C?!$44nnX. }} $JJ"ooh7 #'??8?#M IIOO-""(#  &/  IIOOH %  ($  fWo  !r=cXR;aa[URU5(aURU"5nOURUnURU[R5$XR ;aSUS3$g)zE Return a zsh "action" string for the given argument @return: C{str} r z:_filesr)rjcallabler;rr6rv)r8rrs r0rZshArgumentsGenerator.getAction4sv  &122242$$Xuzz: : 11 1xj( (r=cdXR;aURU$URUSnUbU$UR SS5n[ UR SU-S5nUb[U5nU(aU$U$![a) URUSnNi![a SnNxf=ff=f)zE Return the description to be used for this argument @return: C{str} rrNr_zopt_%s)rfrwKeyErrorrvrrrH descrFromDoc)r8rr longMangledobjs r0r$ZshArgumentsGenerator.getDescriptionDs (( ($$X. . --h7:E  L&&sC0 dllH{$:DA ? %E '  2287r=r0rPrPsi2hB0H $&,*,(*T$sCH}"56@"D B"%Qr=rPc8URbURR5(agURRS5Vs/sH2o(dM UR5(aM"UR5PM4 nnSR U5$s snf)zH Generate an appropriate description from docstring of the given object N r)rWisspacerstripr)rxliness r0rrsp {{ckk1133 # 1 1$ 7 Q 711YQYY[YQWWY 7E Q 88E? Rs BB0Bc`SU;aSU-S-$SnUHnUS;aUS-nX-nM US-nU$)zk Shell escape the given string Implementation borrowed from now-deprecated commands.mkarg() in the stdlib '"z\$"`\r>)rscs r0rrsO  !|Qw} A  <DA E CA Hr=)rWrrlrtypesrtypingrrrtwisted.pythonrrr twisted.python.compatr r1 Completerr3r rrPrrr>r=r0rsp 0""//(aHFuF22j:8oQoQd  r=