← Back
Editing: test_deprecate.cpython-38.pyc
U W[� � @ sN d Z ddlmZmZ ddlZddlZddlZddlZddlm Z ddlm Z m Z zddl m Z W n ek rx dZ Y nX ddlmZ ddlmZ dd lmZ dd lmZmZmZmZmZmZmZm Z m Z dd l m Z m Z dd l!m"Z" dd l#m$Z$ ddl%m&Z& ddl'm(Z( ddl)m*Z* ddl+m,Z, G dd� de-�Z.G dd� de,�Z/G dd� de,�Z0G dd� de*e,�Z1G dd� de,�Z2d d � Z3d d � Z4G d d!� d!e,�Z5ee"d"d#d$d%��G d&d'� d'e-��Z6G d(d)� d)e-�Z7G d*d+� d+e,�Z8G d,d-� d-e,�Z9G d.d/� d/e,�Z:ej;d0k�r.e&e<��=� �>d1�Z?i Z@e e?jAe@� e@d2 ZBn dd3l+mCZC G d4d2� d2eC�ZBdS )5zI Tests for Twisted's deprecation framework, L{twisted.python.deprecate}. � )�division�absolute_importN)�normcase)� simplefilter�catch_warnings)�invalidate_caches)� deprecate)� _getDeprecationWarningString)�DEPRECATION_WARNING_FORMAT) �getDeprecationWarningString� deprecated�_appendToDocstring�_getDeprecationDocstring�_fullyQualifiedName�_mutuallyExclusiveArguments�deprecatedProperty�_passedArgSpec�_passedSignature)�_PY3�execfile)�Version)�platform)�FilePath)�deprecatedattributes)�TwistedModulesMixin)�SynchronousTestCasec @ s e Zd ZdZdd� Zdd� ZdS )�_MockDeprecatedAttributezq Mock of L{twisted.python.deprecate._DeprecatedAttribute}. @ivar value: The value of the attribute. c C s || _ d S �N��value��selfr � r" �D/usr/lib/python3/dist-packages/twisted/python/test/test_deprecate.py�__init__3 s z!_MockDeprecatedAttribute.__init__c C s | j S )z$ Get a known value. r �r! r" r" r# �get7 s z _MockDeprecatedAttribute.getN)�__name__� __module__� __qualname__�__doc__r$ r& r" r" r" r# r - s r c @ s@ e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dS )�ModuleProxyTestsz� Tests for L{twisted.python.deprecate._ModuleProxy}, which proxies access to module-level attributes, intercepting access to deprecated attributes and passing through access to normal attributes. c K s2 t �d�}|�� D ]\}}t|||� qt�|�S )z� Create a temporary module proxy object. @param **kw: Attributes to initialise on the temporary module object @rtype: L{twistd.python.deprecate._ModuleProxy} �foo)�types� ModuleType�items�setattrr Z _ModuleProxy)r! Zattrs�mod�keyr r" r" r# � _makeProxyE s zModuleProxyTests._makeProxyc C s. | j dd�}| �|jd� | �tt|d� dS )z� Getting a normal attribute on a L{twisted.python.deprecate._ModuleProxy} retrieves the underlying attribute's value, and raises C{AttributeError} if a non-existent attribute is accessed. Zhello)�SOME_ATTRIBUTEZDOES_NOT_EXISTN)r3 �assertIsr4 � assertRaises�AttributeError�getattr�r! �proxyr" r" r# �test_getattrPassthroughS s z(ModuleProxyTests.test_getattrPassthroughc C s2 | � � }t�|d�}td�|d< | �|jd� dS )z� Getting an attribute marked as being deprecated on L{twisted.python.deprecate._ModuleProxy} results in calling the deprecated wrapper's C{get} method. �_deprecatedAttributes�* r, N)r3 �object�__getattribute__r � assertEqualr, )r! r: r< r" r" r# �test_getattrIntercept^ s � z&ModuleProxyTests.test_getattrInterceptc C s, | � � }| �tt|d� | �tt|d� dS )z� Private attributes of L{twisted.python.deprecate._ModuleProxy} are inaccessible when regular attribute access is used. �_moduler< N)r3 r6 r7 r8 r9 r" r" r# �test_privateAttributesk s �z'ModuleProxyTests.test_privateAttributesc C s4 | � � }d|_| �t�|d�d� | �|jd� dS )z� Setting attributes on L{twisted.python.deprecate._ModuleProxy} proxies them through to the wrapped module. � rB N)r3 rB �assertNotEqualr> r? r@ r9 r" r" r# � test_setattrv s z ModuleProxyTests.test_setattrc C s6 | � � }t�|d�}| �t|�dt|�j|f � dS )z� L{twisted.python.deprecated._ModuleProxy.__repr__} produces a string containing the proxy type and a representation of the wrapped module object. rB z<%s module=%r>N)r3 r> r? r@ �repr�typer' )r! r: Z realModuler" r" r# � test_repr� s �zModuleProxyTests.test_reprN) r' r( r) r* r3 r; rA rC rF rI r" r" r" r# r+ ? s r+ c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd S ) �DeprecatedAttributeTestsz� Tests for L{twisted.python.deprecate._DeprecatedAttribute} and L{twisted.python.deprecate.deprecatedModuleAttribute}, which issue warnings for deprecated module-level attributes. c C s t j| _t j| _td | _d S )Nz.foo)r �version�messager' �_testModuleNamer% r" r" r# �setUp� s z DeprecatedAttributeTests.setUpc C s" t tjd | tjtd tj �S )zJ Create the warning string used by deprecated attributes. �.z: )r r r' rK r rL )r! �attrr" r" r# �_getWarningString� s �z*DeprecatedAttributeTests._getWarningStringc s� d}t t|d� t�t|| j| j�� | �� j|� � fdd�}|� | �| j g�}| � |d d t � | �|d d | � |�� | �t |�d� d S ) z� L{twisted.python.deprecate._DeprecatedAttribute} correctly sets its __name__ to match that of the deprecated attribute and emits a warning when the original attribute value is accessed. Z ANOTHER_DEPRECATED_ATTRIBUTEr= c s � � � d S r )r& r" �rP r" r# � addStackLevel� s zNDeprecatedAttributeTests.test_deprecatedAttributeHelper.<locals>.addStackLevelr �categoryrL rD N)r0 r r Z_DeprecatedAttributerK rL r@ r' � flushWarnings� test_deprecatedAttributeHelperr5 �DeprecationWarningrQ �len)r! �namerS � warningsShownr" rR r# rV � s( � � �z7DeprecatedAttributeTests.test_deprecatedAttributeHelperc C s� t j | �| jg�}| �t|�d� d}tt |� | �| jg�}| �t|�d� | �|d d t� | �|d d | � |�� dS )a L{twisted.python.deprecate.deprecatedModuleAttribute} wraps a module-level attribute in an object that emits a deprecation warning when it is accessed the first time only, while leaving other unrelated attributes alone. r ZDEPRECATED_ATTRIBUTErD rT rL N) r ZANOTHER_ATTRIBUTErU �test_deprecatedAttributer@ rX r8 r5 rW rQ )r! rZ rY r" r" r# r[ � s �z1DeprecatedAttributeTests.test_deprecatedAttributec C s� t �d� tj| j< }| �tjj| j� t|dd� t|dd� t� t dddd�d | jd� tj| j }| � ||� t� t dddd�d | jd� | � |tj| j � d S ) z� Deprecating an attribute in a module replaces and wraps that module instance, in C{sys.modules}, with a L{twisted.python.deprecate._ModuleProxy} instance but only if it hasn't already been wrapped. r, �firstrD �second� �Twisted� r rL N) r- r. �sys�modulesrM � addCleanup�popr0 r ZdeprecatedModuleAttributer rE r5 )r! r1 r: r" r" r# �test_wrappedModule� s& � �z+DeprecatedAttributeTests.test_wrappedModuleN) r' r( r) r* rN rQ rV r[ re r" r" r" r# rJ � s rJ c @ s< e Zd ZdZdZdd� Zdd� Zdd� Zd d � Zd d � Z d S )� ImportedModuleAttributeTestsza Tests for L{deprecatedModuleAttribute} which involve loading a module via 'import'. z�from twisted.python.deprecate import deprecatedModuleAttribute from incremental import Version deprecatedModuleAttribute( Version('Package', 1, 2, 3), 'message', __name__, 'module') c s^ � fdd�� t | �� �d��}|�� � ||�}| �|j�d�gtj � | �tj � � � |S )a_ Create some files in a hierarchy, based on a dictionary describing those files. The resulting hierarchy will be placed onto sys.path for the duration of the test. @param tree: A dictionary representing a directory structure. Keys are strings, representing filenames, dictionary values represent directories, string values represent file contents. @return: another dictionary similar to the input, with file content strings replaced with L{FilePath} objects pointing at where those contents are now stored. c sl i }|� � D ]Z\}}| �|�}t|t�r<|||< |�|� q t|t�r^|�� � ||�||< q td��q |S )Nz(only strings and dicts allowed as values)r/ �child� isinstance�bytes� setContent�dictZcreateDirectory� ValueError)ZpathobjZdirdictZpathdictr2 r rg �� makeSomeFilesr" r# rn s zAImportedModuleAttributeTests.pathEntryTree.<locals>.makeSomeFiles�utf-8) r �mktemp�encode�makedirsZreplaceSysPath�path�decodera ZreplaceSysModulesrb �copy)r! Ztree�base�resultr" rm r# � pathEntryTree s z*ImportedModuleAttributeTests.pathEntryTreec C s( | � d| j�d�dd�i�}|d d S )z� Add a sample module and package to the path, returning a L{FilePath} pointing at the module which will be loadable as C{package.module}. s packagero � )� __init__.py� module.pyr{ )rx � _packageInitrq )r! �pathsr" r" r# �simpleModuleEntry/ s ��z.ImportedModuleAttributeTests.simpleModuleEntryc C sn ddl m} | �t|j�d��|� | �| jg�}| �t|�d� | �|d d d� | �|d d t � dS ) zB Verification logic for L{test_deprecatedModule}. r ��modulero rD rL z7package.module was deprecated in Package 1.2.3: messagerT N) �packager� r@ r �__file__rq rU �checkOneWarningrX rW )r! Z modulePathr� Zemittedr" r" r# r� : s ��z,ImportedModuleAttributeTests.checkOneWarningc C s | � | �� � dS )z� If L{deprecatedModuleAttribute} is used to deprecate a module attribute of a package, only one deprecation warning is emitted when the deprecated module is imported. N)r� r~ r% r" r" r# �test_deprecatedModuleI s z2ImportedModuleAttributeTests.test_deprecatedModulec C s8 | � � }| �|� | �|� td�D ]}| �|� q$dS )z� If L{deprecatedModuleAttribute} is used to deprecate a module attribute of a package, only one deprecation warning is emitted when the deprecated module is subsequently imported. r^ N)r~ r� �range)r! Zmp�xr" r" r# �"test_deprecatedModuleMultipleTimesR s z?ImportedModuleAttributeTests.test_deprecatedModuleMultipleTimesN) r' r( r) r* r| rx r~ r� r� r� r" r" r" r# rf � s % rf c @ sH e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dd� Z dS )�WarnAboutFunctionTestsz� Tests for L{twisted.python.deprecate.warnAboutFunction} which allows the callers of a function to issue a C{DeprecationWarning} about that function. c s� t | �� �d���d�| _| j�� | j�d��d� | j�d��d� | j�� j� d�}t j� d|� | � t jj |� t j�� � | � � fdd �� t�� r�tr�| �� d S ) zY Create a file that will have known line numbers when emitting warnings. ro � twisted_private_helperrz ry r{ s "A module string" from twisted.python import deprecate def testFunction(): "A doc string" a = 1 + 2 return a def callTestFunction(): b = testFunction() if b == 3: deprecate.warnAboutFunction(testFunction, "A Warning String") r c s t j�� t j�� �fS r )ra rb �clear�updater" �rb r" r# �<lambda>� ry z.WarnAboutFunctionTests.setUp.<locals>.<lambda>N)r rp rq rg r� rr rj �parentrs rt ra �insertrc �removerb ru r Z isWindowsr rU )r! Z packagePathr" r� r# rN m s � � z WarnAboutFunctionTests.setUpc C sn dd� }t �|d� | �� }t}|�� �d�r:|dd� }| �t|d d �t|�� | �|d d d� dS ) z� L{deprecate.warnAboutFunction} emits a warning the file and line number of which point to the beginning of the implementation of the function passed to it. c S s d S r r" r" r" r" r# �aFunc� s z2WarnAboutFunctionTests.test_warning.<locals>.aFunczA Warning Messagez.pycN���r �filenamerL ) r ZwarnAboutFunctionrU r� �lower�endswith�assertSamePathr r@ )r! r� rZ r� r" r" r# � test_warning� s �z#WarnAboutFunctionTests.test_warningc C s� ddl m} |�� | �� }| �t|d d �d��| j�d�� d�� | � |d d d� | � |d d d � | � t |�d � d S ) z� L{deprecate.warnAboutFunction} emits a C{DeprecationWarning} with the number of a line within the implementation of the function passed to it. r r r� ro r� r{ �lineno� rL �A Warning StringrD N) �twisted_private_helperr� �callTestFunctionrU r� r rq r� �siblingrg r@ rX �r! r� rZ r" r" r# �test_warningLineNumber� s �z-WarnAboutFunctionTests.test_warningLineNumberc C s( | � t|j�t|j�kd||f � dS )a Assert that the two paths are the same, considering case normalization appropriate for the current platform. @type first: L{FilePath} @type second: L{FilePath} @raise C{self.failureType}: If the paths are not the same. z%r != %rN)� assertTruer rs )r! r\ r] r" r" r# r� � s �z%WarnAboutFunctionTests.assertSamePathc C s� ddl m} tjd= tj|j= | j�| j�d�� tr<t� ddl m} | � tjj d� | � tjj |j� |� � | � |jg�}t|d d �d��}| j�d��d�}| �||� | �|d d d � | �|d d d � | �t|�d � dS )a Even if the implementation of a deprecated function is moved around on the filesystem, the line number in the warning emitted by L{deprecate.warnAboutFunction} points to a line in the implementation of the deprecated function. r r r� s twisted_renamed_helper�twisted_renamed_helperr� ro r{ r� r� rL r� rD N)r� r� ra rb r' r� ZmoveTor� r r� rc rd r� rU Z testFunctionr rq rg r� r@ rX )r! r� rZ Z warnedPathZ expectedPathr" r" r# �test_renamedFile� s* �� z'WarnAboutFunctionTests.test_renamedFilec C sJ t jdd�= t jddd� ddlm} |�� | �� }| �t|�d� dS )z� L{deprecate.warnAboutFunction} emits a warning that will be filtered if L{warnings.filterwarning} is called with the module name of the deprecated function. N�ignorer� ��actionr� r r ) �warnings�filters�filterwarningsr� r� r� rU r@ rX r� r" r" r# �test_filteredWarning� s � z+WarnAboutFunctionTests.test_filteredWarningc C s� t jdd�= t jddd� ddlm} |�� |�� | �� }| �t|�d� |d d }|d d }|d d }|d d }t � ||||�}| � |� d �d |f � dS )z� L{deprecate.warnAboutFunction} emits a warning that will be filtered once if L{warnings.filterwarning} is called with the module name of the deprecated function and an action of once. Nr� r� r� r r rD rL rT r� r� z=module.py:9: DeprecationWarning: A Warning String return a z Unexpected warning string: %r) r� r� r� r� r� r� rU r@ rX � formatwarningr� r� )r! r� rZ rL rT r� r� �msgr" r" r# �test_filteredOnceWarning s& � �z/WarnAboutFunctionTests.test_filteredOnceWarningN) r' r( r) r* rN r� r� r� r� r� r� r" r" r" r# r� h s '$r� c C s dS )zK Do nothing. This is used to test the deprecation decorators. Nr" r" r" r" r# � dummyCallable s r� c C s dS )z[ Do nothing. This is used to test the replacement parameter to L{deprecated}. Nr" r" r" r" r# �dummyReplacementMethod) s r� c @ sT e Zd Zdd� Zdd� Zdd� Zdd� Zd d � Zd d � Zd d� Z dd� Z dd� Z dS )�DeprecationWarningsTestsc C s, t dddd�}| �t| j|�dtf � dS )z� L{getDeprecationWarningString} returns a string that tells us that a callable was deprecated at a certain released version of Twisted. r_ r` r z\%s.DeprecationWarningsTests.test_getDeprecationWarningString was deprecated in Twisted 8.0.0N)r r@ r � test_getDeprecationWarningStringr' �r! rK r" r" r# r� 3 s ���z9DeprecationWarningsTests.test_getDeprecationWarningStringc C s6 t dddd�}td }| �t| j||�dtf � dS )z� L{getDeprecationWarningString} returns a string that tells us that a callable was deprecated at a certain released version of Twisted, with a message containing additional information about the deprecation. r_ r` r z: This is a messagezo%s.DeprecationWarningsTests.test_getDeprecationWarningString was deprecated in Twisted 8.0.0: This is a messageN)r r r@ r r� r' )r! rK �formatr" r" r# �*test_getDeprecationWarningStringWithFormat@ s ���zCDeprecationWarningsTests.test_getDeprecationWarningStringWithFormatc s� t dddd�}t|�t�� � fdd�}tdd��`}td� |� | �|d jt� | �t|d j �t t|�� | �|d j � d �t � d �� W 5 Q R X d S ) zK Decorating a callable with L{deprecated} emits a warning. r_ r` r c s � � d S r r" r" ��dummyr" r# rS U s zJDeprecationWarningsTests.test_deprecateEmitsWarning.<locals>.addStackLevelT)�record�always�coN)r r r� r r r@ rT rW �strrL r r� �rstripr� )r! rK rS Zcaughtr" r� r# �test_deprecateEmitsWarningO s z3DeprecationWarningsTests.test_deprecateEmitsWarningc C sB t dddd�}t|�t�}| �tj|j� | �tt�t|�� dS )zK The decorated function has the same name as the original. r_ r` r N)r r r� r@ r' �fullyQualifiedName�r! rK r� r" r" r# � test_deprecatedPreservesName` s �z5DeprecationWarningsTests.test_deprecatedPreservesNamec C s$ t dddd�}| �dt|d�� dS )zr L{_getDeprecationDocstring} returns a note about the deprecation to go into a docstring. r_ r` r z Deprecated in Twisted 8.0.0.� N)r r@ r r� r" r" r# � test_getDeprecationDocstringk s �z5DeprecationWarningsTests.test_getDeprecationDocstringc C sF dd� }t dddd�}t|�|�}t|t|d�� | �|j|j� dS )zv The docstring of the deprecated function is appended with information about the deprecation. c S s dS )zc Do nothing. This is used to test the deprecation decorators. Nr" r" r" r" r# �localDummyCallable| s zTDeprecationWarningsTests.test_deprecatedUpdatesDocstring.<locals>.localDummyCallabler_ r` r r� N)r r r r r@ r* )r! r� rK r� r" r" r# � test_deprecatedUpdatesDocstringv s �z8DeprecationWarningsTests.test_deprecatedUpdatesDocstringc C s, t dddd�}t|�t�}| �||j� dS )zt Deprecating a function adds version information to the decorated version of that function. r_ r` r N)r r r� r@ �deprecatedVersionr� r" r" r# �test_versionMetadata� s z-DeprecationWarningsTests.test_versionMetadatac C s: t dddd�}t| j|dd�}| �|dt| j�f � dS )a L{getDeprecationWarningString} takes an additional replacement parameter that can be used to add information to the deprecation. If the replacement parameter is a string, it will be interpolated directly into the result. r_ r` r �something.foobar�Z replacementzG%s was deprecated in Twisted 8.0.0; please use something.foobar insteadN)r r r� r@ r� �r! rK Z warningStringr" r" r# �+test_getDeprecationWarningStringReplacement� s ����zDDeprecationWarningsTests.test_getDeprecationWarningStringReplacementc C s< t dddd�}t| j|td�}| �|dt| j�tf � dS )a L{getDeprecationWarningString} takes an additional replacement parameter that can be used to add information to the deprecation. If the replacement parameter is a callable, its fully qualified name will be interpolated into the result. r_ r` r r� zP%s was deprecated in Twisted 8.0.0; please use %s.dummyReplacementMethod insteadN)r r r� r� r@ r� r' r� r" r" r# �7test_getDeprecationWarningStringReplacementWithCallable� s ����zPDeprecationWarningsTests.test_getDeprecationWarningStringReplacementWithCallableN) r' r( r) r� r� r� r� r� r� r� r� r� r" r" r" r# r� 2 s r� r_ rD r^ � c @ s e Zd ZdZdS )�DeprecatedClasszJ Class which is entirely deprecated without having a replacement. N)r' r( r) r* r" r" r" r# r� � s r� c @ s< e Zd ZdZdZeedddd��dd� �Zejd d� �ZdS ) �ClassWithDeprecatedPropertyz2 Class with a single deprecated property. Nr_ rD r^ r� c C s | j S )zC Getter docstring. @return: The property. ��_someProtectedValuer% r" r" r# � someProperty� s z(ClassWithDeprecatedProperty.somePropertyc C s || _ dS )z# Setter docstring. Nr� r r" r" r# r� � s ) r' r( r) r* r� r r r� �setterr" r" r" r# r� � s r� c @ s@ e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dS )�DeprecatedDecoratorTestsz* Tests for deprecated decorators. c C s | � |dd� |j�� D �� dS )a8 Check that C{target} object has the C{expected} docstring lines. @param target: Object which is checked. @type target: C{anything} @param expected: List of lines, ignoring empty lines or leading or trailing spaces. @type expected: L{list} or L{str} c S s g | ]}|� � r|� � �qS r" )�strip)�.0r� r" r" r# � <listcomp>� s z<DeprecatedDecoratorTests.assertDocstring.<locals>.<listcomp>N)r@ r* � splitlines)r! �targetZexpectedr" r" r# �assertDocstring� s �z(DeprecatedDecoratorTests.assertDocstringc C s� t � }|j | �t jdddg� tdddd�t j_d}| �| jg�}| �dt|�� | �t |d d � | �||d d � d S ) a% When L{deprecatedProperty} is used on a C{property}, accesses raise a L{DeprecationWarning} and getter docstring is updated to inform the version in which it was deprecated. C{deprecatedVersion} attribute is also set to inform the deprecation version. zGetter docstring.z@return: The property.� Deprecated in Twisted 1.2.3.r_ rD r^ r� �ktwisted.python.test.test_deprecate.ClassWithDeprecatedProperty.someProperty was deprecated in Twisted 1.2.3r rT rL N) r� r� r� r r� rU �test_propertyGetterr@ rX rW )r! �objrL r� r" r" r# r� � s* �� ��z,DeprecatedDecoratorTests.test_propertyGetterc C sn t � }t� }||_| �||j� d}| �| jg�}| �dt|�� | �t |d d � | �||d d � dS )z} When L{deprecatedProperty} is used on a C{property}, setter accesses raise a L{DeprecationWarning}. r� rD r rT rL N) r> r� r� r5 r� rU �test_propertySetterr@ rX rW )r! ZnewValuer� rL r� r" r" r# r� s �z,DeprecatedDecoratorTests.test_propertySetterc C st t � | �t ddg� tdddd�t _d}| �| jg�}| �dt|�� | �t|d d � | �||d d � d S ) a When L{deprecated} is used on a class, instantiations raise a L{DeprecationWarning} and class's docstring is updated to inform the version in which it was deprecated. C{deprecatedVersion} attribute is also set to inform the deprecation version. z@Class which is entirely deprecated without having a replacement.r� r_ rD r^ r� zRtwisted.python.test.test_deprecate.DeprecatedClass was deprecated in Twisted 1.2.3r rT rL N) r� r� r r� rU � test_classr@ rX rW )r! rL r� r" r" r# r� * s ���z#DeprecatedDecoratorTests.test_classc C s. t dddd�}t|d�t�}| �|jd� dS )a L{deprecated} takes an additional replacement parameter that can be used to indicate the new, non-deprecated method developers should use. If the replacement parameter is a string, it will be interpolated directly into the warning message. r_ r` r r� z� Do nothing. This is used to test the deprecation decorators. Deprecated in Twisted 8.0.0; please use something.foobar instead. N)r r r� r@ r* r� r" r" r# �test_deprecatedReplacementE s �z3DeprecatedDecoratorTests.test_deprecatedReplacementc C s: t dddd�}t|td�}|t�}| �|jdtf � dS )a) L{deprecated} takes an additional replacement parameter that can be used to indicate the new, non-deprecated method developers should use. If the replacement parameter is a callable, its fully qualified name will be interpolated into the warning message. r_ r` r r� z� Do nothing. This is used to test the deprecation decorators. Deprecated in Twisted 8.0.0; please use %s.dummyReplacementMethod instead. N)r r r� r� r@ r* r' )r! rK Z decoratorr� r" r" r# �&test_deprecatedReplacementWithCallableX s ��z?DeprecatedDecoratorTests.test_deprecatedReplacementWithCallableN) r' r( r) r* r� r� r� r� r� r� r" r" r" r# r� � s r� c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �AppendToDocstringTestszk Test the _appendToDocstring function. _appendToDocstring is used to add text to a docstring. c C s$ dd� }t |d� | �d|j� dS )zP Appending to an empty docstring simply replaces the docstring. c S s d S r r" r" r" r" r# � noDocstringx s zGAppendToDocstringTests.test_appendToEmptyDocstring.<locals>.noDocstring�Appended text.N�r r@ r* )r! r� r" r" r# �test_appendToEmptyDocstrings s z2AppendToDocstringTests.test_appendToEmptyDocstringc C s@ dd� }t |d� | �dddg|j�� � | �|j�d�� dS )a� Appending to a single line docstring places the message on a new line, with a blank line separating it from the rest of the docstring. The docstring ends with a newline, conforming to Twisted and PEP 8 standards. Unfortunately, the indentation is incorrect, since the existing docstring doesn't have enough info to help us indent properly. c S s dS )�;This doesn't comply with standards, but is here for a test.Nr" r" r" r" r# �singleLineDocstring� s zTAppendToDocstringTests.test_appendToSingleLineDocstring.<locals>.singleLineDocstringr� r� r� � N)r r@ r* r� r� r� )r! r� r" r" r# � test_appendToSingleLineDocstring s ��z7AppendToDocstringTests.test_appendToSingleLineDocstringc C s. dd� }dd� }t |d� | �|j|j� dS )z� Appending to a multi-line docstring places the messade on a new line, with a blank line separating it from the rest of the docstring. Because we have multiple lines, we have enough information to do indentation. c S s dS )z9 This is a multi-line docstring. Nr" r" r" r" r# �multiLineDocstring� s zRAppendToDocstringTests.test_appendToMultilineDocstring.<locals>.multiLineDocstringc S s dS )zU This is a multi-line docstring. Appended text. Nr" r" r" r" r# �expectedDocstring� s zQAppendToDocstringTests.test_appendToMultilineDocstring.<locals>.expectedDocstringr� Nr� )r! r� r� r" r" r# � test_appendToMultilineDocstring� s �z6AppendToDocstringTests.test_appendToMultilineDocstringN)r' r( r) r* r� r� r� r" r" r" r# r� l s r� c @ sz e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dd� Z dd� Z dd� Z dd� Z dd� Zeedd�svde_dS )� MutualArgumentExclusionTestsz2 Tests for L{mutuallyExclusiveArguments}. c O s4 t tdd�r tt�|�||�S tt�|�||�S dS )a� Test an invocation of L{passed} with the given function, arguments, and keyword arguments. @param func: A function whose argspec will be inspected. @type func: A callable. @param args: The arguments which could be passed to C{func}. @param kw: The keyword arguments which could be passed to C{func}. @return: L{_passedSignature} or L{_passedArgSpec}'s return value @rtype: L{dict} � signatureN)r8 �inspectr r� r Z getargspec)r! �func�args�kwr" r" r# � checkPassed� s z(MutualArgumentExclusionTests.checkPassedc C s* dd� }| � | �|dd�tddd�� dS )z` L{passed} identifies the arguments passed by a simple positional test. c S s d S r r" ��a�br" r" r# r� � s zGMutualArgumentExclusionTests.test_passed_simplePositional.<locals>.funcrD r^ r� N�r@ r� rk �r! r� r" r" r# � test_passed_simplePositional� s z9MutualArgumentExclusionTests.test_passed_simplePositionalc C s" dd� }| � t| j|ddd� dS )z[ L{passed} raises a L{TypeError} if too many arguments are passed. c S s d S r r" r� r" r" r# r� � s zBMutualArgumentExclusionTests.test_passed_tooManyArgs.<locals>.funcrD r^ r� N�r6 � TypeErrorr� r� r" r" r# �test_passed_tooManyArgs� s z4MutualArgumentExclusionTests.test_passed_tooManyArgsc C s" dd� }| j t| j|ddd� dS )zs L{passed} raises a L{TypeError} if a argument is passed both positionally and by keyword. c S s d S r r" �r� r" r" r# r� � s zHMutualArgumentExclusionTests.test_passed_doublePassKeyword.<locals>.funcrD r^ r� Nr� r� r" r" r# � test_passed_doublePassKeyword� s z:MutualArgumentExclusionTests.test_passed_doublePassKeywordc C s" dd� }| j t| j|ddd� dS )z� L{passed} raises a L{TypeError} if a keyword argument not present in the function's declaration is passed. c S s d S r r" r� r" r" r# r� � s zIMutualArgumentExclusionTests.test_passed_unspecifiedKeyword.<locals>.funcrD r^ )�zNr� r� r" r" r# � test_passed_unspecifiedKeyword� s z;MutualArgumentExclusionTests.test_passed_unspecifiedKeywordc C s, dd� }| � | �|ddd�tddd�� dS ) z| L{passed} places additional positional arguments into a tuple under the name of the star argument. c W s d S r r" r� r" r" r# r� � s z;MutualArgumentExclusionTests.test_passed_star.<locals>.funcrD r^ r� )r^ r� r� Nr� r� r" r" r# �test_passed_star� s �z-MutualArgumentExclusionTests.test_passed_starc C s: dd� }| � | j|ddddd�tdtdddd�d�� d S ) zn Additional keyword arguments are passed as a dict to the star star keyword argument. c [ s d S r r" r� r" r" r# r� s z?MutualArgumentExclusionTests.test_passed_starStar.<locals>.funcrD r^ r� � )r� �yr� r� Nr� r� r" r" r# �test_passed_starStar s �z1MutualArgumentExclusionTests.test_passed_starStarc C s2 d dd�}| � | j|dddd�tdddd�� d S ) zp The results of L{passed} only include arguments explicitly passed, not default values. rD r^ r� c S s d S r r" )r� r� �c�d�er" r" r# r� s zFMutualArgumentExclusionTests.test_passed_noDefaultValues.<locals>.func� )r )r� r� r N)rD r^ r� r� r� r" r" r# �test_passed_noDefaultValues s �z8MutualArgumentExclusionTests.test_passed_noDefaultValuesc C sT t dg�ddd��}| �|dd�d� | �|ddd �d � | �|ddd d �d � d S )z� L{mutuallyExclusiveArguments} does not interfere in its decoratee's operation, either its receipt of arguments or its return value. r� r� r c S s | | | | S r r" )r� r r� r� r" r" r# r� s zMMutualArgumentExclusionTests.test_mutualExclusionPrimeDirective.<locals>.funcrD r^ � r � )r� � N)r� r )r r@ r� r" r" r# �"test_mutualExclusionPrimeDirective s z?MutualArgumentExclusionTests.test_mutualExclusionPrimeDirectivec C s. t ddgg�d dd��}| jt|ddd� dS ) z� L{mutuallyExclusiveArguments} raises a L{TypeError}n if its decoratee is passed a pair of mutually exclusive arguments. r� r� r� r c S s | | S r r" r� r" r" r# r� * s zPMutualArgumentExclusionTests.test_mutualExclusionExcludesByKeyword.<locals>.funcr� N)r� r )r r6 r� r� r" r" r# �%test_mutualExclusionExcludesByKeyword% s zBMutualArgumentExclusionTests.test_mutualExclusionExcludesByKeywordc C sn G dd� d�}G dd� d�}dd� }|dd� t �|�j}|�� }|d d �|d < ||�}| �tt|d i � d S ) z� Create a fake signature with an invalid parameter type to test error handling. The valid parameter types are specified in L{inspect.Parameter}. c @ s e Zd Zdd� ZdS )zMMutualArgumentExclusionTests.test_invalidParameterType.<locals>.FakeSignaturec S s || _ d S r )� parameters)r! r r" r" r# r$ 8 s zVMutualArgumentExclusionTests.test_invalidParameterType.<locals>.FakeSignature.__init__N�r' r( r) r$ r" r" r" r# � FakeSignature7 s r c @ s e Zd Zdd� ZdS )zMMutualArgumentExclusionTests.test_invalidParameterType.<locals>.FakeParameterc S s || _ || _d S r )rY �kind)r! rY r r" r" r# r$ < s zVMutualArgumentExclusionTests.test_invalidParameterType.<locals>.FakeParameter.__init__Nr r" r" r" r# � FakeParameter; s r c S s d S r r" r� r" r" r# r� @ s zDMutualArgumentExclusionTests.test_invalidParameterType.<locals>.funcrD r^ Zfaker )rD r^ N)r� r� r ru r6 r� r )r! r r r� r ZdummyParametersZfakeSigr" r" r# �test_invalidParameterType1 s z6MutualArgumentExclusionTests.test_invalidParameterTyper� Nz!inspect.signature() not available)r' r( r) r* r� r� r� r� r� r r r r r r r8 r� �skipr" r" r" r# r� � s r� )r� z_deprecatetests.py.3only�KeywordOnlyTests)�TestCasec @ s e Zd ZdZdZdd� ZdS )r z� A dummy class to show that this test file was discovered but the tests are unable to be ran in this version of Python. zAkeyword only arguments (PEP 3102) are only in Python 3 and higherc C s dS )zq A skipped test to show that this was not ran because the Python is too old. Nr" r% r" r" r# �test_notAvailable` s z"KeywordOnlyTests.test_notAvailableN)r' r( r) r* r r r" r" r" r# r W s �)Dr* Z __future__r r ra r- r� r� �os.pathr r r � importlibr � ImportErrorZtwisted.pythonr Ztwisted.python.deprecater r r r r r r r� r r r r Ztwisted.python.compatr r Z incrementalr Ztwisted.python.runtimer Ztwisted.python.filepathr Ztwisted.python.testr Z#twisted.python.test.modules_helpersr Ztwisted.trial.unittestr r> r r+ rJ rf r� r� r� r� r� r� r� r� r� � version_infor� r� rg �_pathZ_grs r r r" r" r" r# �<module> sX , Omm 9 E
Save File
Cancel