frames: EndFrame and CancelFrame reason is now Any

changelog/3231.changed.md

@@ -0,0 +1,3 @@
+- Changed the `reason` field in `EndFrame`, `CancelFrame`, `EndTaskFrame`, and
+  `CancelTaskFrame` from `str` to `Any` to indicate that it can hold values
+  other than strings.

src/pipecat/frames/frames.py

@@ -947,7 +947,7 @@ class CancelFrame(SystemFrame):
         reason: Optional reason for pushing a cancel frame.
     """
 
-    reason: Optional[str] = None
+    reason: Optional[Any] = None
 
     def __str__(self):
         return f"{self.name}(reason: {self.reason})"
@@ -1537,7 +1537,7 @@ class EndTaskFrame(TaskFrame):
         reason: Optional reason for pushing an end frame.
     """
 
-    reason: Optional[str] = None
+    reason: Optional[Any] = None
 
     def __str__(self):
         return f"{self.name}(reason: {self.reason})"
@@ -1555,7 +1555,7 @@ class CancelTaskFrame(TaskFrame):
         reason: Optional reason for pushing a cancel frame.
     """
 
-    reason: Optional[str] = None
+    reason: Optional[Any] = None
 
     def __str__(self):
         return f"{self.name}(reason: {self.reason})"
@@ -1634,7 +1634,7 @@ class EndFrame(ControlFrame):
         reason: Optional reason for pushing an end frame.
     """
 
-    reason: Optional[str] = None
+    reason: Optional[Any] = None
 
     def __str__(self):
         return f"{self.name}(reason: {self.reason})"