2020-02-27 06:53:40 -05:00
|
|
|
# Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
|
|
#
|
|
|
|
# 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.
|
2021-02-05 15:39:19 -05:00
|
|
|
from typing import Any, Iterator, List, Mapping, Optional, Sequence, Tuple, Union
|
2020-02-27 06:53:40 -05:00
|
|
|
|
|
|
|
from typing_extensions import Protocol
|
|
|
|
|
|
|
|
"""
|
|
|
|
Some very basic protocol definitions for the DB-API2 classes specified in PEP-249
|
|
|
|
"""
|
|
|
|
|
2021-02-05 15:39:19 -05:00
|
|
|
_Parameters = Union[Sequence[Any], Mapping[str, Any]]
|
|
|
|
|
2020-02-27 06:53:40 -05:00
|
|
|
|
|
|
|
class Cursor(Protocol):
|
2021-02-05 15:39:19 -05:00
|
|
|
def execute(self, sql: str, parameters: _Parameters = ...) -> Any:
|
2020-02-27 06:53:40 -05:00
|
|
|
...
|
|
|
|
|
2021-02-05 15:39:19 -05:00
|
|
|
def executemany(self, sql: str, parameters: Sequence[_Parameters]) -> Any:
|
2020-02-27 06:53:40 -05:00
|
|
|
...
|
|
|
|
|
2021-02-05 15:39:19 -05:00
|
|
|
def fetchone(self) -> Optional[Tuple]:
|
|
|
|
...
|
|
|
|
|
|
|
|
def fetchmany(self, size: Optional[int] = ...) -> List[Tuple]:
|
2020-02-27 06:53:40 -05:00
|
|
|
...
|
|
|
|
|
2021-02-05 15:39:19 -05:00
|
|
|
def fetchall(self) -> List[Tuple]:
|
2020-02-27 06:53:40 -05:00
|
|
|
...
|
|
|
|
|
|
|
|
@property
|
2021-02-05 15:39:19 -05:00
|
|
|
def description(
|
|
|
|
self,
|
|
|
|
) -> Optional[
|
|
|
|
Sequence[
|
|
|
|
# Note that this is an approximate typing based on sqlite3 and other
|
|
|
|
# drivers, and may not be entirely accurate.
|
Disallow untyped defs in synapse._scripts (#12422)
Of note:
* 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"
```
* Drive-by comment in `synapse.storage.types`
* No untyped defs in `synapse_port_db`
This was by far the most painful. I'm happy to break this up into
smaller pieces for review if it's not managable as-is.
2022-04-11 07:41:55 -04:00
|
|
|
# FWIW, the DBAPI 2 spec is: https://peps.python.org/pep-0249/#description
|
2021-02-05 15:39:19 -05:00
|
|
|
Tuple[
|
|
|
|
str,
|
|
|
|
Optional[Any],
|
|
|
|
Optional[int],
|
|
|
|
Optional[int],
|
|
|
|
Optional[int],
|
|
|
|
Optional[int],
|
|
|
|
Optional[int],
|
|
|
|
]
|
|
|
|
]
|
|
|
|
]:
|
|
|
|
...
|
2020-02-27 06:53:40 -05:00
|
|
|
|
|
|
|
@property
|
|
|
|
def rowcount(self) -> int:
|
|
|
|
return 0
|
|
|
|
|
|
|
|
def __iter__(self) -> Iterator[Tuple]:
|
|
|
|
...
|
|
|
|
|
|
|
|
def close(self) -> None:
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
class Connection(Protocol):
|
|
|
|
def cursor(self) -> Cursor:
|
|
|
|
...
|
|
|
|
|
|
|
|
def close(self) -> None:
|
|
|
|
...
|
|
|
|
|
|
|
|
def commit(self) -> None:
|
|
|
|
...
|
|
|
|
|
2021-02-05 15:39:19 -05:00
|
|
|
def rollback(self) -> None:
|
2020-02-27 06:53:40 -05:00
|
|
|
...
|
2020-10-02 10:20:45 -04:00
|
|
|
|
|
|
|
def __enter__(self) -> "Connection":
|
|
|
|
...
|
|
|
|
|
2020-10-17 04:51:38 -04:00
|
|
|
def __exit__(self, exc_type, exc_value, traceback) -> Optional[bool]:
|
2020-10-02 10:20:45 -04:00
|
|
|
...
|