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

Another batch of type annotations #12726

Merged
merged 11 commits into from
May 13, 2022
Merged

Another batch of type annotations #12726

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
680fb0a
Annotations in s.types
May 12, 2022
77f1be9
Annotate s.storage.databases.background_updates
May 12, 2022
6fe983e
Annotate s.http.proxyagent
May 12, 2022
8b1a64d
A few annotations in s.logging.scopecontextmanager
May 12, 2022
23bbbff
Annotations in s.http.connectproxyclient
May 12, 2022
c11b867
Annotate s.logging._remote
May 12, 2022
3c8ec37
Annotate s.logging.handlers
May 12, 2022
9d62e76
Disallow-untyped-defs in s.logging.formatter
May 12, 2022
ea27f05
Changelog
May 12, 2022
71a58f3
linterscript
May 12, 2022
1123bf9
Fix get_verify_key_from_cross_signing_key
May 12, 2022
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
3 changes: 3 additions & 0 deletions mypy.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,9 @@ disallow_untyped_defs = True
[mypy-synapse.http.server]
disallow_untyped_defs = True

[mypy-synapse.logging._remote]
disallow_untyped_defs = True

[mypy-synapse.logging.context]
disallow_untyped_defs = True

Expand Down
20 changes: 12 additions & 8 deletions synapse/logging/_remote.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@
TCP4ClientEndpoint,
TCP6ClientEndpoint,
)
from twisted.internet.interfaces import IPushProducer, IStreamClientEndpoint
from twisted.internet.interfaces import (
IPushProducer,
IReactorTCP,
IStreamClientEndpoint,
)
from twisted.internet.protocol import Factory, Protocol
from twisted.internet.tcp import Connection
from twisted.python.failure import Failure
Expand Down Expand Up @@ -59,14 +63,14 @@ class LogProducer:
_buffer: Deque[logging.LogRecord]
_paused: bool = attr.ib(default=False, init=False)

def pauseProducing(self):
def pauseProducing(self) -> None:
self._paused = True

def stopProducing(self):
def stopProducing(self) -> None:
self._paused = True
self._buffer = deque()

def resumeProducing(self):
def resumeProducing(self) -> None:
# If we're already producing, nothing to do.
self._paused = False

Expand Down Expand Up @@ -102,8 +106,8 @@ def __init__(
host: str,
port: int,
maximum_buffer: int = 1000,
level=logging.NOTSET,
_reactor=None,
level: int = logging.NOTSET,
_reactor: Optional[IReactorTCP] = None,
):
super().__init__(level=level)
self.host = host
Expand All @@ -118,7 +122,7 @@ def __init__(
if _reactor is None:
from twisted.internet import reactor

_reactor = reactor
_reactor = reactor # type: ignore[assignment]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

twisted.internet.reactor is a module that, upon import, removes itself from sys.modules and calls twisted.internet.default.install(). This eventually reinserts twisted.internet.reactor back into sys.modules, but now it points to a reactor instance.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No wonder mypy is confused.

Copy link
Member

Choose a reason for hiding this comment

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

In other spots we do:

from twisted.internet import reactor as _reactor

reactor = cast(ISynapseReactor, _reactor)

🤷 (Could probably just put a cast here instead of an ignore to be consistent.)


try:
ip = ip_address(self.host)
Expand All @@ -139,7 +143,7 @@ def __init__(
self._stopping = False
self._connect()

def close(self):
def close(self) -> None:
self._stopping = True
self._service.stopService()

Expand Down