wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document button as a convenience shortcut, not a deprecation

Browse Source 
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.
This commit is contained in:
Aleix Conchillo Flaqué
2026-04-15 15:09:01 -07:00
parent d8b0e78bc8
commit 9fbe1bf2a3
2 changed files with 6 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
changelog/4313.deprecated.md
View File

@@ -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.

16
src/pipecat/frames/frames.py
View File

@@ -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