mirror of
https://mau.dev/maunium/synapse.git
synced 2024-09-02 23:52:00 +00:00
![David Robertson](/assets/img/avatar_default.png)
* Update mypy and mypy-zope * Remove unused ignores These used to suppress ``` synapse/storage/engines/__init__.py:28: error: "__new__" must return a class instance (got "NoReturn") [misc] ``` and ``` synapse/http/matrixfederationclient.py:1270: error: "BaseException" has no attribute "reasons" [attr-defined] ``` (note that we check `hasattr(e, "reasons")` above) * Avoid empty body warnings, sometimes by marking methods as abstract E.g. ``` tests/handlers/test_register.py:58: error: Missing return statement [empty-body] tests/handlers/test_register.py:108: error: Missing return statement [empty-body] ``` * Suppress false positive about `JaegerConfig` Complaint was ``` synapse/logging/opentracing.py:450: error: Function "Type[Config]" could always be true in boolean context [truthy-function] ``` * Fix not calling `is_state()` Oops! ``` tests/rest/client/test_third_party_rules.py:428: error: Function "Callable[[], bool]" could always be true in boolean context [truthy-function] ``` * Suppress false positives from ParamSpecs ```` synapse/logging/opentracing.py:971: error: Argument 2 to "_custom_sync_async_decorator" has incompatible type "Callable[[Arg(Callable[P, R], 'func'), **P], _GeneratorContextManager[None]]"; expected "Callable[[Callable[P, R], **P], _GeneratorContextManager[None]]" [arg-type] synapse/logging/opentracing.py:1017: error: Argument 2 to "_custom_sync_async_decorator" has incompatible type "Callable[[Arg(Callable[P, R], 'func'), **P], _GeneratorContextManager[None]]"; expected "Callable[[Callable[P, R], **P], _GeneratorContextManager[None]]" [arg-type] ```` * Drive-by improvement to `wrapping_logic` annotation * Workaround false "unreachable" positives See https://github.com/Shoobx/mypy-zope/issues/91 ``` tests/http/test_proxyagent.py:626: error: Statement is unreachable [unreachable] tests/http/test_proxyagent.py:762: error: Statement is unreachable [unreachable] tests/http/test_proxyagent.py:826: error: Statement is unreachable [unreachable] tests/http/test_proxyagent.py:838: error: Statement is unreachable [unreachable] tests/http/test_proxyagent.py:845: error: Statement is unreachable [unreachable] tests/http/federation/test_matrix_federation_agent.py:151: error: Statement is unreachable [unreachable] tests/http/federation/test_matrix_federation_agent.py:452: error: Statement is unreachable [unreachable] tests/logging/test_remote_handler.py:60: error: Statement is unreachable [unreachable] tests/logging/test_remote_handler.py:93: error: Statement is unreachable [unreachable] tests/logging/test_remote_handler.py:127: error: Statement is unreachable [unreachable] tests/logging/test_remote_handler.py:152: error: Statement is unreachable [unreachable] ``` * Changelog * Tweak DBAPI2 Protocol to be accepted by mypy 1.0 Some extra context in: - https://github.com/matrix-org/python-canonicaljson/pull/57 - https://github.com/python/mypy/issues/6002 - https://mypy.readthedocs.io/en/latest/common_issues.html#covariant-subtyping-of-mutable-protocol-members-is-rejected * Pull in updated canonicaljson lib so the protocol check just works * Improve comments in opentracing I tried to workaround the ignores but found it too much trouble. I think the corresponding issue is https://github.com/python/mypy/issues/12909. The mypy repo has a PR claiming to fix this (https://github.com/python/mypy/pull/14677) which might mean this gets resolved soon? * Better annotation for INTERACTIVE_AUTH_CHECKERS * Drive-by AUTH_TYPE annotation, to remove an ignore
64 lines
2.2 KiB
Python
64 lines
2.2 KiB
Python
# Copyright 2015, 2016 OpenMarket Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
from typing import Any, Mapping, NoReturn
|
|
|
|
from ._base import BaseDatabaseEngine, IncorrectDatabaseSetup
|
|
|
|
# The classes `PostgresEngine` and `Sqlite3Engine` must always be importable, because
|
|
# we use `isinstance(engine, PostgresEngine)` to write different queries for postgres
|
|
# and sqlite. But the database driver modules are both optional: they may not be
|
|
# installed. To account for this, create dummy classes on import failure so we can
|
|
# still run `isinstance()` checks.
|
|
try:
|
|
from .postgres import PostgresEngine
|
|
except ImportError:
|
|
|
|
class PostgresEngine(BaseDatabaseEngine): # type: ignore[no-redef]
|
|
def __new__(cls, *args: object, **kwargs: object) -> NoReturn:
|
|
raise RuntimeError(
|
|
f"Cannot create {cls.__name__} -- psycopg2 module is not installed"
|
|
)
|
|
|
|
|
|
try:
|
|
from .sqlite import Sqlite3Engine
|
|
except ImportError:
|
|
|
|
class Sqlite3Engine(BaseDatabaseEngine): # type: ignore[no-redef]
|
|
def __new__(cls, *args: object, **kwargs: object) -> NoReturn:
|
|
raise RuntimeError(
|
|
f"Cannot create {cls.__name__} -- sqlite3 module is not installed"
|
|
)
|
|
|
|
|
|
def create_engine(database_config: Mapping[str, Any]) -> BaseDatabaseEngine:
|
|
name = database_config["name"]
|
|
|
|
if name == "sqlite3":
|
|
return Sqlite3Engine(database_config)
|
|
|
|
if name == "psycopg2":
|
|
return PostgresEngine(database_config)
|
|
|
|
raise RuntimeError("Unsupported database engine '%s'" % (name,))
|
|
|
|
|
|
__all__ = [
|
|
"create_engine",
|
|
"BaseDatabaseEngine",
|
|
"PostgresEngine",
|
|
"Sqlite3Engine",
|
|
"IncorrectDatabaseSetup",
|
|
]
|