o b[@sTdZddlmZmZmZddlZddlmZmZm Z ddl m Z GdddeZ dS)z|Unit tests for the raised exception documentation checking in the `DocstringChecker` in :mod:`pylint.extensions.check_docs` )divisionprint_functionabsolute_importN)CheckerTestCaseMessage set_config)DocstringParameterCheckerc@seZdZdZeZddZddZedddd Z d d Z d d Z ddZ ddZ ddZddZeddddZddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zd2d3Zd4d5Zd6d7Z d8d9Z!d:d;Z"edddd?Z$d@dAZ%dBdCZ&dDdEZ'dFdGZ(dHdIZ)edddJdKZ*dLdMZ+dNdOZ,dPdQZ-dRdSZ.dTdUZ/dVdWZ0dXdYZ1dZS)[TestDocstringCheckerRaisez'Tests for pylint_plugin.RaiseDocCheckercCDtd}||j|WddS1swYdS)NzL def my_func(self): raise RuntimeError('hi') #@ astroid extract_nodeassertNoMessageschecker visit_raiseself raise_noderk/var/www/secure340b-portal/env/lib/python3.10/site-packages/pylint/test/extensions/test_check_raise_docs.pytest_ignores_no_docstrings  "z3TestDocstringCheckerRaise.test_ignores_no_docstringcCsNtd}|jd}||j|WddS1s wYdS)Np def my_func(self): """This is a docstring.""" raise RuntimeError('hi') r)r r bodyrrrrnoderrrrtest_ignores_unknown_style!s   "z4TestDocstringCheckerRaise.test_ignores_unknown_styleF)Zaccept_no_raise_doccCZtd}|jd}|td|dd|j|WddS1s&wYdS)Nrrmissing-raises-doc RuntimeErrorZmsg_idrargsr r rassertAddsMessagesrrrrrrrtest_warns_unknown_style+s  "z2TestDocstringCheckerRaise.test_warns_unknown_stylecCr)Nz def my_func(self): """This is a docstring. :raises NameError: Never """ raise RuntimeError('hi') raise NameError('hi') rrrr r"rrrrtest_find_missing_sphinx_raises:  "z9TestDocstringCheckerRaise.test_find_missing_sphinx_raisescCr)Nz def my_func(self): """This is a docstring. Raises: NameError: Never """ raise RuntimeError('hi') raise NameError('hi') rrrr r"rrrrtest_find_missing_google_raisesL  "z9TestDocstringCheckerRaise.test_find_missing_google_raisescCr )Nz def my_func(self): """This is a google docstring. Raises: re.error: Sometimes """ import re raise re.error('hi') #@ r rrrr&test_find_google_attr_raises_exact_exc_s   z@TestDocstringCheckerRaise.test_find_google_attr_raises_exact_exccCr )Nz def my_func(self): """This is a google docstring. Raises: re.error: Sometimes """ from re import error raise error('hi') #@ r rrrr'test_find_google_attr_raises_substr_excns  "zATestDocstringCheckerRaise.test_find_google_attr_raises_substr_exccCr)Nz def my_func(self): """This is a google docstring. Raises: re.anothererror: Sometimes """ from re import error raise error('hi') rerrorr r"rrrr*test_find_valid_missing_google_attr_raises|r(zDTestDocstringCheckerRaise.test_find_valid_missing_google_attr_raisescCr )Nz def my_func(self): """This is a google docstring. Raises: bogusmodule.error: Sometimes """ from re import error raise error('hi') #@ r rrrr,test_find_invalid_missing_google_attr_raises  "zFTestDocstringCheckerRaise.test_find_invalid_missing_google_attr_raisesc CXd}dD]%}t|j|d}||j|Wdn1s$wYqdS)Nz def my_func(self): """This is a google docstring. Raises: {prefix}re.error: Sometimes """ import re raise re.error('hi') #@ ~!prefixr r formatrrrrZ code_snippetr6rrrrtest_google_raises_with_prefixs  z8TestDocstringCheckerRaise.test_google_raises_with_prefixcCr)Nz def my_func(self): """This is a docstring. Raises ------ NameError Never """ raise RuntimeError('hi') raise NameError('hi') rrrr r"rrrrtest_find_missing_numpy_raises  "z8TestDocstringCheckerRaise.test_find_missing_numpy_raisescCr )Na def my_func(self): """This is a docstring. :raises RuntimeError: Always :except NameError: Never :raise OSError: Never :exception ValueError: Never """ raise RuntimeError('Blah') #@ r rrrr"test_ignore_spurious_sphinx_raises  "zz5TestDocstringCheckerRaise.test_find_all_google_raisescCr )Na% def my_func(self): """This is a docstring. Raises ------ RuntimeError Always NameError Never """ raise RuntimeError('hi') #@ raise NameError('hi') r rrrrtest_find_all_numpy_raisesr@z4TestDocstringCheckerRaise.test_find_all_numpy_raisescCXtd}|}|td|dd|j|WddS1s%wYdS)Na  def my_func(self): """This is a docstring. :raises NameError: Sometimes """ try: fake_func() except RuntimeError: raise #@ raise NameError('hi') rrr r r framer#rrrrrrrrr!test_finds_rethrown_sphinx_raises  "z;TestDocstringCheckerRaise.test_finds_rethrown_sphinx_raisescCrC)Na def my_func(self): """This is a docstring. Raises: NameError: Sometimes """ try: fake_func() except RuntimeError: raise #@ raise NameError('hi') rrr rDrFrrr test_find_rethrown_google_raises "z:TestDocstringCheckerRaise.test_find_rethrown_google_raisescCrC)Na9 def my_func(self): """This is a docstring. Raises ------ NameError Sometimes """ try: fake_func() except RuntimeError: raise #@ raise NameError('hi') rrr rDrFrrrtest_find_rethrown_numpy_raises4 "z9TestDocstringCheckerRaise.test_find_rethrown_numpy_raisescCrC)Na def my_func(self): """This is a docstring. :raises NameError: Sometimes """ try: fake_func() except (RuntimeError, ValueError): raise #@ raise NameError('hi') rzRuntimeError, ValueErrorr rDrFrrr*test_finds_rethrown_sphinx_multiple_raisesMrHzDTestDocstringCheckerRaise.test_finds_rethrown_sphinx_multiple_raisescCrC)Na* def my_func(self): """This is a docstring. Raises: NameError: Sometimes """ try: fake_func() except (RuntimeError, ValueError): raise #@ raise NameError('hi') rrMr rDrFrrr)test_find_rethrown_google_multiple_raisescrJzCTestDocstringCheckerRaise.test_find_rethrown_google_multiple_raisescCrC)NaG def my_func(self): """This is a docstring. Raises ------ NameError Sometimes """ try: fake_func() except (RuntimeError, ValueError): raise #@ raise NameError('hi') rrMr rDrFrrr(test_find_rethrown_numpy_multiple_raiseszrLzBTestDocstringCheckerRaise.test_find_rethrown_numpy_multiple_raisescCr )Na def my_func(self): """This is a docstring. :raises NameError: Sometimes """ try: raise RuntimeError('hi') #@ except RuntimeError: pass raise NameError('hi') r rrrr!test_ignores_caught_sphinx_raises  "z;TestDocstringCheckerRaise.test_ignores_caught_sphinx_raisescCr )Na( def my_func(self): """This is a docstring. Raises: NameError: Sometimes """ try: raise RuntimeError('hi') #@ except RuntimeError: pass raise NameError('hi') r rrrr!test_ignores_caught_google_raisesr@z;TestDocstringCheckerRaise.test_ignores_caught_google_raisescCr )NaK def my_func(self): """This is a numpy docstring. Raises ------ NameError Sometimes """ try: raise RuntimeError('hi') #@ except RuntimeError: pass raise NameError('hi') r rrrr test_ignores_caught_numpy_raisess  "z:TestDocstringCheckerRaise.test_ignores_caught_numpy_raisescCr )Nz def my_func(self): """This is a numpy docstring. Raises ------ re.error Sometimes """ import re raise re.error('hi') #@ r rrrr%test_find_numpy_attr_raises_exact_excs   z?TestDocstringCheckerRaise.test_find_numpy_attr_raises_exact_exccCr )Nz def my_func(self): """This is a numpy docstring. Raises ------ re.error Sometimes """ from re import error raise error('hi') #@ r rrrr&test_find_numpy_attr_raises_substr_excr0z@TestDocstringCheckerRaise.test_find_numpy_attr_raises_substr_exccCr)Nz def my_func(self): """This is a numpy docstring. Raises ------ re.anothererror Sometimes """ from re import error raise error('hi') r+rr,r r"rrrr)test_find_valid_missing_numpy_attr_raisesr<zCTestDocstringCheckerRaise.test_find_valid_missing_numpy_attr_raisescCr )Nz def my_func(self): """This is a numpy docstring. Raises ------ bogusmodule.error Sometimes """ from re import error raise error('hi') #@ r rrrr+test_find_invalid_missing_numpy_attr_raisesr@zETestDocstringCheckerRaise.test_find_invalid_missing_numpy_attr_raisesc Cr1)Nz def my_func(self): """This is a numpy docstring. Raises ------ {prefix}re.error Sometimes """ import re raise re.error('hi') #@ r2r5r7r9rrrtest_numpy_raises_with_prefixs  z7TestDocstringCheckerRaise.test_numpy_raises_with_prefixcCrC)Nz def my_func(self): """This is a docstring. :raises NameError: Never """ my_exception = RuntimeError('hi') raise my_exception #@ raise NameError('hi') rrr rDrFrrr3test_find_missing_sphinx_raises_infer_from_instance%s  "zMTestDocstringCheckerRaise.test_find_missing_sphinx_raises_infer_from_instancecCrC)Na  def my_func(self): """This is a docstring. :raises NameError: Never """ def ex_func(val): return RuntimeError(val) raise ex_func('hi') #@ raise NameError('hi') rrr rDrFrrr3test_find_missing_sphinx_raises_infer_from_function8s  "zMTestDocstringCheckerRaise.test_find_missing_sphinx_raises_infer_from_functioncCr )Nz def my_func(self): """This is a sphinx docstring. :raises re.error: Sometimes """ import re raise re.error('hi') #@ r rrrr&test_find_sphinx_attr_raises_exact_excL  "z@TestDocstringCheckerRaise.test_find_sphinx_attr_raises_exact_exccCr )Nz def my_func(self): """This is a sphinx docstring. :raises re.error: Sometimes """ from re import error raise error('hi') #@ r rrrr'test_find_sphinx_attr_raises_substr_excYr]zATestDocstringCheckerRaise.test_find_sphinx_attr_raises_substr_exccCr)Nz def my_func(self): """This is a sphinx docstring. :raises re.anothererror: Sometimes """ from re import error raise error('hi') r+rr,r r"rrrr*test_find_valid_missing_sphinx_attr_raisesfr&zDTestDocstringCheckerRaise.test_find_valid_missing_sphinx_attr_raisescCr )Nz def my_func(self): """This is a sphinx docstring. :raises bogusmodule.error: Sometimes """ from re import error raise error('hi') #@ r rrrr,test_find_invalid_missing_sphinx_attr_raisesxr>zFTestDocstringCheckerRaise.test_find_invalid_missing_sphinx_attr_raisesc Csd}dD]%}t|j|d}||j|Wdn1s$wYq||j|WddS1s@wYdS)Nz def my_func(self): """This is a sphinx docstring. :raises {prefix}re.error: Sometimes """ import re raise re.error('hi') #@ r2r5r7r9rrrtest_sphinx_raises_with_prefixs   "z8TestDocstringCheckerRaise.test_sphinx_raises_with_prefixcCr )Nz from unknown import Unknown def my_func(self): """This is a docstring. :raises NameError: Never """ raise Unknown('hi') #@ raise NameError('hi') r rrrrtest_ignores_raise_uninferabler>z8TestDocstringCheckerRaise.test_ignores_raise_uninferablecCrC)Na[ def my_func(self): """This is a docstring. :raises NameError: Never """ def ex_func(val): def inner_func(value): return OSError(value) return RuntimeError(val) raise ex_func('hi') #@ raise NameError('hi') rrr rDrFrrr)test_ignores_returns_from_inner_functionss  "zCTestDocstringCheckerRaise.test_ignores_returns_from_inner_functionscCr )Nz def myfunc(): """This is a docstring :raises NameError: Never """ def inner_func(): return 42 raise inner_func() #@ r rrrr#test_ignores_returns_use_only_namesr>z=TestDocstringCheckerRaise.test_ignores_returns_use_only_namescCr )Na def myfunc(): """This is a docstring :raises MyException: Never """ class MyException(Exception): pass def inner_func(): return MyException raise inner_func() #@ r rrrr1test_ignores_returns_use_only_exception_instancesrRzKTestDocstringCheckerRaise.test_ignores_returns_use_only_exception_instancescCr )Nz import collections def test(): """raises :raise U: pass """ try: pass except collections.U as exc: raise #@ r rrrr%test_no_crash_when_inferring_handlersrRz?TestDocstringCheckerRaise.test_no_crash_when_inferring_handlerscCr )Nz import collections def test(): """raises :raise U: pass """ try: pass except U as exc: raise #@ r rrrr&test_no_crash_when_cant_find_exceptionrRz@TestDocstringCheckerRaise.test_no_crash_when_cant_find_exceptioncCr )Nz def my_func(): """ Raises: NotImplementedError: When called. """ raise NotImplementedError #@ r rrrr'test_no_error_notimplemented_documenteds  "zATestDocstringCheckerRaise.test_no_error_notimplemented_documentedN)2__name__ __module__ __qualname____doc__rZ CHECKER_CLASSrrrr$r%r'r)r*r.r/r:r;r=r?rArBrGrIrKrNrOrPrQrSrTrUrVrWrXrYrZr[r\r^r_r`rarbrcrdrerfrgrhrrrrr sd       r ) rl __future__rrrr Zpylint.testutilsrrrZpylint.extensions.docparamsrr rrrrs