1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
import pytest
from scripts.validate_exception_location import (
ERROR_MESSAGE,
validate_exception_and_warning_placement,
)
PATH = "t.py"
# ERRORS_IN_TESTING_RST is the set returned when parsing testing.rst for all the
# exceptions and warnings.
CUSTOM_EXCEPTION_NOT_IN_TESTING_RST = "MyException"
CUSTOM_EXCEPTION__IN_TESTING_RST = "MyOldException"
ERRORS_IN_TESTING_RST = {CUSTOM_EXCEPTION__IN_TESTING_RST}
TEST_CODE = """
import numpy as np
import sys
def my_func():
pass
class {custom_name}({error_type}):
pass
"""
# Test with various python-defined exceptions to ensure they are all flagged.
@pytest.fixture(params=["Exception", "ValueError", "Warning", "UserWarning"])
def error_type(request):
return request.param
def test_class_that_inherits_an_exception_and_is_not_in_the_testing_rst_is_flagged(
capsys, error_type
) -> None:
content = TEST_CODE.format(
custom_name=CUSTOM_EXCEPTION_NOT_IN_TESTING_RST, error_type=error_type
)
expected_msg = ERROR_MESSAGE.format(errors=CUSTOM_EXCEPTION_NOT_IN_TESTING_RST)
with pytest.raises(SystemExit, match=None):
validate_exception_and_warning_placement(PATH, content, ERRORS_IN_TESTING_RST)
result_msg, _ = capsys.readouterr()
assert result_msg == expected_msg
def test_class_that_inherits_an_exception_but_is_in_the_testing_rst_is_not_flagged(
capsys, error_type
) -> None:
content = TEST_CODE.format(
custom_name=CUSTOM_EXCEPTION__IN_TESTING_RST, error_type=error_type
)
validate_exception_and_warning_placement(PATH, content, ERRORS_IN_TESTING_RST)
def test_class_that_does_not_inherit_an_exception_is_not_flagged(capsys) -> None:
content = "class MyClass(NonExceptionClass): pass"
validate_exception_and_warning_placement(PATH, content, ERRORS_IN_TESTING_RST)
|
