Fix type errors introduced by new annotations in the Prometheus Client library. (#11832)

Co-authored-by: David Robertson <[email protected]>

Author: reivilibre

changelog.d/11832.misc

@@ -0,0 +1 @@
+Fix type errors introduced by new annotations in the Prometheus Client library.

synapse/metrics/__init__.py

@@ -30,6 +30,7 @@
     Type,
     TypeVar,
     Union,
+    cast,
 )
 
 import attr
@@ -60,14 +61,21 @@
 HAVE_PROC_SELF_STAT = os.path.exists("/proc/self/stat")
 
 
-class RegistryProxy:
+class _RegistryProxy:
     @staticmethod
     def collect() -> Iterable[Metric]:
         for metric in REGISTRY.collect():
             if not metric.name.startswith("__"):
                 yield metric
 
 
+# A little bit nasty, but collect() above is static so a Protocol doesn't work.
+# _RegistryProxy matches the signature of a CollectorRegistry instance enough
+# for it to be usable in the contexts in which we use it.
+# TODO Do something nicer about this.
+RegistryProxy = cast(CollectorRegistry, _RegistryProxy)
+
+
 @attr.s(slots=True, hash=True, auto_attribs=True)
 class LaterGauge:
 

synapse/python_dependencies.py

@@ -76,8 +76,7 @@
     "msgpack>=0.5.2",
     "phonenumbers>=8.2.0",
     # we use GaugeHistogramMetric, which was added in prom-client 0.4.0.
-    # 0.13.0 has an incorrect type annotation, see #11832.
-    "prometheus_client>=0.4.0,<0.13.0",
+    "prometheus_client>=0.4.0",
     # we use `order`, which arrived in attrs 19.2.0.
     # Note: 21.1.0 broke `/sync`, see #9936
     "attrs>=19.2.0,!=21.1.0",