/usr/lib/python3/dist-packages/twisted/python/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/python/__pycache__/usage.cpython-310.pyc (28635B)
o
b @ sd d Z ddlZddlZddlZddlZddlZddlmZ ddlmZm Z ddl
m Z m Z G dd de
ZeZG dd d ZG d
d d eZd Zd
ZG dd dZG dd deZG dd deZG dd deZG dd deZG dd deZG dd deZG d d d eZ G d d d eZ G d d! d!eZ G d"d# d#Z d,d%d&Z d-d'd(Z!d)d* Z"d+e"_#dS ).a
twisted.python.usage is a module for parsing/handling the
command line of your program.
For information on how to use it, see
U{http://twistedmatrix.com/projects/core/documentation/howto/options.html},
or doc/core/howto/options.xhtml in your Twisted directory.
N)path)Optionalcast)reflectutilc @ s e Zd ZdS )
UsageErrorN)__name__
__module__ __qualname__ r r 6/usr/lib/python3/dist-packages/twisted/python/usage.pyr s r c @ e Zd ZdZdd Zdd ZdS )CoerceParameterzE
Utility class that can corce a parameter before storing it.
c C s || _ || _t| jdd| _dS )zq
@param options: parent Options object
@param coerce: callable used to coerce the value.
coerceDoc N)optionscoercegetattrdoc)selfr r r r r __init__* s zCoerceParameter.__init__c
C s^ |du r t d| dz| |}W n ty& } zt d| d}~ww || jj|< dS )zj
When called in dispatch, do the coerce for C{value} and save the
returned value.
Nz Parameter 'z' requires an argument.z#Parameter type enforcement failed: )r r
ValueErrorr opts)r
parameterNamevalueer r r dispatch3 s zCoerceParameter.dispatchN)r r r
__doc__r r r r r r r % s r c s e Zd ZU dZdZee ed< dZee ed< dZ ded< dZ
e j Z
fddZejZd d
Zd d Zd#d
dZdd Zdd Zd#ddZdd Zdd Zdd Zdefd d Zdefd d Zd#d ee defd!d"Z Z S )$Optionsa5
An option list parser class
C{optFlags} and C{optParameters} are lists of available parameters
which your program can handle. The difference between the two
is the 'flags' have an on(1) or off(0) state (off by default)
whereas 'parameters' have an assigned value, with an optional
default. (Compare '--verbose' and '--verbosity=2')
optFlags is assigned a list of lists. Each list represents
a flag parameter, as so::
optFlags = [['verbose', 'v', 'Makes it tell you what it doing.'],
['quiet', 'q', 'Be vewy vewy quiet.']]
As you can see, the first item is the long option name
(prefixed with '--' on the command line), followed by the
short option name (prefixed with '-'), and the description.
The description is used for the built-in handling of the
--help switch, which prints a usage summary.
C{optParameters} is much the same, except the list also contains
a default value::
optParameters = [['outfile', 'O', 'outfile.log', 'Description...']]
A coerce function can also be specified as the last element: it will be
called with the argument and should return the value that will be stored
for the option. This function can have a C{coerceDoc} attribute which
will be appended to the documentation of the option.
subCommands is a list of 4-tuples of (command name, command shortcut,
parser class, documentation). If the first non-option argument found is
one of the given command names, an instance of the given parser class is
instantiated and given the remainder of the arguments to parse and
self.opts[command] is set to the command name. For example::
subCommands = [
['inquisition', 'inquest', InquisitionOptions,
'Perform an inquisition'],
['holyquest', 'quest', HolyQuestOptions,
'Embark upon a holy quest']
]
In this case, C{"
holyquest --horseback --for-grail"} will cause
C{HolyQuestOptions} to be instantiated and asked to parse
C{['--horseback', '--for-grail']}. Currently, only the first sub-command
is parsed, and all options following it are passed to its parser. If a
subcommand is found, the subCommand attribute is set to its name and the
subOptions attribute is set to the Option instance that parses the
remaining options. If a subcommand is not given to parseOptions,
the subCommand attribute will be None. You can also mark one of
the subCommands to be the default::
defaultSubCommand = 'holyquest'
In this case, the subCommand attribute will never be None, and
the subOptions attribute will always be set.
If you want to handle your own options, define a method named
C{opt_paramname} that takes C{(self, option)} as arguments. C{option}
will be whatever immediately follows the parameter on the
command line. Options fully supports the mapping interface, so you
can do things like C{'self["option"] = val'} in these methods.
Shell tab-completion is supported by this class, for zsh only at present.
Zsh ships with a stub file ("completion function") which, for Twisted
commands, performs tab-completion on-the-fly using the support provided
by this class. The stub file lives in our tree at
C{twisted/python/twisted-completion.zsh}, and in the Zsh tree at
C{Completion/Unix/Command/_twisted}.
Tab-completion is based upon the contents of the optFlags and optParameters
lists. And, optionally, additional metadata may be provided by assigning a
special attribute, C{compData}, which should be an instance of
C{Completions}. See that class for details of what can and should be
included - and see the howto for additional help using these features -
including how third-parties may take advantage of tab-completion for their
own commands.
Advanced functionality is covered in the howto documentation,
available at
U{http://twistedmatrix.com/projects/core/documentation/howto/options.html},
or doc/core/howto/options.xhtml in your Twisted directory.
N
subCommanddefaultSubCommandzOptional[Options]parentc s t | | _i | _g | _d| _i | _i | _i | _| j | j
| j g}|D ]5}| \}}}}}}| j | | j| | _| j
| | j
| | j
| | j
| | j
| q$d S )Nr )superr r defaultslongOptshortOptdocssynonyms _dispatch
_gather_flags_gather_parameters_gather_handlersextendupdate) r
collectorscr$ r% r& settingsr' r __class__r r r s,
zOptions.__init__c C s t | td dS )z-
Display this help and exit.
r N)print__str__sysexitr r r r opt_help s zOptions.opt_helpc C s& ddl m} td|j td dS )z3
Display Twisted version and exit.
r ) copyrightzTwisted version:N)twistedr9 r3 versionr5 r6 )r r9 r r r opt_version s zOptions.opt_versionc
C s |du r t jdd }t|dkr3|d dkr3ddlm} tt jd }|| ||| j t d z
t
|| j | j \}}W n t
j
yS } ztt|d}~ww |D ]P\}}|d dkrg|dd }n|dd }|} | | jvr|dd } | | jvrtd
| d | j| } t| j| tr| j| | | qV| j| | | qVt| d dr|s| jdur|s| jg}|d |dd }
} | jD ]!\} }
}}|
| ks|
|
kr| | _| | _| | j_| j | nqtd
|
nz| j | W n t y tdw | dS )z6
The guts of the command-line parser.
N z--_shell-completionr )
_shellcomp- _zNo such option '' subCommandszUnknown command: %szWrong number of arguments.) r5 argvlentwisted.pythonr? r basename
shellComplete_shellCompFiler6 getoptr% r$ errorr strr' replace
isinstancer( r r r r rD r
subOptionsr! parseOptions parseArgs TypeError postOptions)r r r? cmdNamer argsr optarg
optMangledsubrestcmdshortparserr r r r rQ sb
zOptions.parseOptionsc C dS )z
I am called after the options are parsed.
Override this method in your subclass to do something after
the options have been parsed and assigned, like validate that
all options are sane.
Nr r7 r r r rT zOptions.postOptionsc C r_ )a
I am called with any leftover arguments which were not options.
Override me to do something with the remaining arguments on
the command line, those which were not flags or options. e.g.
interpret them as a list of files to operate on.
Note that if there more arguments on the command line
than this method accepts, parseArgs will blow up with
a getopt.error. This means if you don't override me,
parseArgs will blow up if I am passed any arguments at
all!
Nr r7 r r r rR " r` zOptions.parseArgsc C s& |dvr t d||f d| j|< d S )N)r Nz+Flag '%s' takes no argument. Not even "%s".r= )r r )r flagNamer r r r
_generic_flag1 s
zOptions._generic_flagc C s g d}}i i i i f\}}}}g }t | jd| |D ]1}td|\} }
} | s,td| || < d|| < |
r>||
}| ||
< || | || < | j|| < q||||||fS )z3
Gather up boolean (flag) options.
r optFlags z A flag cannot be without a name.r )r accumulateClassListr2 r padTor appendrb ) r r$ r% r& r0 r' r flagsflaglongr] r r r r r) 9 s"
zOptions._gather_flagsc C s g d}}i i i i f\}}}}g }t | jd| i }|D ]E}td|\} }
} } }
| s0td| || < | || < |
rD||
d }| ||
< || d | || < |
dur[t| |
|| < q t| t|| < q ||||||fS )z4
Gather options which take a value.
r
optParameters z%A parameter cannot be without a name.:=N) r re r2 r rf r rg r rM )r r$ r% r& r0 r' r
parameters parameterrj r] defaultr paramTyper r r r* T s(
zOptions._gather_parametersc C s g d}}i i i i f\}}}}i }t | j|d | D ]^}t| d| } t| | }
|dd} t| dd} | r?| || < n| j| || < | || < |
rT| fdd}
nd| fd d}
|
|| < t |d
krp|| }|
ro|d }q |
rv| d } |
| q i }| D ] }t| d| } | |vrg || < ||
|dd q| D ]\} }t |d
k rqt |t d}|D ]}|||< qq||||||fS )a
Gather up options with their own handler methods.
This returns a tuple of many values. Amongst those values is a
synonyms dictionary, mapping all of the possible aliases (C{str})
for an option to the longest spelling of that option's name
C({str}).
Another element is a dispatch dictionary, mapping each user-facing
option name (with - substituted for _) to a callable to handle that
option.
r opt_rB r@ r Nc S s ||S Nr namer mr r r s z*Options._gather_handlers..c S s | S rt r ru r r r rx s r= rm rn rA key)
r addMethodNamesToDictr2 keysr flagFunctionrN r& getrF rg itemsmax)r r$ r% r& r0 r' r dctrv methodtakesArg
prettyNamer fn reverse_dctnameslongestr r r r+ t sN
zOptions._gather_handlersreturnc C s | d | jd d S )N
width) getSynopsisgetUsager7 r r r r4 s zOptions.__str__c C s t tjd }|dr dtjtj |
dd}| j du r-d|| j r)dp*d}n d| j r3d p4d }t
tt| d
|}| }| j dur]| j jdusPJ d | j | j j|f}|S ) z
Returns a string containing a description of these options and how to
pass them to the executed file.
r z .__main__z{} -m {}r Nz Usage: {}{}z
[options]z%sz [options]synopsis )r filenameToModuleNamer5 rE endswithformatosr rH
executablerN r! r$ r rM r rstripr joinr )r executableNamerq r r r r r s(
zOptions.getSynopsisr c C s t | drtt| jj|dS |sttjdd}t | drCg }| j D ]\}}}}|
|||dd d q$t ||}dd | }nd }i } | j
D ] \}
} | } |
| krat|
d
kra|
| | < qL| | vrjd | | < qL qLg }
| jD ].}|d d krd
}|d d }nd}|
|| | | j| || j|d | j|d d qqt| dd d urtt| j}ndd l}t|dd r|j}nd }|rdd t|| d }|
rt |
|}dd | }nd}|| | S )NrP r COLUMNS80rD command)rj r] r optTyperq z
Commands:
r r= rn rp ri )rj r] r r rq r longdescr r r z Options:
%szOptions: None
) hasattrr r rP r intr environr~ rD rg
docMakeChunksr r' r rF r$ r& r# r( r rM r __main__r textwrapwrapstrip)r r cmdDictsr\ r] r^ descchunkscommands longToShortrz r longnameoptDictsrW r r r sr r r r sl
zOptions.getUsagert ) r r r
r r r rM __annotations__r r! completionDatar5 stdoutrJ r object__hash__r8 r< rQ rT rR rb r) r* r+ r4 r r r
__classcell__r r r1 r r B s*
V "
D
J r zshbashc @ sH e Zd ZU dZdZee ed< d
ddZe dd Z
d d
Z d d Z dS ) CompleteraQ
A completion "action" - provides completion possibilities for a particular
command-line option. For example we might provide the user a fixed list of
choices, or files/dirs according to a glob.
This class produces no completion matches itself - see the various
subclasses for specific completion functionality.
N_descrFc C s |dur|| _ || _dS )a"
@type descr: C{str}
@param descr: An optional descriptive string displayed above matches.
@type repeat: C{bool}
@param repeat: A flag, defaulting to False, indicating whether this
C{Completer} should repeat - that is, be used to complete more
than one command-line word. This may ONLY be set to True for
actions in the C{extraActions} keyword argument to C{Completions}.
And ONLY if it is the LAST (or only) action in the C{extraActions}
list.
N)r _repeat)r descrrepeatr r r r > s
zCompleter.__init__c C s | j rdS dS )N*r )r r7 r r r _repeatFlagO s zCompleter._repeatFlagc C s | j d ur| j S |S rt )r r optNamer r r _descriptionV s
zCompleter._descriptionc C s. |t kr| j d| | dS td|)a
Fetch a fragment of shell code representing this action which is
suitable for use by the completion system in _shellcomp.py
@type optName: C{str}
@param optName: The long name of the option this action is being
used for.
@type shellType: C{str}
@param shellType: One of the supported shell constants e.g.
C{twisted.python.usage._ZSH}
rm Unknown shellType _ZSHr r NotImplementedErrorr r shellTyper r r
_shellCode\ s
zCompleter._shellCode)NF)
r r r
r r r rM r r propertyr r r r r r r r 2 s
r c @ s* e Zd ZdZd
ddZdd Zdd Zd S )
CompleteFilesz6
Completes file names based on a glob pattern
r c K t j| fi | || _d S rt )r r _globPattern)r globPatternkwr r r r s
zCompleteFiles.__init__c C s0 | j d ur| j d| j dS | d| j dS )Nz ())r r r r r r r w s
zCompleteFiles._descriptionc C s. |t krd| j| || jS td|)Nz{}:{}:_files -g "{}"r )r r r r r r r r r r r } s zCompleteFiles._shellCodeN)r )r r r
r r r r r r r r r n s
r c @ e Zd ZdZdd ZdS ) CompleteDirsz#
Completes directory names
c C * |t krd| j| |S td|)Nz{}:{}:_directoriesr r r r r r r r r r r s
zCompleteDirs._shellCodeNr r r
r r r r r r r r c @ r
) CompleteListz2
Completes based on a fixed list of words
c K r rt r r _itemsr r r r r r r r zCompleteList.__init__c C s4 |t krd| j| |d| jS td|)Nz
{}:{}:({})r r r r r r r r r r r r r r s zCompleteList._shellCodeNr r r
r r r r r r r r r c @ r
)CompleteMultiListzQ
Completes multiple comma-separated items based on a fixed list of words
c K r rt r r r r r r r zCompleteMultiList.__init__c C s< |t krd| j| || |d| jS td|)Nz{}:{}:_values -s , '{}' {}r r r r r r r r s
z CompleteMultiList._shellCodeNr r r r r r r r c @ r )CompleteUsernamesz
Complete usernames
c C . |t kr| j d| | dS td|)Nrm z:_usersr r r r r r r z CompleteUsernames._shellCodeNr r r r r r r r c @ e Zd ZdZdZdd ZdS )CompleteGroupsz%
Complete system group names
groupc C r )Nrm z:_groupsr r r r r r r r zCompleteGroups._shellCodeNr r r
r r r r r r r r s r c @ r )CompleteHostnamesz
Complete hostnames
c C r )Nrm z:_hostsr r r r r r r r z CompleteHostnames._shellCodeNr r r r r r r r c @ r )CompleteUserAtHostz
A completion action which produces matches in any of these forms::
@
zhost | user@hostc C s* |t krd| j| |f S td|)NaY %s:%s:{_ssh;if compset -P "*@"; then _wanted hosts expl "remote host name" _ssh_hosts && ret=0 elif compset -S "@*"; then _wanted users expl "login name" _ssh_users -S "" && ret=0 else if (( $+opt_args[-l] )); then tmp=() else tmp=( "users:login name:_ssh_users -qS@" ) fi; _alternative "hosts:remote host name:_ssh_hosts" "$tmp[@]" && ret=0 fi}r r r r r r r s
z CompleteUserAtHost._shellCodeNr r r r r r s r c @ r )CompleteNetInterfacesz*
Complete network interface names
c C r )Nz{}:{}:_net_interfacesr r r r r r r s z CompleteNetInterfaces._shellCodeNr r r r r r r r c @ s$ e Zd ZdZi g g i g fddZdS ) Completionsa:
Extra metadata for the shell tab-completion system.
@type descriptions: C{dict}
@ivar descriptions: ex. C{{"foo" : "use this description for foo instead"}}
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: ex. C{ ["foo", "bar"] }
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: ex. C{ [("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.
@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. By default, all files/dirs will be completed if no
action is given. For example::
{"foo" : CompleteFiles("*.py", descr="python files"),
"bar" : CompleteList(["one", "two", "three"]),
"colors" : CompleteMultiList(["red", "green", "blue"])}
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 in the same way as the literal actions in
the example above.
As you can see in the example above. The "foo" option will have files
that end in .py 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, separated 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
Descriptions for the actions may be given with the optional C{descr}
keyword argument. This is separate from the description of the option
itself.
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'
@type extraActions: C{list}
@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. For
example::
[CompleteFiles(descr="file to read from"),
Completer(descr="book title")]
In the example above, the 1st non-option argument will be described as
"file to read from" and all file/dir names will be completed (*). The
2nd non-option argument will be described as "book title", but no
actual completion matches will be produced.
See the various C{Completer} subclasses for other types of things which
may be tab-completed (users, groups, network interfaces, etc).
Also note the C{repeat=True} flag which may be passed to any of the
C{Completer} classes. This is set to allow the C{Completer} instance
to be re-used for subsequent command-line words. See the C{Completer}
docstring for details.
c C s" || _ || _|| _|| _|| _d S rt ) descriptionsmultiUsemutuallyExclusive
optActions extraActions)r r r r r r r r r r ] s
zCompletions.__init__N)r r r
r r r r r r r s Ur P c C sz | j dd d d}| D ] }t|dd}|r)|ddd kr$|d
}t||}q |td }|| }d | }g }i } | D ]}|d
d| v sP|dd| v rQq>|d
d|ddfD ]
}
|
durgd
| |
< q]g } d } |d
drzd|d
f }
nd}
|ddr|d }|ddd kr|d }d||f }|
rd} nd |td }|dddkrd| }nd|
| |f }|ddr|d }nd}|ddd kr|dddurd||d }|ddd kr|dddur|d }t|tr|jr| d|j }|rt
||}ndg}| | | d d |D ]
}| | | d q$| d
| q>|S ) a"
Makes doc chunks for option declarations.
Takes a list of dictionaries, each of which may have one or more
of the keys 'long', 'short', 'doc', 'default', 'optType'.
Returns a list of strings.
The strings may be multiple lines,
all of them end with a newline.
c S s | dd p | dd S )Nr] rj )r~ )or r r rx { s z docMakeChunks..ry r rj r r Nrp r= z
-s, -- r r] z-%crn z%-*s,z--r z %s z %2s%c --%s r rq z{} [default: {}]r z. r )sortrF r~ r r r rO r r r r rg popr )optListr maxOptLenrW optLen colWidth1 colWidth2
colFiller1 optChunksseenxoptLinescommar] rj column1r d column2_lliner r r r l sx
r c C s: t t| j}|dkrtd|p| j |dkrdS dS )a
Determine whether a function is an optional handler for a I{flag} or an
I{option}.
A I{flag} handler takes no additional arguments. It is used to handle
command-line arguments like I{--nodaemon}.
An I{option} handler takes one argument. It is used to handle command-line
arguments like I{--path=/foo/bar}.
@param method: The bound method object to inspect.
@param name: The name of the option for which the function is a handle.
@type name: L{str}
@raise UsageError: If the method takes more than one argument.
@return: If the method is a flag handler, return C{True}. Otherwise return
C{False}.
r= z Invalid Option function for %sFT)rF inspect signaturero r r )r rv reqArgsr r r r} s r} c C s* t | } | dk s | dkrtd| | S )zO
Coerce a string value to an int port number, and checks the validity.
r i zPort number not in range: )r r )r r r r
portCoerce s r z#Must be an int between 0 and 65535.)r rt )$r rK r r r5 r r typingr r rG r r Exceptionr rL r dictr r _BASHr r r r r r r r r r r r r} r r r r r r sB
o<
c
b