← Back
Editing: usage.cpython-38.pyc
U s�@g � @ s� d Z ddlmZ ddlmZmZ ddlZddlZddlZddlZddlm Z ddl Z ddl m Z m Z ddlmZ G dd � d e�ZeZG d d � d e�ZG d d � d e�ZdZdZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�Z G dd� de�Z G dd� de�Z G d d � d e�Z G d d � d e�Z G d d!� d!e�Z!G d"d#� d#e�Z"G d$d%� d%e�Z#d.d'd(�Z$d/d)d*�Z%d+d,� Z&d-e&_'dS )0a 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. � )�print_function)�division�absolute_importN)�path)�reflect�util)�_PY3c @ s e Zd ZdS )� UsageErrorN)�__name__� __module__� __qualname__� r r �6/usr/lib/python3/dist-packages/twisted/python/usage.pyr s r c @ s 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)�options�coerce�getattr�doc)�selfr r r r r �__init__) s zCoerceParameter.__init__c C sf |dkrt d|f ��z| �|�}W n0 tk rT } zt d|f ��W 5 d}~X Y nX || jj|< dS )zj When called in dispatch, do the coerce for C{value} and save the returned value. Nz$Parameter '%s' requires an argument.z%Parameter type enforcement failed: %s)r r � ValueErrorr �opts)r Z parameterName�value�er r r �dispatch2 s � zCoerceParameter.dispatchN)r r r �__doc__r r r r r r r % s r c s� e Zd ZdZdZdZdZdZej Z � fdd�Z e j Z dd� Zdd� Zd d d �Zd d � Zd d� Zd dd�Zdd� Zdd� Zdd� Zdd� Zdd� Zd dd �Z� ZS ) �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{"<program> 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. Nc s� t t| ��� | | _i | _g | _d| _i | _i | _i | _ | j | j | j g}|D ]j}|� \}}}}}}| j� |� | j| | _| j�|� | j�|� | j�|� | j�|� | j �|� qLd S )Nr )�superr r r �defaults�longOpt�shortOpt�docs�synonyms� _dispatch� _gather_flags�_gather_parameters�_gather_handlers�extend�update) r Z collectors�cr! r" r# �settingsr$ r �� __class__r r r � s* � zOptions.__init__c C s t | �� � t�d� dS )z- Display this help and exit. r N)�print�__str__�sys�exit�r r r r �opt_help� s zOptions.opt_helpc C s& ddl m} td|j� t�d� dS )z3 Display Twisted version and exit. r )� copyrightzTwisted version:N)Ztwistedr5 r/ �versionr1 r2 )r r5 r r r � opt_version� s zOptions.opt_versionc C s: |dkrt jdd� }t|�dkrf|d dkrfddlm} t�t jd �}|�| ||| j� t � d� zt � || j | j �\}}W n0 t j k r� } ztt|���W 5 d}~X Y nX |D ]�\}}|d dkr�|dd� }n |dd� }|} | | jk�r|�dd �} | | jk�rtd |f ��| j| } t| j| t��rJ| j| �| |� q�| j| | |� q�t| d d��r |�s|| jdk �r |�s�| jg}|d |dd� } } | jD ]J\} } }}| | k�s�| | k�r�| | _|� | _| | j_| j� | � �q.�q�td | ��n.z| j |� W n t k �r, td ��Y nX | � � dS )z6 The guts of the command-line parser. N� ���z--_shell-completionr )� _shellcomp�-� �_zNo such option '%s'� subCommandszUnknown command: %szWrong number of arguments.) r1 �argv�len�twisted.pythonr: r �basenameZ shellComplete�_shellCompFiler2 �getoptr" r! �errorr �strr$ �replace� isinstancer% r r r �defaultSubCommandr> � subCommand� subOptions�parent� parseOptions� parseArgs� TypeError� postOptions)r r r: ZcmdNamer �argsr �opt�argZ optMangled�sub�rest�cmd�short�parserr r r r rM � sd � � �� zOptions.parseOptionsc C s 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 r3 r r r rP s zOptions.postOptionsc C s dS )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 r3 r r r rN s zOptions.parseArgsc C s& |dkrt d||f ��d| j|< d S )N)r Nz+Flag '%s' takes no argument. Not even "%s".r8 )r r )r ZflagNamer r r r � _generic_flag/ s �zOptions._generic_flagc C s� g d }}i i i i f\}}}}g }t �| jd|� |D ]b}t�d|�\} } } | sXtd��| || < d|| < | r||| }| || < |�| � | || < | j|| < q6||||||fS )z3 Gather up boolean (flag) options. r ZoptFlags� z A flag cannot be without a name.r )r �accumulateClassListr. r �padTor �appendrY ) r r! r" r# r, r$ r �flags�flag�longrW r r r r r& 6 s" zOptions._gather_flagsc C s� g d }}i i i i f\}}}}g }t �| jd|� i }|D ]�}t�d|�\} } } } } | s`td��| || < | || < | r�|| d }| || < |�| d � | || < | dk r�t| | �|| < q:t| t�|| < q:||||||fS )z4 Gather options which take a value. r Z optParameters� z%A parameter cannot be without a name.�:�=N) r r[ r. r r\ r r] r rF )r r! r" r# r, r$ r � parameters� parameterr` rW �defaultr Z paramTyper r r r' Q s, � zOptions._gather_parametersc C s� g d }}i i i i f\}}}}i }t �| j|d� t|�� �D ]�}t| d| �} t| |� } |�dd�} t| dd�} | r�| || < n| j� | �|| < | || < | r�| fdd�} nd| fd d�} | || < t |�d kr�|| }| r�|d }q>| r�| d } |� | � q>i }|�� D ]<}t| d| �} | |k�r,g || < || � |�dd�� �q|� � D ]<\} }t |�d k �rh�qNt |t d�}|D ]}|||< �qx�qN||||||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 Zopt_r= r; r Nc S s ||�S �Nr ��namer �mr r r �<lambda>� � z*Options._gather_handlers.<locals>.<lambda>c S s |� S rg r rh r r r rk � rl r8 rb rc r< ��key)r ZaddMethodNamesToDictr. �sorted�keysr � flagFunctionrG r# �getr@ r] �items�max)r r! r" r# r, r$ r Zdctri �methodZtakesArgZ prettyNamer �fnZ reverse_dct�namesZlongestr r r r( s sJ zOptions._gather_handlersc C s | � � d | jd d� S )N� ��width)� getSynopsis�getUsager3 r r r r0 � s zOptions.__str__c C s� t �tjd �}|�d�r8d�tj�tj �|� dd��}| j dkrZd|| j rPdpRdf }nd| j rfd phd }t | d |�}|�� }| j dk r�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: %s%sz [options]z%sz [options]�synopsis� )r ZfilenameToModuleNamer1 r? �endswith�format�osr rB � executablerG rL r! r �rstrip�joinr{ rJ )r ZexecutableNamerf r} r r r r{ � s � �zOptions.getSynopsisc C s� t | d�r| jj|d�S |s.ttj�dd��}t | d�r�g }| jD ]"\}}}}|�|||dd d�� qBt ||�}dd � |� }nd }i } | j � � D ]<\} } | } | | kr�t | �d kr�| | | < q�| | kr�d | | < q�q�g } | jD ]\}|d d kr�d }|d d � }nd}| �|| | | j| || j�|d �| j�|d �d�� q�t| dd �d k �rR| j}n"dd l}t|dd ��rp|j}nd }|�r�dd� t�||���� d }| �r�t | |�}dd � |� }nd}|| | S )NrK ry ZCOLUMNSZ80r> �command)r` rW r �optTyperf z Commands: r r8 ���rc re r_ )r` rW r r� rf r �longdescr r rx z Options: %szOptions: None )�hasattrrK r| �intr� �environrr r> r] � docMakeChunksr� r$ rs r@ r! r# r r% r r� �__main__r �textwrap�wrap�strip)r rz ZcmdDictsrV rW rX ZdescZchunksZcommandsZ longToShortrn r ZlongnameZoptDictsrR r� r� r� �sr r r r| � st �� �� �� zOptions.getUsage)N)N)N)r r r r rJ rI rL ZcompletionDatar1 �stdoutrC r �object�__hash__r4 r7 rM rP rN rY r& r' r( r0 r{ r| � __classcell__r r r- r r B s( V ! D "Kr ZzshZbashc @ s> e Zd ZdZdZd dd�Zdd� Zee�Zdd � 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. NFc C s |dk r|| _ || _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)�_descr�_repeat)r Zdescr�repeatr r r r 5 s zCompleter.__init__c C s | j r dS dS d S )N�*r )r� r3 r r r �_getRepeatFlagG s zCompleter._getRepeatFlagc C s | j d k r| j S |S d S rg )r� �r �optNamer r r � _descriptionO s zCompleter._descriptionc C s. |t kr d| j| �|�f S td|f ��dS )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} z%s:%s:�Unknown shellType %rN��_ZSH� _repeatFlagr� �NotImplementedError�r r� Z shellTyper r r � _shellCodeV s �zCompleter._shellCode)NF) r r r r r� r r� �propertyr� r� r� r r r r r� + s r� c @ s* e Zd ZdZd dd�Zdd� Zdd� Zd S ) � CompleteFilesz6 Completes file names based on a glob pattern r� c K s t j| f|� || _d S rg )r� r � _globPattern)r Z globPattern�kwr r r r n s zCompleteFiles.__init__c C s, | j d k rd| j | jf S d|| jf S d S )Nz%s (%s))r� r� r� r r r r� s s zCompleteFiles._descriptionc C s2 |t kr d| j| �|�| jf S td|f ��d S )Nz%s:%s:_files -g "%s"r� )r� r� r� r� r� r� r r r r� z s �zCompleteFiles._shellCodeN)r� )r r r r r r� r� r r r r r� j s r� c @ s e Zd ZdZdd� ZdS )� CompleteDirsz# Completes directory names c C s. |t kr d| j| �|�f S td|f ��d S )Nz%s:%s:_directoriesr� r� r� r r r r� � s �zCompleteDirs._shellCodeN�r r r r r� r r r r r� � s r� c @ s e Zd ZdZdd� Zdd� ZdS )� CompleteListz2 Completes based on a fixed list of words c K s t j| f|� || _d S rg �r� r �_items�r rs r� r r r r � s zCompleteList.__init__c C s8 |t kr&d| j| �|�d�| j�f S td|f ��d S )Nz %s:%s:(%s)r~ r� �r� r� r� r� r� r� r� r r r r� � s �zCompleteList._shellCodeN�r r r r r r� r r r r r� � s r� c @ s e Zd ZdZdd� Zdd� ZdS )�CompleteMultiListzQ Completes multiple comma-separated items based on a fixed list of words c K s t j| f|� || _d S rg r� r� r r r r � s zCompleteMultiList.__init__c C s@ |t kr.d| j| �|�| �|�d�| j�f S td|f ��d S )Nz%s:%s:_values -s , '%s' %sr~ r� r� r� r r r r� � s �z CompleteMultiList._shellCodeNr� r r r r r� � s r� c @ s e Zd ZdZdd� ZdS )�CompleteUsernamesz Complete usernames c C s. |t kr d| j| �|�f S td|f ��d S )Nz %s:%s:_usersr� r� r� r r r r� � s �z CompleteUsernames._shellCodeNr� r r r r r� � s r� c @ s e Zd ZdZdZdd� ZdS )�CompleteGroupsz% Complete system group names �groupc C s. |t kr d| j| �|�f S td|f ��d S )Nz %s:%s:_groupsr� r� r� r r r r� � s �zCompleteGroups._shellCodeN�r r r r r� r� r r r r r� � s r� c @ s e Zd ZdZdd� ZdS )�CompleteHostnamesz Complete hostnames c C s. |t kr d| j| �|�f S td|f ��d S )Nz %s:%s:_hostsr� r� r� r r r r� � s �z CompleteHostnames._shellCodeNr� r r r r r� � s r� c @ s e Zd ZdZdZdd� ZdS )�CompleteUserAtHostz� A completion action which produces matches in any of these forms:: <username> <hostname> <username>@<hostname> zhost | user@hostc C s. |t kr d| j| �|�f S td|f ��d S )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 @ s e Zd ZdZdd� ZdS )�CompleteNetInterfacesz* Complete network interface names c C s. |t kr d| j| �|�f S td|f ��d S )Nz%s:%s:_net_interfacesr� r� r� r r r r� � s �z CompleteNetInterfaces._shellCodeNr� r r r r r� � s r� c @ s$ e Zd ZdZi g g i g fdd�ZdS )� 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 rg )� descriptions�multiUse�mutuallyExclusive� optActions� extraActions)r r� r� r� r� r� r r r r O s zCompletions.__init__N)r r r r r r r r r r� � s R �r� �P c C s� | j dd� d� d}| D ]:}t|�dd��}|r|�dd�d krH|d }t||�}q|td � }|| }d | }g }i } | D �] }|�d d�| ks||�dd�| kr�q||�d d�|�dd�fD ]} | dk r�d | | < q�g } d } |�d d�r�d|d f } nd} |�dd��rB|d }|�dd�d k�r*|d }d||f }| �rRd} nd |td� }|�dd�dk�rnd| }nd| | |f }|�dd��r�|d �� }nd}|�dd�d k�r�|�dd�dk �r�d||d f }|�dd�d k�r |�dd�dk �r |d }t|t��r |j�r d||jf }|�r2t� ||�}ndg}| � d||� d�f � |D ]}| � d||f � �qT|� 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 )NrW r` )rr )�or r r rk h rl z docMakeChunks.<locals>.<lambda>rm r r` r r� Nre r8 z -s, -- r~ rW z-%crc z%-*s�,z--r� z %s z %2s%c --%s r rf z%s [default: %s]r z%s. %sz%s%s ) �sortr@ rr rt r� rH r r r� r� r] �popr� )ZoptListrz Z maxOptLenrR ZoptLenZ colWidth1Z colWidth2Z colFiller1Z optChunks�seen�xZoptLinesZcommarW r` Zcolumn1r �dZ column2_l�liner r r r� Y sp ��r� c C sv t r<tt�| �j�}|dkr.td|p(| j ��|dkrrdS n6tt�| �j�}|dkrftd|p`| j ��|dkrrdS 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}. r8 z Invalid Option function for %sFr< T) r r@ �inspectZ signaturerd r r Z getargspecrQ )ru ri ZreqArgsr r r rq � s ��rq c C s* t | �} | dk s| dkr&td| f ��| S )zO Coerce a string value to an int port number, and checks the validity. r i�� z Port number not in range: %s)r� r )r r r r � portCoerce� s r� z#Must be an int between 0 and 65535.)r� )N)(r Z __future__r r r r� r� r1 rD r r� rA r r Ztwisted.python.compatr � Exceptionr rE r� r �dictr r� Z_BASHr� r� r� r� r� r� r� r� r� r� r� r� rq r� r r r r r �<module> sD i? ] a '
Save File
Cancel