diff options
| author | David Robertson <davidr@element.io> | 2022-01-25 20:29:28 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-25 15:29:28 -0500 |
| commit | 74e4419eb4b18ef7d2a3b4416290a4f103042436 (patch) | |
| tree | 69c752a13e0f2feef22b3dfefc77185fd24bd1ac | |
| parent | Check that `gc` method is available before using in `synapse/app/_base` (#11... (diff) | |
| download | synapse-74e4419eb4b18ef7d2a3b4416290a4f103042436.tar.xz | |
Fix another jsonschema typecheck error (#11830)
Similar to #11817. In `_create_power_level_validator` we - retrieve `validator`. This is a class implementing the `jsonschema.protocols.Validator` interface. In other words, `validator: Type[jsonschema.protocols.Validator]`. - we then create an second validator class by modifying the original `validator`. We return that class, which is also of type `Type[jsonschema.protocols.Validator]`. So the original annotation was incorrect: it claimed we were returning an instance of jsonSchema.Draft7Validator, not the class (or a subclass) itself. (Strictly speaking this is incorrect, because `POWER_LEVELS_SCHEMA` isn't pinned to a particular version of JSON Schema. But there are other complications with the type stubs if you try to fix this; I felt like the change herein was a decent compromise that better expresses intent). (I suspect/hope the typeshed project would welcome an effort to improve the jsonschema stubs. Let's see if I get some spare time.)
| -rw-r--r-- | changelog.d/11817.misc | 2 | ||||
| -rw-r--r-- | changelog.d/11830.misc | 1 | ||||
| -rw-r--r-- | synapse/events/validator.py | 6 |
3 files changed, 4 insertions, 5 deletions
diff --git a/changelog.d/11817.misc b/changelog.d/11817.misc index bd29d8d6eb..3d6b2ea4d4 100644 --- a/changelog.d/11817.misc +++ b/changelog.d/11817.misc @@ -1 +1 @@ -Compatibility with updated type hints for jsonschema 4.4.0. +Correct a type annotation in the event validation logic. diff --git a/changelog.d/11830.misc b/changelog.d/11830.misc new file mode 100644 index 0000000000..fe248d00ab --- /dev/null +++ b/changelog.d/11830.misc @@ -0,0 +1 @@ +Correct a type annotation in the event validation logic. \ No newline at end of file diff --git a/synapse/events/validator.py b/synapse/events/validator.py index 4245573017..360d24274a 100644 --- a/synapse/events/validator.py +++ b/synapse/events/validator.py @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. import collections.abc -from typing import Iterable, Union +from typing import Iterable, Type, Union import jsonschema @@ -246,9 +246,7 @@ POWER_LEVELS_SCHEMA = { # This could return something newer than Draft 7, but that's the current "latest" # validator. -# -# See https://github.com/python/typeshed/issues/7028 for the ignored return type. -def _create_power_level_validator() -> jsonschema.Draft7Validator: # type: ignore[valid-type] +def _create_power_level_validator() -> Type[jsonschema.Draft7Validator]: validator = jsonschema.validators.validator_for(POWER_LEVELS_SCHEMA) # by default jsonschema does not consider a frozendict to be an object so |