Format: application/octet-stream
1 import datetime
2 import types
3 from abc import ABCMeta, abstractmethod
4 from typing import (
5 Any,
6 Callable,
7 Dict,
8 FrozenSet,
9 Iterable,
10 Iterator,
11 List,
12 Mapping,
13 NoReturn,
14 Optional,
15 Pattern,
16 Sequence,
17 Set,
18 Text,
19 TextIO,
20 Tuple,
21 Type,
22 TypeVar,
23 Union,
24 overload,
25 )
26
27 _T = TypeVar("_T")
28 _FT = TypeVar("_FT")
29
30 _ExceptionType = Union[Type[BaseException], Tuple[Type[BaseException], ...]]
31 _Regexp = Union[Text, Pattern[Text]]
32
33 _SysExcInfoType = Union[Tuple[Type[BaseException], BaseException, types.TracebackType], Tuple[None, None, None]]
34
35 class Testable(metaclass=ABCMeta):
36 @abstractmethod
37 def run(self, result: TestResult) -> None: ...
38 @abstractmethod
39 def debug(self) -> None: ...
40 @abstractmethod
41 def countTestCases(self) -> int: ...
42
43 # TODO ABC for test runners?
44
45 class TestResult:
46 errors: List[Tuple[TestCase, str]]
47 failures: List[Tuple[TestCase, str]]
48 skipped: List[Tuple[TestCase, str]]
49 expectedFailures: List[Tuple[TestCase, str]]
50 unexpectedSuccesses: List[TestCase]
51 shouldStop: bool
52 testsRun: int
53 buffer: bool
54 failfast: bool
55 def wasSuccessful(self) -> bool: ...
56 def stop(self) -> None: ...
57 def startTest(self, test: TestCase) -> None: ...
58 def stopTest(self, test: TestCase) -> None: ...
59 def startTestRun(self) -> None: ...
60 def stopTestRun(self) -> None: ...
61 def addError(self, test: TestCase, err: _SysExcInfoType) -> None: ...
62 def addFailure(self, test: TestCase, err: _SysExcInfoType) -> None: ...
63 def addSuccess(self, test: TestCase) -> None: ...
64 def addSkip(self, test: TestCase, reason: str) -> None: ...
65 def addExpectedFailure(self, test: TestCase, err: str) -> None: ...
66 def addUnexpectedSuccess(self, test: TestCase) -> None: ...
67
68 class _AssertRaisesBaseContext:
69 expected: Any
70 failureException: Type[BaseException]
71 obj_name: str
72 expected_regex: Pattern[str]
73
74 class _AssertRaisesContext(_AssertRaisesBaseContext):
75 exception: Any
76 def __enter__(self) -> _AssertRaisesContext: ...
77 def __exit__(self, exc_type, exc_value, tb) -> bool: ...
78
79 class TestCase(Testable):
80 failureException: Type[BaseException]
81 longMessage: bool
82 maxDiff: Optional[int]
83 # undocumented
84 _testMethodName: str
85 def __init__(self, methodName: str = ...) -> None: ...
86 def setUp(self) -> None: ...
87 def tearDown(self) -> None: ...
88 @classmethod
89 def setUpClass(cls) -> None: ...
90 @classmethod
91 def tearDownClass(cls) -> None: ...
92 def run(self, result: TestResult = ...) -> None: ...
93 def debug(self) -> None: ...
94 def assert_(self, expr: Any, msg: object = ...) -> None: ...
95 def failUnless(self, expr: Any, msg: object = ...) -> None: ...
96 def assertTrue(self, expr: Any, msg: object = ...) -> None: ...
97 def assertEqual(self, first: Any, second: Any, msg: object = ...) -> None: ...
98 def assertEquals(self, first: Any, second: Any, msg: object = ...) -> None: ...
99 def failUnlessEqual(self, first: Any, second: Any, msg: object = ...) -> None: ...
100 def assertNotEqual(self, first: Any, second: Any, msg: object = ...) -> None: ...
101 def assertNotEquals(self, first: Any, second: Any, msg: object = ...) -> None: ...
102 def failIfEqual(self, first: Any, second: Any, msg: object = ...) -> None: ...
103 @overload
104 def assertAlmostEqual(self, first: float, second: float, places: int = ..., msg: Any = ...) -> None: ...
105 @overload
106 def assertAlmostEqual(self, first: float, second: float, *, msg: Any = ..., delta: float = ...) -> None: ...
107 @overload
108 def assertAlmostEqual(
109 self, first: datetime.datetime, second: datetime.datetime, *, msg: Any = ..., delta: datetime.timedelta = ...
110 ) -> None: ...
111 @overload
112 def assertAlmostEquals(self, first: float, second: float, places: int = ..., msg: Any = ...) -> None: ...
113 @overload
114 def assertAlmostEquals(self, first: float, second: float, *, msg: Any = ..., delta: float = ...) -> None: ...
115 @overload
116 def assertAlmostEquals(
117 self, first: datetime.datetime, second: datetime.datetime, *, msg: Any = ..., delta: datetime.timedelta = ...
118 ) -> None: ...
119 def failUnlessAlmostEqual(self, first: float, second: float, places: int = ..., msg: object = ...) -> None: ...
120 @overload
121 def assertNotAlmostEqual(self, first: float, second: float, places: int = ..., msg: Any = ...) -> None: ...
122 @overload
123 def assertNotAlmostEqual(self, first: float, second: float, *, msg: Any = ..., delta: float = ...) -> None: ...
124 @overload
125 def assertNotAlmostEqual(
126 self, first: datetime.datetime, second: datetime.datetime, *, msg: Any = ..., delta: datetime.timedelta = ...
127 ) -> None: ...
128 @overload
129 def assertNotAlmostEquals(self, first: float, second: float, places: int = ..., msg: Any = ...) -> None: ...
130 @overload
131 def assertNotAlmostEquals(self, first: float, second: float, *, msg: Any = ..., delta: float = ...) -> None: ...
132 @overload
133 def assertNotAlmostEquals(
134 self, first: datetime.datetime, second: datetime.datetime, *, msg: Any = ..., delta: datetime.timedelta = ...
135 ) -> None: ...
136 def failIfAlmostEqual(
137 self, first: float, second: float, places: int = ..., msg: object = ..., delta: float = ...
138 ) -> None: ...
139 def assertGreater(self, first: Any, second: Any, msg: object = ...) -> None: ...
140 def assertGreaterEqual(self, first: Any, second: Any, msg: object = ...) -> None: ...
141 def assertMultiLineEqual(self, first: str, second: str, msg: object = ...) -> None: ...
142 def assertSequenceEqual(
143 self, first: Sequence[Any], second: Sequence[Any], msg: object = ..., seq_type: type = ...
144 ) -> None: ...
145 def assertListEqual(self, first: List[Any], second: List[Any], msg: object = ...) -> None: ...
146 def assertTupleEqual(self, first: Tuple[Any, ...], second: Tuple[Any, ...], msg: object = ...) -> None: ...
147 def assertSetEqual(
148 self, first: Union[Set[Any], FrozenSet[Any]], second: Union[Set[Any], FrozenSet[Any]], msg: object = ...
149 ) -> None: ...
150 def assertDictEqual(self, first: Dict[Any, Any], second: Dict[Any, Any], msg: object = ...) -> None: ...
151 def assertLess(self, first: Any, second: Any, msg: object = ...) -> None: ...
152 def assertLessEqual(self, first: Any, second: Any, msg: object = ...) -> None: ...
153 @overload
154 def assertRaises(self, exception: _ExceptionType, callable: Callable[..., Any], *args: Any, **kwargs: Any) -> None: ...
155 @overload
156 def assertRaises(self, exception: _ExceptionType) -> _AssertRaisesContext: ...
157 @overload
158 def assertRaisesRegexp(
159 self, exception: _ExceptionType, regexp: _Regexp, callable: Callable[..., Any], *args: Any, **kwargs: Any
160 ) -> None: ...
161 @overload
162 def assertRaisesRegexp(self, exception: _ExceptionType, regexp: _Regexp) -> _AssertRaisesContext: ...
163 def assertRegexpMatches(self, text: Text, regexp: _Regexp, msg: object = ...) -> None: ...
164 def assertNotRegexpMatches(self, text: Text, regexp: _Regexp, msg: object = ...) -> None: ...
165 def assertItemsEqual(self, first: Iterable[Any], second: Iterable[Any], msg: object = ...) -> None: ...
166 def assertDictContainsSubset(self, expected: Mapping[Any, Any], actual: Mapping[Any, Any], msg: object = ...) -> None: ...
167 def addTypeEqualityFunc(self, typeobj: type, function: Callable[..., None]) -> None: ...
168 @overload
169 def failUnlessRaises(self, exception: _ExceptionType, callable: Callable[..., Any], *args: Any, **kwargs: Any) -> None: ...
170 @overload
171 def failUnlessRaises(self, exception: _ExceptionType) -> _AssertRaisesContext: ...
172 def failIf(self, expr: Any, msg: object = ...) -> None: ...
173 def assertFalse(self, expr: Any, msg: object = ...) -> None: ...
174 def assertIs(self, first: object, second: object, msg: object = ...) -> None: ...
175 def assertIsNot(self, first: object, second: object, msg: object = ...) -> None: ...
176 def assertIsNone(self, expr: Any, msg: object = ...) -> None: ...
177 def assertIsNotNone(self, expr: Any, msg: object = ...) -> None: ...
178 def assertIn(self, first: _T, second: Iterable[_T], msg: object = ...) -> None: ...
179 def assertNotIn(self, first: _T, second: Iterable[_T], msg: object = ...) -> None: ...
180 def assertIsInstance(self, obj: Any, cls: Union[type, Tuple[type, ...]], msg: object = ...) -> None: ...
181 def assertNotIsInstance(self, obj: Any, cls: Union[type, Tuple[type, ...]], msg: object = ...) -> None: ...
182 def fail(self, msg: object = ...) -> NoReturn: ...
183 def countTestCases(self) -> int: ...
184 def defaultTestResult(self) -> TestResult: ...
185 def id(self) -> str: ...
186 def shortDescription(self) -> str: ... # May return None
187 def addCleanup(self, function: Any, *args: Any, **kwargs: Any) -> None: ...
188 def doCleanups(self) -> bool: ...
189 def skipTest(self, reason: Any) -> None: ...
190 def _formatMessage(self, msg: Optional[Text], standardMsg: Text) -> str: ... # undocumented
191 def _getAssertEqualityFunc(self, first: Any, second: Any) -> Callable[..., None]: ... # undocumented
192
193 class FunctionTestCase(TestCase):
194 def __init__(
195 self,
196 testFunc: Callable[[], None],
197 setUp: Optional[Callable[[], None]] = ...,
198 tearDown: Optional[Callable[[], None]] = ...,
199 description: Optional[str] = ...,
200 ) -> None: ...
201 def debug(self) -> None: ...
202 def countTestCases(self) -> int: ...
203
204 class TestSuite(Testable):
205 def __init__(self, tests: Iterable[Testable] = ...) -> None: ...
206 def addTest(self, test: Testable) -> None: ...
207 def addTests(self, tests: Iterable[Testable]) -> None: ...
208 def run(self, result: TestResult) -> None: ...
209 def debug(self) -> None: ...
210 def countTestCases(self) -> int: ...
211 def __iter__(self) -> Iterator[Testable]: ...
212
213 class TestLoader:
214 testMethodPrefix: str
215 sortTestMethodsUsing: Optional[Callable[[str, str], int]]
216 suiteClass: Callable[[List[TestCase]], TestSuite]
217 def loadTestsFromTestCase(self, testCaseClass: Type[TestCase]) -> TestSuite: ...
218 def loadTestsFromModule(self, module: types.ModuleType = ..., use_load_tests: bool = ...) -> TestSuite: ...
219 def loadTestsFromName(self, name: str = ..., module: Optional[types.ModuleType] = ...) -> TestSuite: ...
220 def loadTestsFromNames(self, names: List[str] = ..., module: Optional[types.ModuleType] = ...) -> TestSuite: ...
221 def discover(self, start_dir: str, pattern: str = ..., top_level_dir: Optional[str] = ...) -> TestSuite: ...
222 def getTestCaseNames(self, testCaseClass: Type[TestCase] = ...) -> List[str]: ...
223
224 defaultTestLoader: TestLoader
225
226 class TextTestResult(TestResult):
227 def __init__(self, stream: TextIO, descriptions: bool, verbosity: int) -> None: ...
228 def getDescription(self, test: TestCase) -> str: ... # undocumented
229 def printErrors(self) -> None: ... # undocumented
230 def printErrorList(self, flavour: str, errors: List[Tuple[TestCase, str]]) -> None: ... # undocumented
231
232 class TextTestRunner:
233 def __init__(
234 self,
235 stream: Optional[TextIO] = ...,
236 descriptions: bool = ...,
237 verbosity: int = ...,
238 failfast: bool = ...,
239 buffer: bool = ...,
240 resultclass: Optional[Type[TestResult]] = ...,
241 ) -> None: ...
242 def _makeResult(self) -> TestResult: ...
243 def run(self, test: Testable) -> TestResult: ... # undocumented
244
245 class SkipTest(Exception): ...
246
247 # TODO precise types
248 def skipUnless(condition: Any, reason: Union[str, unicode]) -> Any: ...
249 def skipIf(condition: Any, reason: Union[str, unicode]) -> Any: ...
250 def expectedFailure(func: _FT) -> _FT: ...
251 def skip(reason: Union[str, unicode]) -> Any: ...
252
253 # not really documented
254 class TestProgram:
255 result: TestResult
256 def runTests(self) -> None: ... # undocumented
257
258 def main(
259 module: Union[None, Text, types.ModuleType] = ...,
260 defaultTest: Optional[str] = ...,
261 argv: Optional[Sequence[str]] = ...,
262 testRunner: Union[Type[TextTestRunner], TextTestRunner, None] = ...,
263 testLoader: TestLoader = ...,
264 exit: bool = ...,
265 verbosity: int = ...,
266 failfast: Optional[bool] = ...,
267 catchbreak: Optional[bool] = ...,
268 buffer: Optional[bool] = ...,
269 ) -> TestProgram: ...
270 def load_tests(loader: TestLoader, tests: TestSuite, pattern: Optional[Text]) -> TestSuite: ...
271 def installHandler() -> None: ...
272 def registerResult(result: TestResult) -> None: ...
273 def removeResult(result: TestResult) -> bool: ...
274 @overload
275 def removeHandler() -> None: ...
276 @overload
277 def removeHandler(function: Callable[..., Any]) -> Callable[..., Any]: ...
278
279 # private but occasionally used
280 util: types.ModuleType
281