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

Commit 30b56f6

Browse files
clokepclokep
authored
Add type hints to get_domain_from_id and get_localpart_from_id. (#10385)
1 parent 2d16e69 commit 30b56f6

File tree

3 files changed

+75
-26
lines changed

3 files changed

+75
-26
lines changed

‎changelog.d/10385.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add type hints to `get_{domain,localpart}_from_id`.

‎synapse/federation/transport/server.py

Lines changed: 72 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1095,7 +1095,9 @@ async def on_GET(
10951095
query: Dict[bytes, List[bytes]],
10961096
group_id: str,
10971097
) -> Tuple[int, JsonDict]:
1098-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1098+
requester_user_id = parse_string_from_args(
1099+
query, "requester_user_id", required=True
1100+
)
10991101
if get_domain_from_id(requester_user_id) != origin:
11001102
raise SynapseError(403, "requester_user_id doesn't match origin")
11011103

@@ -1110,7 +1112,9 @@ async def on_POST(
11101112
query: Dict[bytes, List[bytes]],
11111113
group_id: str,
11121114
) -> Tuple[int, JsonDict]:
1113-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1115+
requester_user_id = parse_string_from_args(
1116+
query, "requester_user_id", required=True
1117+
)
11141118
if get_domain_from_id(requester_user_id) != origin:
11151119
raise SynapseError(403, "requester_user_id doesn't match origin")
11161120

@@ -1131,7 +1135,9 @@ async def on_GET(
11311135
query: Dict[bytes, List[bytes]],
11321136
group_id: str,
11331137
) -> Tuple[int, JsonDict]:
1134-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1138+
requester_user_id = parse_string_from_args(
1139+
query, "requester_user_id", required=True
1140+
)
11351141
if get_domain_from_id(requester_user_id) != origin:
11361142
raise SynapseError(403, "requester_user_id doesn't match origin")
11371143

@@ -1152,7 +1158,9 @@ async def on_GET(
11521158
query: Dict[bytes, List[bytes]],
11531159
group_id: str,
11541160
) -> Tuple[int, JsonDict]:
1155-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1161+
requester_user_id = parse_string_from_args(
1162+
query, "requester_user_id", required=True
1163+
)
11561164
if get_domain_from_id(requester_user_id) != origin:
11571165
raise SynapseError(403, "requester_user_id doesn't match origin")
11581166

@@ -1174,7 +1182,9 @@ async def on_POST(
11741182
group_id: str,
11751183
room_id: str,
11761184
) -> Tuple[int, JsonDict]:
1177-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1185+
requester_user_id = parse_string_from_args(
1186+
query, "requester_user_id", required=True
1187+
)
11781188
if get_domain_from_id(requester_user_id) != origin:
11791189
raise SynapseError(403, "requester_user_id doesn't match origin")
11801190

@@ -1192,7 +1202,9 @@ async def on_DELETE(
11921202
group_id: str,
11931203
room_id: str,
11941204
) -> Tuple[int, JsonDict]:
1195-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1205+
requester_user_id = parse_string_from_args(
1206+
query, "requester_user_id", required=True
1207+
)
11961208
if get_domain_from_id(requester_user_id) != origin:
11971209
raise SynapseError(403, "requester_user_id doesn't match origin")
11981210

@@ -1220,7 +1232,9 @@ async def on_POST(
12201232
room_id: str,
12211233
config_key: str,
12221234
) -> Tuple[int, JsonDict]:
1223-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1235+
requester_user_id = parse_string_from_args(
1236+
query, "requester_user_id", required=True
1237+
)
12241238
if get_domain_from_id(requester_user_id) != origin:
12251239
raise SynapseError(403, "requester_user_id doesn't match origin")
12261240

@@ -1243,7 +1257,9 @@ async def on_GET(
12431257
query: Dict[bytes, List[bytes]],
12441258
group_id: str,
12451259
) -> Tuple[int, JsonDict]:
1246-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1260+
requester_user_id = parse_string_from_args(
1261+
query, "requester_user_id", required=True
1262+
)
12471263
if get_domain_from_id(requester_user_id) != origin:
12481264
raise SynapseError(403, "requester_user_id doesn't match origin")
12491265

@@ -1264,7 +1280,9 @@ async def on_GET(
12641280
query: Dict[bytes, List[bytes]],
12651281
group_id: str,
12661282
) -> Tuple[int, JsonDict]:
1267-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1283+
requester_user_id = parse_string_from_args(
1284+
query, "requester_user_id", required=True
1285+
)
12681286
if get_domain_from_id(requester_user_id) != origin:
12691287
raise SynapseError(403, "requester_user_id doesn't match origin")
12701288

@@ -1288,7 +1306,9 @@ async def on_POST(
12881306
group_id: str,
12891307
user_id: str,
12901308
) -> Tuple[int, JsonDict]:
1291-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1309+
requester_user_id = parse_string_from_args(
1310+
query, "requester_user_id", required=True
1311+
)
12921312
if get_domain_from_id(requester_user_id) != origin:
12931313
raise SynapseError(403, "requester_user_id doesn't match origin")
12941314

@@ -1354,7 +1374,9 @@ async def on_POST(
13541374
group_id: str,
13551375
user_id: str,
13561376
) -> Tuple[int, JsonDict]:
1357-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1377+
requester_user_id = parse_string_from_args(
1378+
query, "requester_user_id", required=True
1379+
)
13581380
if get_domain_from_id(requester_user_id) != origin:
13591381
raise SynapseError(403, "requester_user_id doesn't match origin")
13601382

@@ -1487,7 +1509,9 @@ async def on_POST(
14871509
category_id: str,
14881510
room_id: str,
14891511
) -> Tuple[int, JsonDict]:
1490-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1512+
requester_user_id = parse_string_from_args(
1513+
query, "requester_user_id", required=True
1514+
)
14911515
if get_domain_from_id(requester_user_id) != origin:
14921516
raise SynapseError(403, "requester_user_id doesn't match origin")
14931517

@@ -1523,7 +1547,9 @@ async def on_DELETE(
15231547
category_id: str,
15241548
room_id: str,
15251549
) -> Tuple[int, JsonDict]:
1526-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1550+
requester_user_id = parse_string_from_args(
1551+
query, "requester_user_id", required=True
1552+
)
15271553
if get_domain_from_id(requester_user_id) != origin:
15281554
raise SynapseError(403, "requester_user_id doesn't match origin")
15291555

@@ -1549,7 +1575,9 @@ async def on_GET(
15491575
query: Dict[bytes, List[bytes]],
15501576
group_id: str,
15511577
) -> Tuple[int, JsonDict]:
1552-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1578+
requester_user_id = parse_string_from_args(
1579+
query, "requester_user_id", required=True
1580+
)
15531581
if get_domain_from_id(requester_user_id) != origin:
15541582
raise SynapseError(403, "requester_user_id doesn't match origin")
15551583

@@ -1571,7 +1599,9 @@ async def on_GET(
15711599
group_id: str,
15721600
category_id: str,
15731601
) -> Tuple[int, JsonDict]:
1574-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1602+
requester_user_id = parse_string_from_args(
1603+
query, "requester_user_id", required=True
1604+
)
15751605
if get_domain_from_id(requester_user_id) != origin:
15761606
raise SynapseError(403, "requester_user_id doesn't match origin")
15771607

@@ -1589,7 +1619,9 @@ async def on_POST(
15891619
group_id: str,
15901620
category_id: str,
15911621
) -> Tuple[int, JsonDict]:
1592-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1622+
requester_user_id = parse_string_from_args(
1623+
query, "requester_user_id", required=True
1624+
)
15931625
if get_domain_from_id(requester_user_id) != origin:
15941626
raise SynapseError(403, "requester_user_id doesn't match origin")
15951627

@@ -1618,7 +1650,9 @@ async def on_DELETE(
16181650
group_id: str,
16191651
category_id: str,
16201652
) -> Tuple[int, JsonDict]:
1621-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1653+
requester_user_id = parse_string_from_args(
1654+
query, "requester_user_id", required=True
1655+
)
16221656
if get_domain_from_id(requester_user_id) != origin:
16231657
raise SynapseError(403, "requester_user_id doesn't match origin")
16241658

@@ -1644,7 +1678,9 @@ async def on_GET(
16441678
query: Dict[bytes, List[bytes]],
16451679
group_id: str,
16461680
) -> Tuple[int, JsonDict]:
1647-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1681+
requester_user_id = parse_string_from_args(
1682+
query, "requester_user_id", required=True
1683+
)
16481684
if get_domain_from_id(requester_user_id) != origin:
16491685
raise SynapseError(403, "requester_user_id doesn't match origin")
16501686

@@ -1666,7 +1702,9 @@ async def on_GET(
16661702
group_id: str,
16671703
role_id: str,
16681704
) -> Tuple[int, JsonDict]:
1669-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1705+
requester_user_id = parse_string_from_args(
1706+
query, "requester_user_id", required=True
1707+
)
16701708
if get_domain_from_id(requester_user_id) != origin:
16711709
raise SynapseError(403, "requester_user_id doesn't match origin")
16721710

@@ -1682,7 +1720,9 @@ async def on_POST(
16821720
group_id: str,
16831721
role_id: str,
16841722
) -> Tuple[int, JsonDict]:
1685-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1723+
requester_user_id = parse_string_from_args(
1724+
query, "requester_user_id", required=True
1725+
)
16861726
if get_domain_from_id(requester_user_id) != origin:
16871727
raise SynapseError(403, "requester_user_id doesn't match origin")
16881728

@@ -1713,7 +1753,9 @@ async def on_DELETE(
17131753
group_id: str,
17141754
role_id: str,
17151755
) -> Tuple[int, JsonDict]:
1716-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1756+
requester_user_id = parse_string_from_args(
1757+
query, "requester_user_id", required=True
1758+
)
17171759
if get_domain_from_id(requester_user_id) != origin:
17181760
raise SynapseError(403, "requester_user_id doesn't match origin")
17191761

@@ -1750,7 +1792,9 @@ async def on_POST(
17501792
role_id: str,
17511793
user_id: str,
17521794
) -> Tuple[int, JsonDict]:
1753-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1795+
requester_user_id = parse_string_from_args(
1796+
query, "requester_user_id", required=True
1797+
)
17541798
if get_domain_from_id(requester_user_id) != origin:
17551799
raise SynapseError(403, "requester_user_id doesn't match origin")
17561800

@@ -1784,7 +1828,9 @@ async def on_DELETE(
17841828
role_id: str,
17851829
user_id: str,
17861830
) -> Tuple[int, JsonDict]:
1787-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1831+
requester_user_id = parse_string_from_args(
1832+
query, "requester_user_id", required=True
1833+
)
17881834
if get_domain_from_id(requester_user_id) != origin:
17891835
raise SynapseError(403, "requester_user_id doesn't match origin")
17901836

@@ -1825,7 +1871,9 @@ async def on_PUT(
18251871
query: Dict[bytes, List[bytes]],
18261872
group_id: str,
18271873
) -> Tuple[int, JsonDict]:
1828-
requester_user_id = parse_string_from_args(query, "requester_user_id")
1874+
requester_user_id = parse_string_from_args(
1875+
query, "requester_user_id", required=True
1876+
)
18291877
if get_domain_from_id(requester_user_id) != origin:
18301878
raise SynapseError(403, "requester_user_id doesn't match origin")
18311879

‎synapse/types.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,14 +182,14 @@ def create_requester(
182182
)
183183

184184

185-
def get_domain_from_id(string):
185+
def get_domain_from_id(string: str) -> str:
186186
idx = string.find(":")
187187
if idx == -1:
188188
raise SynapseError(400, "Invalid ID: %r" % (string,))
189189
return string[idx + 1 :]
190190

191191

192-
def get_localpart_from_id(string):
192+
def get_localpart_from_id(string: str) -> str:
193193
idx = string.find(":")
194194
if idx == -1:
195195
raise SynapseError(400, "Invalid ID: %r" % (string,))

0 commit comments

Comments
 (0)