Your IP : 172.28.240.42
VNc @ s d Z d d l Z e j d e d d d d l Z d d l Z d d l Z d d l Z d d l m
Z
m Z m Z d d l
m Z d e j f d YZ d
f d YZ d e f d
YZ d e f d YZ d e f d YZ d f d YZ d Z d Z d Z d Z d d d f d d d f d d d f d! d" d f d# d$ d% f d& d' d( f d) d* d+ f d, d- d f d. d/ d f d0 d1 d f d2 d3 d+ f d4 d5 d f d6 d7 d f g
Z i e d 6e d& 6Z e e d8 Z d9 Z d: Z e d; k re n d S(< s-
Rebuild the completion functions for the currently active version of Twisted::
$ python zshcomp.py -i
This module implements a zsh code generator which generates completion code for
commands that use twisted.python.usage. This is the stuff that makes pressing
Tab at the command line work.
Maintainer: Eric Mangold
To build completion functions for your own commands, and not Twisted commands,
then just do something like this::
o = mymodule.MyOptions()
f = file('_mycommand', 'w')
Builder("mycommand", o, f).write()
Then all you have to do is place the generated file somewhere in your
C{$fpath}, and restart zsh. Note the "site-functions" directory in your
C{$fpath} where you may install 3rd-party completion functions (like the one
you're building). Call C{siteFunctionsPath} to locate this directory
programmatically.
SPECIAL CLASS VARIABLES. You may set these on your usage.Options subclass::
zsh_altArgDescr
zsh_multiUse
zsh_mutuallyExclusive
zsh_actions
zsh_actionDescr
zsh_extras
Here is what they mean (with examples)::
zsh_altArgDescr = {"foo":"use this description for foo instead"}
A dict mapping long option names to alternate descriptions. When this
variable is present, the descriptions contained here will override
those descriptions provided in the optFlags and optParameters
variables.
zsh_multiUse = ["foo", "bar"]
A sequence containing those long option names which may appear on the
command line more than once. By default, options will only be completed
one time.
zsh_mutuallyExclusive = [("foo", "bar"), ("bar", "baz")]
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.
zsh_actions = {"foo":'_files -g "*.foo"', "bar":"(one two three)",
"colors":"_values -s , 'colors to use' red green blue"}
A dict mapping long option names to Zsh "actions". These actions
define what will be completed as the argument to the given option. By
default, all files/dirs will be completed if no action is given.
Callables may instead be given for the values in this dict. The
callable should accept no arguments, and return a string that will be
used as the zsh "action" in the same way as the literal strings in the
examples above.
As you can see in the example above. The "foo" option will have files
that end in .foo completed when the user presses Tab. The "bar"
option will have either of the strings "one", "two", or "three"
completed when the user presses Tab.
"colors" will allow multiple arguments to be completed, seperated by
commas. The possible arguments are red, green, and blue. Examples::
my_command --foo some-file.foo --colors=red,green
my_command --colors=green
my_command --colors=green,blue
Actions may take many forms, and it is beyond the scope of this
document to illustrate them all. Please refer to the documention for
the Zsh _arguments function. zshcomp is basically a front-end to Zsh's
_arguments completion function.
That documentation is available on the zsh web site at this URL:
U{http://zsh.sunsite.dk/Doc/Release/zsh_19.html#SEC124}
zsh_actionDescr = {"logfile":"log file name", "random":"random seed"}
A dict mapping long option names to a description for the corresponding
zsh "action". These descriptions are show above the generated matches
when the user is doing completions for this option.
Normally Zsh does not show these descriptions unless you have
"verbose" completion turned on. Turn on verbosity with this in your
~/.zshrc::
zstyle ':completion:*' verbose yes
zstyle ':completion:*:descriptions' format '%B%d%b'
zsh_extras = [":file to read from:action", ":file to write to:action"]
A sequence of extra arguments that will be passed verbatim to Zsh's
_arguments completion function. The _arguments function does all the
hard work of doing command line completions. You can see how zshcomp
invokes the _arguments call by looking at the generated completion
files that this module creates.
*** NOTE ***
You will need to use this variable to describe completions for normal
command line arguments. That is, those arguments that are not
associated with an option. That is, the arguments that are given to the
parseArgs method of your usage.Options subclass.
In the example above, the 1st non-option argument will be described as
"file to read from" and completion options will be generated in
accordance with the "action". (See above about zsh "actions") The
2nd non-option argument will be described as "file to write to" and
the action will be interpreted likewise.
Things you can put here are all documented under the _arguments
function here: U{http://zsh.sunsite.dk/Doc/Release/zsh_19.html#SEC124}
Zsh Notes:
To enable advanced completion add something like this to your ~/.zshrc::
autoload -U compinit
compinit
For some extra verbosity, and general niceness add these lines too::
zstyle ':completion:*' verbose yes
zstyle ':completion:*:descriptions' format '%B%d%b'
zstyle ':completion:*:messages' format '%d'
zstyle ':completion:*:warnings' format 'No matches for: %d'
Have fun!
iNsf zshcomp is deprecated as of Twisted 11.1. Shell tab-completion is now handled by twisted.python.usage.t
stackleveli ( t reflectt utilt usage( t
IServiceMakert MyOptionsc B sJ e Z d Z d Z d Z d d d g g Z d d d
d g g Z d Z RS( s
Options for this file
t s> Usage: python zshcomp.py [--install | -i] | <output directory>t installt isi Output files to the "installation" directory (twisted/python/zsh in the currently active Twisted package)t directoryt ds Output files to this directoryc C s | d r# | d r# t j d n | d rH | d rH t j d n | d r t j j | d r t j d | d n d S( NR R s5 Can't have --install and --directory at the same times Not enough argumentss %s is not a directory( R t
UsageErrort ost patht isdir( t self( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt postOptions s !N( t __name__t
__module__t __doc__t longdesct synopsist optFlagst Nonet
optParametersR ( ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR s t Builderc B s e Z d Z d Z RS( c C s | | _ | | _ | | _ d S( s[
@type cmd_name: C{str}
@param cmd_name: The name of the command
@type options: C{twisted.usage.Options}
@param options: The C{twisted.usage.Options} instance defined for
this command
@type file: C{file}
@param file: The C{file} to write the completion function to
N( t cmd_namet optionst file( R R R R ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt __init__ s
c C sC | j j d | j f t | j | j | j } | j d S( sf
Write the completion function to the file given to __init__
@return: C{None}
s #compdef %s
N( R t writeR t ArgumentsGeneratorR ( R t gen( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR s ( R R R R ( ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR s t SubcommandBuilderc B s# e Z d Z d Z d Z d Z RS( s
Use this builder for commands that have sub-commands. twisted.python.usage
has the notion of sub-commands that are defined using an entirely seperate
Options class.
c C sd | j j d | j f | j j d d d l m } | j | j } x. | D]& } | j j d | j | j f qS W| j j d d g | j j
_ t | j | j | j } | j | j j d | j
f | j | j } x] | D]U } | j j | j d t | j | j | j } | j | j j d
q W| j j d d S(
sf
Write the completion function to the file given to __init__
@return: C{None}
s #compdef %s
s. local _zsh_subcmds_array
_zsh_subcmds_array=(
i( t plugins "%s:%s"
s )
s *::subcmd:->subcmds if (( CURRENT == 1 )); then
_describe "%s" _zsh_subcmds_array && ret=0
fi
(( ret )) || return 0
service="$words[1]"
case $service in
s )
s ;;
s8 *) _message "don't know how to complete $service";;
esacN( R R R t twistedR" t
getPluginst interfacet tapnamet descriptionR t __class__t
zsh_extrasR t subcmdLabel( R t newplugint pluginst pR ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR s&
$
N( R R R R R% R* R ( ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR! s t MktapBuilderc B s e Z d Z e Z d Z RS( s'
Builder for the mktap command
s tap to build( R R R R R% R* ( ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR. s t
TwistdBuilderc B s e Z d Z e Z d Z RS( s(
Builder for the twistd command
s service to run( R R R R R% R* ( ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR/ s R c B s e Z d Z d Z d Z d Z d Z d Z d Z d Z e
d Z d Z d
Z
d Z d Z d
Z d Z d Z RS( sq
Generate a call to the zsh _arguments completion function
based on data in a usage.Options subclass
c
C so | | _ | | _ | | _ i | _ i | _ g | _ g | _ i | _ g | _ t j
} t j } | | j d | j | | j d | j | | j d | j | | j d | j | | j d | j | | j d | j g } g } | | j d | | | j d | xE t
| D]7 \ } } t | d k r&t j d | | | <q&q&WxE t
| D]7 \ } } t | d
k rnt j d
| | | <qnqnW| | _ | | _ i }
x | D] } | d |
| d <qW|
| _ i } x | D] } | d | | d <qW| | _ i } | j |
| j | | | _ | j | j | j | _ d
S( s[
@type cmd_name: C{str}
@param cmd_name: The name of the command
@type options: C{twisted.usage.Options}
@param options: The C{twisted.usage.Options} instance defined
for this command
@type file: C{file}
@param file: The C{file} to write the completion function to
t zsh_altArgDescrt zsh_actionDescrt zsh_multiUset zsh_mutuallyExclusivet zsh_actionsR) R R i i i i N( R R R t altArgDescrt actionDescrt multiUset mutuallyExclusivet actionst extrasR t accumulateClassListt accumulateClassDictR( t enumeratet lenR t padToR t optParamst optParams_dt
optFlags_dt updatet optAll_dt addAdditionalOptionst verifyZshNamest makeExcludesDictt excludes(
R R R R t aCLt aCDR R@ R t optListRA RB RD ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR sZ
c C s, | j | j | j | j d S( sf
Write the zsh completion code to the file given to __init__
@return: C{None}
N( t writeHeadert writeExtrast writeOptionst writeFooter( R ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR _ s
c C s | j j d d S( s^
This is the start of the code that calls _arguments
@return: C{None}
s _arguments -s -A "-*" \
N( R R ( R ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRL j s c C s; | j j } | j x | D] } | j | q Wd S( s]
Write out zsh code for each option in this command
@return: C{None}
N( RD t keyst sortt writeOpt( R t optNamest longname( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRN r s
c C s> x7 | j D], } | j j t | | j j d q
Wd S( s
Write out the "extras" list. These are just passed verbatim to the
_arguments call
@return: C{None}
s \
N( R: R R t escape( R t s( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRM } s c C s | j j d d S( sj
Write the last bit of code that finishes the call to _arguments
@return: C{None}
s && return 0
N( R R ( R ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRO s c s f d } xH t j j j j j D]" } | j k r4 | | q4 q4 Wx> j D]3 } x* | D]" } | j k rq | | qq qq Wqd Wd S( s
Ensure that none of the names given in zsh_* variables are typoed
@return: C{None}
@raise ValueError: Raised if unknown option names have been given in
zsh_* variables
c s t d | j f d S( NsQ Unknown option name "%s" found while
examining zsh_ attributes for the %s command( t
ValueErrorR ( t name( R ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt err s N( t itertoolst chainR5 R6 R9 R7 RD R8 ( R RY RX t seq( ( R s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRF s
c C s | | j k r | j | } n g } | | j k r | t k ro | j | } | d k r| | j | q| q | j | n | s d Sg } xE | D]= } t | d k r | j d | q | j d | q Wd d j | S( s
Generate an "exclusion string" for the given option
@type longname: C{str}
@param longname: The long name of the option
(i.e. "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 correspondes to
the given long opt
@return: The generated C{str}
R i t -s --s (%s)t N( RH R7 t Falset getShortOptionR t appendR> t join( R RT t
buildShortt
exclusionst shortt stringst optName( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt
excludeStr s"
c C s) i } x] t j | j | j D]C } y) | d d k rM | d | | d <n Wq t k
ra q Xq Wi } x | j D] } x t | D] \ } } g } | j | | | j | | d x/ | D]& } | | k r | j | | q q W| | k r| | j | q | | | <q Wqv W| S( s
@return: A C{dict} that maps each option name appearing in
self.mutuallyExclusive to a list of those option names that
is it mutually exclusive with (can't appear on the cmd line with)
i i N(
RZ R[ R@ R R t
IndexErrorR8 R= t extendRa ( R t longToShortRK RH t lstR RT t tmpRX ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRG s(
c C s | | j k r d | } n
d | } | j | } | d k rN d | } n d } | j | } | j d d } | j d d } d | } | | j k r | j | } n | } | j | } | | j k r d
} n d } | j | }
| rI| j | d t } | j
j t d | | | | | f | j
j d
n | j
j t d |
| | | | f | j
j d
d S( s
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 name of the option
(i.e. "verbose" instead of "v")
@return: C{None}
s --%ss --%s=R] R t [s \[t ]s \]s [%s]t *Rc s
%s%s%s%s%ss \
N(
RB R` R t getDescriptiont replaceR6 t getActionR7 Rh t TrueR R RU ( R RT t
long_fieldRe t short_fieldt descrt descr_fieldt actionDescr_fieldt action_fieldt multi_fieldt longExclusions_fieldt shortExclusions_field( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRR s6
c C s} | | j k rY t | j | r5 | j | } n
| j | } d | j | | f S| | j k ry d | j | Sd S( s]
Return a zsh "action" string for the given argument
@return: C{str}
s :%s:%ss
:%s:_filesR ( R9 t callablet getActionDescrRA ( R RT t action( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRs ) s
c C s" | | j k r | j | S| Sd S( sk
Return the description to be used when this argument is completed
@return: C{str}
N( R6 ( R RT ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR 9 s c C s | | j k r | j | Sy | j | d } Wn@ t k
rq y | j | d } Wqr t k
rm d } qr Xn X| d k r | S| j d d } t | j d | d } | r t | } | d k r | Sn | S( s]
Return the description to be used for this argument
@return: C{str}
i i R] t _s opt_%sN( R5 RB t KeyErrorRA R Rr t getattrR t descrFromDoc( R RT Rw t longMangledt obj( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRq D s$
c C s7 | j | } y | d p d SWn t k
r2 n Xd S( s[
Return the short option letter or None
@return: C{str} or C{None}
i N( RD R Ri ( R RT RK ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR` d s
c
C s i } t j | j | d i } x> | j D]0 } t | d k r/ | | | | <| | =q/ q/ Wx6| j D](\ } } | j d d } | | j k r qp n | j | } d } | | k r | | } n | j
j j } | d k r7| j
j | | d | g | d | g | j | <| d | g | j | <qp | d k r| j j | | | g | | g | j | <| d | g | j | <qp t d | f qp Wd S( s
Add additional options to the optFlags and optParams lists.
These will be defined by 'opt_foo' methods of the Options subclass
@return: C{None}
t opt_i R R] i s %r has wrong number of argumentsN( R t accumulateMethodsR t copyR> t itemsRr RD Rq R t im_funct func_codet co_argcountR@ Ra RA R RB t TypeError(
R t methodsDictt
methodToShortRX t
methodNamet methodObjRT Rw Re t reqArgs( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRE p s4
( R R R R R RL RN RM RO RF R_ Rh RG RR Rs R Rq R` RE ( ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR s L , ! 5 c C s | j d k r d S| j j d } d } yl | d d k rb | d j rb | d j } n4 | d d k r | d j r | d j } n Wn t k
r n X| S( sP
Generate an appropriate description from docstring of the given object
s
i R i N( R R t splitt isspacet lstripRi ( R t linesRw ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR s !!
c C s4 y | j d } | | SWn t k
r/ | SXd S( s3
Return the first line of the given string
s
N( t indexRW ( RV R ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt firstLine s
c C s t j | d S( s'
Shell escape the given string
i ( t commandst mkarg( t str( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyRU s c C s= y/ d } t j | } t j j | r. | SWn n Xd S( so
Return the path to the system-wide site-functions directory or
C{None} if it cannot be determined
s/ zsh -f -c 'echo ${(M)fpath:#/*/site-functions}'N( R t getoutputR R
R ( t cmdt output( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt siteFunctionsPath s t conchs twisted.conch.scripts.concht
ClientOptionst mktaps twisted.scripts.mktapt FirstPassOptionst trials twisted.scripts.trialt Optionst cftps twisted.conch.scripts.cftpt
tapconverts twisted.scripts.tapconvertt ConvertOptionst twistds twisted.scripts.twistdt
ServerOptionst ckeygens twisted.conch.scripts.ckeygent GeneralOptionst lores twisted.lore.scripts.loret
pyhtmlizers twisted.scripts.htmlizert tap2debs twisted.scripts.tap2debt tkconchs twisted.conch.scripts.tkconcht manholes twisted.scripts.manholet tap2rpms twisted.scripts.tap2rpmc C s g } x | D] \ } } } | d k rG t | | } | j q
n y t d | f d d | } t | | } t | | } | | k r | | | | | }
|
j n t | | | }
|
j Wq
t k
r } | j | | f q
q
Xq
W| S( sN
Generate completion function files in the given directory for all
twisted commands
@type out_path: C{str}
@param out_path: The path to the directory to generate completion function
fils in
@param generateFor: Sequence in the form of the 'generateFor' top-level
variable as defined in this module. Indicates what
commands to build completion files for.
@param specialBuilders: Sequence in the form of the 'specialBuilders'
top-level variable as defined in this module.
Indicates what commands require a special
Builder class.
@return: C{list} of 2-tuples of the form (cmd_name, error) indicating
commands that we skipped building completions for. cmd_name
is the name of the skipped command, and error is the Exception
that was raised when trying to import the script module.
Commands are usually skipped due to a missing dependency,
e.g. Tkinter.
s %sN( R t _openCmdFilet closet
__import__R R R t ExceptionRa ( t out_patht generateFort specialBuilderst skipsR t module_namet
class_namet ft mt ot bt e( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt makeCompFunctionFiles s&
c C s t t j j | d | d S( NR t w( R R R
Rb ( R R ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyR s c C s t } y | j t j d Wn3 t j k
rV } | GH| j GHt j d n X| d r d d l } t j
j t j
j | j
d d } t | } n t | d } xE | D]= \ } } t j j d | f t j j t | d q W| rt j d
n d S( Ni i R it pythont zshR sG zshcomp: Skipped building for %s. Script module could not be imported:
s
i ( R t parseOptionst syst argvR R t getUsaget exitR# R R
Rb t dirnamet __file__R t stderrR R ( R R R# t dirR R t error( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt run s$
' t __main__( R t warningst warnt DeprecationWarningRZ R R t os.pathR t twisted.pythonR R R t twisted.application.serviceR R R R R! R. R/ R R R RU R R R R R R R ( ( ( s: /usr/lib/python2.7/dist-packages/twisted/python/zshcomp.pyt <module> sN
0 0
2