[Bug] Combo.update causes _tkinter.TclError: unknown color name "1234567890" if theme is Default or Default1

[nachocho]

Type of Issue (Enhancement, Error, Bug, Question)

Bug

Operating System

MacOS

PySimpleGUI Port (tkinter, Qt, Wx, Web)

tkinter

---

Versions

Version information can be obtained by calling sg.main_get_debug_data()

Python version: 3.10.0b4 (v3.10.0b4:2ba4b20854, Jul 9 2021, 21:56:21) [Clang 12.0.5 (clang-1205.0.22.9)]
port: tkinter
tkinter version: 8.6.11
PySimpleGUI version: 4.45.0.44
PySimpleGUI filename: /Users/Nacho/PycharmProjects/test/PySimpleGUI.py

---

Your Experience In Months or Years (optional)

Years Python programming experience: 3 years

Years Programming experience overall: 20 years

Have used another Python GUI Framework? Qt

Anything else you think would be helpful?

---

Troubleshooting

These items may solve your problem. Please check those you've done by changing - [ ] to - [X]

• Searched main docs for your problem www.PySimpleGUI.org
• Looked for Demo Programs that are similar to your goal Demos.PySimpleGUI.org
• If not tkinter - looked for Demo Programs for specific port
• For non tkinter - Looked at readme for your specific port if not PySimpleGUI (Qt, WX, Remi)
• Run your program outside of your debugger (from a command line)
• Searched through Issues (open and closed) to see if already reported Issues.PySimpleGUI.org
• Tried using the PySimpleGUI.py file on GitHub. Your problem may have already been fixed but not released

Detailed Description

This issue is an extension of issue #4576.
Trying to change the background color of an element to the "default" color defined in sg.DEFAULT_INPUT_ELEMENTS_COLOR after calling sg.theme('Default1') or sg.theme('Default') does not change the color for Input and Multiline elements, and throws the same error reported in issue #4576 for Combo and Listbox elements:

_tkinter.TclError: unknown color name "1234567890"

Note that I only tested those 4 elements but other elements might be affected as well.

The tkinter error is not raised with the latest published version in PyPi (at the moment 4.45.0).

Code To Duplicate

Using this first snippet of code, you can reproduce the behavior of the Input and Multiline elements not changing their background color. Clicking Change to default BG color shows the problem, while clicking Change BG color works as expected.

import PySimpleGUI as sg


sg.theme('Default1')
window = sg.Window(title='Window',
                   layout=[[sg.Input(background_color='RED', key='INPUT')],
                           [sg.Multiline(background_color='RED', key='MULTILINE')],
                           [sg.Combo(values=['YELLOW', 'BLUE', 'GREEN', 'ORANGE'], default_value='YELLOW',
                                     key='COLOR'),
                            sg.Button(button_text='Change BG color', key='CHANGE')],
                           [sg.Button(button_text='Change to default BG color', key='CHANGE_DEFAULT')],
                           [sg.CloseButton(button_text='Close')]])
while True:
    event, values = window.read()
    if event in ('Close', sg.WIN_CLOSED):
        break
    if event in ('CHANGE', 'CHANGE_DEFAULT'):
        bg_color = values['COLOR'] if event == 'CHANGE' else sg.DEFAULT_INPUT_ELEMENTS_COLOR
        for key in ('INPUT', 'MULTILINE'):
            window[key].update(background_color=bg_color)
window.close()

Using this second snippet of code you will see 2 different problems:

1. The background color of the Combo element is not initially set as expected ONLY if sg.theme('Default1) or sg.theme('Default') is used before trying to set the combo background color initially. (This error happens even in PySimpleGUI version 4.45.0 released last year)
2. The _tkinter.TclError: unknown color name "1234567890" error is raised when trying to update the background color of Combo and Listbox elements. (This error does not happen in PySimpleGUI version 4.45.0 released last year)

import PySimpleGUI as sg


sg.theme('Default1')
window = sg.Window(title='Window',
                   layout=[[sg.Input(background_color='RED', key='INPUT')],
                           [sg.Combo(values=['A', 'B', 'C'], background_color='RED', key='COMBO')],
                           [sg.Multiline(background_color='RED', key='MULTILINE')],
                           [sg.Listbox(values=['A', 'B', 'C'], size=(5, 8), background_color='RED', key='LISTBOX')],
                           [sg.Combo(values=['YELLOW', 'BLUE', 'GREEN', 'ORANGE'], default_value='YELLOW',
                                     key='COLOR'),
                            sg.Button(button_text='Change BG color', key='CHANGE')],
                           [sg.Button(button_text='Change to default BG color', key='CHANGE_DEFAULT')],
                           [sg.CloseButton(button_text='Close')]])
while True:
    event, values = window.read()
    if event in ('Close', sg.WIN_CLOSED):
        break
    if event in ('CHANGE', 'CHANGE_DEFAULT'):
        bg_color = values['COLOR'] if event == 'CHANGE' else sg.DEFAULT_INPUT_ELEMENTS_COLOR
        for key in ('INPUT', 'MULTILINE'):
            window[key].update(background_color=bg_color)
        for key in ('LISTBOX',):
            window[key].Widget.config(background=bg_color)
        for key in ('COMBO',):
            sg.ttk.Style().configure(f"{key}.TCombobox", fieldbackground=bg_color)
window.close()

Screenshot, Sketch, or Drawing

This screenshot shows the error of the Combo element not having its background color set:

[jason990420]

Platform

• Operating System: WIN10
• Python 3.9.5
• PySimpleGUI 4.45.0 or 4.45.0.44,
• Detailed tkinter version: 8.6.9

Code 1

• Using sg.DEFAULT_INPUT_ELEMENTS_COLOR ('#f0f3f7') to update background of Multiline and Input , it will be always look like white color and not about what theme you use.
• Using sg.theme_input_background_color() ('1234567890'), there'll be no update if the value of the color is None or '1234567890'. It is default in PySimpleGUI.
• Code executed correctly and nothing wrong.

Code 2

• Same as in Code 1, but
• background_color for Combo only work when text_color is not None or "1234567890' when initialize.
• There's no option for text_color and background_color in method update of element Combo.
• The style name will be 'TCombobox' if text_color is None or "1234567890', otherwise it will be str(element.Key) + '.TCombobox'.
• Use theme Default or Default1, text_color will be '1234567890'.

To update color for Combo, following code may work

if window['COMBO'].TextColor in (None, sg.COLOR_SYSTEM_DEFAULT):
    name = 'TCombobox'
else:
    name = str(window['COMBO'].Key) + '.TCombobox'
style = sg.ttk.Style()
# Of course, you cannot use invalid color here, like None or "1234567890"
bg, fg = "blue", "white"
style.configure(name, foreground=fg, background=bg, selectforeground=fg,
    selectbackground=bg, fieldbackground=bg, arrowcolor=fg)
style.map(name, fieldbackground=[('readonly', bg)])

[PySimpleGUI]

Looks like the update methods don't have as much protection.

It's a somewhat unusual sequence for a user to do. Usually if you've chosen that theme, then it means you're not desiring colors to be changed. You're asking for the system defaults with no color modifications at all.

I'm guessing you'll be able to find plenty of problems with many elements with this theme.

For colors, the theme calls should be used rather than the individual color settings like DEFAULT_INPUT_ELEMENTS_COLOR . The APIs evolved away from using these variables and instead have used the theme calls.

[PySimpleGUI]

I can't find anything in the documentation, nor the demo programs, that shows using the variable DEFAULT_INPUT_ELEMENTS_COLOR. Can you provide some context behind where the code came from tor trying this?

[nachocho]

Thanks for the reply @jason990420 . I am trying to understand what you are saying, but failing to do so.
I will reply inline.

Code 1

• Using sg.DEFAULT_INPUT_ELEMENTS_COLOR ('#f0f3f7') to update background of Multiline and Input , it will be always look like white color and not about what theme you use.

I understand sg.DEFAULT_INPUT_ELEMENTS_COLOR ('#f0f3f7') always looks white, and it makes more sense to use sg.theme_background_color(). My point is, this works correctly with PySimpleGUI v4.45.0 but not with v4.45.0.44. I suspect the fix of issue #4576 (or other code changes) may have broken something.

• Using sg.theme_input_background_color() ('1234567890'), there'll be no update if the value of the color is None or '1234567890'. It is default in PySimpleGUI.

Actually I just tried using sg.theme_input_background_color() instead if sg.DEFAULT_INPUT_ELEMENTS_COLOR (are these the same internally?), and there is an update of the background color if I change if first to another color and then I update it to sg.theme_input_background_color()or sg.DEFAULT_INPUT_ELEMENTS_COLOR, but only in v4.45.0. In v4.45.0.44 the update call is simply ignored for the Input and Multiline elements.

This change of behavior between v4.45.0 and v4.45.0.44 is what I am pointing out.

• Code executed correctly and nothing wrong.

So what you are saying is that on Windows testing with v4.45.0.44 the background color does change correctly if you first set it to a known color like YELLOW or RED and then change it to sg.theme_input_background_color()or sg.DEFAULT_INPUT_ELEMENTS_COLOR?

Code 2

• Same as in Code 1, but
• background_color for Combo only work when text_color is not None or "1234567890' when initialize.
• There's no option for text_color and background_color in method update of element Combo.
• The style name will be 'TCombobox' if text_color is None or "1234567890', otherwise it will be str(element.Key) + '.TCombobox'.
• Use theme Default or Default1, text_color will be '1234567890'.

But again, this works correctly setting the background color for the Combo element in v4.45.0.
And I am talking specifically about doing this:

sg.ttk.Style().configure("COMBO.TCombobox", fieldbackground=sg.DEFAULT_INPUT_ELEMENTS_COLOR)

but it no longer works in v4.45.0.44

To update color for Combo, following code may work

if window['COMBO'].TextColor in (None, sg.COLOR_SYSTEM_DEFAULT):
    name = 'TCombobox'
else:
    name = str(window['COMBO'].Key) + '.TCombobox'
style = sg.ttk.Style()
# Of course, you cannot use invalid color here, like None or "1234567890"

This statement is what is causing me problems. Why calling sg.ttk.Style().configure("COMBO.TCombobox", fieldbackground=sg.DEFAULT_INPUT_ELEMENTS_COLOR) works in one version and not in another. Are you suggesting the behavior in 4.45.0 is then wrong and using an invalid color '1234567890' although it works in that version it should not be used?

bg, fg = "blue", "white"
style.configure(name, foreground=fg, background=bg, selectforeground=fg,
selectbackground=bg, fieldbackground=bg, arrowcolor=fg)
style.map(name, fieldbackground=[('readonly', bg)])

[nachocho]

Looks like the update methods don't have as much protection.

It's a somewhat unusual sequence for a user to do. Usually if you've chosen that theme, then it means you're not desiring colors to be changed. You're asking for the system defaults with no color modifications at all.

Regardless of the theme used (which I want to let the user of my app choose), I am setting the background color of empty elements to a YELLOW color, and resetting them to sg.DEFAULT_INPUT_ELEMENTS_COLOR when the field has a value. I understand that maybe resetting the background color to sg.theme_background_color() might be a better choice, although that also works in v4.45.0 and not in v4.45.0.44, hence my bug report.

I'm guessing you'll be able to find plenty of problems with many elements with this theme.

Right, these problems are happening with the "Default" themes only.

For colors, the theme calls should be used rather than the individual color settings like DEFAULT_INPUT_ELEMENTS_COLOR . The APIs evolved away from using these variables and instead have used the theme calls.

[nachocho]

I can't find anything in the documentation, nor the demo programs, that shows using the variable DEFAULT_INPUT_ELEMENTS_COLOR. Can you provide some context behind where the code came from tor trying this?

I inspected the code in PySimpleGUI.py to check how the initial background color of elements was being set, and saw DEFAULT_INPUT_ELEMENTS_COLOR as being used. If I use sg.theme_background_color() anyway the problem happens as well in v4.45.0.44.

[PySimpleGUI]

Until the fix is added or workaround for this specific bug, your best general workaround is going to be limit the use of themes to not include the default and default1 themes (i.e. themes that do not use the value COLOR_SYSTEM_DEFAULT)

[nachocho]

Until the fix is added or workaround for this specific bug, your best general workaround is going to be limit the use of themes to not include the default and default1 themes (i.e. themes that do not use the value COLOR_SYSTEM_DEFAULT)

Got it, I will restrict the theme choices to not include any of the "Default" themes.
Thanks!

[jason990420]

Code 1

• Using sg.DEFAULT_INPUT_ELEMENTS_COLOR ('#f0f3f7') to update background of Multiline and Input , it will be always look like white color and not about what theme you use.

I understand sg.DEFAULT_INPUT_ELEMENTS_COLOR ('#f0f3f7') always looks white, and it makes more sense to use sg.theme_background_color(). My point is, this works correctly with PySimpleGUI v4.45.0 but not with v4.45.0.44. I suspect the fix of issue #4576 (or other code changes) may have broken something.

It work fine for both vesion, v4.45.0 and v4.45.0.44, nothing different there.
If you use sg.DEFAULT_INPUT_ELEMENTS_COLOR ('#f0f3f7'), update background color to almost white.
If you use sg.theme_background_color(), it do nothing for color is "1234567890".

• Using sg.theme_input_background_color() ('1234567890'), there'll be no update if the value of the color is None or '1234567890'. It is default in PySimpleGUI.

Actually I just tried using sg.theme_input_background_color() instead if sg.DEFAULT_INPUT_ELEMENTS_COLOR (are these the same internally?), and there is an update of the background color if I change if first to another color and then I update it to sg.theme_input_background_color()or sg.DEFAULT_INPUT_ELEMENTS_COLOR, but only in v4.45.0. In v4.45.0.44 the update call is simply ignored for the Input and Multiline elements.
This change of behavior between v4.45.0 and v4.45.0.44 is what I am pointing out.

sg.DEFAULT_INPUT_ELEMENTS_COLOR is the default color, sg.theme_input_background_color() is the color set by sg,theme, basically, they are totally different.

In 4.45.0 or 4.45.0.44, they have the same code for method update

        if background_color not in (None, COLOR_SYSTEM_DEFAULT):    # Code for class Input
            self.TKEntry.configure(background=background_color)
        if background_color not in (None, COLOR_SYSTEM_DEFAULT):    # Code for class Multiline
            self.TKText.configure(background=background_color)

• Code executed correctly and nothing wrong.

So what you are saying is that on Windows testing with v4.45.0.44 the background color does change correctly if you first set it to a known color like YELLOW or RED and then change it to sg.theme_input_background_color()or sg.DEFAULT_INPUT_ELEMENTS_COLOR?

Yes, they show same result, no matter you set it to a known color or not.

If you use sg.DEFAULT_INPUT_ELEMENTS_COLOR ('#f0f3f7'), update background color to almost white.
If you use sg.theme_background_color(), it do nothing for color is "1234567890".

Code 2

• Same as in Code 1, but
• background_color for Combo only work when text_color is not None or "1234567890' when initialize.
• There's no option for text_color and background_color in method update of element Combo.
• The style name will be 'TCombobox' if text_color is None or "1234567890', otherwise it will be str(element.Key) + '.TCombobox'.
• Use theme Default or Default1, text_color will be '1234567890'.

But again, this works correctly setting the background color for the Combo element in v4.45.0.
And I am talking specifically about doing this:

sg.ttk.Style().configure("COMBO.TCombobox", fieldbackground=sg.DEFAULT_INPUT_ELEMENTS_COLOR)

but it no longer works in v4.45.0.44

To update color for Combo, following code may work

if window['COMBO'].TextColor in (None, sg.COLOR_SYSTEM_DEFAULT):
    name = 'TCombobox'
else:
    name = str(window['COMBO'].Key) + '.TCombobox'
style = sg.ttk.Style()
# Of course, you cannot use invalid color here, like None or "1234567890"

This statement is what is causing me problems. Why calling sg.ttk.Style().configure("COMBO.TCombobox", fieldbackground=sg.DEFAULT_INPUT_ELEMENTS_COLOR) works in one version and not in another. Are you suggesting the behavior in 4.45.0 is then wrong and using an invalid color '1234567890' although it works in that version it should not be used?

bg, fg = "blue", "white"
style.configure(name, foreground=fg, background=bg, selectforeground=fg,
selectbackground=bg, fieldbackground=bg, arrowcolor=fg)
style.map(name, fieldbackground=[('readonly', bg)])

IMO, "COMBO.TCombobox" should not work on both version if theme is default or default1, code to finalize a Combo is exactly same in both version.

                style_name = 'TCombobox'
                if element.TextColor is not None and element.TextColor != COLOR_SYSTEM_DEFAULT:
                    style_name = str(element.Key) + '.TCombobox'

It is clear you got different result as mine, they should be same even in different platform.
Checked the code between both versions, it looks like nothing updated.

[PySimpleGUI]

I need to do a check of the update methods to make sure these checks are done for the COLOR_SYSTEM_DEFAULT like they are when the window is created. It's on the list for today.

I appreciate the help @jason990420 and @nachocho.... l'll take a look at these areas today. I've not looked through the update code to see where it's going to get tripped up with the themes. You've given me plenty of info. Thank you.

[PySimpleGUI]

OK, I've looked at both the Listbox and Combo.

What I was holding the release back for and thought there was a really big problem was that the update methods had a color parameter that was not being protected correctly by checking the value of the color.

But, that's not what I'm finding and looking at everything in much more detail, reading the example code and the code that Jason has been providing. Using the .Widget member variable is an extension of PySimpleGUI. It's not a "feature".

@nachocho if you choose the use the colors being returned from the themes and you're going to use the themes that include COLOR_SYSTEM_DEFAULT then it's your responsibility to check for those values just as the entirety of PySimpleGUI does. I do want to do a scan to see where colors are passed into parameters and how they may get tripped up. That will be for other elements thought than Combo and Listbox as those don't have colors in the update methods.

[PySimpleGUI]

Maybe I've not done a good job of describing what this value is?

COLOR_SYSTEM_DEFAULT is a "magic number".

It was chosen to be something that looks unique and sadly, frustratingly, causes errors. I could make it a value that doesn't cause an error. I could make it say '#000000'. But that would mask the problem. It's intentionally a bad value so that I must check for it. The whole idea is to NOT try and set the value within the GUI framework. I'm not aware of a value I can set that is a "don't change the value". None doesn't do that in tktiner if you pass it as a color.... it didn't in the tests I ran initially. Maybe I got that wrong but I don't think so.

In the code that creates the Widgets, it explicitly checks to see if this value is set. If it is, I don't change the setting.

You'll find all over the widget creation code these checks:

                if element.BackgroundColor is not None and element.BackgroundColor != COLOR_SYSTEM_DEFAULT:

or when I thought it through a little better and was more Pythonic:

                        if not element.BackgroundColor in (None, COLOR_SYSTEM_DEFAULT):

So... it's just a value that is meant to cause the code to not modify whatever is being set.