newsfile

Add a `self` parameter to each method signature in the module api
documentation. This makes them easier to copy-paste, and more accurately
conveys that Synapse expects them to be methods, rather than static
functions.

.ci/scripts/auditwheel_wrapper.py

@@ -25,6 +25,7 @@
 import argparse
 import os
 import subprocess
+from typing import Optional
 from zipfile import ZipFile
 
 from packaging.tags import Tag
@@ -79,7 +80,7 @@ def cpython(wheel_file: str, name: str, version: Version, tag: Tag) -> str:
     return new_wheel_file
 
 
-def main(wheel_file: str, dest_dir: str, archs: str | None) -> None:
+def main(wheel_file: str, dest_dir: str, archs: Optional[str]) -> None:
     """Entry point"""
 
     # Parse the wheel file name into its parts. Note that `parse_wheel_filename`

.ci/scripts/calculate_jobs.py

@@ -35,28 +35,18 @@ IS_PR = os.environ["GITHUB_REF"].startswith("refs/pull/")
 
 # First calculate the various trial jobs.
 #
-# For PRs, we only run each type of test with the oldest and newest Python
-# version that's supported. The oldest version ensures we don't accidentally
-# introduce syntax or code that's too new, and the newest ensures we don't use
-# code that's been dropped in the latest supported Python version.
+# For PRs, we only run each type of test with the oldest Python version supported (which
+# is Python 3.10 right now)
 
 trial_sqlite_tests = [
     {
         "python-version": "3.10",
         "database": "sqlite",
         "extras": "all",
-    },
-    {
-        "python-version": "3.14",
-        "database": "sqlite",
-        "extras": "all",
-    },
+    }
 ]
 
 if not IS_PR:
-    # Otherwise, check all supported Python versions.
-    #
-    # Avoiding running all of these versions on every PR saves on CI time.
     trial_sqlite_tests.extend(
         {
             "python-version": version,
@@ -66,24 +56,25 @@ if not IS_PR:
         for version in ("3.11", "3.12", "3.13")
     )
 
-# Only test postgres against the earliest and latest Python versions that we
-# support in order to save on CI time.
 trial_postgres_tests = [
     {
         "python-version": "3.10",
         "database": "postgres",
         "postgres-version": "13",
         "extras": "all",
-    },
-    {
-        "python-version": "3.14",
-        "database": "postgres",
-        "postgres-version": "17",
-        "extras": "all",
-    },
+    }
 ]
 
-# Ensure that Synapse passes unit tests even with no extra dependencies installed.
+if not IS_PR:
+    trial_postgres_tests.append(
+        {
+            "python-version": "3.13",
+            "database": "postgres",
+            "postgres-version": "17",
+            "extras": "all",
+        }
+    )
+
 trial_no_extra_tests = [
     {
         "python-version": "3.10",

.ci/scripts/prepare_old_deps.sh

@@ -16,23 +16,20 @@ export VIRTUALENV_NO_DOWNLOAD=1
 # to select the lowest possible versions, rather than resorting to this sed script.
 
 # Patch the project definitions in-place:
-# - `-E` use extended regex syntax.
-# - Don't modify the line that defines required Python versions.
-# - Replace all lower and tilde bounds with exact bounds.
-# - Replace all caret bounds with exact bounds.
-# - Delete all lines referring to psycopg2 - so no testing of postgres support.
+# - Replace all lower and tilde bounds with exact bounds
+# - Replace all caret bounds---but not the one that defines the supported Python version!
+# - Delete all lines referring to psycopg2 --- so no testing of postgres support.
 # - Use pyopenssl 17.0, which is the oldest version that works with
 #   a `cryptography` compiled against OpenSSL 1.1.
 # - Omit systemd: we're not logging to journal here.
 
-sed -i -E '
-  /^\s*requires-python\s*=/b
-  s/[~>]=/==/g
-  s/\^/==/g
-  /psycopg2/d
-  s/pyOpenSSL\s*==\s*16\.0\.0"/pyOpenSSL==17.0.0"/
-  /systemd/d
-' pyproject.toml
+sed -i \
+   -e "s/[~>]=/==/g" \
+   -e '/^python = "^/!s/\^/==/g' \
+   -e "/psycopg2/d" \
+   -e 's/pyOpenSSL = "==16.0.0"/pyOpenSSL = "==17.0.0"/' \
+   -e '/systemd/d' \
+   pyproject.toml
 
 echo "::group::Patched pyproject.toml"
 cat pyproject.toml

.git-blame-ignore-revs

@@ -26,8 +26,3 @@ c4268e3da64f1abb5b31deaeb5769adb6510c0a7
 # Update black to 23.1.0 (https://github.com/matrix-org/synapse/pull/15103)
 9bb2eac71962970d02842bca441f4bcdbbf93a11
 
-# Use type hinting generics in standard collections (https://github.com/element-hq/synapse/pull/19046)
-fc244bb592aa481faf28214a2e2ce3bb4e95d990
-
-# Write union types as X | Y where possible (https://github.com/element-hq/synapse/pull/19111)
-fcac7e0282b074d4bd3414d1c9c181e9701875d9

.github/workflows/docker.yml

@@ -123,7 +123,7 @@ jobs:
         uses: sigstore/cosign-installer@faadad0cce49287aee09b3a48701e75088a2c6ad # v4.0.0
 
       - name: Calculate docker image tag
-        uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 # v5.9.0
+        uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
         with:
           images: ${{ matrix.repository }}
           flavor: |

.github/workflows/push_complement_image.yml

@@ -55,7 +55,7 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
       - name: Work out labels for complement image
         id: meta
-        uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 # v5.9.0
+        uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
         with:
           images: ghcr.io/${{ github.repository }}/complement-synapse
           tags: |

.github/workflows/release-artifacts.yml

@@ -141,7 +141,7 @@ jobs:
           python-version: "3.x"
 
       - name: Install cibuildwheel
-        run: python -m pip install cibuildwheel==3.2.1
+        run: python -m pip install cibuildwheel==3.0.0
 
       - name: Only build a single wheel on PR
         if: startsWith(github.ref, 'refs/pull/')
@@ -150,14 +150,9 @@ jobs:
       - name: Build wheels
         run: python -m cibuildwheel --output-dir wheelhouse
         env:
-          # The platforms that we build for are determined by the
-          # `tool.cibuildwheel.skip` option in `pyproject.toml`.
-
-          # We skip testing wheels for the following platforms in CI:
-          #
-          # pp3*-* (PyPy wheels) broke in CI (TODO: investigate).
-          # musl: (TODO: investigate).
-          CIBW_TEST_SKIP: pp3*-* *musl*
+          # Skip testing for platforms which various libraries don't have wheels
+          # for, and so need extra build deps.
+          CIBW_TEST_SKIP: pp3*-* *i686* *musl*
 
       - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
         with:

.github/workflows/tests.yml

@@ -207,6 +207,26 @@ jobs:
         env:
           PULL_REQUEST_NUMBER: ${{ github.event.number }}
 
+  lint-pydantic:
+    runs-on: ubuntu-latest
+    needs: changes
+    if: ${{ needs.changes.outputs.linting == 'true' }}
+
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9 # master
+        with:
+          toolchain: ${{ env.RUST_VERSION }}
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1
+      - uses: matrix-org/setup-python-poetry@5bbf6603c5c930615ec8a29f1b5d7d258d905aa4 # v2.0.0
+        with:
+          poetry-version: "2.1.1"
+          extras: "all"
+      - run: poetry run scripts-dev/check_pydantic_models.py
+
   lint-clippy:
     runs-on: ubuntu-latest
     needs: changes
@@ -321,6 +341,7 @@ jobs:
       - lint-mypy
       - lint-crlf
       - lint-newsfile
+      - lint-pydantic
       - check-sampleconfig
       - check-schema-delta
       - check-lockfile
@@ -342,6 +363,7 @@ jobs:
             lint
             lint-mypy
             lint-newsfile
+            lint-pydantic
             lint-clippy
             lint-clippy-nightly
             lint-rust
@@ -619,7 +641,7 @@ jobs:
           - python-version: "3.10"
             postgres-version: "13"
 
-          - python-version: "3.14"
+          - python-version: "3.13"
             postgres-version: "17"
 
     services:

CHANGES.md

@@ -1,143 +1,3 @@
-# Synapse 1.142.0 (2025-11-11)
-
-## Dropped support for Python 3.9
-
-This release drops support for Python 3.9, in line with our [dependency
-deprecation
-policy](https://element-hq.github.io/synapse/latest/deprecation_policy.html#platform-dependencies),
-as it is now [end of life](https://endoflife.date/python).
-
-## SQLite 3.40.0+ is now required
-
-The minimum supported SQLite version has been increased from 3.27.0 to 3.40.0.
-
-If you use current versions of the
-[matrixorg/synapse](setup/installation.html#docker-images-and-ansible-playbooks)
-Docker images, no action is required.
-
-
-## Deprecation of MacOS Python wheels
-
-The team has decided to deprecate and eventually stop publishing python wheels
-for MacOS. This is a burden on the team, and we're not aware of any parties
-that use them. Synapse docker images will continue to work on MacOS, as will
-building Synapse from source (though note this requires a Rust compiler).
-
-At present, publishing MacOS Python wheels will continue for the next release
-(1.143.0), but will not be available after that (1.144.0+). If you do make use
-of these wheels downstream, please reach out to us in
-[#synapse-dev:matrix.org](https://matrix.to/#/#synapse-dev:matrix.org). We'd
-love to hear from you!
-
-## Internal Changes
-
-- Properly stop building wheels for Python 3.9 and free-threaded CPython. ([\#19154](https://github.com/element-hq/synapse/issues/19154))
-
-
-
-
-# Synapse 1.142.0rc4 (2025-11-07)
-
-## Bugfixes
-
-- Fix a bug introduced in 1.142.0rc1 where any attempt to configure `matrix_authentication_service.secret_path` would prevent the homeserver from starting up. ([\#19144](https://github.com/element-hq/synapse/issues/19144))
-
-
-
-
-# Synapse 1.142.0rc3 (2025-11-04)
-
-## Internal Changes
-
-- Update release scripts to prevent building wheels for free-threaded Python, as Synapse does not currently support it. ([\#19140](https://github.com/element-hq/synapse/issues/19140))
-
-
-# Synapse 1.142.0rc2 (2025-11-04)
-
-
-## Internal Changes
-
-- Manually skip building Python 3.9 wheels, to prevent errors in the release workflow. ([\#19119](https://github.com/element-hq/synapse/issues/19119))
-
-
-
-
-# Synapse 1.142.0rc1 (2025-11-04)
-
-## Features
-
-- Add support for Python 3.14. ([\#19055](https://github.com/element-hq/synapse/issues/19055), [\#19134](https://github.com/element-hq/synapse/issues/19134))
-- Add an [Admin API](https://element-hq.github.io/synapse/latest/usage/administration/admin_api/index.html)
-  to allow an admin to fetch the space/room hierarchy for a given space. ([\#19021](https://github.com/element-hq/synapse/issues/19021))
-
-## Bugfixes
-
-- Fix a bug introduced in 1.111.0 where failed attempts to download authenticated remote media would not be handled correctly. ([\#19062](https://github.com/element-hq/synapse/issues/19062))
-- Update the `oidc_session_no_samesite` cookie to have the `Secure` attribute, so the only difference between it and the paired `oidc_session` cookie, is the configuration of the `SameSite` attribute as described in the comments / cookie names. Contributed by @kieranlane. ([\#19079](https://github.com/element-hq/synapse/issues/19079))
-- Fix a bug introduced in 1.140.0 where lost logcontext warnings would be emitted from timeouts in sync and requests made by Synapse itself. ([\#19090](https://github.com/element-hq/synapse/issues/19090))
-- Fix a bug introdued in 1.140.0 where lost logcontext warning were emitted when using `HomeServer.shutdown()`. ([\#19108](https://github.com/element-hq/synapse/issues/19108))
-
-## Improved Documentation
-
-- Update the link to the Debian oldstable package for SQLite. ([\#19047](https://github.com/element-hq/synapse/issues/19047))
-- Point out additional Redis configuration options available in the worker docs. Contributed by @servisbryce. ([\#19073](https://github.com/element-hq/synapse/issues/19073))
-- Update the list of Debian releases that the downstream Debian package is maintained for. ([\#19100](https://github.com/element-hq/synapse/issues/19100))
-- Add [a page](https://element-hq.github.io/synapse/latest/development/internal_documentation/release_notes_review_checklist.html) to the documentation describing the steps the Synapse team takes to review the release notes before publishing them. ([\#19109](https://github.com/element-hq/synapse/issues/19109))
-
-## Deprecations and Removals
-
-- Drop support for Python 3.9. ([\#19099](https://github.com/element-hq/synapse/issues/19099))
-- Remove support for SQLite < 3.37.2. ([\#19047](https://github.com/element-hq/synapse/issues/19047))
-
-## Internal Changes
-
-- Fix CI linter for schema delta files to correctly handle all types of `CREATE TABLE` syntax. ([\#19020](https://github.com/element-hq/synapse/issues/19020))
-- Use type hinting generics in standard collections, as per [PEP 585](https://peps.python.org/pep-0585/), added in Python 3.9. ([\#19046](https://github.com/element-hq/synapse/issues/19046))
-- Always treat `RETURNING` as supported by SQL engines, now that the minimum-supported versions of both SQLite and PostgreSQL support it. ([\#19047](https://github.com/element-hq/synapse/issues/19047))
-- Move `oidc.load_metadata()` startup into `_base.start()`. ([\#19056](https://github.com/element-hq/synapse/issues/19056))
-- Remove logcontext problems caused by awaiting raw `deferLater(...)`. ([\#19058](https://github.com/element-hq/synapse/issues/19058))
-- Prevent duplicate logging setup when running multiple Synapse instances. ([\#19067](https://github.com/element-hq/synapse/issues/19067))
-- Be mindful of other logging context filters in 3rd-party code and avoid overwriting log record fields unless we know the log record is relevant to Synapse. ([\#19068](https://github.com/element-hq/synapse/issues/19068))
-- Update pydantic to v2. ([\#19071](https://github.com/element-hq/synapse/issues/19071))
-- Update deprecated code in the release script to prevent a warning message from being printed. ([\#19080](https://github.com/element-hq/synapse/issues/19080))
-- Update the deprecated poetry development dependencies group name in `pyproject.toml`. ([\#19081](https://github.com/element-hq/synapse/issues/19081))
-- Remove `pp38*` skip selector from cibuildwheel to silence warning. ([\#19085](https://github.com/element-hq/synapse/issues/19085))
-- Don't immediately exit the release script if the checkout is dirty. Instead, allow the user to clear the dirty changes and retry. ([\#19088](https://github.com/element-hq/synapse/issues/19088))
-- Update the release script's generated announcement text to include a title and extra text for RC's. ([\#19089](https://github.com/element-hq/synapse/issues/19089))
-- Fix lints on main branch. ([\#19092](https://github.com/element-hq/synapse/issues/19092))
-- Use cheaper random string function in logcontext utilities. ([\#19094](https://github.com/element-hq/synapse/issues/19094))
-- Avoid clobbering other `SIGHUP` handlers in 3rd-party code. ([\#19095](https://github.com/element-hq/synapse/issues/19095))
-- Prevent duplicate GitHub draft releases being created during the Synapse release process. ([\#19096](https://github.com/element-hq/synapse/issues/19096))
-- Use Pillow's `Image.getexif` method instead of the experimental `Image._getexif`. ([\#19098](https://github.com/element-hq/synapse/issues/19098))
-- Prevent uv `/usr/local/.lock` file from appearing in built Synapse docker images. ([\#19107](https://github.com/element-hq/synapse/issues/19107))
-- Allow Synapse's runtime dependency checking code to take packaging markers (i.e. `python <= 3.14`) into account when checking dependencies. ([\#19110](https://github.com/element-hq/synapse/issues/19110))
-- Move exception handling up the stack (avoid `exit(1)` in our composable functions). ([\#19116](https://github.com/element-hq/synapse/issues/19116))
-- Fix a lint error related to lifetimes in Rust 1.90. ([\#19118](https://github.com/element-hq/synapse/issues/19118))
-- Refactor and align app entrypoints (avoid `exit(1)` in our composable functions). ([\#19121](https://github.com/element-hq/synapse/issues/19121), [\#19131](https://github.com/element-hq/synapse/issues/19131))
-- Speed up pruning of ratelimiters. ([\#19129](https://github.com/element-hq/synapse/issues/19129))
-
-
-
-### Updates to locked dependencies
-
-* Bump actions/download-artifact from 5.0.0 to 6.0.0. ([\#19102](https://github.com/element-hq/synapse/issues/19102))
-* Bump actions/upload-artifact from 4 to 5. ([\#19106](https://github.com/element-hq/synapse/issues/19106))
-* Bump hiredis from 3.2.1 to 3.3.0. ([\#19103](https://github.com/element-hq/synapse/issues/19103))
-* Bump icu_segmenter from 2.0.0 to 2.0.1. ([\#19126](https://github.com/element-hq/synapse/issues/19126))
-* Bump idna from 3.10 to 3.11. ([\#19053](https://github.com/element-hq/synapse/issues/19053))
-* Bump ijson from 3.4.0 to 3.4.0.post0. ([\#19051](https://github.com/element-hq/synapse/issues/19051))
-* Bump markdown-it-py from 3.0.0 to 4.0.0. ([\#19123](https://github.com/element-hq/synapse/issues/19123))
-* Bump msgpack from 1.1.1 to 1.1.2. ([\#19050](https://github.com/element-hq/synapse/issues/19050))
-* Bump psycopg2 from 2.9.10 to 2.9.11. ([\#19125](https://github.com/element-hq/synapse/issues/19125))
-* Bump pyyaml from 6.0.2 to 6.0.3. ([\#19105](https://github.com/element-hq/synapse/issues/19105))
-* Bump regex from 1.11.3 to 1.12.2. ([\#19074](https://github.com/element-hq/synapse/issues/19074))
-* Bump reqwest from 0.12.23 to 0.12.24. ([\#19077](https://github.com/element-hq/synapse/issues/19077))
-* Bump ruff from 0.12.10 to 0.14.3. ([\#19124](https://github.com/element-hq/synapse/issues/19124))
-* Bump sigstore/cosign-installer from 3.10.0 to 4.0.0. ([\#19075](https://github.com/element-hq/synapse/issues/19075))
-* Bump stefanzweifel/git-auto-commit-action from 6.0.1 to 7.0.0. ([\#19052](https://github.com/element-hq/synapse/issues/19052))
-* Bump tokio from 1.47.1 to 1.48.0. ([\#19076](https://github.com/element-hq/synapse/issues/19076))
-* Bump types-psycopg2 from 2.9.21.20250915 to 2.9.21.20251012. ([\#19054](https://github.com/element-hq/synapse/issues/19054))
-
 # Synapse 1.141.0 (2025-10-29)
 
 ## Deprecation of MacOS Python wheels

Cargo.lock

@@ -589,9 +589,9 @@ dependencies = [
 
 [[package]]
 name = "icu_segmenter"
-version = "2.0.1"
+version = "2.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "38e30e593cf9c3ca2f51aa312eb347cd1ba95715e91a842ec3fc9058eab2af4b"
+checksum = "e185fc13b6401c138cf40db12b863b35f5edf31b88192a545857b41aeaf7d3d3"
 dependencies = [
  "core_maths",
  "displaydoc",
@@ -814,9 +814,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3"
-version = "0.26.0"
+version = "0.25.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7ba0117f4212101ee6544044dae45abe1083d30ce7b29c4b5cbdfa2354e07383"
+checksum = "8970a78afe0628a3e3430376fc5fd76b6b45c4d43360ffd6cdd40bdde72b682a"
 dependencies = [
  "anyhow",
  "indoc",
@@ -832,18 +832,19 @@ dependencies = [
 
 [[package]]
 name = "pyo3-build-config"
-version = "0.26.0"
+version = "0.25.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4fc6ddaf24947d12a9aa31ac65431fb1b851b8f4365426e182901eabfb87df5f"
+checksum = "458eb0c55e7ece017adeba38f2248ff3ac615e53660d7c71a238d7d2a01c7598"
 dependencies = [
+ "once_cell",
  "target-lexicon",
 ]
 
 [[package]]
 name = "pyo3-ffi"
-version = "0.26.0"
+version = "0.25.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "025474d3928738efb38ac36d4744a74a400c901c7596199e20e45d98eb194105"
+checksum = "7114fe5457c61b276ab77c5055f206295b812608083644a5c5b2640c3102565c"
 dependencies = [
  "libc",
  "pyo3-build-config",
@@ -851,9 +852,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-log"
-version = "0.13.2"
+version = "0.12.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2f8bae9ad5ba08b0b0ed2bb9c2bdbaeccc69cafca96d78cf0fbcea0d45d122bb"
+checksum = "45192e5e4a4d2505587e27806c7b710c231c40c56f3bfc19535d0bb25df52264"
 dependencies = [
  "arc-swap",
  "log",
@@ -862,9 +863,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros"
-version = "0.26.0"
+version = "0.25.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2e64eb489f22fe1c95911b77c44cc41e7c19f3082fc81cce90f657cdc42ffded"
+checksum = "a8725c0a622b374d6cb051d11a0983786448f7785336139c3c94f5aa6bef7e50"
 dependencies = [
  "proc-macro2",
  "pyo3-macros-backend",
@@ -874,9 +875,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros-backend"
-version = "0.26.0"
+version = "0.25.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "100246c0ecf400b475341b8455a9213344569af29a3c841d29270e53102e0fcf"
+checksum = "4109984c22491085343c05b0dbc54ddc405c3cf7b4374fc533f5c3313a572ccc"
 dependencies = [
  "heck",
  "proc-macro2",
@@ -887,9 +888,9 @@ dependencies = [
 
 [[package]]
 name = "pythonize"
-version = "0.26.0"
+version = "0.25.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "11e06e4cff9be2bbf2bddf28a486ae619172ea57e79787f856572878c62dcfe2"
+checksum = "597907139a488b22573158793aa7539df36ae863eba300c75f3a0d65fc475e27"
 dependencies = [
  "pyo3",
  "serde",

changelog.d/18784.feature

@@ -1 +0,0 @@
-Support multiple config files in `register_new_matrix_user`.

changelog.d/18943.doc

@@ -1 +0,0 @@
-Improve documentation around streams, particularly ID generators and adding new streams.

changelog.d/19021.feature

@@ -0,0 +1,2 @@
+Add an [Admin API](https://element-hq.github.io/synapse/latest/usage/administration/admin_api/index.html)
+to allow an admin to fetch the space/room hierarchy for a given space.

changelog.d/19046.misc

@@ -0,0 +1 @@
+Use type hinting generics in standard collections, as per PEP 585, added in Python 3.9.

changelog.d/19047.doc

@@ -0,0 +1 @@
+Update the link to the Debian oldstable package for SQLite.

changelog.d/19047.misc

@@ -0,0 +1 @@
+Always treat `RETURNING` as supported by SQL engines, now that the minimum-supported versions of both SQLite and PostgreSQL support it.

changelog.d/19047.removal

@@ -0,0 +1 @@
+Remove support for SQLite < 3.37.2.

changelog.d/19058.misc

@@ -0,0 +1 @@
+Remove logcontext problems caused by awaiting raw `deferLater(...)`.

changelog.d/19073.doc

@@ -0,0 +1 @@
+Point out additional Redis configuration options available in the worker docs. Contributed by @servisbryce.

changelog.d/19079.bugfix

@@ -0,0 +1 @@
+Fix the `oidc_session_no_samesite` cookie to have the `Secure` attribute, so the only difference between it and the paired `oidc_session` cookie, is the configuration of the `SameSite` attribute as described in the comments / cookie names. Contributed by @kieranlane.

changelog.d/19080.misc

@@ -0,0 +1 @@
+Update deprecated code in the release script to prevent a warning message from being printed.

changelog.d/19081.misc

@@ -0,0 +1 @@
+Update the deprecated poetry development dependencies group name in `pyproject.toml`.

changelog.d/19085.misc

@@ -0,0 +1 @@
+Remove `pp38*` skip selector from cibuildwheel to silence warning.

changelog.d/19088.misc

@@ -0,0 +1 @@
+Don't immediately exit the release script if the checkout is dirty. Instead, allow the user to clear the dirty changes and retry.

changelog.d/19089.misc

@@ -0,0 +1 @@
+Update the release script's generated announcement text to include a title and extra text for RC's.

changelog.d/19092.misc

@@ -0,0 +1 @@
+Fix lints on main branch.

changelog.d/19095.misc

@@ -0,0 +1 @@
+Avoid clobbering other `SIGHUP` handlers in 3rd-party code.

changelog.d/19096.misc

@@ -0,0 +1 @@
+Prevent duplicate GitHub draft releases being created during the Synapse release process.

changelog.d/19098.misc

@@ -0,0 +1 @@
+Use Pillow's `Image.getexif` method instead of the experimental `Image._getexif`.

changelog.d/19099.removal

@@ -0,0 +1 @@
+Drop support for Python 3.9.

changelog.d/19100.doc

@@ -0,0 +1 @@
+Update the list of Debian releases that the downstream Debian package is maintained for.

changelog.d/19107.misc

@@ -0,0 +1 @@
+Prevent uv `/usr/local/.lock` file from appearing in built Synapse docker images.

changelog.d/19109.doc

@@ -0,0 +1 @@
+Add [a page](https://element-hq.github.io/synapse/latest/development/internal_documentation/release_notes_review_checklist.html) to the documentation describing the steps the Synapse team takes to review the release notes before publishing them.

changelog.d/19111.misc

@@ -1 +0,0 @@
-Write union types as `X | Y` where possible, as per PEP 604, added in Python 3.10.

changelog.d/19112.doc

@@ -0,0 +1 @@
+Add a `self` parameter to each method in the ModuleApi documentation to make them easier to copy-paste.

changelog.d/19133.misc

@@ -1 +0,0 @@
-Reduce cardinality of `synapse_storage_events_persisted_events_sep_total` metric by removing `origin_entity` label. This also separates out events sent by local application services by changing the `origin_type` for such events to `application_service`. The `type` field also only tracks common event types, and anything else is bucketed under `*other*`.

changelog.d/19135.misc

@@ -1 +0,0 @@
-Run trial tests on Python 3.14 for PRs.

changelog.d/19137.misc

@@ -1 +0,0 @@
-Update `pyproject.toml` project metadata to be compatible with standard Python packaging tooling.

changelog.d/19138.misc

@@ -1 +0,0 @@
-Minor speed up of processing of inbound replication.

changelog.d/19145.misc

@@ -1 +0,0 @@
-Minor speed up of processing of inbound replication.

changelog.d/19146.misc

@@ -1 +0,0 @@
-Minor speed up of processing of inbound replication.

changelog.d/19150.misc

@@ -1 +0,0 @@
-Ignore recent Python language refactors from git blame (`.git-blame-ignore-revs`).

changelog.d/19155.bugfix

@@ -1 +0,0 @@
-Let the SQLite-to-PostgreSQL migration script correctly migrate a boolean column in the `delayed_events` table.

changelog.d/19167.misc

@@ -1 +0,0 @@
-Bump lower bounds of dependencies `parameterized` to `0.9.0` and `idna` to `3.3` as those are the first to advertise support for Python 3.10.

changelog.d/19168.misc

@@ -1 +0,0 @@
-Reduce cardinality of `synapse_storage_events_persisted_events_sep_total` metric by removing `origin_entity` label. This also separates out events sent by local application services by changing the `origin_type` for such events to `application_service`. The `type` field also only tracks common event types, and anything else is bucketed under `*other*`.

changelog.d/19169.misc

@@ -1 +0,0 @@
-Point out which event caused the exception when checking [MSC4293](https://github.com/matrix-org/matrix-spec-proposals/pull/4293) redactions.

contrib/cmdclient/console.py

@@ -33,6 +33,7 @@ import sys
 import time
 import urllib
 from http import TwistedHttpClient
+from typing import Optional
 
 import urlparse
 from signedjson.key import NACL_ED25519, decode_verify_key_bytes
@@ -725,7 +726,7 @@ class SynapseCmd(cmd.Cmd):
         method,
         path,
         data=None,
-        query_params: dict | None = None,
+        query_params: Optional[dict] = None,
         alt_text=None,
     ):
         """Runs an HTTP request and pretty prints the output.

contrib/cmdclient/http.py

@@ -22,6 +22,7 @@
 import json
 import urllib
 from pprint import pformat
+from typing import Optional
 
 from twisted.internet import defer, reactor
 from twisted.web.client import Agent, readBody
@@ -89,7 +90,7 @@ class TwistedHttpClient(HttpClient):
         body = yield readBody(response)
         return json.loads(body)
 
-    def _create_put_request(self, url, json_data, headers_dict: dict | None = None):
+    def _create_put_request(self, url, json_data, headers_dict: Optional[dict] = None):
         """Wrapper of _create_request to issue a PUT request"""
         headers_dict = headers_dict or {}
 
@@ -100,7 +101,7 @@ class TwistedHttpClient(HttpClient):
             "PUT", url, producer=_JsonProducer(json_data), headers_dict=headers_dict
         )
 
-    def _create_get_request(self, url, headers_dict: dict | None = None):
+    def _create_get_request(self, url, headers_dict: Optional[dict] = None):
         """Wrapper of _create_request to issue a GET request"""
         return self._create_request("GET", url, headers_dict=headers_dict or {})
 
@@ -112,7 +113,7 @@ class TwistedHttpClient(HttpClient):
         data=None,
         qparams=None,
         jsonreq=True,
-        headers: dict | None = None,
+        headers: Optional[dict] = None,
     ):
         headers = headers or {}
 
@@ -137,7 +138,7 @@ class TwistedHttpClient(HttpClient):
 
     @defer.inlineCallbacks
     def _create_request(
-        self, method, url, producer=None, headers_dict: dict | None = None
+        self, method, url, producer=None, headers_dict: Optional[dict] = None
     ):
         """Creates and sends a request to the given url"""
         headers_dict = headers_dict or {}

contrib/grafana/synapse.json

@@ -2166,10 +2166,10 @@
               "datasource": {
                 "uid": "${DS_PROMETHEUS}"
               },
-              "expr": "rate(synapse_storage_events_persisted_events_sep_total{instance=\"$instance\",job=~\"$job\",index=~\"$index\"}[$bucket_size])",
+              "expr": "rate(synapse_storage_events_persisted_by_source_type{instance=\"$instance\",job=~\"$job\",index=~\"$index\"}[$bucket_size])",
               "format": "time_series",
               "intervalFactor": 2,
-              "legendFormat": "{{origin_type}}",
+              "legendFormat": "{{type}}",
               "refId": "D"
             }
           ],
@@ -2254,7 +2254,7 @@
               "datasource": {
                 "uid": "${DS_PROMETHEUS}"
               },
-              "expr": "sum by(type) (rate(synapse_storage_events_persisted_events_sep_total{job=~\"$job\",index=~\"$index\",instance=\"$instance\"}[$bucket_size]))",
+              "expr": "rate(synapse_storage_events_persisted_by_event_type{job=~\"$job\",index=~\"$index\",instance=\"$instance\"}[$bucket_size])",
               "format": "time_series",
               "instant": false,
               "intervalFactor": 2,
@@ -2294,6 +2294,99 @@
             "align": false
           }
         },
+        {
+          "aliasColors": {
+            "irc-freenode (local)": "#EAB839"
+          },
+          "bars": false,
+          "dashLength": 10,
+          "dashes": false,
+          "datasource": {
+            "uid": "${DS_PROMETHEUS}"
+          },
+          "decimals": 1,
+          "fill": 1,
+          "fillGradient": 0,
+          "gridPos": {
+            "h": 7,
+            "w": 12,
+            "x": 0,
+            "y": 44
+          },
+          "hiddenSeries": false,
+          "id": 44,
+          "legend": {
+            "alignAsTable": true,
+            "avg": false,
+            "current": false,
+            "hideEmpty": true,
+            "hideZero": true,
+            "max": false,
+            "min": false,
+            "show": true,
+            "total": false,
+            "values": false
+          },
+          "lines": true,
+          "linewidth": 1,
+          "links": [],
+          "nullPointMode": "null",
+          "options": {
+            "alertThreshold": true
+          },
+          "percentage": false,
+          "pluginVersion": "9.2.2",
+          "pointradius": 5,
+          "points": false,
+          "renderer": "flot",
+          "seriesOverrides": [],
+          "spaceLength": 10,
+          "stack": false,
+          "steppedLine": false,
+          "targets": [
+            {
+              "datasource": {
+                "uid": "${DS_PROMETHEUS}"
+              },
+              "expr": "rate(synapse_storage_events_persisted_by_origin{job=~\"$job\",index=~\"$index\",instance=\"$instance\"}[$bucket_size])",
+              "format": "time_series",
+              "intervalFactor": 2,
+              "legendFormat": "{{origin_entity}} ({{origin_type}})",
+              "refId": "A",
+              "step": 20
+            }
+          ],
+          "thresholds": [],
+          "timeRegions": [],
+          "title": "Events/s by Origin",
+          "tooltip": {
+            "shared": false,
+            "sort": 2,
+            "value_type": "individual"
+          },
+          "type": "graph",
+          "xaxis": {
+            "mode": "time",
+            "show": true,
+            "values": []
+          },
+          "yaxes": [
+            {
+              "format": "hertz",
+              "logBase": 1,
+              "min": "0",
+              "show": true
+            },
+            {
+              "format": "short",
+              "logBase": 1,
+              "show": true
+            }
+          ],
+          "yaxis": {
+            "align": false
+          }
+        },
         {
           "aliasColors": {},
           "bars": false,

contrib/prometheus/synapse-v2.rules

@@ -44,3 +44,31 @@ groups:
   ###
   ### End of 'Prometheus Console Only' rules block
   ###
+
+
+  ###
+  ### Grafana Only
+  ### The following rules are only needed if you use the Grafana dashboard
+  ### in contrib/grafana/synapse.json
+  ###
+  - record: synapse_storage_events_persisted_by_source_type
+    expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_type="remote"})
+    labels:
+      type: remote
+  - record: synapse_storage_events_persisted_by_source_type
+    expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_entity="*client*",origin_type="local"})
+    labels:
+      type: local
+  - record: synapse_storage_events_persisted_by_source_type
+    expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_entity!="*client*",origin_type="local"})
+    labels:
+      type: bridges
+
+  - record: synapse_storage_events_persisted_by_event_type
+    expr: sum without(origin_entity, origin_type) (synapse_storage_events_persisted_events_sep_total)
+
+  - record: synapse_storage_events_persisted_by_origin
+    expr: sum without(type) (synapse_storage_events_persisted_events_sep_total)
+  ###
+  ### End of 'Grafana Only' rules block
+  ###

debian/changelog

@@ -1,33 +1,3 @@
-matrix-synapse-py3 (1.142.0) stable; urgency=medium
-
-  * New Synapse release 1.142.0.
-
- -- Synapse Packaging team <packages@matrix.org>  Tue, 11 Nov 2025 09:45:51 +0000
-
-matrix-synapse-py3 (1.142.0~rc4) stable; urgency=medium
-
-  * New Synapse release 1.142.0rc4.
-
- -- Synapse Packaging team <packages@matrix.org>  Fri, 07 Nov 2025 10:54:42 +0000
-
-matrix-synapse-py3 (1.142.0~rc3) stable; urgency=medium
-
-  * New Synapse release 1.142.0rc3.
-
- -- Synapse Packaging team <packages@matrix.org>  Tue, 04 Nov 2025 17:39:11 +0000
-
-matrix-synapse-py3 (1.142.0~rc2) stable; urgency=medium
-
-  * New Synapse release 1.142.0rc2.
-
- -- Synapse Packaging team <packages@matrix.org>  Tue, 04 Nov 2025 16:21:30 +0000
-
-matrix-synapse-py3 (1.142.0~rc1) stable; urgency=medium
-
-  * New Synapse release 1.142.0rc1.
-
- -- Synapse Packaging team <packages@matrix.org>  Tue, 04 Nov 2025 13:20:15 +0000
-
 matrix-synapse-py3 (1.141.0) stable; urgency=medium
 
   * New Synapse release 1.141.0.

docker/configure_workers_and_start.py

@@ -68,6 +68,7 @@ from typing import (
     Mapping,
     MutableMapping,
     NoReturn,
+    Optional,
     SupportsIndex,
 )
 
@@ -467,7 +468,7 @@ def add_worker_roles_to_shared_config(
 
 
 def merge_worker_template_configs(
-    existing_dict: dict[str, Any] | None,
+    existing_dict: Optional[dict[str, Any]],
     to_be_merged_dict: dict[str, Any],
 ) -> dict[str, Any]:
     """When given an existing dict of worker template configuration consisting with both
@@ -1025,7 +1026,7 @@ def generate_worker_log_config(
     Returns: the path to the generated file
     """
     # Check whether we should write worker logs to disk, in addition to the console
-    extra_log_template_args: dict[str, str | None] = {}
+    extra_log_template_args: dict[str, Optional[str]] = {}
     if environ.get("SYNAPSE_WORKERS_WRITE_LOGS_TO_DISK"):
         extra_log_template_args["LOG_FILE_PATH"] = f"{data_dir}/logs/{worker_name}.log"
 

docker/start.py

@@ -6,7 +6,7 @@ import os
 import platform
 import subprocess
 import sys
-from typing import Any, Mapping, MutableMapping, NoReturn
+from typing import Any, Mapping, MutableMapping, NoReturn, Optional
 
 import jinja2
 
@@ -50,7 +50,7 @@ def generate_config_from_template(
     config_dir: str,
     config_path: str,
     os_environ: Mapping[str, str],
-    ownership: str | None,
+    ownership: Optional[str],
 ) -> None:
     """Generate a homeserver.yaml from environment variables
 
@@ -147,7 +147,7 @@ def generate_config_from_template(
     subprocess.run(args, check=True)
 
 
-def run_generate_config(environ: Mapping[str, str], ownership: str | None) -> None:
+def run_generate_config(environ: Mapping[str, str], ownership: Optional[str]) -> None:
     """Run synapse with a --generate-config param to generate a template config file
 
     Args:

docs/development/synapse_architecture/cancellation.md

@@ -299,7 +299,7 @@ logcontext is not finished before the `async` processing completes.
 
 **Bad**:
 ```python
-cache: ObservableDeferred[None] | None = None
+cache: Optional[ObservableDeferred[None]] = None
 
 async def do_something_else(
     to_resolve: Deferred[None]
@@ -326,7 +326,7 @@ with LoggingContext("request-1"):
 
 **Good**:
 ```python
-cache: ObservableDeferred[None] | None = None
+cache: Optional[ObservableDeferred[None]] = None
 
 async def do_something_else(
     to_resolve: Deferred[None]
@@ -358,7 +358,7 @@ with LoggingContext("request-1"):
 
 **OK**:
 ```python
-cache: ObservableDeferred[None] | None = None
+cache: Optional[ObservableDeferred[None]] = None
 
 async def do_something_else(
     to_resolve: Deferred[None]

docs/development/synapse_architecture/streams.md

@@ -1,4 +1,4 @@
-# Streams
+## Streams
 
 Synapse has a concept of "streams", which are roughly described in [`id_generators.py`](
     https://github.com/element-hq/synapse/blob/develop/synapse/storage/util/id_generators.py
@@ -19,7 +19,7 @@ To that end, let's describe streams formally, paraphrasing from the docstring of
     https://github.com/element-hq/synapse/blob/a719b703d9bd0dade2565ddcad0e2f3a7a9d4c37/synapse/storage/util/id_generators.py#L96
 ).
 
-## Definition
+### Definition
 
 A stream is an append-only log `T1, T2, ..., Tn, ...` of facts[^1] which grows over time.
 Only "writers" can add facts to a stream, and there may be multiple writers.
@@ -47,7 +47,7 @@ But unhappy cases (e.g. transaction rollback due to an error) also count as comp
 Once completed, the rows written with that stream ID are fixed, and no new rows
 will be inserted with that ID.
 
-## Current stream ID
+### Current stream ID
 
 For any given stream reader (including writers themselves), we may define a per-writer current stream ID:
 
@@ -93,7 +93,7 @@ Consider a single-writer stream which is initially at ID 1.
 | Complete 6 | 6                 |                                                 |
 
 
-## Multi-writer streams
+### Multi-writer streams
 
 There are two ways to view a multi-writer stream.
 
@@ -115,7 +115,7 @@ The facts this stream holds are instructions to "you should now invalidate these
 We only ever treat this as a multiple single-writer streams as there is no important ordering between cache invalidations.
 (Invalidations are self-contained facts; and the invalidations commute/are idempotent).
 
-## Writing to streams
+### Writing to streams
 
 Writers need to track:
  - track their current position (i.e. its own per-writer stream ID).
@@ -133,7 +133,7 @@ To complete a fact, first remove it from your map of facts currently awaiting co
 Then, if no earlier fact is awaiting completion, the writer can advance its current position in that stream.
 Upon doing so it should emit an `RDATA` message[^3], once for every fact between the old and the new stream ID.
 
-## Subscribing to streams
+### Subscribing to streams
 
 Readers need to track the current position of every writer.
 
@@ -146,44 +146,10 @@ The `RDATA` itself is not a self-contained representation of the fact;
 readers will have to query the stream tables for the full details.
 Readers must also advance their record of the writer's current position for that stream.
 
-## Summary
+# Summary
 
 In a nutshell: we have an append-only log with a "buffer/scratchpad" at the end where we have to wait for the sequence to be linear and contiguous.
 
----
-
-## Cheatsheet for creating a new stream
-
-These rough notes and links may help you to create a new stream and add all the
-necessary registration and event handling.
-
-**Create your stream:**
-- [create a stream class and stream row class](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/replication/tcp/streams/_base.py#L728)
-  - will need an [ID generator](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/storage/databases/main/thread_subscriptions.py#L75)
-    - may need [writer configuration](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/config/workers.py#L177), if there isn't already an obvious source of configuration for which workers should be designated as writers to your new stream.
-      - if adding new writer configuration, add Docker-worker configuration, which lets us configure the writer worker in Complement tests: [[1]](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/docker/configure_workers_and_start.py#L331), [[2]](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/docker/configure_workers_and_start.py#L440)
-- most of the time, you will likely introduce a new datastore class for the concept represented by the new stream, unless there is already an obvious datastore that covers it.
-- consider whether it may make sense to introduce a handler
-
-**Register your stream in:**
-- [`STREAMS_MAP`](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/replication/tcp/streams/__init__.py#L71)
-
-**Advance your stream in:**
-- [`process_replication_position` of your appropriate datastore](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/storage/databases/main/thread_subscriptions.py#L111)
-  - don't forget the super call
-
-**If you're going to do any caching that needs invalidation from new rows:**
-- add invalidations to [`process_replication_rows` of your appropriate datastore](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/storage/databases/main/thread_subscriptions.py#L91)
-  - don't forget the super call
-- add local-only [invalidations to your writer transactions](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/storage/databases/main/thread_subscriptions.py#L201)
-
-**For streams to be used in sync:**
-- add a new field to [`StreamToken`](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/types/__init__.py#L1003)
-  - add a new [`StreamKeyType`](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/types/__init__.py#L999)
-- add appropriate wake-up rules
-  - in [`on_rdata`](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/replication/tcp/client.py#L260)
-  - locally on the same worker when completing a write, [e.g. in your handler](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/handlers/thread_subscriptions.py#L139)
-- add the stream in [`bound_future_token`](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/streams/events.py#L127)
 
 ---
 

docs/modules/account_data_callbacks.md

@@ -14,8 +14,9 @@ _First introduced in Synapse v1.57.0_
 
 ```python
 async def on_account_data_updated(
+    self,
     user_id: str,
-    room_id: str | None,
+    room_id: Optional[str],
     account_data_type: str,
     content: "synapse.module_api.JsonDict",
 ) -> None:
@@ -82,7 +83,7 @@ class CustomAccountDataModule:
     async def log_new_account_data(
         self,
         user_id: str,
-        room_id: str | None,
+        room_id: Optional[str],
         account_data_type: str,
         content: JsonDict,
     ) -> None:

docs/modules/account_validity_callbacks.md

@@ -12,7 +12,10 @@ The available account validity callbacks are:
 _First introduced in Synapse v1.39.0_
 
 ```python
-async def is_user_expired(user: str) -> bool | None
+async def is_user_expired(
+    self,
+    user: str,
+) -> Optional[bool]
 ```
 
 Called when processing any authenticated request (except for logout requests). The module
@@ -34,7 +37,10 @@ any of the subsequent implementations of this callback.
 _First introduced in Synapse v1.39.0_
 
 ```python
-async def on_user_registration(user: str) -> None
+async def on_user_registration(
+    self,
+    user: str,
+) -> None
 ```
 
 Called after successfully registering a user, in case the module needs to perform extra
@@ -48,7 +54,12 @@ If multiple modules implement this callback, Synapse runs them all in order.
 _First introduced in Synapse v1.98.0_
 
 ```python
-async def on_user_login(user_id: str, auth_provider_type: str, auth_provider_id: str) -> None
+async def on_user_login(
+    self,
+    user_id: str,
+    auth_provider_type: str,
+    auth_provider_id: str,
+) -> None
 ```
 
 Called after successfully login or registration of a user for cases when module needs to perform extra operations after auth.

docs/modules/add_extra_fields_to_client_events_unsigned.md

@@ -18,6 +18,7 @@ The callback should be of the form
 
 ```python
 async def add_field_to_unsigned(
+    self,
     event: EventBase,
 ) -> JsonDict:
 ```

docs/modules/background_update_controller_callbacks.md

@@ -20,7 +20,12 @@ The available background update controller callbacks are:
 _First introduced in Synapse v1.49.0_
 
 ```python
-def on_update(update_name: str, database_name: str, one_shot: bool) -> AsyncContextManager[int]
+def on_update(
+    self,
+    update_name: str,
+    database_name: str,
+    one_shot: bool,
+) -> AsyncContextManager[int]
 ```
 
 Called when about to do an iteration of a background update. The module is given the name
@@ -46,7 +51,11 @@ This callback is required when registering any other background update controlle
 _First introduced in Synapse v1.49.0_
 
 ```python
-async def default_batch_size(update_name: str, database_name: str) -> int
+async def default_batch_size(
+    self,
+    update_name: str,
+    database_name: str,
+) -> int
 ```
 
 Called before the first iteration of a background update, with the name of the update and
@@ -60,7 +69,11 @@ If this callback is not defined, Synapse will use a default value of 100.
 _First introduced in Synapse v1.49.0_
 
 ```python
-async def min_batch_size(update_name: str, database_name: str) -> int
+async def min_batch_size(
+    self,
+    update_name: str,
+    database_name: str,
+) -> int
 ```
 
 Called before running a new batch for a background update, with the name of the update and

docs/modules/media_repository_callbacks.md

@@ -11,7 +11,10 @@ The available media repository callbacks are:
 _First introduced in Synapse v1.132.0_
 
 ```python
-async def get_media_config_for_user(user_id: str) -> JsonDict | None
+async def get_media_config_for_user(
+    self,
+    user_id: str,
+) -> Optional[JsonDict]
 ```
 
 **<span style="color:red">
@@ -41,7 +44,11 @@ If no module returns a non-`None` value then the default media config will be re
 _First introduced in Synapse v1.132.0_
 
 ```python
-async def is_user_allowed_to_upload_media_of_size(user_id: str, size: int) -> bool
+async def is_user_allowed_to_upload_media_of_size(
+    self,
+    user_id: str,
+    size: int,
+) -> bool
 ```
 
 **<span style="color:red">
@@ -70,7 +77,11 @@ implementations of this callback.
 _First introduced in Synapse v1.139.0_
 
 ```python
-async def get_media_upload_limits_for_user(user_id: str, size: int) -> list[synapse.module_api.MediaUploadLimit] | None
+async def get_media_upload_limits_for_user(
+    self,
+    user_id: str,
+    size: int,
+) -> Optional[List[synapse.module_api.MediaUploadLimit]]
 ```
 
 **<span style="color:red">
@@ -105,7 +116,13 @@ will be used.
 _First introduced in Synapse v1.139.0_
 
 ```python
-async def on_media_upload_limit_exceeded(user_id: str, limit: synapse.module_api.MediaUploadLimit, sent_bytes: int, attempted_bytes: int) -> None
+async def on_media_upload_limit_exceeded(
+    self,
+    user_id: str,
+    limit: synapse.module_api.MediaUploadLimit,
+    sent_bytes: int,
+    attempted_bytes: int,
+) -> None
 ```
 
 **<span style="color:red">

docs/modules/password_auth_provider_callbacks.md

@@ -20,10 +20,16 @@ callbacks, which should be of the following form:
 
 ```python
 async def check_auth(
+    self,
     user: str,
     login_type: str,
     login_dict: "synapse.module_api.JsonDict",
-) -> tuple[str, Callable[["synapse.module_api.LoginResponse"], Awaitable[None]] | None] | None
+) -> Optional[
+    Tuple[
+        str, 
+        Optional[Callable[["synapse.module_api.LoginResponse"], Awaitable[None]]]
+    ]
+]
 ```
 
 The login type and field names should be provided by the user in the
@@ -59,10 +65,16 @@ _First introduced in Synapse v1.46.0_
 
 ```python
 async def check_3pid_auth(
+    self,
     medium: str, 
     address: str,
     password: str,
-) -> tuple[str, Callable[["synapse.module_api.LoginResponse"], Awaitable[None]] | None]
+) -> Optional[
+    Tuple[
+        str, 
+        Optional[Callable[["synapse.module_api.LoginResponse"], Awaitable[None]]]
+    ]
+]
 ```
 
 Called when a user attempts to register or log in with a third party identifier,
@@ -87,9 +99,10 @@ _First introduced in Synapse v1.46.0_
 
 ```python
 async def on_logged_out(
+    self,
     user_id: str,
-    device_id: str | None,
-    access_token: str
+    device_id: Optional[str],
+    access_token: str,
 ) -> None
 ``` 
 Called during a logout request for a user. It is passed the qualified user ID, the ID of the
@@ -107,9 +120,10 @@ _First introduced in Synapse v1.52.0_
 
 ```python
 async def get_username_for_registration(
+    self,
     uia_results: Dict[str, Any],
     params: Dict[str, Any],
-) -> str | None
+) -> Optional[str]
 ```
 
 Called when registering a new user. The module can return a username to set for the user
@@ -168,9 +182,10 @@ _First introduced in Synapse v1.54.0_
 
 ```python
 async def get_displayname_for_registration(
+    self,
     uia_results: Dict[str, Any],
     params: Dict[str, Any],
-) -> str | None
+) -> Optional[str]
 ```
 
 Called when registering a new user. The module can return a display name to set for the
@@ -195,7 +210,12 @@ the username will be used (e.g. `alice` if the user being registered is `@alice:
 _First introduced in Synapse v1.53.0_
 
 ```python
-async def is_3pid_allowed(self, medium: str, address: str, registration: bool) -> bool
+async def is_3pid_allowed(
+    self,
+    medium: str,
+    address: str,
+    registration: bool,
+) -> bool
 ```
 
 Called when attempting to bind a third-party identifier (i.e. an email address or a phone
@@ -249,7 +269,12 @@ class MyAuthProvider:
         username: str,
         login_type: str,
         login_dict: "synapse.module_api.JsonDict",
-    ) -> tuple[str, Callable[["synapse.module_api.LoginResponse"], Awaitable[None]] | None] | None:
+    ) -> Optional[
+        Tuple[
+            str,
+            Optional[Callable[["synapse.module_api.LoginResponse"], Awaitable[None]]],
+        ]
+    ]:
         if login_type != "my.login_type":
             return None
 
@@ -261,7 +286,12 @@ class MyAuthProvider:
         username: str,
         login_type: str,
         login_dict: "synapse.module_api.JsonDict",
-    ) -> tuple[str, Callable[["synapse.module_api.LoginResponse"], Awaitable[None]] | None] | None:
+    ) -> Optional[
+        Tuple[
+            str,
+            Optional[Callable[["synapse.module_api.LoginResponse"], Awaitable[None]]],
+        ]
+    ]:
         if login_type != "m.login.password":
             return None
 

docs/modules/presence_router_callbacks.md

@@ -22,8 +22,9 @@ _First introduced in Synapse v1.42.0_
 
 ```python 
 async def get_users_for_states(
+    self,
     state_updates: Iterable["synapse.api.UserPresenceState"],
-) -> dict[str, set["synapse.api.UserPresenceState"]]
+) -> Dict[str, Set["synapse.api.UserPresenceState"]]
 ```
 **Requires** `get_interested_users` to also be registered
 
@@ -44,8 +45,9 @@ _First introduced in Synapse v1.42.0_
 
 ```python
 async def get_interested_users(
-    user_id: str
-) -> set[str] | "synapse.module_api.PRESENCE_ALL_USERS"
+    self,
+    user_id: str,
+) -> Union[Set[str], "synapse.module_api.PRESENCE_ALL_USERS"]
 ```
 **Requires** `get_users_for_states` to also be registered
 
@@ -73,7 +75,7 @@ that `@alice:example.org` receives all presence updates from `@bob:example.com`
 `@charlie:somewhere.org`, regardless of whether Alice shares a room with any of them.
 
 ```python
-from typing import Iterable
+from typing import Dict, Iterable, Set, Union
 
 from synapse.module_api import ModuleApi
 
@@ -90,7 +92,7 @@ class CustomPresenceRouter:
     async def get_users_for_states(
         self,
         state_updates: Iterable["synapse.api.UserPresenceState"],
-    ) -> dict[str, set["synapse.api.UserPresenceState"]]:
+    ) -> Dict[str, Set["synapse.api.UserPresenceState"]]:
         res = {}
         for update in state_updates:
             if (
@@ -104,7 +106,7 @@ class CustomPresenceRouter:
     async def get_interested_users(
         self,
         user_id: str,
-    ) -> set[str] | "synapse.module_api.PRESENCE_ALL_USERS":
+    ) -> Union[Set[str], "synapse.module_api.PRESENCE_ALL_USERS"]:
         if user_id == "@alice:example.com":
             return {"@bob:example.com", "@charlie:somewhere.org"}
 

docs/modules/ratelimit_callbacks.md

@@ -11,7 +11,11 @@ The available ratelimit callbacks are:
 _First introduced in Synapse v1.132.0_
 
 ```python
-async def get_ratelimit_override_for_user(user: str, limiter_name: str) -> synapse.module_api.RatelimitOverride | None
+async def get_ratelimit_override_for_user(
+    self,
+    user: str,
+    limiter_name: str,
+) -> Optional[synapse.module_api.RatelimitOverride]
 ```
 
 **<span style="color:red">

docs/modules/spam_checker_callbacks.md

@@ -15,7 +15,10 @@ _First introduced in Synapse v1.37.0_
 _Changed in Synapse v1.60.0: `synapse.module_api.NOT_SPAM` and `synapse.module_api.errors.Codes` can be returned by this callback. Returning a boolean or a string is now deprecated._ 
 
 ```python
-async def check_event_for_spam(event: "synapse.module_api.EventBase") -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", str, bool]
+async def check_event_for_spam(
+    self,
+    event: "synapse.module_api.EventBase",
+) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", str, bool]
 ```
 
 Called when receiving an event from a client or via federation. The callback must return one of:
@@ -41,7 +44,12 @@ _First introduced in Synapse v1.37.0_
 _Changed in Synapse v1.61.0: `synapse.module_api.NOT_SPAM` and `synapse.module_api.errors.Codes` can be returned by this callback. Returning a boolean is now deprecated._ 
 
 ```python
-async def user_may_join_room(user: str, room: str, is_invited: bool) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
+async def user_may_join_room(
+    self,
+    user: str,
+    room: str,
+    is_invited: bool,
+) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
 ```
 
 Called when a user is trying to join a room. The user is represented by their Matrix user ID (e.g.
@@ -73,7 +81,12 @@ _First introduced in Synapse v1.37.0_
 _Changed in Synapse v1.62.0: `synapse.module_api.NOT_SPAM` and `synapse.module_api.errors.Codes` can be returned by this callback. Returning a boolean is now deprecated._ 
 
 ```python
-async def user_may_invite(inviter: str, invitee: str, room_id: str) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
+async def user_may_invite(
+    self,
+    inviter: str,
+    invitee: str,
+    room_id: str,
+) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
 ```
 
 Called when processing an invitation, both when one is created locally or when
@@ -104,7 +117,10 @@ this callback.
 _First introduced in Synapse v1.133.0_
 
 ```python
-async def federated_user_may_invite(event: "synapse.events.EventBase") -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
+async def federated_user_may_invite(
+    self,
+    event: "synapse.events.EventBase",
+) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
 ```
 
 Called when processing an invitation received over federation. Unlike `user_may_invite`,
@@ -135,6 +151,7 @@ _Changed in Synapse v1.62.0: `synapse.module_api.NOT_SPAM` and `synapse.module_a
 
 ```python
 async def user_may_send_3pid_invite(
+    self,
     inviter: str,
     medium: str,
     address: str,
@@ -192,7 +209,11 @@ _Changed in Synapse v1.62.0: `synapse.module_api.NOT_SPAM` and `synapse.module_a
 _Changed in Synapse v1.132.0: Added the `room_config` argument. Callbacks that only expect a single `user_id` argument are still supported._
 
 ```python
-async def user_may_create_room(user_id: str, room_config: synapse.module_api.JsonDict) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
+async def user_may_create_room(
+    self,
+    user_id: str,
+    room_config: synapse.module_api.JsonDict,
+) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
 ```
 
 Called when processing a room creation or room upgrade request.
@@ -229,7 +250,11 @@ _First introduced in Synapse v1.37.0_
 _Changed in Synapse v1.62.0: `synapse.module_api.NOT_SPAM` and `synapse.module_api.errors.Codes` can be returned by this callback. Returning a boolean is now deprecated._ 
 
 ```python
-async def user_may_create_room_alias(user_id: str, room_alias: "synapse.module_api.RoomAlias") -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
+async def user_may_create_room_alias(
+    self,
+    user_id: str,
+    room_alias: "synapse.module_api.RoomAlias",
+) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
 ```
 
 Called when trying to associate an alias with an existing room.
@@ -258,7 +283,11 @@ _First introduced in Synapse v1.37.0_
 _Changed in Synapse v1.62.0: `synapse.module_api.NOT_SPAM` and `synapse.module_api.errors.Codes` can be returned by this callback. Returning a boolean is now deprecated._ 
 
 ```python
-async def user_may_publish_room(user_id: str, room_id: str) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
+async def user_may_publish_room(
+    self,
+    user_id: str,
+    room_id: str,
+) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
 ```
 
 Called when trying to publish a room to the homeserver's public rooms directory.
@@ -284,7 +313,14 @@ this callback.
 _First introduced in Synapse v1.132.0_
 
 ```python
-async def user_may_send_state_event(user_id: str, room_id: str, event_type: str, state_key: str, content: JsonDict) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes"]
+async def user_may_send_state_event(
+    self,
+    user_id: str,
+    room_id: str,
+    event_type: str,
+    state_key: str,
+    content: JsonDict,
+) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes"]
 ```
 
 **<span style="color:red">
@@ -320,7 +356,11 @@ this callback.
 _First introduced in Synapse v1.37.0_
 
 ```python
-async def check_username_for_spam(user_profile: synapse.module_api.UserProfile, requester_id: str) -> bool
+async def check_username_for_spam(
+    self,
+    user_profile: synapse.module_api.UserProfile,
+    requester_id: str,
+) -> bool
 ```
 
 Called when computing search results in the user directory. The module must return a
@@ -331,9 +371,9 @@ search results; otherwise return `False`.
 The profile is represented as a dictionary with the following keys:
 
 * `user_id: str`. The Matrix ID for this user.
-* `display_name: str | None`. The user's display name, or `None` if this user
+* `display_name: Optional[str]`. The user's display name, or `None` if this user
   has not set a display name.
-* `avatar_url: str | None`. The `mxc://` URL to the user's avatar, or `None`
+* `avatar_url: Optional[str]`. The `mxc://` URL to the user's avatar, or `None`
   if this user has not set an avatar.
 
 The module is given a copy of the original dictionary, so modifying it from within the
@@ -352,10 +392,11 @@ _First introduced in Synapse v1.37.0_
 
 ```python
 async def check_registration_for_spam(
-    email_threepid: dict | None,
-    username: str | None,
+    self,
+    email_threepid: Optional[dict],
+    username: Optional[str],
     request_info: Collection[Tuple[str, str]],
-    auth_provider_id: str | None = None,
+    auth_provider_id: Optional[str] = None,
 ) -> "synapse.spam_checker_api.RegistrationBehaviour"
 ```
 
@@ -387,6 +428,7 @@ _Changed in Synapse v1.62.0: `synapse.module_api.NOT_SPAM` and `synapse.module_a
 
 ```python
 async def check_media_file_for_spam(
+    self,
     file_wrapper: "synapse.media.media_storage.ReadableFileWrapper",
     file_info: "synapse.media._base.FileInfo",
 ) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
@@ -415,7 +457,10 @@ this callback.
 _First introduced in Synapse v1.60.0_
 
 ```python
-async def should_drop_federated_event(event: "synapse.events.EventBase") -> bool
+async def should_drop_federated_event(
+    self,
+    event: "synapse.events.EventBase",
+) -> bool
 ```
 
 Called when checking whether a remote server can federate an event with us. **Returning
@@ -437,11 +482,12 @@ _First introduced in Synapse v1.87.0_
 
 ```python
 async def check_login_for_spam(
+    self,
     user_id: str,
-    device_id: str | None,
-    initial_display_name: str | None,
-    request_info: Collection[tuple[str | None, str]],
-    auth_provider_id: str | None = None,
+    device_id: Optional[str],
+    initial_display_name: Optional[str],
+    request_info: Collection[Tuple[Optional[str], str]],
+    auth_provider_id: Optional[str] = None,
 ) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes"]
 ```
 
@@ -509,7 +555,7 @@ class ListSpamChecker:
             resource=IsUserEvilResource(config),
         )
 
-    async def check_event_for_spam(self, event: "synapse.events.EventBase") -> Literal["NOT_SPAM"] | Codes:
+    async def check_event_for_spam(self, event: "synapse.events.EventBase") -> Union[Literal["NOT_SPAM"], Codes]:
         if event.sender in self.evil_users:
           return Codes.FORBIDDEN
         else:

docs/modules/third_party_rules_callbacks.md

@@ -14,9 +14,10 @@ _First introduced in Synapse v1.39.0_
 
 ```python
 async def check_event_allowed(
+    self,
     event: "synapse.events.EventBase",
     state_events: "synapse.types.StateMap",
-) -> tuple[bool, dict | None]
+) -> Tuple[bool, Optional[dict]]
 ```
 
 **<span style="color:red">
@@ -65,6 +66,7 @@ _First introduced in Synapse v1.39.0_
 
 ```python
 async def on_create_room(
+    self,
     requester: "synapse.types.Requester",
     request_content: dict,
     is_requester_admin: bool,
@@ -92,6 +94,7 @@ _First introduced in Synapse v1.39.0_
 
 ```python
 async def check_threepid_can_be_invited(
+    self,
     medium: str,
     address: str,
     state_events: "synapse.types.StateMap",
@@ -112,6 +115,7 @@ _First introduced in Synapse v1.39.0_
 
 ```python
 async def check_visibility_can_be_modified(
+    self,
     room_id: str,
     state_events: "synapse.types.StateMap",
     new_visibility: str,
@@ -133,6 +137,7 @@ _First introduced in Synapse v1.47.0_
 
 ```python
 async def on_new_event(
+    self,
     event: "synapse.events.EventBase",
     state_events: "synapse.types.StateMap",
 ) -> None:
@@ -161,7 +166,9 @@ _First introduced in Synapse v1.55.0_
 
 ```python
 async def check_can_shutdown_room(
-    user_id: str, room_id: str,
+    self,
+    user_id: str,
+    room_id: str,
 ) -> bool:
 ```
 
@@ -180,7 +187,9 @@ _First introduced in Synapse v1.55.0_
 
 ```python
 async def check_can_deactivate_user(
-    user_id: str, by_admin: bool,
+    self,
+    user_id: str,
+    by_admin: bool,
 ) -> bool:
 ```
 
@@ -204,6 +213,7 @@ _First introduced in Synapse v1.54.0_
 
 ```python
 async def on_profile_update(
+    self,
     user_id: str,
     new_profile: "synapse.module_api.ProfileInfo",
     by_admin: bool,
@@ -239,7 +249,10 @@ _First introduced in Synapse v1.54.0_
 
 ```python
 async def on_user_deactivation_status_changed(
-    user_id: str, deactivated: bool, by_admin: bool
+    self,
+    user_id: str,
+    deactivated: bool,
+    by_admin: bool,
 ) -> None:
 ```
 
@@ -264,7 +277,12 @@ features the same functionality. The only difference is in name.
 </span>**
 
 ```python
-async def on_threepid_bind(user_id: str, medium: str, address: str) -> None:
+async def on_threepid_bind(
+    self,
+    user_id: str,
+    medium: str,
+    address: str,
+) -> None:
 ```
 
 Called after creating an association between a local user and a third-party identifier
@@ -282,7 +300,12 @@ If multiple modules implement this callback, Synapse runs them all in order.
 _First introduced in Synapse v1.79.0_
 
 ```python
-async def on_add_user_third_party_identifier(user_id: str, medium: str, address: str) -> None:
+async def on_add_user_third_party_identifier(
+    self,
+    user_id: str,
+    medium: str,
+    address: str,
+) -> None:
 ```
 
 Called after successfully creating an association between a user and a third-party identifier
@@ -301,7 +324,12 @@ If multiple modules implement this callback, Synapse runs them all in order.
 _First introduced in Synapse v1.79.0_
 
 ```python
-async def on_remove_user_third_party_identifier(user_id: str, medium: str, address: str) -> None:
+async def on_remove_user_third_party_identifier(
+    self,
+    user_id: str,
+    medium: str,
+    address: str,
+) -> None:
 ```
 
 Called after successfully removing an association between a user and a third-party identifier
@@ -340,7 +368,7 @@ class EventCensorer:
         self,
         event: "synapse.events.EventBase",
         state_events: "synapse.types.StateMap",
-    ) -> Tuple[bool, dict | None]:
+    ) -> Tuple[bool, Optional[dict]]:
         event_dict = event.get_dict()
         new_event_content = await self.api.http_client.post_json_get_json(
             uri=self._endpoint, post_json=event_dict,

docs/modules/writing_a_module.md

@@ -48,7 +48,11 @@ Modules can register web resources onto Synapse's web server using the following
 API method:
 
 ```python
-def ModuleApi.register_web_resource(path: str, resource: IResource) -> None
+def ModuleApi.register_web_resource(
+    self,
+    path: str,
+    resource: IResource,
+) -> None
 ```
 
 The path is the full absolute path to register the resource at. For example, if you

docs/presence_router_module.md

@@ -76,7 +76,7 @@ possible.
 #### `get_interested_users`
 
 ```python
-async def get_interested_users(self, user_id: str) -> set[str] | str
+async def get_interested_users(self, user_id: str) -> Union[Set[str], str]
 ```
 
 **Required.** An asynchronous method that is passed a single Matrix User ID. This
@@ -182,7 +182,7 @@ class ExamplePresenceRouter:
     async def get_interested_users(
         self,
         user_id: str,
-    ) -> set[str] | PresenceRouter.ALL_USERS:
+    ) -> Union[Set[str], PresenceRouter.ALL_USERS]:
         """
         Retrieve a list of users that `user_id` is interested in receiving the
         presence of. This will be in addition to those they share a room with.

docs/reverse_proxy.md

@@ -86,45 +86,6 @@ server {
 }
 ```
 
-### Nginx Proxy Manager or NPMPlus
-
-```nginx
-Add New Proxy-Host
-	- Tab Details
-		- Domain Names: matrix.example.com
-		- Scheme: http
-		- Forward Hostname / IP: localhost # IP address or hostname where Synapse is hosted. Bare-metal or Container.
-		- Forward Port: 8008
-
-	- Tab Custom locations
-		- Add Location
-		- Define Location: /_matrix
-		- Scheme: http
-		- Forward Hostname / IP: localhost # IP address or hostname where Synapse is hosted. Bare-metal or Container.
-		- Forward Port: 8008
-		- Click on the gear icon to display a custom configuration field. Increase client_max_body_size to match max_upload_size defined in homeserver.yaml
-			- Enter this in the Custom Field: client_max_body_size 50M;
-
-	- Tab SSL/TLS
-		- Choose your SSL/TLS certificate and preferred settings.
-
-	- Tab Advanced
-		- Enter this in the Custom Field. This means that port 8448 no longer needs to be opened in your Firewall.
-		  The Federation communication use now Port 443.
-
-			location /.well-known/matrix/server {
-			  return 200 '{"m.server": "matrix.example.com:443"}';
-      		  add_header Content-Type application/json;
-			}
-
- 			location /.well-known/matrix/client {
-      		  return 200 '{"m.homeserver": {"base_url": "https://matrix.example.com"}}';
-      		  add_header Content-Type application/json;
-      		  add_header "Access-Control-Allow-Origin" *;
-			}
-
-```
-
 ### Caddy v2
 
 ```

docs/upgrade.md

@@ -119,7 +119,7 @@ stacking them up. You can monitor the currently running background updates with
 
 # Upgrading to v1.142.0
 
-## Python 3.10+ is now required
+## Minimum supported Python version
 
 The minimum supported Python version has been increased from v3.9 to v3.10.
 You will need Python 3.10+ to run Synapse v1.142.0.
@@ -128,14 +128,6 @@ If you use current versions of the
 [matrixorg/synapse](setup/installation.html#docker-images-and-ansible-playbooks)
 Docker images, no action is required.
 
-## SQLite 3.40.0+ is now required
-
-The minimum supported SQLite version has been increased from 3.27.0 to 3.40.0.
-
-If you use current versions of the
-[matrixorg/synapse](setup/installation.html#docker-images-and-ansible-playbooks)
-Docker images, no action is required.
-
 
 # Upgrading to v1.141.0
 

pyproject.toml

@@ -1,183 +1,3 @@
-[project]
-name = "matrix-synapse"
-version = "1.142.0"
-description = "Homeserver for the Matrix decentralised comms protocol"
-readme = "README.rst"
-authors = [
-    { name = "Matrix.org Team and Contributors", email = "packages@matrix.org" }
-]
-requires-python = ">=3.10.0,<4.0.0"
-license = "AGPL-3.0-or-later OR LicenseRef-Element-Commercial"
-classifiers = [
-    "Development Status :: 5 - Production/Stable",
-    "Topic :: Communications :: Chat",
-]
-
-# Mandatory Dependencies
-dependencies = [
-    # we use the TYPE_CHECKER.redefine method added in jsonschema 3.0.0
-    "jsonschema>=3.0.0",
-    # 0.25.0 is the first version to support Python 3.14.
-    # We can remove this once https://github.com/python-jsonschema/jsonschema/issues/1426 is fixed
-    # and included in a release.
-    "rpds-py>=0.25.0",
-    # We choose 2.0 as a lower bound: the most recent backwards incompatible release.
-    # It seems generally available, judging by https://pkgs.org/search/?q=immutabledict
-    "immutabledict>=2.0",
-    # We require 2.1.0 or higher for type hints. Previous guard was >= 1.1.0
-    "unpaddedbase64>=2.1.0",
-    # We require 2.0.0 for immutabledict support.
-    "canonicaljson>=2.0.0,<3.0.0",
-    # we use the type definitions added in signedjson 1.1.
-    "signedjson>=1.1.0,<2.0.0",
-    # validating SSL certs for IP addresses requires service_identity 18.1.
-    "service-identity>=18.1.0",
-    # Twisted 18.9 introduces some logger improvements that the structured
-    # logger utilises
-    # Twisted 19.7.0 moves test helpers to a new module and deprecates the old location.
-    # Twisted 21.2.0 introduces contextvar support.
-    # We could likely bump this to 22.1 without making distro packagers'
-    # lives hard (as of 2025-07, distro support is Ubuntu LTS: 22.1, Debian stable: 22.4,
-    # RHEL 9: 22.10)
-    "Twisted[tls]>=21.2.0",
-    "treq>=21.5.0",
-    # Twisted has required pyopenssl 16.0 since about Twisted 16.6.
-    "pyOpenSSL>=16.0.0",
-    "PyYAML>=5.3",
-    "pyasn1>=0.1.9",
-    "pyasn1-modules>=0.0.7",
-    "bcrypt>=3.1.7",
-    # 10.0.1 minimum is mandatory here because of libwebp CVE-2023-4863.
-    # Packagers that already took care of libwebp can lower that down to 5.4.0.
-    "Pillow>=10.0.1",
-    # We use SortedDict.peekitem(), which was added in sortedcontainers 1.5.2.
-    # 2.0.5 updates collections.abc imports to avoid Python 3.10 incompatibility.
-    "sortedcontainers>=2.0.5",
-    "pymacaroons>=0.13.0",
-    "msgpack>=0.5.2",
-    "phonenumbers>=8.2.0",
-    # we use GaugeHistogramMetric, which was added in prom-client 0.4.0.
-    # `prometheus_client.metrics` was added in 0.5.0, so we require that too.
-    # We chose 0.6.0 as that is the current version in Debian Buster (oldstable).
-    "prometheus-client>=0.6.0",
-    # we use `order`, which arrived in attrs 19.2.0.
-    # Note: 21.1.0 broke `/sync`, see https://github.com/matrix-org/synapse/issues/9936
-    "attrs>=19.2.0,!=21.1.0",
-    "netaddr>=0.7.18",
-    # Jinja 2.x is incompatible with MarkupSafe>=2.1. To ensure that admins do not
-    # end up with a broken installation, with recent MarkupSafe but old Jinja, we
-    # add a lower bound to the Jinja2 dependency.
-    "Jinja2>=3.0",
-    # 3.2.0 updates collections.abc imports to avoid Python 3.10 incompatibility.
-    "bleach>=3.2.0",
-    # pydantic 2.12 depends on typing-extensions>=4.14.1
-    "typing-extensions>=4.14.1",
-    # We enforce that we have a `cryptography` version that bundles an `openssl`
-    # with the latest security patches.
-    "cryptography>=3.4.7",
-    # ijson 3.1.4 fixes a bug with "." in property names
-    "ijson>=3.1.4",
-    "matrix-common>=1.3.0,<2.0.0",
-    # We need packaging.verison.Version(...).major added in 20.0.
-    "packaging>=20.0",
-    "pydantic>=2.8;python_version < '3.14'",
-    "pydantic>=2.12;python_version >= '3.14'",
-
-    # This is for building the rust components during "poetry install", which
-    # currently ignores the `build-system.requires` directive (c.f.
-    # https://github.com/python-poetry/poetry/issues/6154). Both `pip install` and
-    # `poetry build` do the right thing without this explicit dependency.
-    #
-    # This isn't really a dev-dependency, as `poetry install --without dev` will fail,
-    # but the alternative is to add it to the main list of deps where it isn't
-    # needed.
-    "setuptools_rust>=1.3",
-
-    # This is used for parsing multipart responses
-    "python-multipart>=0.0.9",
-]
-
-[project.optional-dependencies]
-matrix-synapse-ldap3 = ["matrix-synapse-ldap3>=0.1"]
-postgres = [
-    "psycopg2>=2.8;platform_python_implementation != 'PyPy'",
-    "psycopg2cffi>=2.8;platform_python_implementation == 'PyPy'",
-    "psycopg2cffi-compat==1.1;platform_python_implementation == 'PyPy'",
-]
-saml2 = ["pysaml2>=4.5.0"]
-oidc = ["authlib>=0.15.1"]
-# systemd-python is necessary for logging to the systemd journal via
-# `systemd.journal.JournalHandler`, as is documented in
-# `contrib/systemd/log_config.yaml`.
-systemd = ["systemd-python>=231"]
-url-preview = ["lxml>=4.6.3"]
-sentry = ["sentry-sdk>=0.7.2"]
-opentracing = ["jaeger-client>=4.2.0", "opentracing>=2.2.0"]
-jwt = ["authlib"]
-# hiredis is not a *strict* dependency, but it makes things much faster.
-# (if it is not installed, we fall back to slow code.)
-redis = ["txredisapi>=1.4.7", "hiredis"]
-# Required to use experimental `caches.track_memory_usage` config option.
-cache-memory = ["pympler"]
-# If this is updated, don't forget to update the equivalent lines in
-# tool.poetry.group.dev.dependencies.
-test = ["parameterized>=0.9.0", "idna>=3.3"]
-
-# The duplication here is awful.
-#
-# TODO: This can be resolved via PEP 735 dependency groups, which poetry supports
-# since 2.2.0. However, switching to that would require updating the command
-# developers use to install the `all` group. This would require some coordination.
-#
-# NB: the strings in this list must be *package* names, not extra names.
-# Some of our extra names _are_ package names, which can lead to great confusion.
-all = [
-    # matrix-synapse-ldap3
-    "matrix-synapse-ldap3>=0.1",
-    # postgres
-    "psycopg2>=2.8;platform_python_implementation != 'PyPy'",
-    "psycopg2cffi>=2.8;platform_python_implementation == 'PyPy'",
-    "psycopg2cffi-compat==1.1;platform_python_implementation == 'PyPy'",
-    # saml2
-    "pysaml2>=4.5.0",
-    # oidc and jwt
-    "authlib>=0.15.1",
-    # url-preview
-    "lxml>=4.6.3",
-    # sentry
-    "sentry-sdk>=0.7.2",
-    # opentracing
-    "jaeger-client>=4.2.0", "opentracing>=2.2.0",
-    # redis
-    "txredisapi>=1.4.7", "hiredis",
-    # cache-memory
-    "pympler",
-    # omitted:
-    #   - test: it's useful to have this separate from dev deps in the olddeps job
-    #   - systemd: this is a system-based requirement
-]
-
-[project.urls]
-repository = "https://github.com/element-hq/synapse"
-documentation = "https://element-hq.github.io/synapse/latest"
-"Issue Tracker" = "https://github.com/element-hq/synapse/issues"
-
-[project.scripts]
-synapse_homeserver = "synapse.app.homeserver:main"
-synapse_worker = "synapse.app.generic_worker:main"
-synctl = "synapse._scripts.synctl:main"
-
-export_signing_key = "synapse._scripts.export_signing_key:main"
-generate_config = "synapse._scripts.generate_config:main"
-generate_log_config = "synapse._scripts.generate_log_config:main"
-generate_signing_key = "synapse._scripts.generate_signing_key:main"
-hash_password = "synapse._scripts.hash_password:main"
-register_new_matrix_user = "synapse._scripts.register_new_matrix_user:main"
-synapse_port_db = "synapse._scripts.synapse_port_db:main"
-synapse_review_recent_signups = "synapse._scripts.review_recent_signups:main"
-update_synapse_database = "synapse._scripts.update_synapse_database:main"
-
-
 [tool.towncrier]
     package = "synapse"
     filename = "CHANGES.md"
@@ -260,15 +80,10 @@ select = [
     "G",
     # pyupgrade
     "UP006",
-    "UP007",
-    "UP045",
 ]
 extend-safe-fixes = [
-    # pyupgrade rules compatible with Python >= 3.9
-    "UP006",
-    "UP007",
-    # pyupgrade rules compatible with Python >= 3.10
-    "UP045",
+    # pyupgrade
+    "UP006"
 ]
 
 [tool.ruff.lint.isort]
@@ -291,9 +106,20 @@ manifest-path = "rust/Cargo.toml"
 module-name = "synapse.synapse_rust"
 
 [tool.poetry]
+name = "matrix-synapse"
+version = "1.141.0"
+description = "Homeserver for the Matrix decentralised comms protocol"
+authors = ["Matrix.org Team and Contributors <packages@matrix.org>"]
+license = "AGPL-3.0-or-later OR LicenseRef-Element-Commercial"
+readme = "README.rst"
+repository = "https://github.com/element-hq/synapse"
 packages = [
     { include = "synapse" },
 ]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Topic :: Communications :: Chat",
+]
 include = [
     { path = "AUTHORS.rst", format = "sdist" },
     { path = "book.toml", format = "sdist" },
@@ -323,12 +149,194 @@ exclude = [
 script = "build_rust.py"
 generate-setup-file = true
 
+[tool.poetry.scripts]
+synapse_homeserver = "synapse.app.homeserver:main"
+synapse_worker = "synapse.app.generic_worker:main"
+synctl = "synapse._scripts.synctl:main"
+
+export_signing_key = "synapse._scripts.export_signing_key:main"
+generate_config = "synapse._scripts.generate_config:main"
+generate_log_config = "synapse._scripts.generate_log_config:main"
+generate_signing_key = "synapse._scripts.generate_signing_key:main"
+hash_password = "synapse._scripts.hash_password:main"
+register_new_matrix_user = "synapse._scripts.register_new_matrix_user:main"
+synapse_port_db = "synapse._scripts.synapse_port_db:main"
+synapse_review_recent_signups = "synapse._scripts.review_recent_signups:main"
+update_synapse_database = "synapse._scripts.update_synapse_database:main"
+
+[tool.poetry.dependencies]
+python = "^3.10.0"
+
+# Mandatory Dependencies
+# ----------------------
+# we use the TYPE_CHECKER.redefine method added in jsonschema 3.0.0
+jsonschema = ">=3.0.0"
+# We choose 2.0 as a lower bound: the most recent backwards incompatible release.
+# It seems generally available, judging by https://pkgs.org/search/?q=immutabledict
+immutabledict = ">=2.0"
+# We require 2.1.0 or higher for type hints. Previous guard was >= 1.1.0
+unpaddedbase64 = ">=2.1.0"
+# We require 2.0.0 for immutabledict support.
+canonicaljson = "^2.0.0"
+# we use the type definitions added in signedjson 1.1.
+signedjson = "^1.1.0"
+# validating SSL certs for IP addresses requires service_identity 18.1.
+service-identity = ">=18.1.0"
+# Twisted 18.9 introduces some logger improvements that the structured
+# logger utilises
+# Twisted 19.7.0 moves test helpers to a new module and deprecates the old location.
+# Twisted 21.2.0 introduces contextvar support.
+# We could likely bump this to 22.1 without making distro packagers'
+# lives hard (as of 2025-07, distro support is Ubuntu LTS: 22.1, Debian stable: 22.4,
+# RHEL 9: 22.10)
+Twisted = {extras = ["tls"], version = ">=21.2.0"}
+treq = ">=21.5.0"
+# Twisted has required pyopenssl 16.0 since about Twisted 16.6.
+pyOpenSSL = ">=16.0.0"
+PyYAML = ">=5.3"
+pyasn1 = ">=0.1.9"
+pyasn1-modules = ">=0.0.7"
+bcrypt = ">=3.1.7"
+# 10.0.1 minimum is mandatory here because of libwebp CVE-2023-4863.
+# Packagers that already took care of libwebp can lower that down to 5.4.0.
+Pillow = ">=10.0.1"
+# We use SortedDict.peekitem(), which was added in sortedcontainers 1.5.2.
+# 2.0.5 updates collections.abc imports to avoid Python 3.10 incompatibility.
+sortedcontainers = ">=2.0.5"
+pymacaroons = ">=0.13.0"
+msgpack = ">=0.5.2"
+phonenumbers = ">=8.2.0"
+# we use GaugeHistogramMetric, which was added in prom-client 0.4.0.
+# `prometheus_client.metrics` was added in 0.5.0, so we require that too.
+# We chose 0.6.0 as that is the current version in Debian Buster (oldstable).
+prometheus-client = ">=0.6.0"
+# we use `order`, which arrived in attrs 19.2.0.
+# Note: 21.1.0 broke `/sync`, see https://github.com/matrix-org/synapse/issues/9936
+attrs = ">=19.2.0,!=21.1.0"
+netaddr = ">=0.7.18"
+# Jinja 2.x is incompatible with MarkupSafe>=2.1. To ensure that admins do not
+# end up with a broken installation, with recent MarkupSafe but old Jinja, we
+# add a lower bound to the Jinja2 dependency.
+Jinja2 = ">=3.0"
+# 3.2.0 updates collections.abc imports to avoid Python 3.10 incompatibility.
+bleach = ">=3.2.0"
+# We use `assert_never`, which were added in `typing-extensions` 4.1.
+typing-extensions = ">=4.1"
+# We enforce that we have a `cryptography` version that bundles an `openssl`
+# with the latest security patches.
+cryptography = ">=3.4.7"
+# ijson 3.1.4 fixes a bug with "." in property names
+ijson = ">=3.1.4"
+matrix-common = "^1.3.0"
+# We need packaging.verison.Version(...).major added in 20.0.
+packaging = ">=20.0"
+# We support pydantic v1 and pydantic v2 via the pydantic.v1 compat module.
+# See https://github.com/matrix-org/synapse/issues/15858
+pydantic = ">=1.7.4, <3"
+
+# This is for building the rust components during "poetry install", which
+# currently ignores the `build-system.requires` directive (c.f.
+# https://github.com/python-poetry/poetry/issues/6154). Both `pip install` and
+# `poetry build` do the right thing without this explicit dependency.
+#
+# This isn't really a dev-dependency, as `poetry install --without dev` will fail,
+# but the alternative is to add it to the main list of deps where it isn't
+# needed.
+setuptools_rust = ">=1.3"
+
+# This is used for parsing multipart responses
+python-multipart = ">=0.0.9"
+
+# Optional Dependencies
+# ---------------------
+matrix-synapse-ldap3 = { version = ">=0.1", optional = true }
+psycopg2 = { version = ">=2.8", markers = "platform_python_implementation != 'PyPy'", optional = true }
+psycopg2cffi = { version = ">=2.8", markers = "platform_python_implementation == 'PyPy'", optional = true }
+psycopg2cffi-compat = { version = "==1.1", markers = "platform_python_implementation == 'PyPy'", optional = true }
+pysaml2 = { version = ">=4.5.0", optional = true }
+authlib = { version = ">=0.15.1", optional = true }
+# systemd-python is necessary for logging to the systemd journal via
+# `systemd.journal.JournalHandler`, as is documented in
+# `contrib/systemd/log_config.yaml`.
+# Note: systemd-python 231 appears to have been yanked from pypi
+systemd-python = { version = ">=231", optional = true }
+# 4.6.3 removes usage of _PyGen_Send which is unavailable in CPython as of Python 3.10.
+lxml = { version = ">=4.6.3", optional = true }
+sentry-sdk = { version = ">=0.7.2", optional = true }
+opentracing = { version = ">=2.2.0", optional = true }
+# 4.2.0 updates collections.abc imports to avoid Python 3.10 incompatibility.
+jaeger-client = { version = ">=4.2.0", optional = true }
+txredisapi = { version = ">=1.4.7", optional = true }
+hiredis = { version = "*", optional = true }
+Pympler = { version = "*", optional = true }
+parameterized = { version = ">=0.7.4", optional = true }
+idna = { version = ">=2.5", optional = true }
+
+[tool.poetry.extras]
+# NB: Packages that should be part of `pip install matrix-synapse[all]` need to be specified
+# twice: once here, and once in the `all` extra.
+matrix-synapse-ldap3 = ["matrix-synapse-ldap3"]
+postgres = ["psycopg2", "psycopg2cffi", "psycopg2cffi-compat"]
+saml2 = ["pysaml2"]
+oidc = ["authlib"]
+# systemd-python is necessary for logging to the systemd journal via
+# `systemd.journal.JournalHandler`, as is documented in
+# `contrib/systemd/log_config.yaml`.
+systemd = ["systemd-python"]
+url-preview = ["lxml"]
+sentry = ["sentry-sdk"]
+opentracing = ["jaeger-client", "opentracing"]
+jwt = ["authlib"]
+# hiredis is not a *strict* dependency, but it makes things much faster.
+# (if it is not installed, we fall back to slow code.)
+redis = ["txredisapi", "hiredis"]
+# Required to use experimental `caches.track_memory_usage` config option.
+cache-memory = ["pympler"]
+test = ["parameterized", "idna"]
+
+# The duplication here is awful. I hate hate hate hate hate it. However, for now I want
+# to ensure you can still `pip install matrix-synapse[all]` like today. Two motivations:
+# 1) for new installations, I want instructions in existing documentation and tutorials
+#    out there to still work.
+# 2) I don't want to hard-code a list of extras into CI if I can help it. The ideal
+#    solution here would be something like https://github.com/python-poetry/poetry/issues/3413
+# Poetry 1.2's dependency groups might make this easier. But I'm not trying that out
+# until there's a stable release of 1.2.
+#
+# NB: the strings in this list must be *package* names, not extra names.
+# Some of our extra names _are_ package names, which can lead to great confusion.
+all = [
+    # matrix-synapse-ldap3
+    "matrix-synapse-ldap3",
+    # postgres
+    "psycopg2", "psycopg2cffi", "psycopg2cffi-compat",
+    # saml2
+    "pysaml2",
+    # oidc and jwt
+    "authlib",
+    # url-preview
+    "lxml",
+    # sentry
+    "sentry-sdk",
+    # opentracing
+    "jaeger-client", "opentracing",
+    # redis
+    "txredisapi", "hiredis",
+    # cache-memory
+    "pympler",
+    # omitted:
+    #   - test: it's useful to have this separate from dev deps in the olddeps job
+    #   - systemd: this is a system-based requirement
+]
+
 [tool.poetry.group.dev.dependencies]
 # We pin development dependencies in poetry.lock so that our tests don't start
 # failing on new releases. Keeping lower bounds loose here means that dependabot
 # can bump versions without having to update the content-hash in the lockfile.
 # This helps prevents merge conflicts when running a batch of dependabot updates.
-ruff = "0.14.3"
+ruff = "0.12.10"
+# Type checking only works with the pydantic.v1 compat module from pydantic v2
+pydantic = "^2"
 
 # Typechecking
 lxml-stubs = ">=0.4.0"
@@ -348,11 +356,10 @@ types-setuptools = ">=57.4.0"
 # Dependencies which are exclusively required by unit test code. This is
 # NOT a list of all modules that are necessary to run the unit tests.
 # Tests assume that all optional dependencies are installed.
-#
-# If this is updated, don't forget to update the equivalent lines in
-# project.optional-dependencies.test.
-parameterized = ">=0.9.0"
-idna = ">=3.3"
+# parameterized<0.7.4 can create classes with names that would normally be invalid
+# identifiers. trial really does not like this when running with multiple workers.
+parameterized = ">=0.7.4"
+idna = ">=2.5"
 
 # The following are used by the release script
 click = ">=8.1.3"
@@ -376,29 +383,19 @@ tomli = ">=1.2.3"
 # runtime errors caused by build system changes.
 # We are happy to raise these upper bounds upon request,
 # provided we check that it's safe to do so (i.e. that CI passes).
-requires = ["poetry-core>=2.0.0,<=2.1.3", "setuptools_rust>=1.3,<=1.11.1"]
+requires = ["poetry-core>=1.1.0,<=2.1.3", "setuptools_rust>=1.3,<=1.11.1"]
 build-backend = "poetry.core.masonry.api"
 
 
 [tool.cibuildwheel]
 # Skip unsupported platforms (by us or by Rust).
-#
-# See https://cibuildwheel.readthedocs.io/en/stable/options/#build-skip for the
-# list of supported build targets.
-#
-# Also see `.github/workflows/release-artifacts.yml` for the list of
-# architectures we build for (based on the runner OS types we use), as well as
-# the platforms we exclude from testing in CI.
-#
+# See https://cibuildwheel.readthedocs.io/en/stable/options/#build-skip for the list of build targets.
 # We skip:
-#  - free-threaded cpython builds: these are not currently supported.
-#  - cp38: Python 3.8 is end-of-life.
-#  - cp39: Python 3.9 is end-of-life.
-#  - i686: We don't support 32-bit platforms.
-skip = "cp3??t-* cp38-* cp39-* *i686*"
-# Enable non-default builds. See the list of available options:
-# https://cibuildwheel.pypa.io/en/stable/options#enable
-#
+#  - CPython 3.8: EOLed
+#  - musllinux i686: excluded to reduce number of wheels we build.
+#    c.f. https://github.com/matrix-org/synapse/pull/12595#discussion_r963107677
+skip = "cp38* *-musllinux_i686"
+# Enable non-default builds.
 # "pypy" used to be included by default up until cibuildwheel 3.
 enable = "pypy"
 

rust/Cargo.toml

@@ -30,14 +30,14 @@ http = "1.1.0"
 lazy_static = "1.4.0"
 log = "0.4.17"
 mime = "0.3.17"
-pyo3 = { version = "0.26.0", features = [
+pyo3 = { version = "0.25.1", features = [
     "macros",
     "anyhow",
     "abi3",
     "abi3-py310",
 ] }
-pyo3-log = "0.13.1"
-pythonize = "0.26.0"
+pyo3-log = "0.12.4"
+pythonize = "0.25.0"
 regex = "1.6.0"
 sha2 = "0.10.8"
 serde = { version = "1.0.144", features = ["derive"] }

rust/src/events/internal_metadata.rs

@@ -41,7 +41,7 @@ use pyo3::{
     pybacked::PyBackedStr,
     pyclass, pymethods,
     types::{PyAnyMethods, PyDict, PyDictMethods, PyString},
-    Bound, IntoPyObject, Py, PyAny, PyResult, Python,
+    Bound, IntoPyObject, PyAny, PyObject, PyResult, Python,
 };
 
 use crate::UnwrapInfallible;
@@ -289,7 +289,7 @@ impl EventInternalMetadata {
     /// Get a dict holding the data stored in the `internal_metadata` column in the database.
     ///
     /// Note that `outlier` and `stream_ordering` are stored in separate columns so are not returned here.
-    fn get_dict(&self, py: Python<'_>) -> PyResult<Py<PyAny>> {
+    fn get_dict(&self, py: Python<'_>) -> PyResult<PyObject> {
         let dict = PyDict::new(py);
 
         for entry in &self.data {

rust/src/http_client.rs

@@ -134,10 +134,10 @@ fn get_runtime<'a>(reactor: &Bound<'a, PyAny>) -> PyResult<PyRef<'a, PyTokioRunt
 }
 
 /// A reference to the `twisted.internet.defer` module.
-static DEFER: OnceCell<Py<PyAny>> = OnceCell::new();
+static DEFER: OnceCell<PyObject> = OnceCell::new();
 
 /// Access to the `twisted.internet.defer` module.
-fn defer(py: Python<'_>) -> PyResult<&Bound<'_, PyAny>> {
+fn defer(py: Python<'_>) -> PyResult<&Bound<PyAny>> {
     Ok(DEFER
         .get_or_try_init(|| py.import("twisted.internet.defer").map(Into::into))?
         .bind(py))
@@ -165,7 +165,7 @@ pub fn register_module(py: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()>
 #[pyclass]
 struct HttpClient {
     client: reqwest::Client,
-    reactor: Py<PyAny>,
+    reactor: PyObject,
 }
 
 #[pymethods]
@@ -237,7 +237,7 @@ impl HttpClient {
                 return Err(HttpResponseException::new(status, buffer));
             }
 
-            let r = Python::attach(|py| buffer.into_pyobject(py).map(|o| o.unbind()))?;
+            let r = Python::with_gil(|py| buffer.into_pyobject(py).map(|o| o.unbind()))?;
 
             Ok(r)
         })
@@ -270,7 +270,7 @@ where
     handle.spawn(async move {
         let res = task.await;
 
-        Python::attach(move |py| {
+        Python::with_gil(move |py| {
             // Flatten the panic into standard python error
             let res = match res {
                 Ok(r) => r,

rust/src/rendezvous/mod.rs

@@ -29,7 +29,7 @@ use pyo3::{
     exceptions::PyValueError,
     pyclass, pymethods,
     types::{PyAnyMethods, PyModule, PyModuleMethods},
-    Bound, IntoPyObject, Py, PyAny, PyResult, Python,
+    Bound, IntoPyObject, Py, PyAny, PyObject, PyResult, Python,
 };
 use ulid::Ulid;
 
@@ -56,7 +56,7 @@ fn prepare_headers(headers: &mut HeaderMap, session: &Session) {
 #[pyclass]
 struct RendezvousHandler {
     base: Uri,
-    clock: Py<PyAny>,
+    clock: PyObject,
     sessions: BTreeMap<Ulid, Session>,
     capacity: usize,
     max_content_length: u64,

schema/synapse-config.schema.yaml

@@ -1,5 +1,5 @@
 $schema: https://element-hq.github.io/synapse/latest/schema/v1/meta.schema.json
-$id: https://element-hq.github.io/synapse/schema/synapse/v1.142/synapse-config.schema.json
+$id: https://element-hq.github.io/synapse/schema/synapse/v1.141/synapse-config.schema.json
 type: object
 properties:
   modules:

scripts-dev/build_debian_packages.py

@@ -18,7 +18,7 @@ import sys
 import threading
 from concurrent.futures import ThreadPoolExecutor
 from types import FrameType
-from typing import Collection, Sequence
+from typing import Collection, Optional, Sequence
 
 # These are expanded inside the dockerfile to be a fully qualified image name.
 # e.g. docker.io/library/debian:bookworm
@@ -49,7 +49,7 @@ class Builder:
     def __init__(
         self,
         redirect_stdout: bool = False,
-        docker_build_args: Sequence[str] | None = None,
+        docker_build_args: Optional[Sequence[str]] = None,
     ):
         self.redirect_stdout = redirect_stdout
         self._docker_build_args = tuple(docker_build_args or ())
@@ -167,7 +167,7 @@ class Builder:
 def run_builds(
     builder: Builder, dists: Collection[str], jobs: int = 1, skip_tests: bool = False
 ) -> None:
-    def sig(signum: int, _frame: FrameType | None) -> None:
+    def sig(signum: int, _frame: Optional[FrameType]) -> None:
         print("Caught SIGINT")
         builder.kill_containers()
 

scripts-dev/check_pydantic_models.py

@@ -0,0 +1,474 @@
+#! /usr/bin/env python
+#
+# This file is licensed under the Affero General Public License (AGPL) version 3.
+#
+# Copyright 2022 The Matrix.org Foundation C.I.C.
+# Copyright (C) 2023 New Vector, Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# See the GNU Affero General Public License for more details:
+# <https://www.gnu.org/licenses/agpl-3.0.html>.
+#
+# Originally licensed under the Apache License, Version 2.0:
+# <http://www.apache.org/licenses/LICENSE-2.0>.
+#
+# [This file includes modifications made by New Vector Limited]
+#
+#
+"""
+A script which enforces that Synapse always uses strict types when defining a Pydantic
+model.
+
+Pydantic does not yet offer a strict mode, but it is planned for pydantic v2. See
+
+    https://github.com/pydantic/pydantic/issues/1098
+    https://pydantic-docs.helpmanual.io/blog/pydantic-v2/#strict-mode
+
+until then, this script is a best effort to stop us from introducing type coersion bugs
+(like the infamous stringy power levels fixed in room version 10).
+"""
+
+import argparse
+import contextlib
+import functools
+import importlib
+import logging
+import os
+import pkgutil
+import sys
+import textwrap
+import traceback
+import unittest.mock
+from contextlib import contextmanager
+from typing import (
+    Any,
+    Callable,
+    Generator,
+    TypeVar,
+)
+
+from parameterized import parameterized
+from typing_extensions import ParamSpec
+
+from synapse._pydantic_compat import (
+    BaseModel as PydanticBaseModel,
+    conbytes,
+    confloat,
+    conint,
+    constr,
+    get_args,
+)
+
+logger = logging.getLogger(__name__)
+
+CONSTRAINED_TYPE_FACTORIES_WITH_STRICT_FLAG: list[Callable] = [
+    constr,
+    conbytes,
+    conint,
+    confloat,
+]
+
+TYPES_THAT_PYDANTIC_WILL_COERCE_TO = [
+    str,
+    bytes,
+    int,
+    float,
+    bool,
+]
+
+
+P = ParamSpec("P")
+R = TypeVar("R")
+
+
+class ModelCheckerException(Exception):
+    """Dummy exception. Allows us to detect unwanted types during a module import."""
+
+
+class MissingStrictInConstrainedTypeException(ModelCheckerException):
+    factory_name: str
+
+    def __init__(self, factory_name: str):
+        self.factory_name = factory_name
+
+
+class FieldHasUnwantedTypeException(ModelCheckerException):
+    message: str
+
+    def __init__(self, message: str):
+        self.message = message
+
+
+def make_wrapper(factory: Callable[P, R]) -> Callable[P, R]:
+    """We patch `constr` and friends with wrappers that enforce strict=True."""
+
+    @functools.wraps(factory)
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
+        if "strict" not in kwargs:
+            raise MissingStrictInConstrainedTypeException(factory.__name__)
+        if not kwargs["strict"]:
+            raise MissingStrictInConstrainedTypeException(factory.__name__)
+        return factory(*args, **kwargs)
+
+    return wrapper
+
+
+def field_type_unwanted(type_: Any) -> bool:
+    """Very rough attempt to detect if a type is unwanted as a Pydantic annotation.
+
+    At present, we exclude types which will coerce, or any generic type involving types
+    which will coerce."""
+    logger.debug("Is %s unwanted?")
+    if type_ in TYPES_THAT_PYDANTIC_WILL_COERCE_TO:
+        logger.debug("yes")
+        return True
+    logger.debug("Maybe. Subargs are %s", get_args(type_))
+    rv = any(field_type_unwanted(t) for t in get_args(type_))
+    logger.debug("Conclusion: %s %s unwanted", type_, "is" if rv else "is not")
+    return rv
+
+
+class PatchedBaseModel(PydanticBaseModel):
+    """A patched version of BaseModel that inspects fields after models are defined.
+
+    We complain loudly if we see an unwanted type.
+
+    Beware: ModelField.type_ is presumably private; this is likely to be very brittle.
+    """
+
+    @classmethod
+    def __init_subclass__(cls: type[PydanticBaseModel], **kwargs: object):
+        for field in cls.__fields__.values():
+            # Note that field.type_ and field.outer_type are computed based on the
+            # annotation type, see pydantic.fields.ModelField._type_analysis
+            if field_type_unwanted(field.outer_type_):
+                # TODO: this only reports the first bad field. Can we find all bad ones
+                #  and report them all?
+                raise FieldHasUnwantedTypeException(
+                    f"{cls.__module__}.{cls.__qualname__} has field '{field.name}' "
+                    f"with unwanted type `{field.outer_type_}`"
+                )
+
+
+@contextmanager
+def monkeypatch_pydantic() -> Generator[None, None, None]:
+    """Patch pydantic with our snooping versions of BaseModel and the con* functions.
+
+    If the snooping functions see something they don't like, they'll raise a
+    ModelCheckingException instance.
+    """
+    with contextlib.ExitStack() as patches:
+        # Most Synapse code ought to import the patched objects directly from
+        # `pydantic`. But we also patch their containing modules `pydantic.main` and
+        # `pydantic.types` for completeness.
+        patch_basemodel = unittest.mock.patch(
+            "synapse._pydantic_compat.BaseModel", new=PatchedBaseModel
+        )
+        patches.enter_context(patch_basemodel)
+        for factory in CONSTRAINED_TYPE_FACTORIES_WITH_STRICT_FLAG:
+            wrapper: Callable = make_wrapper(factory)
+            patch = unittest.mock.patch(
+                f"synapse._pydantic_compat.{factory.__name__}", new=wrapper
+            )
+            patches.enter_context(patch)
+        yield
+
+
+def format_model_checker_exception(e: ModelCheckerException) -> str:
+    """Work out which line of code caused e. Format the line in a human-friendly way."""
+    # TODO. FieldHasUnwantedTypeException gives better error messages. Can we ditch the
+    #   patches of constr() etc, and instead inspect fields to look for ConstrainedStr
+    #   with strict=False? There is some difficulty with the inheritance hierarchy
+    #   because StrictStr < ConstrainedStr < str.
+    if isinstance(e, FieldHasUnwantedTypeException):
+        return e.message
+    elif isinstance(e, MissingStrictInConstrainedTypeException):
+        frame_summary = traceback.extract_tb(e.__traceback__)[-2]
+        return (
+            f"Missing `strict=True` from {e.factory_name}() call \n"
+            + traceback.format_list([frame_summary])[0].lstrip()
+        )
+    else:
+        raise ValueError(f"Unknown exception {e}") from e
+
+
+def lint() -> int:
+    """Try to import all of Synapse and see if we spot any Pydantic type coercions.
+
+    Print any problems, then return a status code suitable for sys.exit."""
+    failures = do_lint()
+    if failures:
+        print(f"Found {len(failures)} problem(s)")
+    for failure in sorted(failures):
+        print(failure)
+    return os.EX_DATAERR if failures else os.EX_OK
+
+
+def do_lint() -> set[str]:
+    """Try to import all of Synapse and see if we spot any Pydantic type coercions."""
+    failures = set()
+
+    with monkeypatch_pydantic():
+        logger.debug("Importing synapse")
+        try:
+            # TODO: make "synapse" an argument so we can target this script at
+            # a subpackage
+            module = importlib.import_module("synapse")
+        except ModelCheckerException as e:
+            logger.warning("Bad annotation found when importing synapse")
+            failures.add(format_model_checker_exception(e))
+            return failures
+
+        try:
+            logger.debug("Fetching subpackages")
+            module_infos = list(
+                pkgutil.walk_packages(module.__path__, f"{module.__name__}.")
+            )
+        except ModelCheckerException as e:
+            logger.warning("Bad annotation found when looking for modules to import")
+            failures.add(format_model_checker_exception(e))
+            return failures
+
+        for module_info in module_infos:
+            logger.debug("Importing %s", module_info.name)
+            try:
+                importlib.import_module(module_info.name)
+            except ModelCheckerException as e:
+                logger.warning(
+                    "Bad annotation found when importing %s", module_info.name
+                )
+                failures.add(format_model_checker_exception(e))
+
+    return failures
+
+
+def run_test_snippet(source: str) -> None:
+    """Exec a snippet of source code in an isolated environment."""
+    # To emulate `source` being called at the top level of the module,
+    # the globals and locals we provide apparently have to be the same mapping.
+    #
+    # > Remember that at the module level, globals and locals are the same dictionary.
+    # > If exec gets two separate objects as globals and locals, the code will be
+    # > executed as if it were embedded in a class definition.
+    globals_: dict[str, object]
+    locals_: dict[str, object]
+    globals_ = locals_ = {}
+    exec(textwrap.dedent(source), globals_, locals_)
+
+
+class TestConstrainedTypesPatch(unittest.TestCase):
+    def test_expression_without_strict_raises(self) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                """
+                try:
+                    from pydantic.v1 import constr
+                except ImportError:
+                    from pydantic import constr
+                constr()
+                """
+            )
+
+    def test_called_as_module_attribute_raises(self) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                """
+                import pydantic
+                pydantic.constr()
+                """
+            )
+
+    def test_wildcard_import_raises(self) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                """
+                try:
+                    from pydantic.v1 import *
+                except ImportError:
+                    from pydantic import *
+                constr()
+                """
+            )
+
+    def test_alternative_import_raises(self) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                """
+                try:
+                    from pydantic.v1.types import constr
+                except ImportError:
+                    from pydantic.types import constr
+                constr()
+                """
+            )
+
+    def test_alternative_import_attribute_raises(self) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                """
+                try:
+                    from pydantic.v1 import types as pydantic_types
+                except ImportError:
+                    from pydantic import types as pydantic_types
+                pydantic_types.constr()
+                """
+            )
+
+    def test_kwarg_but_no_strict_raises(self) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                """
+                try:
+                    from pydantic.v1 import constr
+                except ImportError:
+                    from pydantic import constr
+                constr(min_length=10)
+                """
+            )
+
+    def test_kwarg_strict_False_raises(self) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                """
+                try:
+                    from pydantic.v1 import constr
+                except ImportError:
+                    from pydantic import constr
+                constr(strict=False)
+                """
+            )
+
+    def test_kwarg_strict_True_doesnt_raise(self) -> None:
+        with monkeypatch_pydantic():
+            run_test_snippet(
+                """
+                try:
+                    from pydantic.v1 import constr
+                except ImportError:
+                    from pydantic import constr
+                constr(strict=True)
+                """
+            )
+
+    def test_annotation_without_strict_raises(self) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                """
+                try:
+                    from pydantic.v1 import constr
+                except ImportError:
+                    from pydantic import constr
+                x: constr()
+                """
+            )
+
+    def test_field_annotation_without_strict_raises(self) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                """
+                try:
+                    from pydantic.v1 import BaseModel, conint
+                except ImportError:
+                    from pydantic import BaseModel, conint
+                class C:
+                    x: conint()
+                """
+            )
+
+
+class TestFieldTypeInspection(unittest.TestCase):
+    @parameterized.expand(
+        [
+            ("str",),
+            ("bytes"),
+            ("int",),
+            ("float",),
+            ("bool"),
+            ("Optional[str]",),
+            ("Union[None, str]",),
+            ("list[str]",),
+            ("list[list[str]]",),
+            ("dict[StrictStr, str]",),
+            ("dict[str, StrictStr]",),
+            ("TypedDict('D', x=int)",),
+        ]
+    )
+    def test_field_holding_unwanted_type_raises(self, annotation: str) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                f"""
+                from typing import *
+                try:
+                    from pydantic.v1 import *
+                except ImportError:
+                    from pydantic import *
+                class C(BaseModel):
+                    f: {annotation}
+                """
+            )
+
+    @parameterized.expand(
+        [
+            ("StrictStr",),
+            ("StrictBytes"),
+            ("StrictInt",),
+            ("StrictFloat",),
+            ("StrictBool"),
+            ("constr(strict=True, min_length=10)",),
+            ("Optional[StrictStr]",),
+            ("Union[None, StrictStr]",),
+            ("list[StrictStr]",),
+            ("list[list[StrictStr]]",),
+            ("dict[StrictStr, StrictStr]",),
+            ("TypedDict('D', x=StrictInt)",),
+        ]
+    )
+    def test_field_holding_accepted_type_doesnt_raise(self, annotation: str) -> None:
+        with monkeypatch_pydantic():
+            run_test_snippet(
+                f"""
+                from typing import *
+                try:
+                    from pydantic.v1 import *
+                except ImportError:
+                    from pydantic import *
+                class C(BaseModel):
+                    f: {annotation}
+                """
+            )
+
+    def test_field_holding_str_raises_with_alternative_import(self) -> None:
+        with monkeypatch_pydantic(), self.assertRaises(ModelCheckerException):
+            run_test_snippet(
+                """
+                try:
+                    from pydantic.v1.main import BaseModel
+                except ImportError:
+                    from pydantic.main import BaseModel
+                class C(BaseModel):
+                    f: str
+                """
+            )
+
+
+parser = argparse.ArgumentParser()
+parser.add_argument("mode", choices=["lint", "test"], default="lint", nargs="?")
+parser.add_argument("-v", "--verbose", action="store_true")
+
+
+if __name__ == "__main__":
+    args = parser.parse_args(sys.argv[1:])
+    logging.basicConfig(
+        format="%(asctime)s %(name)s:%(lineno)d %(levelname)s %(message)s",
+        level=logging.DEBUG if args.verbose else logging.INFO,
+    )
+    # suppress logs we don't care about
+    logging.getLogger("xmlschema").setLevel(logging.WARNING)
+    if args.mode == "lint":
+        sys.exit(lint())
+    elif args.mode == "test":
+        unittest.main(argv=sys.argv[:1])

scripts-dev/check_schema_delta.py

@@ -11,13 +11,9 @@ import click
 import git
 
 SCHEMA_FILE_REGEX = re.compile(r"^synapse/storage/schema/(.*)/delta/(.*)/(.*)$")
-INDEX_CREATION_REGEX = re.compile(
-    r"CREATE .*INDEX .*ON ([a-z_0-9]+)", flags=re.IGNORECASE
-)
-INDEX_DELETION_REGEX = re.compile(r"DROP .*INDEX ([a-z_0-9]+)", flags=re.IGNORECASE)
-TABLE_CREATION_REGEX = re.compile(
-    r"CREATE .*TABLE.* ([a-z_0-9]+)\s*\(", flags=re.IGNORECASE
-)
+INDEX_CREATION_REGEX = re.compile(r"CREATE .*INDEX .*ON ([a-z_]+)", flags=re.IGNORECASE)
+INDEX_DELETION_REGEX = re.compile(r"DROP .*INDEX ([a-z_]+)", flags=re.IGNORECASE)
+TABLE_CREATION_REGEX = re.compile(r"CREATE .*TABLE ([a-z_]+)", flags=re.IGNORECASE)
 
 # The base branch we want to check against. We use the main development branch
 # on the assumption that is what we are developing against.
@@ -177,14 +173,11 @@ def main(force_colors: bool) -> None:
                 clause = match.group()
 
                 click.secho(
-                    f"Found delta with index deletion: '{clause}' in {delta_file}",
+                    f"Found delta with index deletion: '{clause}' in {delta_file}\nThese should be in background updates.",
                     fg="red",
                     bold=True,
                     color=force_colors,
                 )
-                click.secho(
-                    " ↪ These should be in background updates.",
-                )
                 return_code = 1
 
             # Check for index creation, which is only allowed for tables we've
@@ -195,14 +188,11 @@ def main(force_colors: bool) -> None:
                 table_name = match.group(1)
                 if table_name not in created_tables:
                     click.secho(
-                        f"Found delta with index creation for existing table: '{clause}' in {delta_file}",
+                        f"Found delta with index creation: '{clause}' in {delta_file}\nThese should be in background updates.",
                         fg="red",
                         bold=True,
                         color=force_colors,
                     )
-                    click.secho(
-                        " ↪ These should be in background updates (or the table should be created in the same delta).",
-                    )
                     return_code = 1
 
     click.get_current_context().exit(return_code)

scripts-dev/federation_client.py

@@ -43,7 +43,7 @@ import argparse
 import base64
 import json
 import sys
-from typing import Any, Mapping
+from typing import Any, Mapping, Optional, Union
 from urllib import parse as urlparse
 
 import requests
@@ -103,12 +103,12 @@ def sign_json(
 
 
 def request(
-    method: str | None,
+    method: Optional[str],
     origin_name: str,
     origin_key: signedjson.types.SigningKey,
     destination: str,
     path: str,
-    content: str | None,
+    content: Optional[str],
     verify_tls: bool,
 ) -> requests.Response:
     if method is None:
@@ -301,9 +301,9 @@ class MatrixConnectionAdapter(HTTPAdapter):
     def get_connection_with_tls_context(
         self,
         request: PreparedRequest,
-        verify: bool | str | None,
-        proxies: Mapping[str, str] | None = None,
-        cert: tuple[str, str] | str | None = None,
+        verify: Optional[Union[bool, str]],
+        proxies: Optional[Mapping[str, str]] = None,
+        cert: Optional[Union[tuple[str, str], str]] = None,
     ) -> HTTPConnectionPool:
         # overrides the get_connection_with_tls_context() method in the base class
         parsed = urlparse.urlsplit(request.url)
@@ -368,7 +368,7 @@ class MatrixConnectionAdapter(HTTPAdapter):
             return server_name, 8448, server_name
 
     @staticmethod
-    def _get_well_known(server_name: str) -> str | None:
+    def _get_well_known(server_name: str) -> Optional[str]:
         if ":" in server_name:
             # explicit port, or ipv6 literal. Either way, no .well-known
             return None

scripts-dev/gen_config_documentation.py

@@ -4,7 +4,7 @@
 import json
 import re
 import sys
-from typing import Any
+from typing import Any, Optional
 
 import yaml
 
@@ -259,17 +259,17 @@ def indent(text: str, first_line: bool = True) -> str:
     return text
 
 
-def em(s: str | None) -> str:
+def em(s: Optional[str]) -> str:
     """Add emphasis to text."""
     return f"*{s}*" if s else ""
 
 
-def a(s: str | None, suffix: str = " ") -> str:
+def a(s: Optional[str], suffix: str = " ") -> str:
     """Appends a space if the given string is not empty."""
     return s + suffix if s else ""
 
 
-def p(s: str | None, prefix: str = " ") -> str:
+def p(s: Optional[str], prefix: str = " ") -> str:
     """Prepend a space if the given string is not empty."""
     return prefix + s if s else ""
 

scripts-dev/lint.sh

@@ -134,6 +134,9 @@ fi
 # Ensure the formatting of Rust code.
 cargo-fmt
 
+# Ensure all Pydantic models use strict types.
+./scripts-dev/check_pydantic_models.py lint
+
 # Ensure type hints are correct.
 mypy
 

scripts-dev/mypy_synapse_plugin.py

@@ -24,7 +24,7 @@ can crop up, e.g the cache descriptors.
 """
 
 import enum
-from typing import Callable, Mapping
+from typing import Callable, Mapping, Optional, Union
 
 import attr
 import mypy.types
@@ -123,7 +123,7 @@ class ArgLocation:
     """
 
 
-prometheus_metric_fullname_to_label_arg_map: Mapping[str, ArgLocation | None] = {
+prometheus_metric_fullname_to_label_arg_map: Mapping[str, Optional[ArgLocation]] = {
     # `Collector` subclasses:
     "prometheus_client.metrics.MetricWrapperBase": ArgLocation("labelnames", 2),
     "prometheus_client.metrics.Counter": ArgLocation("labelnames", 2),
@@ -211,7 +211,7 @@ class SynapsePlugin(Plugin):
 
     def get_base_class_hook(
         self, fullname: str
-    ) -> Callable[[ClassDefContext], None] | None:
+    ) -> Optional[Callable[[ClassDefContext], None]]:
         def _get_base_class_hook(ctx: ClassDefContext) -> None:
             # Run any `get_base_class_hook` checks from other plugins first.
             #
@@ -232,7 +232,7 @@ class SynapsePlugin(Plugin):
 
     def get_function_signature_hook(
         self, fullname: str
-    ) -> Callable[[FunctionSigContext], FunctionLike] | None:
+    ) -> Optional[Callable[[FunctionSigContext], FunctionLike]]:
         # Strip off the unique identifier for classes that are dynamically created inside
         # functions. ex. `synapse.metrics.jemalloc.JemallocCollector@185` (this is the line
         # number)
@@ -262,7 +262,7 @@ class SynapsePlugin(Plugin):
 
     def get_method_signature_hook(
         self, fullname: str
-    ) -> Callable[[MethodSigContext], CallableType] | None:
+    ) -> Optional[Callable[[MethodSigContext], CallableType]]:
         if fullname.startswith(
             (
                 "synapse.util.caches.descriptors.CachedFunction.__call__",
@@ -721,7 +721,7 @@ def check_is_cacheable_wrapper(ctx: MethodSigContext) -> CallableType:
 
 def check_is_cacheable(
     signature: CallableType,
-    ctx: MethodSigContext | FunctionSigContext,
+    ctx: Union[MethodSigContext, FunctionSigContext],
 ) -> None:
     """
     Check if a callable returns a type which can be cached.
@@ -795,7 +795,7 @@ AT_CACHED_MUTABLE_RETURN = ErrorCode(
 
 def is_cacheable(
     rt: mypy.types.Type, signature: CallableType, verbose: bool
-) -> tuple[bool, str | None]:
+) -> tuple[bool, Optional[str]]:
     """
     Check if a particular type is cachable.
 

scripts-dev/release.py

@@ -32,7 +32,7 @@ import time
 import urllib.request
 from os import path
 from tempfile import TemporaryDirectory
-from typing import Any, Match
+from typing import Any, Match, Optional, Union
 
 import attr
 import click
@@ -327,11 +327,11 @@ def _prepare() -> None:
 
 @cli.command()
 @click.option("--gh-token", envvar=["GH_TOKEN", "GITHUB_TOKEN"])
-def tag(gh_token: str | None) -> None:
+def tag(gh_token: Optional[str]) -> None:
     _tag(gh_token)
 
 
-def _tag(gh_token: str | None) -> None:
+def _tag(gh_token: Optional[str]) -> None:
     """Tags the release and generates a draft GitHub release"""
 
     # Test that the GH Token is valid before continuing.
@@ -471,11 +471,11 @@ def _publish(gh_token: str) -> None:
 
 @cli.command()
 @click.option("--gh-token", envvar=["GH_TOKEN", "GITHUB_TOKEN"], required=False)
-def upload(gh_token: str | None) -> None:
+def upload(gh_token: Optional[str]) -> None:
     _upload(gh_token)
 
 
-def _upload(gh_token: str | None) -> None:
+def _upload(gh_token: Optional[str]) -> None:
     """Upload release to pypi."""
 
     # Test that the GH Token is valid before continuing.
@@ -576,11 +576,11 @@ def _merge_into(repo: Repo, source: str, target: str) -> None:
 
 @cli.command()
 @click.option("--gh-token", envvar=["GH_TOKEN", "GITHUB_TOKEN"], required=False)
-def wait_for_actions(gh_token: str | None) -> None:
+def wait_for_actions(gh_token: Optional[str]) -> None:
     _wait_for_actions(gh_token)
 
 
-def _wait_for_actions(gh_token: str | None) -> None:
+def _wait_for_actions(gh_token: Optional[str]) -> None:
     # Test that the GH Token is valid before continuing.
     check_valid_gh_token(gh_token)
 
@@ -658,7 +658,7 @@ def _notify(message: str) -> None:
     envvar=["GH_TOKEN", "GITHUB_TOKEN"],
     required=False,
 )
-def merge_back(_gh_token: str | None) -> None:
+def merge_back(_gh_token: Optional[str]) -> None:
     _merge_back()
 
 
@@ -715,7 +715,7 @@ def _merge_back() -> None:
     envvar=["GH_TOKEN", "GITHUB_TOKEN"],
     required=False,
 )
-def announce(_gh_token: str | None) -> None:
+def announce(_gh_token: Optional[str]) -> None:
     _announce()
 
 
@@ -851,7 +851,7 @@ def get_repo_and_check_clean_checkout(
     return repo
 
 
-def check_valid_gh_token(gh_token: str | None) -> None:
+def check_valid_gh_token(gh_token: Optional[str]) -> None:
     """Check that a github token is valid, if supplied"""
 
     if not gh_token:
@@ -867,7 +867,7 @@ def check_valid_gh_token(gh_token: str | None) -> None:
         raise click.ClickException(f"Github credentials are bad: {e}")
 
 
-def find_ref(repo: git.Repo, ref_name: str) -> git.HEAD | None:
+def find_ref(repo: git.Repo, ref_name: str) -> Optional[git.HEAD]:
     """Find the branch/ref, looking first locally then in the remote."""
     if ref_name in repo.references:
         return repo.references[ref_name]
@@ -904,7 +904,7 @@ def get_changes_for_version(wanted_version: version.Version) -> str:
 
         # These are 0-based.
         start_line: int
-        end_line: int | None = None  # Is none if its the last entry
+        end_line: Optional[int] = None  # Is none if its the last entry
 
     headings: list[VersionSection] = []
     for i, token in enumerate(tokens):
@@ -991,7 +991,7 @@ def build_dependabot_changelog(repo: Repo, current_version: version.Version) ->
     messages = []
     for commit in reversed(commits):
         if commit.author.name == "dependabot[bot]":
-            message: str | bytes = commit.message
+            message: Union[str, bytes] = commit.message
             if isinstance(message, bytes):
                 message = message.decode("utf-8")
             messages.append(message.split("\n", maxsplit=1)[0])

scripts-dev/schema_versions.py

@@ -38,7 +38,7 @@ import io
 import json
 import sys
 from collections import defaultdict
-from typing import Any, Iterator
+from typing import Any, Iterator, Optional
 
 import git
 from packaging import version
@@ -57,7 +57,7 @@ SCHEMA_VERSION_FILES = (
 OLDEST_SHOWN_VERSION = version.parse("v1.0")
 
 
-def get_schema_versions(tag: git.Tag) -> tuple[int | None, int | None]:
+def get_schema_versions(tag: git.Tag) -> tuple[Optional[int], Optional[int]]:
     """Get the schema and schema compat versions for a tag."""
     schema_version = None
     schema_compat_version = None

stubs/sortedcontainers/sorteddict.pyi

@@ -13,8 +13,10 @@ from typing import (
     Iterator,
     KeysView,
     Mapping,
+    Optional,
     Sequence,
     TypeVar,
+    Union,
     ValuesView,
     overload,
 )
@@ -49,7 +51,7 @@ class SortedDict(dict[_KT, _VT]):
         self, __key: _Key[_KT], __iterable: Iterable[tuple[_KT, _VT]], **kwargs: _VT
     ) -> None: ...
     @property
-    def key(self) -> _Key[_KT] | None: ...
+    def key(self) -> Optional[_Key[_KT]]: ...
     @property
     def iloc(self) -> SortedKeysView[_KT]: ...
     def clear(self) -> None: ...
@@ -77,10 +79,10 @@ class SortedDict(dict[_KT, _VT]):
     @overload
     def pop(self, key: _KT) -> _VT: ...
     @overload
-    def pop(self, key: _KT, default: _T = ...) -> _VT | _T: ...
+    def pop(self, key: _KT, default: _T = ...) -> Union[_VT, _T]: ...
     def popitem(self, index: int = ...) -> tuple[_KT, _VT]: ...
     def peekitem(self, index: int = ...) -> tuple[_KT, _VT]: ...
-    def setdefault(self, key: _KT, default: _VT | None = ...) -> _VT: ...
+    def setdefault(self, key: _KT, default: Optional[_VT] = ...) -> _VT: ...
     # Mypy now reports the first overload as an error, because typeshed widened the type
     # of `__map` to its internal `_typeshed.SupportsKeysAndGetItem` type in
     #   https://github.com/python/typeshed/pull/6653
@@ -104,8 +106,8 @@ class SortedDict(dict[_KT, _VT]):
     def _check(self) -> None: ...
     def islice(
         self,
-        start: int | None = ...,
-        stop: int | None = ...,
+        start: Optional[int] = ...,
+        stop: Optional[int] = ...,
         reverse: bool = ...,
     ) -> Iterator[_KT]: ...
     def bisect_left(self, value: _KT) -> int: ...
@@ -116,7 +118,7 @@ class SortedKeysView(KeysView[_KT_co], Sequence[_KT_co]):
     def __getitem__(self, index: int) -> _KT_co: ...
     @overload
     def __getitem__(self, index: slice) -> list[_KT_co]: ...
-    def __delitem__(self, index: int | slice) -> None: ...
+    def __delitem__(self, index: Union[int, slice]) -> None: ...
 
 class SortedItemsView(ItemsView[_KT_co, _VT_co], Sequence[tuple[_KT_co, _VT_co]]):
     def __iter__(self) -> Iterator[tuple[_KT_co, _VT_co]]: ...
@@ -124,11 +126,11 @@ class SortedItemsView(ItemsView[_KT_co, _VT_co], Sequence[tuple[_KT_co, _VT_co]]
     def __getitem__(self, index: int) -> tuple[_KT_co, _VT_co]: ...
     @overload
     def __getitem__(self, index: slice) -> list[tuple[_KT_co, _VT_co]]: ...
-    def __delitem__(self, index: int | slice) -> None: ...
+    def __delitem__(self, index: Union[int, slice]) -> None: ...
 
 class SortedValuesView(ValuesView[_VT_co], Sequence[_VT_co]):
     @overload
     def __getitem__(self, index: int) -> _VT_co: ...
     @overload
     def __getitem__(self, index: slice) -> list[_VT_co]: ...
-    def __delitem__(self, index: int | slice) -> None: ...
+    def __delitem__(self, index: Union[int, slice]) -> None: ...

stubs/sortedcontainers/sortedlist.pyi

@@ -10,8 +10,10 @@ from typing import (
     Iterable,
     Iterator,
     MutableSequence,
+    Optional,
     Sequence,
     TypeVar,
+    Union,
     overload,
 )
 
@@ -27,8 +29,8 @@ class SortedList(MutableSequence[_T]):
     DEFAULT_LOAD_FACTOR: int = ...
     def __init__(
         self,
-        iterable: Iterable[_T] | None = ...,
-        key: _Key[_T] | None = ...,
+        iterable: Optional[Iterable[_T]] = ...,
+        key: Optional[_Key[_T]] = ...,
     ): ...
     # NB: currently mypy does not honour return type, see mypy #3307
     @overload
@@ -40,7 +42,7 @@ class SortedList(MutableSequence[_T]):
     @overload
     def __new__(cls, iterable: Iterable[_T], key: _Key[_T]) -> SortedKeyList[_T]: ...
     @property
-    def key(self) -> Callable[[_T], Any] | None: ...
+    def key(self) -> Optional[Callable[[_T], Any]]: ...
     def _reset(self, load: int) -> None: ...
     def clear(self) -> None: ...
     def _clear(self) -> None: ...
@@ -55,7 +57,7 @@ class SortedList(MutableSequence[_T]):
     def _pos(self, idx: int) -> int: ...
     def _build_index(self) -> None: ...
     def __contains__(self, value: Any) -> bool: ...
-    def __delitem__(self, index: int | slice) -> None: ...
+    def __delitem__(self, index: Union[int, slice]) -> None: ...
     @overload
     def __getitem__(self, index: int) -> _T: ...
     @overload
@@ -74,8 +76,8 @@ class SortedList(MutableSequence[_T]):
     def reverse(self) -> None: ...
     def islice(
         self,
-        start: int | None = ...,
-        stop: int | None = ...,
+        start: Optional[int] = ...,
+        stop: Optional[int] = ...,
         reverse: bool = ...,
     ) -> Iterator[_T]: ...
     def _islice(
@@ -88,8 +90,8 @@ class SortedList(MutableSequence[_T]):
     ) -> Iterator[_T]: ...
     def irange(
         self,
-        minimum: int | None = ...,
-        maximum: int | None = ...,
+        minimum: Optional[int] = ...,
+        maximum: Optional[int] = ...,
         inclusive: tuple[bool, bool] = ...,
         reverse: bool = ...,
     ) -> Iterator[_T]: ...
@@ -105,7 +107,7 @@ class SortedList(MutableSequence[_T]):
     def insert(self, index: int, value: _T) -> None: ...
     def pop(self, index: int = ...) -> _T: ...
     def index(
-        self, value: _T, start: int | None = ..., stop: int | None = ...
+        self, value: _T, start: Optional[int] = ..., stop: Optional[int] = ...
     ) -> int: ...
     def __add__(self: _SL, other: Iterable[_T]) -> _SL: ...
     def __radd__(self: _SL, other: Iterable[_T]) -> _SL: ...
@@ -124,10 +126,10 @@ class SortedList(MutableSequence[_T]):
 
 class SortedKeyList(SortedList[_T]):
     def __init__(
-        self, iterable: Iterable[_T] | None = ..., key: _Key[_T] = ...
+        self, iterable: Optional[Iterable[_T]] = ..., key: _Key[_T] = ...
     ) -> None: ...
     def __new__(
-        cls, iterable: Iterable[_T] | None = ..., key: _Key[_T] = ...
+        cls, iterable: Optional[Iterable[_T]] = ..., key: _Key[_T] = ...
     ) -> SortedKeyList[_T]: ...
     @property
     def key(self) -> Callable[[_T], Any]: ...
@@ -144,15 +146,15 @@ class SortedKeyList(SortedList[_T]):
     def _delete(self, pos: int, idx: int) -> None: ...
     def irange(
         self,
-        minimum: int | None = ...,
-        maximum: int | None = ...,
+        minimum: Optional[int] = ...,
+        maximum: Optional[int] = ...,
         inclusive: tuple[bool, bool] = ...,
         reverse: bool = ...,
     ) -> Iterator[_T]: ...
     def irange_key(
         self,
-        min_key: Any | None = ...,
-        max_key: Any | None = ...,
+        min_key: Optional[Any] = ...,
+        max_key: Optional[Any] = ...,
         inclusive: tuple[bool, bool] = ...,
         reserve: bool = ...,
     ) -> Iterator[_T]: ...
@@ -168,7 +170,7 @@ class SortedKeyList(SortedList[_T]):
     def copy(self: _SKL) -> _SKL: ...
     def __copy__(self: _SKL) -> _SKL: ...
     def index(
-        self, value: _T, start: int | None = ..., stop: int | None = ...
+        self, value: _T, start: Optional[int] = ..., stop: Optional[int] = ...
     ) -> int: ...
     def __add__(self: _SKL, other: Iterable[_T]) -> _SKL: ...
     def __radd__(self: _SKL, other: Iterable[_T]) -> _SKL: ...

stubs/sortedcontainers/sortedset.pyi

@@ -11,8 +11,10 @@ from typing import (
     Iterable,
     Iterator,
     MutableSet,
+    Optional,
     Sequence,
     TypeVar,
+    Union,
     overload,
 )
 
@@ -26,19 +28,21 @@ _Key = Callable[[_T], Any]
 class SortedSet(MutableSet[_T], Sequence[_T]):
     def __init__(
         self,
-        iterable: Iterable[_T] | None = ...,
-        key: _Key[_T] | None = ...,
+        iterable: Optional[Iterable[_T]] = ...,
+        key: Optional[_Key[_T]] = ...,
     ) -> None: ...
     @classmethod
-    def _fromset(cls, values: set[_T], key: _Key[_T] | None = ...) -> SortedSet[_T]: ...
+    def _fromset(
+        cls, values: set[_T], key: Optional[_Key[_T]] = ...
+    ) -> SortedSet[_T]: ...
     @property
-    def key(self) -> _Key[_T] | None: ...
+    def key(self) -> Optional[_Key[_T]]: ...
     def __contains__(self, value: Any) -> bool: ...
     @overload
     def __getitem__(self, index: int) -> _T: ...
     @overload
     def __getitem__(self, index: slice) -> list[_T]: ...
-    def __delitem__(self, index: int | slice) -> None: ...
+    def __delitem__(self, index: Union[int, slice]) -> None: ...
     def __eq__(self, other: Any) -> bool: ...
     def __ne__(self, other: Any) -> bool: ...
     def __lt__(self, other: Iterable[_T]) -> bool: ...
@@ -58,28 +62,32 @@ class SortedSet(MutableSet[_T], Sequence[_T]):
     def _discard(self, value: _T) -> None: ...
     def pop(self, index: int = ...) -> _T: ...
     def remove(self, value: _T) -> None: ...
-    def difference(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def __sub__(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def difference_update(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def __isub__(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def intersection(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def __and__(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def __rand__(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def intersection_update(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def __iand__(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def symmetric_difference(self, other: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def __xor__(self, other: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def __rxor__(self, other: Iterable[_S]) -> SortedSet[_T | _S]: ...
+    def difference(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def __sub__(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def difference_update(
+        self, *iterables: Iterable[_S]
+    ) -> SortedSet[Union[_T, _S]]: ...
+    def __isub__(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def intersection(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def __and__(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def __rand__(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def intersection_update(
+        self, *iterables: Iterable[_S]
+    ) -> SortedSet[Union[_T, _S]]: ...
+    def __iand__(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def symmetric_difference(self, other: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def __xor__(self, other: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def __rxor__(self, other: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
     def symmetric_difference_update(
         self, other: Iterable[_S]
-    ) -> SortedSet[_T | _S]: ...
-    def __ixor__(self, other: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def union(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def __or__(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def __ror__(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def update(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def __ior__(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
-    def _update(self, *iterables: Iterable[_S]) -> SortedSet[_T | _S]: ...
+    ) -> SortedSet[Union[_T, _S]]: ...
+    def __ixor__(self, other: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def union(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def __or__(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def __ror__(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def update(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def __ior__(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
+    def _update(self, *iterables: Iterable[_S]) -> SortedSet[Union[_T, _S]]: ...
     def __reduce__(
         self,
     ) -> tuple[type[SortedSet[_T]], set[_T], Callable[[_T], Any]]: ...
@@ -89,18 +97,18 @@ class SortedSet(MutableSet[_T], Sequence[_T]):
     def bisect_right(self, value: _T) -> int: ...
     def islice(
         self,
-        start: int | None = ...,
-        stop: int | None = ...,
+        start: Optional[int] = ...,
+        stop: Optional[int] = ...,
         reverse: bool = ...,
     ) -> Iterator[_T]: ...
     def irange(
         self,
-        minimum: _T | None = ...,
-        maximum: _T | None = ...,
+        minimum: Optional[_T] = ...,
+        maximum: Optional[_T] = ...,
         inclusive: tuple[bool, bool] = ...,
         reverse: bool = ...,
     ) -> Iterator[_T]: ...
     def index(
-        self, value: _T, start: int | None = ..., stop: int | None = ...
+        self, value: _T, start: Optional[int] = ..., stop: Optional[int] = ...
     ) -> int: ...
     def _reset(self, load: int) -> None: ...

stubs/txredisapi.pyi

@@ -15,7 +15,7 @@
 
 """Contains *incomplete* type hints for txredisapi."""
 
-from typing import Any
+from typing import Any, Optional, Union
 
 from twisted.internet import protocol
 from twisted.internet.defer import Deferred
@@ -29,8 +29,8 @@ class RedisProtocol(protocol.Protocol):
         self,
         key: str,
         value: Any,
-        expire: int | None = None,
-        pexpire: int | None = None,
+        expire: Optional[int] = None,
+        pexpire: Optional[int] = None,
         only_if_not_exists: bool = False,
         only_if_exists: bool = False,
     ) -> "Deferred[None]": ...
@@ -38,8 +38,8 @@ class RedisProtocol(protocol.Protocol):
 
 class SubscriberProtocol(RedisProtocol):
     def __init__(self, *args: object, **kwargs: object): ...
-    password: str | None
-    def subscribe(self, channels: str | list[str]) -> "Deferred[None]": ...
+    password: Optional[str]
+    def subscribe(self, channels: Union[str, list[str]]) -> "Deferred[None]": ...
     def connectionMade(self) -> None: ...
     # type-ignore: twisted.internet.protocol.Protocol provides a default argument for
     # `reason`. txredisapi's LineReceiver Protocol doesn't. But that's fine: it's what's
@@ -49,12 +49,12 @@ class SubscriberProtocol(RedisProtocol):
 def lazyConnection(
     host: str = ...,
     port: int = ...,
-    dbid: int | None = ...,
+    dbid: Optional[int] = ...,
     reconnect: bool = ...,
     charset: str = ...,
-    password: str | None = ...,
-    connectTimeout: int | None = ...,
-    replyTimeout: int | None = ...,
+    password: Optional[str] = ...,
+    connectTimeout: Optional[int] = ...,
+    replyTimeout: Optional[int] = ...,
     convertNumbers: bool = ...,
 ) -> RedisProtocol: ...
 
@@ -70,18 +70,18 @@ class RedisFactory(protocol.ReconnectingClientFactory):
     continueTrying: bool
     handler: ConnectionHandler
     pool: list[RedisProtocol]
-    replyTimeout: int | None
+    replyTimeout: Optional[int]
     def __init__(
         self,
         uuid: str,
-        dbid: int | None,
+        dbid: Optional[int],
         poolsize: int,
         isLazy: bool = False,
         handler: type = ConnectionHandler,
         charset: str = "utf-8",
-        password: str | None = None,
-        replyTimeout: int | None = None,
-        convertNumbers: int | None = True,
+        password: Optional[str] = None,
+        replyTimeout: Optional[int] = None,
+        convertNumbers: Optional[int] = True,
     ): ...
     def buildProtocol(self, addr: IAddress) -> RedisProtocol: ...
 

synapse/_pydantic_compat.py

@@ -0,0 +1,104 @@
+#
+# This file is licensed under the Affero General Public License (AGPL) version 3.
+#
+# Copyright 2023 Maxwell G <maxwell@gtmx.me>
+# Copyright (C) 2023 New Vector, Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# See the GNU Affero General Public License for more details:
+# <https://www.gnu.org/licenses/agpl-3.0.html>.
+#
+# Originally licensed under the Apache License, Version 2.0:
+# <http://www.apache.org/licenses/LICENSE-2.0>.
+#
+# [This file includes modifications made by New Vector Limited]
+#
+#
+
+from typing import TYPE_CHECKING
+
+from packaging.version import Version
+
+try:
+    from pydantic import __version__ as pydantic_version
+except ImportError:
+    import importlib.metadata
+
+    pydantic_version = importlib.metadata.version("pydantic")
+
+HAS_PYDANTIC_V2: bool = Version(pydantic_version).major == 2
+
+if TYPE_CHECKING or HAS_PYDANTIC_V2:
+    from pydantic.v1 import (
+        AnyHttpUrl,
+        BaseModel,
+        Extra,
+        Field,
+        FilePath,
+        MissingError,
+        PydanticValueError,
+        StrictBool,
+        StrictInt,
+        StrictStr,
+        ValidationError,
+        conbytes,
+        confloat,
+        conint,
+        constr,
+        parse_obj_as,
+        root_validator,
+        validator,
+    )
+    from pydantic.v1.error_wrappers import ErrorWrapper
+    from pydantic.v1.typing import get_args
+else:
+    from pydantic import (
+        AnyHttpUrl,
+        BaseModel,
+        Extra,
+        Field,
+        FilePath,
+        MissingError,
+        PydanticValueError,
+        StrictBool,
+        StrictInt,
+        StrictStr,
+        ValidationError,
+        conbytes,
+        confloat,
+        conint,
+        constr,
+        parse_obj_as,
+        root_validator,
+        validator,
+    )
+    from pydantic.error_wrappers import ErrorWrapper
+    from pydantic.typing import get_args
+
+__all__ = (
+    "HAS_PYDANTIC_V2",
+    "AnyHttpUrl",
+    "BaseModel",
+    "constr",
+    "conbytes",
+    "conint",
+    "confloat",
+    "ErrorWrapper",
+    "Extra",
+    "Field",
+    "FilePath",
+    "get_args",
+    "MissingError",
+    "parse_obj_as",
+    "PydanticValueError",
+    "StrictBool",
+    "StrictInt",
+    "StrictStr",
+    "ValidationError",
+    "validator",
+    "root_validator",
+)

synapse/_scripts/export_signing_key.py

@@ -22,13 +22,13 @@
 import argparse
 import sys
 import time
-from typing import NoReturn
+from typing import NoReturn, Optional
 
 from signedjson.key import encode_verify_key_base64, get_verify_key, read_signing_keys
 from signedjson.types import VerifyKey
 
 
-def exit(status: int = 0, message: str | None = None) -> NoReturn:
+def exit(status: int = 0, message: Optional[str] = None) -> NoReturn:
     if message:
         print(message, file=sys.stderr)
     sys.exit(status)

synapse/_scripts/generate_workers_map.py

@@ -25,7 +25,7 @@ import logging
 import re
 from collections import defaultdict
 from dataclasses import dataclass
-from typing import Iterable, Pattern
+from typing import Iterable, Optional, Pattern
 
 import yaml
 
@@ -46,7 +46,7 @@ logger = logging.getLogger("generate_workers_map")
 class MockHomeserver(HomeServer):
     DATASTORE_CLASS = DataStore
 
-    def __init__(self, config: HomeServerConfig, worker_app: str | None) -> None:
+    def __init__(self, config: HomeServerConfig, worker_app: Optional[str]) -> None:
         super().__init__(config.server.server_name, config=config)
         self.config.worker.worker_app = worker_app
 
@@ -65,7 +65,7 @@ class EndpointDescription:
 
     # The category of this endpoint. Is read from the `CATEGORY` constant in the servlet
     # class.
-    category: str | None
+    category: Optional[str]
 
     # TODO:
     #  - does it need to be routed based on a stream writer config?
@@ -141,7 +141,7 @@ def get_registered_paths_for_hs(
 
 
 def get_registered_paths_for_default(
-    worker_app: str | None, base_config: HomeServerConfig
+    worker_app: Optional[str], base_config: HomeServerConfig
 ) -> dict[tuple[str, str], EndpointDescription]:
     """
     Given the name of a worker application and a base homeserver configuration,
@@ -271,7 +271,7 @@ def main() -> None:
     # TODO SSO endpoints (pick_idp etc) NOT REGISTERED BY THIS SCRIPT
 
     categories_to_methods_and_paths: dict[
-        str | None, dict[tuple[str, str], EndpointDescription]
+        Optional[str], dict[tuple[str, str], EndpointDescription]
     ] = defaultdict(dict)
 
     for (method, path), desc in elided_worker_paths.items():
@@ -282,7 +282,7 @@ def main() -> None:
 
 
 def print_category(
-    category_name: str | None,
+    category_name: Optional[str],
     elided_worker_paths: dict[tuple[str, str], EndpointDescription],
 ) -> None:
     """

synapse/_scripts/register_new_matrix_user.py

@@ -26,7 +26,7 @@ import hashlib
 import hmac
 import logging
 import sys
-from typing import Any, Callable, Iterable, TextIO
+from typing import Any, Callable, Optional
 
 import requests
 import yaml
@@ -54,7 +54,7 @@ def request_registration(
     server_location: str,
     shared_secret: str,
     admin: bool = False,
-    user_type: str | None = None,
+    user_type: Optional[str] = None,
     _print: Callable[[str], None] = print,
     exit: Callable[[int], None] = sys.exit,
     exists_ok: bool = False,
@@ -123,13 +123,13 @@ def register_new_user(
     password: str,
     server_location: str,
     shared_secret: str,
-    admin: bool | None,
-    user_type: str | None,
+    admin: Optional[bool],
+    user_type: Optional[str],
     exists_ok: bool = False,
 ) -> None:
     if not user:
         try:
-            default_user: str | None = getpass.getuser()
+            default_user: Optional[str] = getpass.getuser()
         except Exception:
             default_user = None
 
@@ -244,7 +244,6 @@ def main() -> None:
     group.add_argument(
         "-c",
         "--config",
-        action="append",
         type=argparse.FileType("r"),
         help="Path to server config file. Used to read in shared secret.",
     )
@@ -263,9 +262,9 @@ def main() -> None:
 
     args = parser.parse_args()
 
-    config: dict[str, Any] | None = None
+    config: Optional[dict[str, Any]] = None
     if "config" in args and args.config:
-        config = _read_config_files(args.config)
+        config = yaml.safe_load(args.config)
 
     if args.shared_secret:
         secret = args.shared_secret
@@ -327,33 +326,6 @@ def main() -> None:
     )
 
 
-# Adapted from synapse.config._base.
-def _read_config_files(config_files: Iterable[TextIO]) -> dict[str, Any]:
-    """Read the config files and shallowly merge them into a dict.
-
-    Successive configurations are shallowly merged into ones provided earlier,
-    i.e., entirely replacing top-level sections of the configuration.
-
-    Args:
-        config_files: A list of the config files to read
-
-    Returns:
-        The configuration dictionary.
-    """
-    specified_config = {}
-    for config_file in config_files:
-        yaml_config = yaml.safe_load(config_file)
-
-        if not isinstance(yaml_config, dict):
-            err = "File %r is empty or doesn't parse into a key-value map. IGNORING."
-            print(err % (config_file,))
-            continue
-
-        specified_config.update(yaml_config)
-
-    return specified_config
-
-
 def _read_file(file_path: Any, config_path: str) -> str:
     """Check the given file exists, and read it into a string
 
@@ -378,7 +350,7 @@ def _read_file(file_path: Any, config_path: str) -> str:
         sys.exit(1)
 
 
-def _find_client_listener(config: dict[str, Any]) -> str | None:
+def _find_client_listener(config: dict[str, Any]) -> Optional[str]:
     # try to find a listener in the config. Returns a host:port pair
     for listener in config.get("listeners", []):
         if listener.get("type") != "http" or listener.get("tls", False):

synapse/_scripts/synapse_port_db.py

@@ -107,7 +107,6 @@ logger = logging.getLogger("synapse_port_db")
 BOOLEAN_COLUMNS = {
     "access_tokens": ["used"],
     "account_validity": ["email_sent"],
-    "delayed_events": ["is_processed"],
     "device_lists_changes_in_room": ["converted_to_destinations"],
     "device_lists_outbound_pokes": ["sent"],
     "devices": ["hidden"],
@@ -234,14 +233,14 @@ IGNORED_BACKGROUND_UPDATES = {
 
 # Error returned by the run function. Used at the top-level part of the script to
 # handle errors and return codes.
-end_error: str | None = None
+end_error: Optional[str] = None
 # The exec_info for the error, if any. If error is defined but not exec_info the script
 # will show only the error message without the stacktrace, if exec_info is defined but
 # not the error then the script will show nothing outside of what's printed in the run
 # function. If both are defined, the script will print both the error and the stacktrace.
-end_error_exec_info: tuple[type[BaseException], BaseException, TracebackType] | None = (
-    None
-)
+end_error_exec_info: Optional[
+    tuple[type[BaseException], BaseException, TracebackType]
+] = None
 
 R = TypeVar("R")
 
@@ -486,7 +485,7 @@ class Porter:
 
             def r(
                 txn: LoggingTransaction,
-            ) -> tuple[list[str] | None, list[tuple], list[tuple]]:
+            ) -> tuple[Optional[list[str]], list[tuple], list[tuple]]:
                 forward_rows = []
                 backward_rows = []
                 if do_forward[0]:
@@ -503,7 +502,7 @@ class Porter:
 
                 if forward_rows or backward_rows:
                     assert txn.description is not None
-                    headers: list[str] | None = [
+                    headers: Optional[list[str]] = [
                         column[0] for column in txn.description
                     ]
                 else:
@@ -1153,7 +1152,9 @@ class Porter:
         return done, remaining + done
 
     async def _setup_state_group_id_seq(self) -> None:
-        curr_id: int | None = await self.sqlite_store.db_pool.simple_select_one_onecol(
+        curr_id: Optional[
+            int
+        ] = await self.sqlite_store.db_pool.simple_select_one_onecol(
             table="state_groups", keyvalues={}, retcol="MAX(id)", allow_none=True
         )
 
@@ -1270,10 +1271,10 @@ class Porter:
 
         await self.postgres_store.db_pool.runInteraction("_setup_%s" % (seq_name,), r)
 
-    async def _pg_get_serial_sequence(self, table: str, column: str) -> str | None:
+    async def _pg_get_serial_sequence(self, table: str, column: str) -> Optional[str]:
         """Returns the name of the postgres sequence associated with a column, or NULL."""
 
-        def r(txn: LoggingTransaction) -> str | None:
+        def r(txn: LoggingTransaction) -> Optional[str]:
             txn.execute("SELECT pg_get_serial_sequence('%s', '%s')" % (table, column))
             result = txn.fetchone()
             if not result:
@@ -1285,9 +1286,9 @@ class Porter:
         )
 
     async def _setup_auth_chain_sequence(self) -> None:
-        curr_chain_id: (
-            int | None
-        ) = await self.sqlite_store.db_pool.simple_select_one_onecol(
+        curr_chain_id: Optional[
+            int
+        ] = await self.sqlite_store.db_pool.simple_select_one_onecol(
             table="event_auth_chains",
             keyvalues={},
             retcol="MAX(chain_id)",

synapse/_scripts/synctl.py

@@ -30,7 +30,7 @@ import signal
 import subprocess
 import sys
 import time
-from typing import Iterable, NoReturn, TextIO
+from typing import Iterable, NoReturn, Optional, TextIO
 
 import yaml
 
@@ -135,7 +135,7 @@ def start(pidfile: str, app: str, config_files: Iterable[str], daemonize: bool)
         return False
 
 
-def stop(pidfile: str, app: str) -> int | None:
+def stop(pidfile: str, app: str) -> Optional[int]:
     """Attempts to kill a synapse worker from the pidfile.
     Args:
         pidfile: path to file containing worker's pid

synapse/api/auth/__init__.py

@@ -18,7 +18,7 @@
 # [This file includes modifications made by New Vector Limited]
 #
 #
-from typing import TYPE_CHECKING, Protocol
+from typing import TYPE_CHECKING, Optional, Protocol
 
 from prometheus_client import Histogram
 
@@ -51,7 +51,7 @@ class Auth(Protocol):
         room_id: str,
         requester: Requester,
         allow_departed_users: bool = False,
-    ) -> tuple[str, str | None]:
+    ) -> tuple[str, Optional[str]]:
         """Check if the user is in the room, or was at some point.
         Args:
             room_id: The room to check.
@@ -190,7 +190,7 @@ class Auth(Protocol):
 
     async def check_user_in_room_or_world_readable(
         self, room_id: str, requester: Requester, allow_departed_users: bool = False
-    ) -> tuple[str, str | None]:
+    ) -> tuple[str, Optional[str]]:
         """Checks that the user is or was in the room or the room is world
         readable. If it isn't then an exception is raised.
 

synapse/api/auth/base.py

@@ -19,7 +19,7 @@
 #
 #
 import logging
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 
 from netaddr import IPAddress
 
@@ -64,7 +64,7 @@ class BaseAuth:
         room_id: str,
         requester: Requester,
         allow_departed_users: bool = False,
-    ) -> tuple[str, str | None]:
+    ) -> tuple[str, Optional[str]]:
         """Check if the user is in the room, or was at some point.
         Args:
             room_id: The room to check.
@@ -114,7 +114,7 @@ class BaseAuth:
     @trace
     async def check_user_in_room_or_world_readable(
         self, room_id: str, requester: Requester, allow_departed_users: bool = False
-    ) -> tuple[str, str | None]:
+    ) -> tuple[str, Optional[str]]:
         """Checks that the user is or was in the room or the room is world
         readable. If it isn't then an exception is raised.
 
@@ -294,7 +294,7 @@ class BaseAuth:
     @cancellable
     async def get_appservice_user(
         self, request: Request, access_token: str
-    ) -> Requester | None:
+    ) -> Optional[Requester]:
         """
         Given a request, reads the request parameters to determine:
         - whether it's an application service that's making this request

synapse/api/auth/mas.py

@@ -13,19 +13,17 @@
 #
 #
 import logging
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 from urllib.parse import urlencode
 
-from pydantic import (
-    AnyHttpUrl,
+from synapse._pydantic_compat import (
     BaseModel,
-    ConfigDict,
+    Extra,
     StrictBool,
     StrictInt,
     StrictStr,
     ValidationError,
 )
-
 from synapse.api.auth.base import BaseAuth
 from synapse.api.errors import (
     AuthError,
@@ -65,7 +63,8 @@ STABLE_SCOPE_MATRIX_DEVICE_PREFIX = "urn:matrix:client:device:"
 
 
 class ServerMetadata(BaseModel):
-    model_config = ConfigDict(extra="allow")
+    class Config:
+        extra = Extra.allow
 
     issuer: StrictStr
     account_management_uri: StrictStr
@@ -74,12 +73,14 @@ class ServerMetadata(BaseModel):
 class IntrospectionResponse(BaseModel):
     retrieved_at_ms: StrictInt
     active: StrictBool
-    scope: StrictStr | None = None
-    username: StrictStr | None = None
-    sub: StrictStr | None = None
-    device_id: StrictStr | None = None
-    expires_in: StrictInt | None = None
-    model_config = ConfigDict(extra="allow")
+    scope: Optional[StrictStr]
+    username: Optional[StrictStr]
+    sub: Optional[StrictStr]
+    device_id: Optional[StrictStr]
+    expires_in: Optional[StrictInt]
+
+    class Config:
+        extra = Extra.allow
 
     def get_scope_set(self) -> set[str]:
         if not self.scope:
@@ -147,33 +148,11 @@ class MasDelegatedAuth(BaseAuth):
 
     @property
     def _metadata_url(self) -> str:
-        return str(
-            AnyHttpUrl.build(
-                scheme=self._config.endpoint.scheme,
-                username=self._config.endpoint.username,
-                password=self._config.endpoint.password,
-                host=self._config.endpoint.host or "",
-                port=self._config.endpoint.port,
-                path=".well-known/openid-configuration",
-                query=None,
-                fragment=None,
-            )
-        )
+        return f"{self._config.endpoint.rstrip('/')}/.well-known/openid-configuration"
 
     @property
     def _introspection_endpoint(self) -> str:
-        return str(
-            AnyHttpUrl.build(
-                scheme=self._config.endpoint.scheme,
-                username=self._config.endpoint.username,
-                password=self._config.endpoint.password,
-                host=self._config.endpoint.host or "",
-                port=self._config.endpoint.port,
-                path="oauth2/introspect",
-                query=None,
-                fragment=None,
-            )
-        )
+        return f"{self._config.endpoint.rstrip('/')}/oauth2/introspect"
 
     async def _load_metadata(self) -> ServerMetadata:
         response = await self._http_client.get_json(self._metadata_url)

synapse/api/auth/msc3861_delegated.py

@@ -20,7 +20,7 @@
 #
 import logging
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, Callable
+from typing import TYPE_CHECKING, Any, Callable, Optional
 from urllib.parse import urlencode
 
 from authlib.oauth2 import ClientAuth
@@ -102,25 +102,25 @@ class IntrospectionResult:
             return []
         return scope_to_list(value)
 
-    def get_sub(self) -> str | None:
+    def get_sub(self) -> Optional[str]:
         value = self._inner.get("sub")
         if not isinstance(value, str):
             return None
         return value
 
-    def get_username(self) -> str | None:
+    def get_username(self) -> Optional[str]:
         value = self._inner.get("username")
         if not isinstance(value, str):
             return None
         return value
 
-    def get_name(self) -> str | None:
+    def get_name(self) -> Optional[str]:
         value = self._inner.get("name")
         if not isinstance(value, str):
             return None
         return value
 
-    def get_device_id(self) -> str | None:
+    def get_device_id(self) -> Optional[str]:
         value = self._inner.get("device_id")
         if value is not None and not isinstance(value, str):
             raise AuthError(
@@ -174,7 +174,7 @@ class MSC3861DelegatedAuth(BaseAuth):
         self._clock = hs.get_clock()
         self._http_client = hs.get_proxied_http_client()
         self._hostname = hs.hostname
-        self._admin_token: Callable[[], str | None] = self._config.admin_token
+        self._admin_token: Callable[[], Optional[str]] = self._config.admin_token
         self._force_tracing_for_users = hs.config.tracing.force_tracing_for_users
 
         self._rust_http_client = HttpClient(
@@ -247,7 +247,7 @@ class MSC3861DelegatedAuth(BaseAuth):
         metadata = await self._issuer_metadata.get()
         return metadata.issuer or self._config.issuer
 
-    async def account_management_url(self) -> str | None:
+    async def account_management_url(self) -> Optional[str]:
         """
         Get the configured account management URL
 

synapse/api/auth_blocking.py

@@ -20,7 +20,7 @@
 #
 
 import logging
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 
 from synapse.api.constants import LimitBlockingTypes, UserTypes
 from synapse.api.errors import Codes, ResourceLimitError
@@ -51,10 +51,10 @@ class AuthBlocking:
 
     async def check_auth_blocking(
         self,
-        user_id: str | None = None,
-        threepid: dict | None = None,
-        user_type: str | None = None,
-        requester: Requester | None = None,
+        user_id: Optional[str] = None,
+        threepid: Optional[dict] = None,
+        user_type: Optional[str] = None,
+        requester: Optional[Requester] = None,
     ) -> None:
         """Checks if the user should be rejected for some external reason,
         such as monthly active user limiting or global disable flag