Add type annotations to samples.py

csmarchbanks · csmarchbanks · commit bbeb7c36b2c4 · 2022-02-09T07:41:58.000-07:00
diff --git a/prometheus_client/samples.py b/prometheus_client/samples.py
@@ -4,30 +4,30 @@
 class Timestamp:
     """A nanosecond-resolution timestamp."""
 
-    def __init__(self, sec, nsec):
+    def __init__(self, sec: Union[int, float], nsec: Union[int, float]) -> None:
         if nsec < 0 or nsec >= 1e9:
             raise ValueError(f"Invalid value for nanoseconds in Timestamp: {nsec}")
         if sec < 0:
             nsec = -nsec
-        self.sec = int(sec)
-        self.nsec = int(nsec)
+        self.sec: int = int(sec)
+        self.nsec: int = int(nsec)
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.sec}.{self.nsec:09d}"
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return f"Timestamp({self.sec}, {self.nsec})"
 
-    def __float__(self):
+    def __float__(self) -> float:
         return float(self.sec) + float(self.nsec) / 1e9
 
-    def __eq__(self, other):
-        return type(self) == type(other) and self.sec == other.sec and self.nsec == other.nsec
+    def __eq__(self, other: object) -> bool:
+        return isinstance(other, Timestamp) and self.sec == other.sec and self.nsec == other.nsec
 
-    def __ne__(self, other):
+    def __ne__(self, other: object) -> bool:
         return not self == other
 
-    def __gt__(self, other):
+    def __gt__(self, other: "Timestamp") -> bool:
         return self.sec > other.sec or self.nsec > other.nsec
 
 
@@ -45,6 +45,6 @@ class Exemplar(NamedTuple):
 class Sample(NamedTuple):
     name: str
     labels: Dict[str, str]
-    value: float
+    value: Union[int, float]
     timestamp: Optional[Union[float, Timestamp]] = None
     exemplar: Optional[Exemplar] = None
