Your IP : 216.73.216.213
B
�d{T�+ � @ s� d Z ddlmZ dZddlZddlZddlmZ ddlm Z ddl
m Z m Z ddl
mZ G d d
� d
e�ZG d d � d e�ZG d
d� de�ZG dd� de �ZG dd� de�Ze� ZdZed�dd� �Zed�d dd��Zed�d dd ��ZdS ) z�Helper functions to support command line tools providing more than
one command.
e.g called as "tool command [options] args..." where <options> and <args> are
command'specific
� )�print_functionzrestructuredtext enN)�basename)�
Configuration)�init_log�
get_threshold)�
deprecatedc @ s e Zd ZdZdS )�BadCommandUsagez�Raised when an unknown command is used or when a command is not
correctly used (bad options, too much / missing arguments...).
Trigger display of command usage.
N)�__name__�
__module__� __qualname__�__doc__� r
r
�J/opt/alt/python37/lib/python3.7/site-packages/logilab/common/clcommands.pyr & s r c @ s e Zd ZdZdS )� CommandErrorz|Raised when a command can't be processed and we want to display it and
exit, without traceback nor usage displayed.
N)r r
r r r
r
r
r r - s r c @ s` e Zd ZdZdddddejdfdd�Zddd�Zd d
� Zdd d �Z dd
d�Z
dd� Z dd� Z dS )� CommandLineaF Usage:
>>> LDI = cli.CommandLine('ldi', doc='Logilab debian installer',
version=version, rcfile=RCFILE)
>>> LDI.register(MyCommandClass)
>>> LDI.register(MyOtherCommandClass)
>>> LDI.run(sys.argv[1:])
Arguments:
* `pgm`, the program name, default to `basename(sys.argv[0])`
* `doc`, a short description of the command line tool
* `copyright`, additional doc string that will be appended to the generated
doc
* `version`, version number of string of the tool. If specified, global
--version option will be available.
* `rcfile`, path to a configuration file. If specified, global --C/--rc-file
option will be available? self.rcfile = rcfile
* `logger`, logger to propagate to commands, default to
`logging.getLogger(self.pgm))`
NTc C sJ |d krt tjd �}|| _|| _|| _|| _|| _d | _|| _ || _
d S )Nr ) r �sys�argv�pgm�doc� copyright�version�rcfile�logger� logthreshold�check_duplicated_command)�selfr r r r r r r r
r
r �__init__P s zCommandLine.__init__Fc C s0 | j r"|s"|j| ks"td|j ��|| |j< |S )z,register the given :class:`Command` subclassz a command %s is already defined)r �name�AssertionError)r �cls�forcer
r
r �register^ s
zCommandLine.registerc
C s� t d| jdd� y|�d�}W n tk
r< | �d� Y nX |dkrP| �d� | jdk rv|dkrvt| j� t�d� | j }|dk r�|d kr�y|�d�}|�d�}W n tk
r� | �d� Y nX y| �
|�}W n2 t k
�r td
| � t� | �d� Y nX yt�|� ||�� W n� t
k
�rv } z:td d d
� t|��rVtd| d d
� t� t�d� W dd}~X Y nJ tk
�r� } z*td|� t� t|�� � t�d� W dd}~X Y nX dS )z�main command line access point:
* init logging
* handle global options (-h/--help, --version, -C/--rc-file)
* check command
* run command
Terminate by :exc:`SystemExit`
Tz%(levelname)s: %(message)s)�debugr Z logformatr � )z-hz--helpNz --version)z-Cz --rc-filezERROR: no %s commandZ Interrupted� )�endz: %s� zERROR:)r r �pop�
IndexError�usage_and_exitr �printr �exitr � get_command�KeyError�main_run�KeyboardInterrupt�strr �help)r �args�argr �command�exc�errr
r
r �rune sL
zCommandLine.runc C s4 t �| j�}|g|_|d kr&t| j�}|�|� |S )N)�logging�Loggerr �handlersr r �setLevel)r �handlerr r r
r
r �
create_logger� s
zCommandLine.create_loggerc C sD |d kr| j }|d kr8t�| j� }| _ |�t| j�� | | |�S )N)r r8 � getLoggerr r; r r )r �cmdr r
r
r r, � s zCommandLine.get_commandc C s� t d| jdd� | jr"t ddd� t d� | jr>t d| j � t d| j � tdd � | D ��}d| }x:t| �� �D ]*\}}|jstt d|| d
|� |� � � qtW | jr�t d | j � t d | j � | j
r�t d
| j � | j r�t d| j � d
S )z\display usage for the main program (i.e. when no command supplied)
and exit
zusage:r$ )r% z [--rc-file=<configuration file>]z)<command> [options] <command argument>...z
%szi
Type "%(pgm)s <command> --help" for more information about a specific
command. Available commands are :
c S s g | ] }t |��qS r
)�len)�.0r? r
r
r �
<listcomp>� s z%CommandLine.usage.<locals>.<listcomp>Nz�
Use --rc-file=<configuration file> / -C <configuration file> before the command
to specify a configuration file. Default to %s.
z?%(pgm)s -h/--help
display this usage information and exitzA%(pgm)s -v/--version
display version configuration and exit�
) r* r r r �__dict__�max�sorted�items�hidden�short_descriptionr r )r Zmax_len�paddingZcmdnamer? r
r
r �usage� s. zCommandLine.usagec C s | � � t�|� d S )N)rK r r+ )r �statusr
r
r r) � s zCommandLine.usage_and_exit)F)N)N)
r r
r r r8 �ERRORr r! r7 r= r, rK r) r
r
r
r r 5 s
0
r c @ s^ e Zd ZdZdZdZdZdZdZe dd� �Z
e dd� �Z d d
� Z d d � Z
dd
d�Zdd� ZdS )�Commanda� Base class for command line commands.
Class attributes:
* `name`, the name of the command
* `min_args`, minimum number of arguments, None if unspecified
* `max_args`, maximum number of arguments, None if unspecified
* `arguments`, string describing arguments, used in command usage
* `hidden`, boolean flag telling if the command should be hidden, e.g. does
not appear in help's commands list
* `options`, options list, as allowed by :mod:configuration
� FNc C s | j �dd�S )Nz rO )r �replace)r r
r
r � description� s zCommand.descriptionc C s | � � �d�d S )N�.r )rQ �split)r r
r
r rI � s zCommand.short_descriptionc C s. d| j | j| �� f }tj| |d� || _d S )Nz%%prog %s %s
%s)rK )r � argumentsrQ r r r )r r rK r
r
r r � s
zCommand.__init__c C sD | j dk r t|�| j k r td��| jdk r@t|�| jkr@td��dS )z&check command's arguments are providedNzmissing argumentztoo many arguments)�min_argsr@ r �max_args)r r2 r
r
r �
check_args� s zCommand.check_argsc
C sd |r| � |� | �|�}y| �|� | �|� W n. tk
r^ } z| j�|� dS d}~X Y nX dS )a Run the command and return status 0 if everything went fine.
If :exc:`CommandError` is raised by the underlying command, simply log
the error and return status 2.
Any other exceptions, including :exc:`BadCommandUsage` will be
propagated.
� Nr )Zload_file_configurationZ load_command_line_configurationrW r7 r r �error)r r2 r r6 r
r
r r. � s
zCommand.main_runc C s
t � �dS )z+run the command with its specific argumentsN)�NotImplementedError)r r2 r
r
r r7 s z Command.run)N)r r
r r rT r rH rU rV � classmethodrQ rI r rW r. r7 r
r
r
r rN � s
rN c @ s$ e Zd ZdZdZdZdZdd� ZdS )�ListCommandsCommandz4list available commands, useful for bash completion.Z listcommandsz [command]Tc C sr |r>|� � }t| }xX|jD ] \}}td� td| � q W n0tt�� �}x"|D ]}t| }|jsPt|� qPW dS )z+run the command with its specific argumentsz--helpz--N)r' � _COMMANDS�optionsr* rF �keysrH )r r2 r4 r? �optname�optdict�commandsr
r
r r7 s
zListCommandsCommand.runN)r r
r r r rT rH r7 r
r
r
r r\ s
r\ z~Copyright (c) 2004-2011 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
http://www.logilab.fr/ -- mailto:contact@logilab.frzuse cls.register(cli)c C s x| D ]}t �|� qW dS )zregister existing commandsN)r] r! )rb Z
command_klassr
r
r �register_commands2 s
rc zuse args.pop(0)c C s |t _|t _|t _t �| � dS )z�command line tool: run command specified by argument list (without the
program name). Raise SystemExit with status 0 if everything went fine.
>>> main_run(sys.argv[1:])
N)r] r r r r7 )r2 r r r r
r
r r. 8 s r. �Missing argumentc C sL y| � d�}W n tk
r* t|��Y nX |dk rHt| �|krHtd��|S )z7helper function to get and check command line argumentsr Nztoo many arguments)r' r( r r@ )Z args_listZexpected_size_after�msg�valuer
r
r �pop_argD s rg )NNN)Nrd )r �
__future__r �
__docformat__r r8 �os.pathr Z logilab.common.configurationr Zlogilab.common.logging_extr r Zlogilab.common.deprecationr � Exceptionr r �dictr rN r\ r] ZDEFAULT_COPYRIGHTrc r. rg r
r
r
r �<module> s* I