From eb6dbe510df2914b453d0ac692df922bb4601133 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Savo=20Kova=C4=8Devi=C4=87?= Date: Sun, 6 Jan 2019 02:31:32 +0100 Subject: [PATCH] Fix unittest.TestCase assert methods' argument names (#2724) And fix assertNotAlmostEqual overloads --- stdlib/3/unittest/__init__.pyi | 60 ++++++++++++++++++---------------- 1 file changed, 32 insertions(+), 28 deletions(-) diff --git a/stdlib/3/unittest/__init__.pyi b/stdlib/3/unittest/__init__.pyi index f161c280e..782c75056 100644 --- a/stdlib/3/unittest/__init__.pyi +++ b/stdlib/3/unittest/__init__.pyi @@ -46,11 +46,10 @@ class TestCase: 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 assertIs(self, expr1: Any, expr2: Any, msg: Any = ...) -> None: ... + def assertIsNot(self, expr1: Any, expr2: Any, msg: Any = ...) -> None: ... + def assertIsNone(self, obj: Any, msg: Any = ...) -> None: ... + def assertIsNotNone(self, obj: Any, msg: Any = ...) -> None: ... def assertIn(self, member: Any, container: Union[Iterable[Any], Container[Any]], msg: Any = ...) -> None: ... @@ -63,21 +62,18 @@ class TestCase: def assertNotIsInstance(self, obj: Any, cls: Union[type, Tuple[type, ...]], 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: ... + def assertGreater(self, a: Any, b: Any, msg: Any = ...) -> None: ... + def assertGreaterEqual(self, a: Any, b: Any, msg: Any = ...) -> None: ... + def assertLess(self, a: Any, b: Any, msg: Any = ...) -> None: ... + def assertLessEqual(self, a: Any, b: Any, msg: Any = ...) -> None: ... @overload def assertRaises(self, # type: ignore - exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]], + expected_exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]], callable: Callable[..., Any], *args: Any, **kwargs: Any) -> None: ... @overload def assertRaises(self, - exception: Union[Type[_E], Tuple[Type[_E], ...]], + expected_exception: Union[Type[_E], Tuple[Type[_E], ...]], msg: Any = ...) -> _AssertRaisesContext[_E]: ... @overload def assertRaisesRegex(self, # type: ignore @@ -92,21 +88,23 @@ class TestCase: msg: Any = ...) -> _AssertRaisesContext[_E]: ... @overload def assertWarns(self, # type: ignore - exception: Union[Type[Warning], Tuple[Type[Warning], ...]], + expected_warning: 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], ...]], + expected_warning: Union[Type[Warning], Tuple[Type[Warning], ...]], msg: Any = ...) -> _AssertWarnsContext: ... @overload def assertWarnsRegex(self, # type: ignore - exception: Union[Type[Warning], Tuple[Type[Warning], ...]], + expected_warning: Union[Type[Warning], Tuple[Type[Warning], ...]], + expected_regex: Union[str, bytes, Pattern[str], Pattern[bytes]], callable: Callable[..., Any], *args: Any, **kwargs: Any) -> None: ... @overload def assertWarnsRegex(self, - exception: Union[Type[Warning], Tuple[Type[Warning], ...]], + expected_warning: Union[Type[Warning], Tuple[Type[Warning], ...]], + expected_regex: Union[str, bytes, Pattern[str], Pattern[bytes]], msg: Any = ...) -> _AssertWarnsContext: ... def assertLogs( self, logger: Optional[logging.Logger] = ..., @@ -114,12 +112,18 @@ class TestCase: ) -> _AssertLogsContext: ... def assertAlmostEqual(self, first: float, second: float, places: int = ..., msg: Any = ..., delta: float = ...) -> None: ... + @overload + def assertNotAlmostEqual(self, first: float, second: float, *, + msg: Any = ...) -> None: ... + @overload def assertNotAlmostEqual(self, first: float, second: float, - places: int = ..., msg: Any = ..., - delta: float = ...) -> None: ... - def assertRegex(self, text: AnyStr, regex: Union[AnyStr, Pattern[AnyStr]], + places: int = ..., msg: Any = ...) -> None: ... + @overload + def assertNotAlmostEqual(self, first: float, second: float, *, + msg: Any = ..., delta: float = ...) -> None: ... + def assertRegex(self, text: AnyStr, expected_regex: Union[AnyStr, Pattern[AnyStr]], msg: Any = ...) -> None: ... - def assertNotRegex(self, text: AnyStr, regex: Union[AnyStr, Pattern[AnyStr]], + def assertNotRegex(self, text: AnyStr, unexpected_regex: Union[AnyStr, Pattern[AnyStr]], msg: Any = ...) -> None: ... def assertCountEqual(self, first: Iterable[Any], second: Iterable[Any], msg: Any = ...) -> None: ... @@ -127,16 +131,16 @@ class TestCase: function: Callable[..., None]) -> None: ... def assertMultiLineEqual(self, first: str, second: str, msg: Any = ...) -> None: ... - def assertSequenceEqual(self, first: Sequence[Any], second: Sequence[Any], + def assertSequenceEqual(self, seq1: Sequence[Any], seq2: Sequence[Any], msg: Any = ..., seq_type: Type[Sequence[Any]] = ...) -> None: ... - def assertListEqual(self, first: List[Any], second: List[Any], + def assertListEqual(self, list1: List[Any], list2: List[Any], msg: Any = ...) -> None: ... - def assertTupleEqual(self, first: Tuple[Any, ...], second: Tuple[Any, ...], + def assertTupleEqual(self, tuple1: Tuple[Any, ...], tuple2: Tuple[Any, ...], msg: Any = ...) -> None: ... - def assertSetEqual(self, first: Union[Set[Any], FrozenSet[Any]], - second: Union[Set[Any], FrozenSet[Any]], msg: Any = ...) -> None: ... - def assertDictEqual(self, first: Dict[Any, Any], second: Dict[Any, Any], + def assertSetEqual(self, set1: Union[Set[Any], FrozenSet[Any]], + set2: Union[Set[Any], FrozenSet[Any]], msg: Any = ...) -> None: ... + def assertDictEqual(self, d1: Dict[Any, Any], d2: Dict[Any, Any], msg: Any = ...) -> None: ... def fail(self, msg: Any = ...) -> NoReturn: ... def countTestCases(self) -> int: ...