Add missing typings to `unittest.mock` #7431

itaisteinherz · 2022-03-03T22:24:09Z

(I found these by adding the --disallow-incomplete-defs flag to the mypy tests.)

itaisteinherz · 2022-03-03T22:26:00Z

stdlib/unittest/mock.pyi

@@ -428,14 +428,14 @@ if sys.version_info >= (3, 8):
    class AsyncMock(AsyncMockMixin, AsyncMagicMixin, Mock): ...  # type: ignore # argument disparities between base classes

 class MagicProxy:
-    name: Any
+    name: str


I'm not sure if I should change this, however it doesn't really make much sense to me that name is typed as Any in the module's stubs, when it's clear that it's supposed to be a string (at least from what I could tell from the CPython source).

itaisteinherz · 2022-03-03T22:28:40Z

Note that I doubt that mypy_primer's output will be of use here, as tests in Python projects are usually not type-checked, and the unittest module is usually not used in regular (non-test) code.

AlexWaygood · 2022-03-03T22:31:38Z

If these are the only missing annotations in this file, you could also delete this line as part of this PR, increasing pyright's strictness when checking this file as part of CI:

typeshed/pyrightconfig.stricter.json

Line 16 in c50cb06

"stdlib/unittest/mock.pyi",

itaisteinherz · 2022-03-03T22:32:37Z

@AlexWaygood will do!

itaisteinherz · 2022-03-03T22:37:03Z

Seems like there are some missing typings which mypy didn't report. I'll look into pyright's output.

itaisteinherz · 2022-03-03T23:17:32Z

stdlib/unittest/mock.pyi

@@ -74,21 +74,35 @@ class _Sentinel:

 sentinel: Any
 DEFAULT: Any
+_ArgsKwargs = tuple[tuple[Any, ...], Mapping[str, Any]]
+_NameArgsKwargs = tuple[str, tuple[Any, ...], Mapping[str, Any]]


Note that kwargs is typed as Any in the rest of the stubs, but I wanted to be more strict here.

stdlib/unittest/mock.pyi

hauntsaninja

Skimmed, the simple annotation additions look good to me. If we do want to try making _Call generic over something, I'd move that into its own PR. We've had at least a couple bad regressions involving unittest.mock, so it's something I'm wary of :-)

itaisteinherz · 2022-03-03T23:32:38Z

@hauntsaninja I agree :) I'll revert some of my newer additions.

stdlib/unittest/mock.pyi

github-actions · 2022-03-04T00:05:05Z

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

Add missing typings to unittest.mock

8866ad0

itaisteinherz commented Mar 3, 2022

View reviewed changes