File: //usr/lib/python3/dist-packages/twisted/python/test/__pycache__/test_shellcomp.cpython-38.pyc
U
W[1U � @ sT d Z ddlmZmZ ddlZddlmZ ddlmZ ddl m
Z
m Z m Z ddl
mZmZmZ ddl
mZ G d d
� d
e�ZG d d � d e�Zd
d� ZG dd� dej�ZG dd� dej�ZG dd� dej�ZG dd� de j�Z G dd� de j�Z G dd� de �Z dd � Z G d d � d e j�Z G d d � d e j�Z!G d!d"� d"e j�Z"G d#d$� d$e �Z#d%Z$d&Z%dS )'z*
Test cases for twisted.python._shellcomp
� )�division�absolute_importN)�BytesIO)�unittest)�
_shellcomp�usage�reflect)� Completions� Completer�
CompleteFiles�� CompleteListc @ s e Zd ZdZdd� ZdS )�ZshScriptTestMetaz*
Metaclass of ZshScriptTestMixin.
c C sH dd� }d|kr8|d D ] \}}|||�}||d| < qt �| |||�S )Nc s � �fdd�}|S )Nc s t | � ��S )N)�test_genZshFunction��self��cmdName� optionsFQPN� �D/usr/lib/python3/dist-packages/twisted/python/test/test_shellcomp.py�runTest s z<ZshScriptTestMeta.__new__.<locals>.makeTest.<locals>.runTestr )r r r r r r �makeTest s z+ZshScriptTestMeta.__new__.<locals>.makeTestZ generateForZtest_genZshFunction_)�type�__new__)�cls�name�basesZattrsr r r �testr r r r s
zZshScriptTestMeta.__new__N)�__name__�
__module__� __qualname__�__doc__r r r r r r s r c @ s e Zd ZdZeZdS )�ZshScriptTestMixina�
Integration test helper to show that C{usage.Options} classes can have zsh
completion functions generated for them without raising errors.
In your subclasses set a class variable like so:
# | cmd name | Fully Qualified Python Name of Options class |
#
generateFor = [('conch', 'twisted.conch.scripts.conch.ClientOptions'),
('twistd', 'twisted.scripts.twistd.ServerOptions'),
]
Each package that contains Twisted scripts should contain one TestCase
subclass which also inherits from this mixin, and contains a C{generateFor}
list appropriate for the scripts in that package.
N)r r r! r" r Z
__metaclass__r r r r r# ) s r# c
C s� t � }| �tjd|� zt�|�� }W n2 tk
rX } zt�d|f ��W 5 d}~X Y nX z|� dddg� W nB t
k
r� } zt�d|f��W 5 d}~X Y n t k
r� Y n X | � d� |�
d � | �d
t|�d
��� |�
d � |�� t|d ��r�|jD ]�\}}}} z|� |ddd g� W nF t
k
�rT } zt�d
|f��W 5 d}~X Y n t k
�rh Y n X | � d� |�
d � | �d
t|�d
��� |�
d � |�� �q | �� dS )aI
Generate completion functions for given twisted command - no errors
should be raised
@type cmdName: C{str}
@param cmdName: The name of the command-line utility e.g. 'twistd'
@type optionsFQPN: C{str}
@param optionsFQPN: The Fully Qualified Python Name of the C{Options}
class to be tested.
�_shellCompFilez0Couldn't import or instantiate Options class: %sN� �--_shell-completion�zsh:2z&ImportError calling parseOptions(): %szSystemExit not raisedr � � subCommandszzsh:3z4ImportError calling parseOptions() on subcommand: %s)r �patchr �Optionsr ZnamedAny� Exceptionr ZSkipTest� parseOptions� ImportError�
SystemExitZfail�seek� assertEqual�len�read�truncate�hasattrr) Z
flushWarnings)
r r r �
outputFile�o�e�cmdZshort�parser�docr r r r > sJ �
�
�
r c @ sx e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd� Zd S ) �ZshTestsz'
Tests for zsh completion code
c C s� t � }t�|dt� �}tjj�� }|�t jj� | � |j|� | � |j
t tjj
�� | � |j tjj � tjj
�� }|�t jj
� | � |j
|� | � |jtjj� dS )zi
Are `compData' attributes you can place on Options classes
picked up correctly?
�aceN)�FighterAceExtendedOptionsr �ZshArgumentsGeneratorr �FighterAceOptions�compData� descriptions�copy�updater1 �multiUse�set�mutuallyExclusive�
optActions� extraActions)r �opts�agrB rH r r r �test_accumulateMetadata� s"
�� �z ZshTests.test_accumulateMetadatac C s� G dd� dt �}|� }t�|dt� �}tdddddd d
g�td d ddddd d
g�td d dddd d
g�td d dddd d
g�td d dddddg�d
�}| �|j|� dS )z�
Exercise a corner-case of ZshArgumentsGenerator.makeExcludesDict()
where the long option name already exists in the `excludes` dict being
built.
c @ s. e Zd ZdddggZedddddggd�ZdS ) zGZshTests.test_mutuallyExclusiveCornerCase.<locals>.OddFighterAceOptions�anatraNz0Select the Anatra DS as your dogfighter aircraft�fokker�albatros�spad�bristol�rG )r r r! �optFlagsr rA r r r r �OddFighterAceOptions� s � ��rT r= rM �brQ �frN �srP �arO )rO rM rQ rN rP N)r> r r? r rF r1 Zexcludes)r rT rJ rK Zexpectedr r r � test_mutuallyExclusiveCornerCase� s>
�
�
�
�
�� z)ZshTests.test_mutuallyExclusiveCornerCasec C sR t � }t�|dt� �}| �d|j� | �d|j� | �d|j� | �d|j� dS )z�
We pick up options that are only defined by having an
appropriately named method on your Options class,
e.g. def opt_foo(self, foo)
r= Znocrash�
difficultyN)r> r r? r ZassertInZflagNameToDefinitionZallOptionsNameToDefinitionZparamNameToDefinition)r rJ rK r r r � test_accumulateAdditionalOptions� s z)ZshTests.test_accumulateAdditionalOptionsc C sT G dd� dt �}| �ttj|� dt� � G dd� dt �}| �ttj|� dt� � dS )z\
Using a parameter/flag name that doesn't exist
will raise an error
c @ s e Zd Zeddid�ZdS )z0ZshTests.test_verifyZshNames.<locals>.TmpOptionsZdetaillN)rH �r r r! r rA r r r r �
TmpOptions� s r] r= c @ s e Zd Zedgd�ZdS )z1ZshTests.test_verifyZshNames.<locals>.TmpOptions2)ZfooZbarrR Nr\ r r r r � TmpOptions2� s �r^ N)r> � assertRaises�
ValueErrorr r? r )r r] r^ r r r �test_verifyZshNames� s
�
�z ZshTests.test_verifyZshNamesc C sT t � }| �tjd|� | �tdddddg� t� }| �t|j� | � t
|� � � dS )zt
Generate a completion function, and test the textual output
against a known correct output
r$ �argv�sillyr% r& r' N) r r* r r+ �sys�SimpleProgOptionsr_ r/ r- r1 � testOutput1�getvalue�r r6 rJ r r r � test_zshCode� s zZshTests.test_zshCodec C sT t � }| �tjd|� | �tdddddg� t� }| �t|j� | � t
|� � � dS )z�
Generate a completion function with subcommands,
and test the textual output against a known correct output
r$ rb Zsilly2r% r& r' N) r r* r r+ rd �SimpleProgWithSubcommandsr_ r/ r- r1 � testOutput2rg rh r r r �test_zshCodeWithSubs� s z ZshTests.test_zshCodeWithSubsc
C s\ t � }| �tjd|� t� }| �t|jddddddg� |�d� | � d t
|� d ��� d
S ) zx
Completion still happens even if a command-line is given
that would normally throw UsageError.
r$ �--fokker�server�--unknown-optionz--unknown-option2r& �zsh:5r r( N� r r* r r+ r@ r_ r/ r- r0 r1 r2 r3 rh r r r �test_incompleteCommandLine s
��
z#ZshTests.test_incompleteCommandLinec
C sn t � }| �tjd|� t� }| �t|jddddddg� |�d� | � d t
|� d ��� |�d� |� � d
S ) z�
Completion still happens even if a command-line is given
that would normally throw UsageError.
The existence of --unknown-option prior to the subcommand
will break subcommand detection... but we complete anyway
r$ rm ro rn �
--list-serverr& rp r r( N)
r r* r r+ r@ r_ r/ r- r0 r1 r2 r3 r4 rh r r r � test_incompleteCommandLine_case2 s
��
z)ZshTests.test_incompleteCommandLine_case2c C sZ t � }| �tjd|� t� }| �t|jdddddg� |�d� | � dt
|� d��� d S )
z�
Completion still happens even if a command-line is given
that would normally throw UsageError.
Break subcommand detection in a different way by providing
an invalid subcommand name.
r$ rm zunknown-subcommandrs r& zzsh:4r r( Nrq rh r r r � test_incompleteCommandLine_case3* s
��
z)ZshTests.test_incompleteCommandLine_case3c C sV t � }| �tjd|� t� }| �t|jdddg� |�d� | � dt
|� d��� dS )z�
Ensure the optimization which skips building the subcommand list
under certain conditions isn't broken.
r$ z--albar& r' r r( Nrq rh r r r �test_skipSubcommandList> s
�
z ZshTests.test_skipSubcommandListc C s. t � }t�|dd�}|�d�}| �|d� dS )zY
Test corner case fetching an option description from a method docstring
r= Nrc )r@ r r? �getDescriptionr1 )r rJ �argGen�descrr r r � test_poorlyDescribedOptMethodN s
z&ZshTests.test_poorlyDescribedOptMethodc C sF G dd� dt j�}t� }|� }| �|d|� | �t|jdddg� dS )zu
A C{Completer} with repeat=True may only be used as the
last item in the extraActions list.
c @ s( e Zd Zejejdd�e�� gd�ZdS )z2ZshTests.test_brokenActions.<locals>.BrokenActionsT)�repeat)rI N)r r r! r r r
rA r r r r �
BrokenActionsa s
��r| r$ r% r& r' N)r r+ r r* r_ r` r- )r r| r6 rJ r r r �test_brokenActions\ s
�zZshTests.test_brokenActionsc C sN G dd� dt j�}|� }t�|dd�}| �|�d�d� | �|�d�d� dS ) z~
opt_* methods on Options classes should not override the
data provided in optFlags or optParameters.
c @ s6 e Zd ZdddggZddddggZdd � Zd
d � ZdS ) z5ZshTests.test_optMethodsDontOverride.<locals>.Options�flagrV �A flag�param�pN�A paramc S s dS �z junk description Nr r r r r �opt_flagw s z>ZshTests.test_optMethodsDontOverride.<locals>.Options.opt_flagc S s dS r� r )r r� r r r � opt_paramz s z?ZshTests.test_optMethodsDontOverride.<locals>.Options.opt_param)r r r! rS �
optParametersr� r� r r r r r+ s s r+ r= Nr~ r r� r� )r r+ r r? r1 rw )r r+ rJ rx r r r �test_optMethodsDontOverriden s
z$ZshTests.test_optMethodsDontOverrideN)r r r! r" rL rY r[ ra ri rl rr rt ru rv rz r} r� r r r r r< � s "
r< c @ s e Zd Zdd� ZdS )� EscapeTestsc C s2 t j}d}| �||�d� d}| �||�d� dS )z5
Verify _shellcomp.escape() function
�$z'$'z A--'$"\`--Bz"A--'\$\"\\\`--B"N)r �escaper1 )r Zescr r r r � test_escape� s
zEscapeTests.test_escapeN)r r r! r� r r r r r� � s r� c @ s e Zd ZdZdd� ZdS )� CompleterNotImplementedTestsz�
Test that using an unknown shell constant with SubcommandAction
raises NotImplementedError
The other Completer() subclasses are tested in test_usage.py
c C s t �� }| �t|jdd� dS )zM
Using an unknown shellType should raise NotImplementedError
NZbad_shell_type)r ZSubcommandActionr_ �NotImplementedErrorZ
_shellCode)r �actionr r r �test_unknownShell� s
�z.CompleterNotImplementedTests.test_unknownShellN)r r r! r" r� r r r r r� � s r� c @ s* e Zd ZdZdddggZddddggZdS )�FighterAceServerOptionsz4
Options for FighterAce 'server' subcommand
z list-serverNz3List this server with the online FighterAce networkzpackets-per-secondz+Number of update packets to send per secondZ20)r r r! r" rS r� r r r r r� � s � �r� c @ s� e Zd ZdZdddgdddgdd d
gd d d
gdddgdddgdddggZddddgdd d d ggZd ded ggZed!d"d#�dgdddd ggde d$g�ie
d%d&�gd'�Z d(d)� Z dS )*r@ zB
Command-line options for an imaginary `Fighter Ace` game
rN rV z2Select the Fokker Dr.I as your dogfighter aircraftrO rX z5Select the Albatros D-III as your dogfighter aircraftrP rW z1Select the SPAD S.VII as your dogfighter aircraftrQ rU z4Select the Bristol Scout as your dogfighter aircraft�physicsr� z$Enable secret Twisted physics engineZjam�jz6Enable a small chance that your machine guns will jam!�verbose�v�1Verbose logging (may be specified more than once)z
pilot-nameNzWhat's your name, Ace?zManfred von Richthofen�detail�dz*Select the level of rendering detail (1-5)�3rn z Start FighterAce game-server.zTwisted-PhysicszRendering detail level)r� r� Z12345zsaved game file to load�ry �rB rE rG rH rI c C s dS )� Nr r r r r � opt_silly� s zFighterAceOptions.opt_silly)
r r r! r" rS r� r� r) r r
r rA r� r r r r r@ � s\ ��������� �����
� r@ c @ sT e Zd ZdZdddggZddddggZeddided d
�id �Zd d
� Z dd� Z
dS )r> z�
Extend the options and zsh metadata provided by FighterAceOptions.
_shellcomp must accumulate options and metadata from all classes in the
hiearchy so this is important to test.
z no-stallsNz+Turn off the ability to stall your aircraftz
reality-levelz)Select the level of physics reality (1-5)�5zCan't stall your planezPhysics reality levelr� )rB rH c C s dS )z8
Select that you can't crash your plane
Nr r r r r � opt_nocrash� s z%FighterAceExtendedOptions.opt_nocrashc C s dS )z+
How tough are you? (1-10)
Nr )r rZ r r r �opt_difficulty� s z(FighterAceExtendedOptions.opt_difficulty) r r r! r" rS r� r r
rA r� r� r r r r r> � s � ���r> c C s t dddgdd�S )N�1�2r� z Accuracy'`?r� r r r r r �_accuracyAction� s r� c
@ s� e Zd ZdZdddgdddgdd d
ggZd d d
dgddddggZeddd�dgddggeddddd
gdd�ed�e d d�gd �Z
d d � Z d S ) re z>
Command-line options for a `Silly` imaginary program
�color�czTurn on color outputZgray�gzTurn on gray-scale outputr� r� r� � optimizationNr� z&Select the level of optimization (1-5)�accuracyrX r� z"Select the level of accuracy (1-3)zColor onzOptimization level)r� r� r� r� �4z
Optimization?r� )r� r� z output filer� c C s dS )zM
usage.Options does not recognize single-letter opt_ methods
Nr r r r r �opt_X s zSimpleProgOptions.opt_X) r r r! r" rS r� r r
r� r rA r� r r r r re s8 ��������
� re c @ s e Zd ZdddggZdS )�SimpleProgSub1�sub-optrW z Sub Opt OneN�r r r! rS r r r r r� ' s r� c @ s e Zd ZdddggZdS )�SimpleProgSub2r� rW z Sub Opt TwoNr� r r r r r� , s r� c @ sH e Zd ZdgddggZdgddgddd ggZd
d ed gd
d edggZd S )rj z some-optionz other-optionr7 z
some-paramz other-paramr� z
another-param�PzYet Another ParamZsub1Nz
Sub Command 1Zsub2z
Sub Command 2)r r r! rS r� r� r� r) r r r r rj 1 s ��
�rj s� #compdef silly
_arguments -s -A "-*" \
':output file (*):_files -g "*"' \
"(--accuracy)-a[Select the level of accuracy (1-3)]:Accuracy'\`?:(1 2 3)" \
"(-a)--accuracy=[Select the level of accuracy (1-3)]:Accuracy'\`?:(1 2 3)" \
'(--color --gray -g)-c[Color on]' \
'(--gray -c -g)--color[Color on]' \
'(--color --gray -c)-g[Turn on gray-scale output]' \
'(--color -c -g)--gray[Turn on gray-scale output]' \
'--help[Display this help and exit.]' \
'--optimization=[Optimization level]:Optimization?:(1 2 3 4 5)' \
'*-v[Verbose logging (may be specified more than once)]' \
'*--verbose[Verbose logging (may be specified more than once)]' \
'--version[Display Twisted version and exit.]' \
&& return 0
s� #compdef silly2
_arguments -s -A "-*" \
'*::subcmd:->subcmd' \
':output file (*):_files -g "*"' \
"(--accuracy)-a[Select the level of accuracy (1-3)]:Accuracy'\`?:(1 2 3)" \
"(-a)--accuracy=[Select the level of accuracy (1-3)]:Accuracy'\`?:(1 2 3)" \
'(--another-param)-P[another-param]:another-param:_files' \
'(-P)--another-param=[another-param]:another-param:_files' \
'(--color --gray -g)-c[Color on]' \
'(--gray -c -g)--color[Color on]' \
'(--color --gray -c)-g[Turn on gray-scale output]' \
'(--color -c -g)--gray[Turn on gray-scale output]' \
'--help[Display this help and exit.]' \
'--optimization=[Optimization level]:Optimization?:(1 2 3 4 5)' \
'(--other-option)-o[other-option]' \
'(-o)--other-option[other-option]' \
'(--other-param)-p[other-param]:other-param:_files' \
'(-p)--other-param=[other-param]:other-param:_files' \
'--some-option[some-option]' \
'--some-param=[some-param]:some-param:_files' \
'*-v[Verbose logging (may be specified more than once)]' \
'*--verbose[Verbose logging (may be specified more than once)]' \
'--version[Display Twisted version and exit.]' \
&& return 0
local _zsh_subcmds_array
_zsh_subcmds_array=(
"sub1:Sub Command 1"
"sub2:Sub Command 2"
)
_describe "sub-command" _zsh_subcmds_array
)&r" Z
__future__r r rd �ior Z
twisted.trialr Ztwisted.pythonr r r Ztwisted.python.usager r
r r
r r �objectr# r ZTestCaser< r� r� r+ r� r@ r> r� re r� r� rj rf rk r r r r �<module> s2 D / #