From 9fbe1bf2a3aadf74294963b9c9e2308bcce50b3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleix=20Conchillo=20Flaqu=C3=A9?= Date: Wed, 15 Apr 2026 15:09:01 -0700 Subject: [PATCH] Document `button` as a convenience shortcut, not a deprecation The single-key `button` field on `OutputDTMFFrame` and `OutputDTMFUrgentFrame` is kept as a first-class ergonomic shortcut for the common single-keypress case, equivalent to `buttons=[button]`. `buttons` takes precedence when both are set. --- changelog/4313.deprecated.md | 1 - src/pipecat/frames/frames.py | 16 ++++++---------- 2 files changed, 6 insertions(+), 11 deletions(-) delete mode 100644 changelog/4313.deprecated.md diff --git a/changelog/4313.deprecated.md b/changelog/4313.deprecated.md deleted file mode 100644 index 58b826c6f..000000000 --- a/changelog/4313.deprecated.md +++ /dev/null @@ -1 +0,0 @@ -- Deprecated the `button` field on `OutputDTMFFrame` and `OutputDTMFUrgentFrame`. Use the new `buttons` field (a `list[KeypadEntry]`) instead. When only `button` is set, it is wrapped in a single-entry list for backward compatibility. diff --git a/src/pipecat/frames/frames.py b/src/pipecat/frames/frames.py index 68574b6a5..230fe9c8f 100644 --- a/src/pipecat/frames/frames.py +++ b/src/pipecat/frames/frames.py @@ -747,11 +747,9 @@ class OutputDTMFFrame(DTMFFrame, DataFrame): Parameters: buttons: Sequence of one or more DTMF keypad buttons to send. Use :meth:`from_string` to build this from a string like ``"123#"``. - button: A single DTMF keypad entry to send. - - .. deprecated:: 1.1.0 - Use ``buttons`` instead. When only ``button`` is set, it is - used as a single-entry ``buttons`` list. + button: Convenience shortcut for sending a single DTMF keypad + entry. Equivalent to ``buttons=[button]``. If both ``buttons`` + and ``button`` are provided, ``buttons`` takes precedence. """ button: Optional[KeypadEntry] = None @@ -1284,11 +1282,9 @@ class OutputDTMFUrgentFrame(DTMFFrame, SystemFrame): Parameters: buttons: Sequence of one or more DTMF keypad buttons to send. Use :meth:`from_string` to build this from a string like ``"123#"``. - button: A single DTMF keypad entry to send. - - .. deprecated:: 1.1.0 - Use ``buttons`` instead. When only ``button`` is set, it is - used as a single-entry ``buttons`` list. + button: Convenience shortcut for sending a single DTMF keypad + entry. Equivalent to ``buttons=[button]``. If both ``buttons`` + and ``button`` are provided, ``buttons`` takes precedence. """ button: Optional[KeypadEntry] = None