Skip to content

Allow optional copyable text in setup flows #395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcelveldt merged 1 commit into from
Sep 11, 2026
Merged

Allow optional copyable text in setup flows #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions music_assistant_models/setup_flow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ class SetupFlowStep(DataClassDictMixin):
last_step: bool | None = None
# url [EXTERNAL]: url the user must open (e.g. an OAuth authorize url)
url: str | None = None
# copy_text [EXTERNAL]: optional value that the client may copy to the clipboard
copy_text: str | None = None
# progress_text [PROGRESS]: status slug/message, resolved from the translations at serialization
progress_text: str | None = None
# progress [PROGRESS]: optional completion fraction between 0 and 1
Expand Down
4 changes: 3 additions & 1 deletion tests/test_setup_flow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,19 @@ def test_form_step_shape() -> None:


def test_external_step_shape() -> None:
"""An EXTERNAL step carries the url to open and an optional deadline."""
"""An EXTERNAL step carries the url to open, copyable text and an optional deadline."""
step = SetupFlowStep(
flow_id="f",
step_id="oauth",
type=FlowStepType.EXTERNAL,
url="https://example.test/authorize",
copy_text="123456",
expires_at=1234.5,
)
d = step.to_dict()
assert d["type"] == "external"
assert d["url"] == "https://example.test/authorize"
assert d["copy_text"] == "123456"
assert d["expires_at"] == 1234.5


Expand Down