Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit d960589

Browse files
author
David Robertson
committed
No untyped defs in register_new_matrix_user
This one might be contraversial. `request_registration` has three dependency-injection arguments used for testing. I'm removing the injection of the `requests` module and using `unitest.mock.patch` in the test cases instead. Doing `reveal_type(requests)` and `reveal_type(requests.get)` before the change: ``` synapse/_scripts/register_new_matrix_user.py:45: note: Revealed type is "Any" synapse/_scripts/register_new_matrix_user.py:46: note: Revealed type is "Any" ``` And after: ``` synapse/_scripts/register_new_matrix_user.py:44: note: Revealed type is "types.ModuleType" synapse/_scripts/register_new_matrix_user.py:45: note: Revealed type is "def (url: Union[builtins.str, builtins.bytes], params: Union[Union[_typeshed.SupportsItems[Union[builtins.str, builtins.bytes, builtins.int, builtins.float], Union[builtins.str, builtins.bytes, builtins.int, builtins.float, typing.Iterable[Union[builtins.str, builtins.bytes, builtins.int, builtins.float]], None]], Tuple[Union[builtins.str, builtins.bytes, builtins.int, builtins.float], Union[builtins.str, builtins.bytes, builtins.int, builtins.float, typing.Iterable[Union[builtins.str, builtins.bytes, builtins.int, builtins.float]], None]], typing.Iterable[Tuple[Union[builtins.str, builtins.bytes, builtins.int, builtins.float], Union[builtins.str, builtins.bytes, builtins.int, builtins.float, typing.Iterable[Union[builtins.str, builtins.bytes, builtins.int, builtins.float]], None]]], builtins.str, builtins.bytes], None] =, data: Union[Any, None] =, headers: Union[Any, None] =, cookies: Union[Any, None] =, files: Union[Any, None] =, auth: Union[Any, None] =, timeout: Union[Any, None] =, allow_redirects: builtins.bool =, proxies: Union[Any, None] =, hooks: Union[Any, None] =, stream: Union[Any, None] =, verify: Union[Any, None] =, cert: Union[Any, None] =, json: Union[Any, None] =) -> requests.models.Response" ```
1 parent 8fb1187 commit d960589

File tree

2 files changed

+32
-33
lines changed

2 files changed

+32
-33
lines changed

synapse/_scripts/register_new_matrix_user.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import sys
2323
from typing import Callable, Optional
2424

25-
import requests as _requests
25+
import requests
2626
import yaml
2727

2828

@@ -33,7 +33,6 @@ def request_registration(
3333
shared_secret: str,
3434
admin: bool = False,
3535
user_type: Optional[str] = None,
36-
requests=_requests,
3736
_print: Callable[[str], None] = print,
3837
exit: Callable[[int], None] = sys.exit,
3938
) -> None:

tests/scripts/test_new_matrix_user.py

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
from unittest.mock import Mock
15+
from unittest.mock import Mock, patch
1616

1717
from synapse._scripts.register_new_matrix_user import request_registration
1818

@@ -52,16 +52,16 @@ def post(url, json=None, verify=None):
5252
out = []
5353
err_code = []
5454

55-
request_registration(
56-
"user",
57-
"pass",
58-
"matrix.org",
59-
"shared",
60-
admin=False,
61-
requests=requests,
62-
_print=out.append,
63-
exit=err_code.append,
64-
)
55+
with patch("synapse._scripts.register_new_matrix_user.requests", requests):
56+
request_registration(
57+
"user",
58+
"pass",
59+
"matrix.org",
60+
"shared",
61+
admin=False,
62+
_print=out.append,
63+
exit=err_code.append,
64+
)
6565

6666
# We should get the success message making sure everything is OK.
6767
self.assertIn("Success!", out)
@@ -88,16 +88,16 @@ def get(url, verify=None):
8888
out = []
8989
err_code = []
9090

91-
request_registration(
92-
"user",
93-
"pass",
94-
"matrix.org",
95-
"shared",
96-
admin=False,
97-
requests=requests,
98-
_print=out.append,
99-
exit=err_code.append,
100-
)
91+
with patch("synapse._scripts.register_new_matrix_user.requests", requests):
92+
request_registration(
93+
"user",
94+
"pass",
95+
"matrix.org",
96+
"shared",
97+
admin=False,
98+
_print=out.append,
99+
exit=err_code.append,
100+
)
101101

102102
# Exit was called
103103
self.assertEqual(err_code, [1])
@@ -140,16 +140,16 @@ def post(url, json=None, verify=None):
140140
out = []
141141
err_code = []
142142

143-
request_registration(
144-
"user",
145-
"pass",
146-
"matrix.org",
147-
"shared",
148-
admin=False,
149-
requests=requests,
150-
_print=out.append,
151-
exit=err_code.append,
152-
)
143+
with patch("synapse._scripts.register_new_matrix_user.requests", requests):
144+
request_registration(
145+
"user",
146+
"pass",
147+
"matrix.org",
148+
"shared",
149+
admin=False,
150+
_print=out.append,
151+
exit=err_code.append,
152+
)
153153

154154
# Exit was called
155155
self.assertEqual(err_code, [1])

0 commit comments

Comments
 (0)