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

Add type hints to the federation server transport. #10080

Merged
merged 10 commits into from
Jun 8, 2021
Merged

Add type hints to the federation server transport. #10080

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
91b730e
Federation servlets take a homeserver instead of a handler.
clokep May 26, 2021
c13a26e
Fix a missing argument to spaces summary.
clokep May 26, 2021
468aaed
network tuple can be none.
clokep May 26, 2021
b07d1a8
Handle workers for groups.
clokep May 26, 2021
36c4c37
Newsfragment
clokep May 27, 2021
d7216d7
Merge remote-tracking branch 'origin/develop' into clokep/fed-trans-t…
clokep May 27, 2021
8214e0a
Add docstrings to base classes.
clokep Jun 1, 2021
acc6e45
Lint
clokep Jun 1, 2021
28356db
Merge remote-tracking branch 'origin/develop' into clokep/fed-trans-t…
clokep Jun 8, 2021
6deea89
Fix a few more type hints.
clokep Jun 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions synapse/federation/federation_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ def __init__(self, hs: "HomeServer"):
# come in waves.
self._state_resp_cache = ResponseCache(
hs.get_clock(), "state_resp", timeout_ms=30000
) # type: ResponseCache[Tuple[str, str]]
) # type: ResponseCache[Tuple[str, Optional[str]]]
self._state_ids_resp_cache = ResponseCache(
hs.get_clock(), "state_ids_resp", timeout_ms=30000
) # type: ResponseCache[Tuple[str, str]]
Expand Down Expand Up @@ -406,7 +406,7 @@ async def _process_edu(edu_dict):
)

async def on_room_state_request(
self, origin: str, room_id: str, event_id: str
self, origin: str, room_id: str, event_id: Optional[str]
) -> Tuple[int, Dict[str, Any]]:
origin_host, _ = parse_server_name(origin)
await self.check_server_matches_acl(origin_host, room_id)
Expand Down Expand Up @@ -463,7 +463,7 @@ async def _on_state_ids_request_compute(self, room_id, event_id):
return {"pdu_ids": state_ids, "auth_chain_ids": auth_chain_ids}

async def _on_context_state_request_compute(
self, room_id: str, event_id: str
self, room_id: str, event_id: Optional[str]
) -> Dict[str, list]:
if event_id:
pdus = await self.handler.get_state_for_pdu(
Expand Down
24 changes: 24 additions & 0 deletions synapse/http/servlet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,30 @@ def parse_strings_from_args(
return default


@overload
def parse_string_from_args(
args: Dict[bytes, List[bytes]],
name: str,
default: Optional[str] = None,
required: Literal[True] = True,
allowed_values: Optional[Iterable[str]] = None,
encoding: str = "ascii",
) -> str:
...


@overload
def parse_string_from_args(
args: Dict[bytes, List[bytes]],
name: str,
default: Optional[str] = None,
required: bool = False,
allowed_values: Optional[Iterable[str]] = None,
encoding: str = "ascii",
) -> Optional[str]:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this meant to be in here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes were necessary since previously the only caller of parse_string_from_args that was covered by mypy was parse_string, but with the additional type hints being added to the synapse/federation/transport/server.py file it seems to have shook out that we need an overload for this.

...


def parse_string_from_args(
args: Dict[bytes, List[bytes]],
name: str,
Expand Down