add default values option for Dialog

[motty-mio2]

Hello, I'm happy to post here.

Why

Default Value settings are important for some people (includes me).

What

I add an option to set default value for Dialogs(Checkbox list dialog and Radio list dialog).

• It can check whether the value is valid or invalid.
  • later checkbox example, "banana" is not a valid option, so it is removed. "eggs" and "croissants" are selected.

Usage

Checkbox list dialog

results_array = checkboxlist_dialog(
    title="CheckboxList dialog",
    text="What would you like in your breakfast ?",
    values=[
        ("eggs", "Eggs"),
        ("bacon", "Bacon"),
        ("croissants", "20 Croissants"),
        ("daily", "The breakfast of the day")
    ],
    default_values=["banana", "eggs", "croissants"]
).run()
All values in default_values will be used for default value.

Radio list dialog

result = radiolist_dialog(
    values=[
        ("red", "Red"),
        ("green", "Green"),
        ("blue", "Blue"),
        ("orange", "Orange"),
    ],
    default_values=["blue"],
    title="Radiolist dialog example",
    text="Please select a color:",
).run()

First index (default_values[0], in this case "blue") item will be used for default value.

How It Works

checkbox dialogs

I set default_values as ["banana", "eggs", "croissants"]

radio dialogs

I set default_values as ["blue"]
"blue" is selected.

Related

• issue
  • [Question] How to pass a default value to input_dialog() #1544
• PR
  • Added default parameter to RadioList and radiolist_dialog #651

Thank you.

[jonathanslenders]

Looks good overall. A few small comments. Thanks for the pull request!

[jonathanslenders]

mutable values should not be used as keyword arguments. State could leak from one call to the next.

Better is to do:

default_values: Optional[List[_T]] = None,

and in the body of the function:

if default_values is None:
    default_values = []

[jonathanslenders]

Same comment here about mutable defaults.

[jonathanslenders]

Same comment about mutable defaults here.

[jonathanslenders]

no parentheses are required around this expression.

[jonathanslenders]

@motty-mio2: I did some changes to this pull request, and merged it from here: #1569
Thanks again for the contribution!

[motty-mio2]

Oh Thank you so much.