improve unittest

This commit is contained in:
tharvik
2016-07-06 11:33:48 +02:00
parent c98c2afb58
commit e102c99f36

View File

@@ -1,177 +1,329 @@
# Stubs for unittest
# Based on http://docs.python.org/3.0/library/unittest.html
# NOTE: These stubs are based on the 3.0 version API, since later versions
# would require featurs not supported currently by mypy.
# Only a subset of functionality is included.
## Stubs for unittest
from typing import (
Any, Callable, Iterable, Tuple, List, TextIO, Sequence,
overload, TypeVar, Pattern
Any, Callable, Iterable, Iterator, List, Optional, Pattern, Sequence,
TextIO, Tuple, Type, TypeVar, Union,
overload,
)
from abc import abstractmethod, ABCMeta
import logging
import sys
from types import ModuleType, TracebackType
_T = TypeVar('_T')
_FT = TypeVar('_FT')
_FT = TypeVar('_FT', Callable[[Any], Any])
class Testable(metaclass=ABCMeta):
@abstractmethod
def run(self, result: 'TestResult') -> None: ...
@abstractmethod
def debug(self) -> None: ...
@abstractmethod
def countTestCases(self) -> int: ...
# TODO ABC for test runners?
def skip(reason: str) -> Callable[[_FT], _FT]: ...
def skipIf(condition: bool, reason: str) -> Callable[[_FT], _FT]: ...
def skipUnless(condition: bool, reason: str) -> Callable[[_FT], _FT]: ...
def expectedFailure(func: _FT) -> _FT: ...
class TestResult:
errors = ... # type: List[Tuple[Testable, str]]
failures = ... # type: List[Tuple[Testable, str]]
testsRun = 0
shouldStop = False
class SkipTest(Exception):
def __init__(self, reason: str) -> None: ...
def wasSuccessful(self) -> bool: ...
def stop(self) -> None: ...
def startTest(self, test: Testable) -> None: ...
def stopTest(self, test: Testable) -> None: ...
def addError(self, test: Testable,
err: Tuple[type, Any, Any]) -> None: ... # TODO
def addFailure(self, test: Testable,
err: Tuple[type, Any, Any]) -> None: ... # TODO
def addSuccess(self, test: Testable) -> None: ...
class _AssertRaisesBaseContext:
expected = ... # type: Any
failureException = ... # type: type
obj_name = ... # type: str
expected_regex = ... # type: Pattern[str]
class _AssertRaisesContext(_AssertRaisesBaseContext):
exception = ... # type: Any # TODO precise type
def __enter__(self) -> _AssertRaisesContext: ...
def __exit__(self, exc_type, exc_value, tb) -> bool: ...
class _AssertWarnsContext(_AssertRaisesBaseContext):
warning = ... # type: Any # TODO precise type
filename = ... # type: str
lineno = 0
def __enter__(self) -> _AssertWarnsContext: ...
def __exit__(self, exc_type, exc_value, tb) -> bool: ...
class TestCase(Testable):
class TestCase:
failureException = ... # type: Type[BaseException]
longMessage = ... # type: bool
maxDiff = ... # type: Optional[int]
def __init__(self, methodName: str = ...) -> None: ...
# TODO failureException
def setUp(self) -> None: ...
def tearDown(self) -> None: ...
def run(self, result: TestResult = ...) -> None: ...
@classmethod
def setUpClass(cls) -> None: ...
@classmethod
def tearDownClass(cls) -> None: ...
def run(self, result: Optional[TestResult] = ...) -> TestCase: ...
def skipTest(self, reason: Any) -> None: ...
if sys.version_info >= (3, 4):
def subTest(self, msg: Any = ..., **params: Any) -> None: ...
def debug(self) -> None: ...
def assert_(self, expr: Any, msg: object = ...) -> None: ...
def failUnless(self, expr: Any, msg: object = ...) -> None: ...
def assertTrue(self, expr: Any, msg: object = ...) -> None: ...
def assertEqual(self, first: Any, second: Any,
msg: object = ...) -> None: ...
def failUnlessEqual(self, first: Any, second: Any,
msg: object = ...) -> None: ...
def assertEqual(self, first: Any, second: Any, msg: Any = ...) -> None: ...
def assertNotEqual(self, first: Any, second: Any,
msg: object = ...) -> None: ...
def failIfEqual(self, first: Any, second: Any,
msg: object = ...) -> None: ...
def assertAlmostEqual(self, first: float, second: float, places: int = ...,
msg: object = ...,
delta: float = ...) -> None: ...
def failUnlessAlmostEqual(self, first: float, second: float,
places: int = ...,
msg: object = ...) -> None: ...
def assertNotAlmostEqual(self, first: float, second: float,
places: int = ..., msg: object = ...,
delta: float = ...) -> None: ...
def failIfAlmostEqual(self, first: float, second: float, places: int = ...,
msg: object = ...) -> None: ...
def assertGreater(self, first: Any, second: Any,
msg: object = ...) -> None: ...
def assertGreaterEqual(self, first: Any, second: Any,
msg: object = ...) -> None: ...
def assertMultiLineEqual(self, first: str, second: str,
msg: object = ...) -> None: ...
def assertSequenceEqual(self, first: Sequence[Any], second: Sequence[Any],
msg: object = ...,
seq_type: type = ...) -> None: ...
def assertListEqual(self, first: List[Any], second: List[Any],
msg: object = ...) -> None: ...
def assertTupleEqual(self, first: Tuple[Any, ...], second: Tuple[Any, ...],
msg: object = ...) -> None: ...
def assertSetEqual(self, first: Set[Any], second: Set[Any],
msg: object = ...) -> None: ...
def assertDictEqual(self, first: Dict[Any, Any], second: Dict[Any, Any],
msg: object = ...) -> None: ...
def assertLess(self, first: Any, second: Any,
msg: object = ...) -> None: ...
def assertLessEqual(self, first: Any, second: Any,
msg: object = ...) -> None: ...
# TODO: If callableObj is None, the return value is None.
def assertRaises(self, excClass: type, callableObj: Any = ...,
*args: Any, **kwargs: Any) -> _AssertRaisesContext: ...
def failIf(self, expr: Any, msg: object = ...) -> None: ...
def assertFalse(self, expr: Any, msg: object = ...) -> None: ...
def assertIs(self, first: object, second: object,
msg: object = ...) -> None: ...
def assertIsNot(self, first: object, second: object,
msg: object = ...) -> None: ...
def assertIsNone(self, expr: Any, msg: object = ...) -> None: ...
def assertIsNotNone(self, expr: Any, msg: object = ...) -> None: ...
msg: Any = ...) -> None: ...
def assertTrue(self, expr: Any, msg: Any = ...) -> None: ...
def assertFalse(self, expr: Any, msg: Any = ...) -> None: ...
def assertIs(self, first: Any, second: Any, msg: Any = ...) -> None: ...
def assertIsNot(self, first: Any, second: Any,
msg: Any = ...) -> None: ...
def assertIsNone(self, expr: Any, msg: Any = ...) -> None: ...
def assertIsNotNone(self, expr: Any, msg: Any = ...) -> None: ...
def assertIn(self, first: _T, second: Iterable[_T],
msg: object = ...) -> None: ...
msg: Any = ...) -> None: ...
def assertNotIn(self, first: _T, second: Iterable[_T],
msg: object = ...) -> None: ...
def assertIsInstance(self, obj: Any, cls: type,
msg: object = ...) -> None: ...
def assertNotIsInstance(self, obj: Any, cls: type,
msg: object = ...) -> None: ...
def assertWarns(self, expected_warning: type, callable_obj: Any = ...,
*args: Any, **kwargs: Any) -> _AssertWarnsContext: ...
def fail(self, msg: object = ...) -> None: ...
msg: Any = ...) -> None: ...
def assertIsInstance(self, obj: Any,
cls: Union[Type[Any], Tuple[Type[Any], ...]],
msg: Any = ...) -> None: ...
def assertNotIsInstance(self, obj: Any,
cls: Union[Type[Any], Tuple[Type[Any], ...]],
msg: Any = ...) -> None: ...
def assertGreater(self, first: Any, second: Any,
msg: Any = ...) -> None: ...
def assertGreaterEqual(self, first: Any, second: Any,
msg: Any = ...) -> None: ...
def assertLess(self, first: Any, second: Any, msg: Any = ...) -> None: ...
def assertLessEqual(self, first: Any, second: Any,
msg: Any = ...) -> None: ...
@overload
def assertRaises(self, # type: ignore
exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]],
callable: Callable[..., Any] = ...,
*args: Any, **kwargs: Any) -> None: ...
@overload
def assertRaises(self,
exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]],
msg: Any = ...) -> _AssertRaisesContext: ...
@overload
def assertRaisesRegex(self, # type: ignore
exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]],
callable: Callable[..., Any] = ...,
*args: Any, **kwargs: Any) -> None: ...
@overload
def assertRaisesRegex(self,
exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]],
msg: Any = ...) -> _AssertRaisesContext: ...
@overload
def assertWarns(self, # type: ignore
exception: Union[Type[Warning], Tuple[Type[Warning], ...]],
callable: Callable[..., Any] = ...,
*args: Any, **kwargs: Any) -> None: ...
@overload
def assertWarns(self,
exception: Union[Type[Warning], Tuple[Type[Warning], ...]],
msg: Any = ...) -> _AssertWarnsContext: ...
@overload
def assertWarnsRegex(self, # type: ignore
exception: Union[Type[Warning], Tuple[Type[Warning], ...]],
callable: Callable[..., Any] = ...,
*args: Any, **kwargs: Any) -> None: ...
@overload
def assertWarnsRegex(self,
exception: Union[Type[Warning], Tuple[Type[Warning], ...]],
msg: Any = ...) -> _AssertWarnsContext: ...
if sys.version_info >= (3, 4):
def assertLogs(self, logger: Optional[logging.Logger] = ...,
level: Union[int, str, None] = ...) \
-> _AssertLogsContext: ...
def assertAlmostEqual(self, first: float, second: float, places: int = ...,
msg: Any = ..., delta: float = ...) -> None: ...
def assertNotAlmostEqual(self, first: float, second: float,
places: int = ..., msg: Any = ...,
delta: float = ...) -> None: ...
def assertRegex(self, text: str, regex: Union[str, Pattern[str]],
msg: Any = ...) -> None: ...
def assertNotRegex(self, text: str, regex: Union[str, Pattern[str]],
msg: Any = ...) -> None: ...
def assertCountEqual(self, first: Sequence[Any], second: Sequence[Any],
msg: Any = ...) -> None: ...
def addTypeEqualityFunc(self, typeobj: Type[Any],
function: Callable[..., None]) -> None: ...
def assertMultiLineEqual(self, first: str, second: str,
msg: Any = ...) -> None: ...
def assertSequenceEqual(self, first: Sequence[Any], second: Sequence[Any],
msg: Any = ...,
seq_type: Type[Sequence[Any]] = ...) -> None: ...
def assertListEqual(self, first: List[Any], second: List[Any],
msg: Any = ...) -> None: ...
def assertTupleEqual(self, first: Tuple[Any, ...], second: Tuple[Any, ...],
msg: Any = ...) -> None: ...
def assertSetEqual(self, first: Set[Any], second: Set[Any],
msg: Any = ...) -> None: ...
def assertDictEqual(self, first: Dict[Any, Any], second: Dict[Any, Any],
msg: Any = ...) -> None: ...
def fail(self, msg: Any = ...) -> None: ...
def countTestCases(self) -> int: ...
def defaultTestResult(self) -> TestResult: ...
def id(self) -> str: ...
def shortDescription(self) -> str: ... # May return None
def addCleanup(function: Any, *args: Any, **kwargs: Any) -> None: ...
def skipTest(self, reason: Any) -> None: ...
def shortDescription(self) -> Optional[str]: ...
def addCleanup(function: Callable[..., Any], *args: Any,
**kwargs: Any) -> None: ...
def doCleanups(self) -> None: ...
# below is deprecated
def failUnlessEqual(self, first: Any, second: Any,
msg: Any = ...) -> None: ...
def assertEquals(self, first: Any, second: Any, msg: Any = ...) -> None: ...
def failIfEqual(self, first: Any, second: Any, msg: Any = ...) -> None: ...
def assertNotEquals(self, first: Any, second: Any,
msg: Any = ...) -> None: ...
def failUnless(self, expr: bool, msg: Any = ...) -> None: ...
def assert_(self, expr: bool, msg: Any = ...) -> None: ...
def failIf(self, expr: bool, msg: Any = ...) -> None: ...
@overload
def failUnlessRaises(self, # type: ignore
exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]],
callable: Callable[..., Any] = ...,
*args: Any, **kwargs: Any) -> None: ...
@overload
def failUnlessRaises(self,
exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]],
msg: Any = ...) -> _AssertRaisesContext: ...
def failUnlessAlmostEqual(self, first: float, second: float,
places: int = ..., msg: Any = ...) -> None: ...
def assertAlmostEquals(self, first: float, second: float, places: int = ...,
msg: Any = ..., delta: float = ...) -> None: ...
def failIfAlmostEqual(self, first: float, second: float, places: int = ...,
msg: Any = ...) -> None: ...
def assertNotAlmostEquals(self, first: float, second: float,
places: int = ..., msg: Any = ...,
delta: float = ...) -> None: ...
def assertRegexpMatches(self, text: str, regex: Union[str, Pattern[str]],
msg: Any = ...) -> None: ...
@overload
def assertRaisesRegexp(self, # type: ignore
exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]],
callable: Callable[..., Any] = ...,
*args: Any, **kwargs: Any) -> None: ...
@overload
def assertRaisesRegexp(self,
exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]],
msg: Any = ...) -> _AssertRaisesContext: ...
class CallableTestCase(Testable):
class FunctionTestCase(TestCase):
def __init__(self, testFunc: Callable[[], None],
setUp: Callable[[], None] = ...,
tearDown: Callable[[], None] = ...,
description: str = ...) -> None: ...
def run(self, result: TestResult) -> None: ...
setUp: Optional[Callable[[], None]] = ...,
tearDown: Optional[Callable[[], None]] = ...,
description: Optional[str] = ...) -> None: ...
class _AssertRaisesContext:
exception = ... # type: Exception
def __enter__(self) -> _AssertRaisesContext: ...
def __exit__(self, exc_type: Optional[type], exc_val: Optional[Exception],
exc_tb: Optional[TracebackType]) -> bool: ...
class _AssertWarnsContext:
warning = ... # type: Warning
filename = ... # type: str
lineno = ... # type: int
def __enter__(self) -> _AssertWarnsContext: ...
def __exit__(self, exc_type: Optional[type], exc_val: Optional[Exception],
exc_tb: Optional[TracebackType]) -> bool: ...
class _AssertLogsContext:
records = ... # type: List[logging.LogRecord]
output = ... # type: List[str]
def __enter__(self) -> _AssertLogsContext: ...
def __exit__(self, exc_type: Optional[type], exc_val: Optional[Exception],
exc_tb: Optional[TracebackType]) -> bool: ...
_TestType = Union[TestCase, TestSuite]
class TestSuite(Iterable[_TestType]):
def __init__(self, tests: Iterable[_TestType] = ...) -> None: ...
def addTest(self, test: _TestType) -> None: ...
def addTests(self, tests: Iterable[_TestType]) -> None: ...
def run(self, result: TestResult) -> TestResult: ...
def debug(self) -> None: ...
def countTestCases(self) -> int: ...
def __iter__(self) -> Iterator[_TestType]: ...
class TestSuite(Testable):
def __init__(self, tests: Iterable[Testable] = ...) -> None: ...
def addTest(self, test: Testable) -> None: ...
def addTests(self, tests: Iterable[Testable]) -> None: ...
def run(self, result: TestResult) -> None: ...
def debug(self) -> None: ...
def countTestCases(self) -> int: ...
# TODO TestLoader
# TODO defaultTestLoader
class TestLoader:
if sys.version_info >= (3, 5):
errors = ... # type: List[Type[BaseException]]
testMethodPrefix = ... # type: str
sortTestMethodsUsing = ... # type: Callable[[str, str], bool]
suiteClass = ... # type: Callable[[List[TestCase]], TestSuite]
def loadTestsFromTestCase(self,
testCaseClass: Type[TestCase]) -> TestSuite: ...
if sys.version_info >= (3, 5):
def loadTestsFromModule(self, module: ModuleType,
*, pattern: Any = ...) -> TestSuite: ...
else:
def loadTestsFromModule(self, # type: ignore
module: ModuleType) -> TestSuite: ...
def loadTestsFromName(self, name: str,
module: Optional[ModuleType] = ...) -> TestSuite: ...
def loadTestsFromNames(self, names: Sequence[str],
module: Optional[ModuleType] = ...) -> TestSuite: ...
def getTestCaseNames(self,
testCaseClass: Type[TestCase]) -> Sequence[str]: ...
def discover(self, start_dir: str, pattern: str = ...,
top_level_dir: Optional[str] = ...) -> TestSuite: ...
class TextTestRunner:
_SysExcInfoType = Tuple[Optional[Type[BaseException]],
Optional[BaseException],
Optional[TracebackType]]
class TestResult:
errors = ... # type: List[Tuple[TestCase, str]]
failures = ... # type: List[Tuple[TestCase, str]]
skipped = ... # type: List[Tuple[TestCase, str]]
expectedFailures = ... # type: List[Tuple[TestCase, str]]
unexpectedSuccesses = ... # type: List[TestCase]
shouldStop = ... # type: bool
testsRun = ... # type: int
buffer = ... # type: bool
failfast = ... # type: bool
tb_locals = ... # type: bool
def wasSuccessful(self) -> bool: ...
def stop(self) -> None: ...
def startTest(self, test: TestCase) -> None: ...
def stopTest(self, test: TestCase) -> None: ...
def startTestRun(self) -> None: ...
def stopTestRun(self) -> None: ...
def addError(self, test: TestCase, err: _SysExcInfoType) -> None: ...
def addFailure(self, test: TestCase, err: _SysExcInfoType) -> None: ...
def addSuccess(self, test: TestCase) -> None: ...
def addSkip(self, test: TestCase, reason: str) -> None: ...
def addExpectedFailure(self, test: TestCase,
err: _SysExcInfoType) -> None: ...
def addUnexpectedSuccess(self, test: TestCase) -> None: ...
if sys.version_info >= (3, 4):
def addSubTest(self, test: TestCase, subtest: TestCase,
outcome: Optional[_SysExcInfoType]) -> None: ...
class TextTestResult(TestResult):
def __init__(self, stream: TextIO = ..., descriptions: bool = ...,
verbosity: int = ..., failfast: bool = ...) -> None: ...
verbosity: int = ...) -> None: ...
_TextTestResult = TextTestResult
class SkipTest(Exception):
...
defaultTestLoader = ... # type: TestLoader
# TODO precise types
def skipUnless(condition: Any, reason: str) -> Any: ...
def skipIf(condition: Any, reason: str) -> Any: ...
def expectedFailure(func: _FT) -> _FT: ...
def skip(reason: str) -> Any: ...
_ResultClassType = Callable[[TextIO, bool, int], TestResult]
def main(module: str = ..., defaultTest: str = ...,
argv: List[str] = ..., testRunner: Any = ...,
testLoader: Any = ...) -> None: ... # TODO types
# not really documented
class TestRunner:
def run(self, test: Union[TestSuite, TestCase]) -> None: ...
class TextTestRunner(TestRunner):
if sys.version_info >= (3, 5):
def __init__(self, stream: Optional[TextIO] = ...,
descriptions: bool = ..., verbosity: int = ...,
failfast: bool = ..., buffer: bool = ...,
resultclass: Optional[_ResultClassType] = ...,
warnings: Optional[Type[Warning]] = ...,
*, tb_locals: bool = ...) -> None: ...
else:
def __init__(self, # type: ignore
stream: Optional[TextIO] = ...,
descriptions: bool = ..., verbosity: int = ...,
failfast: bool = ..., buffer: bool = ...,
resultclass: Optional[_ResultClassType] = ...,
warnings: Optional[Type[Warning]] = ...) -> None: ...
def _makeResult(self) -> TestResult: ...
if sys.version_info >= (3, 4):
_DefaultTestType = Union[str, Iterable[str], None]
else:
_DefaultTestType = Optional[str]
# not really documented
class TestProgram:
result = ... # type: TestResult
def main(module: str = ..., defaultTest: _DefaultTestType = ...,
argv: Optional[List[str]] = ...,
testRunner: Union[Type[TestRunner], TestRunner, None] = ...,
testLoader: TestLoader = ..., exit: bool = ..., verbosity: int = ...,
failfast: Optional[bool] = ..., catchbreak: Optional[bool] = ...,
buffer: Optional[bool] = ...,
warnings: Optional[str] = ...) -> TestProgram: ...
def installHandler() -> None: ...
def registerResult(result: TestResult) -> None: ...
def removeResult(result: TestResult) -> None: ...
def removeHandler(function: Optional[_FT]) -> _FT: ...