Add support for language selection in preferences #2349

goanpeca · 2015-04-22T11:08:20Z

Description

Add support for language selection in preferences.

This was a bit trickier than expected, namely the configuration of the language needs to be stored in a separate file, because we cannot use CONF at the stage the _ function is called.

I added a langconfig in the .spyder folder, which stores the language value ('en', 'fr' etc)

With this change I had to implement some new logic in the config dialog, so now comboboxes (so far) have an extra parameter call restart (by default False).

Preferences dialog

Pop up message box

When the user changes one or more options flagged with restart=True and then clicks on Apply or Ok, the a message box will popup informing the user which options need to restart and asking if he/she wants to restart right away.

If the user accepts, any restart specific (defined) settings will be applied and spyder will restart automatically.

Note:

The message box is now available for any other combobox that is created with the restart=True parameter. Adding this functionality to other widgets will be left for another PR.

Todo

Display language names In original Language
Agree on additional file method and name
Define when to pop the box to the user for restart

For another PR

Add the restart functionality to all the other widgets besides comboboxes

ccordoba12 · 2015-04-23T17:21:07Z

spyderlib/baseconfig.py

@@ -204,18 +205,102 @@ def get_image_path(name, default="not_found.png"):
 #==============================================================================
 # Translations
 #==============================================================================
+LANG_FILE = osp.join(get_conf_path(), '.langconfig')


I'm ok with adding this new file, but don't call it .langconfig, just langconfig, so that it's not hidden on Linux :-)

At the end, it's going to be inside of ~/.spyder, so there is no need to be hidden.

goanpeca · 2015-04-26T11:38:08Z

@ccordoba12 I updated with the fixes, when you have some time can you take a look at some questions I left in the description?

goanpeca · 2015-05-01T18:54:30Z

This PR is waiting for some input from the @spyder-ide/core-developers ...

There are 2 ways of doing this.
1.) Ask the user if he wants to restart for the setting to take place, immediately after changing the setting
2.) Ask the user if he wants to restart for the setting to take place, only after pressing Ok or Apply

I implemented the first one.. but the second one could be also implemented if you consider is better.

@ccordoba12 any ideas, thoughts?

Nodd · 2015-05-01T19:08:49Z

I vote 2 because:

there could be other settings which ask to reload (changing the icon theme, enabling plugins…)
It's annoying to have a popup without being able to check if the change was correct.

If 2 is chosen, it should be written that it requires a restart.

goanpeca · 2015-05-01T19:15:19Z

In that case of 2, I would make the popup appear at the end when clicking ok, or apply

Nodd · 2015-05-01T19:23:48Z

Yep. Bonus points if the dialog contains the reason why the restart is needed (as a list so that other settings can give their information too)

goanpeca · 2015-05-02T08:20:35Z

Yep, you read my mind ;-)

goanpeca · 2015-05-03T11:08:11Z

@Nodd ok, this is now updated to ask only after pressing Ok or Apply and displays a list of all the options that require a restart (and were changed).

Can you give it a try @ccordoba12?

I would expect this to work in mac without changes but, @blink1073 can you give it a try?

ccordoba12 · 2015-05-03T14:28:51Z

The restart popup message is very nice!! It looks very professional! Thanks a lot for working on it @goanpeca!

ccordoba12 · 2015-05-03T14:30:24Z

spyderlib/baseconfig.py

+        language = DEFAULT_LANGUAGE
+    else:
+        spyder_languages = get_available_translations()
+        for spyder_language in spyder_languages:


Let's simplify the variables here to make it a bit easier to read. What about this?

for lang in spyder_languages

Ok sure, I will adapt ;-)

Nodd · 2015-05-05T19:15:00Z

In python3 I didn't have this problem (the unicode support is way better).
It should be put at the same place where sys.stdout is redirected to the internal console, I guess. I have no idea where it is 😞

ccordoba12 · 2015-05-05T21:08:17Z

spyderlib/spyder.py

@@ -2743,6 +2743,9 @@ def restart(self):
            startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
            shell = False
        else:
+            # This environment variable is needed so that the new python
+            # process spawned with Popen sets this as the default encoding
+            env['PYTHONIOENCODING'] = 'utf-8'


I think setting this system-wide is not a good idea. For example, It could mess with Pandas trying to import/export files :-)

ccordoba12 · 2015-05-05T21:13:12Z

If I'm not wrong, redirection of stdio for the internal console happens in redirect_internalshell_stdio, currently present in

https://github.com/spyder-ide/spyder/blob/master/spyderlib/spyder.py#L2435

goanpeca · 2015-05-07T16:38:25Z

I tried putting @Nodd where @ccordoba12 without success

goanpeca · 2015-05-07T18:25:07Z

@Nodd I think I have it fixed, can you check the latest commit?

@blink1073, or @ccordoba12 can you please test on Mac? remember to run using

python bootstrap.py --debug

blink1073 · 2015-05-08T01:25:32Z

It works for me, other than the fact that the restart dialog was entirely in English.

blink1073 · 2015-05-08T01:26:33Z

goanpeca · 2015-05-08T07:02:10Z

Cause we need To rerun the localización scripts 👍

goanpeca · 2015-05-10T21:46:23Z

@ccordoba12 can we merge this one so that @SylvainCorlay can add this to his icon PR 😄 ?

SylvainCorlay · 2015-05-13T17:26:44Z

Yeah seems I will need to rebase again anyway!

ccordoba12 · 2015-05-13T19:47:22Z

spyderlib/config.py

@@ -169,6 +169,7 @@ def is_ubuntu():
              'animated_docks': True,
              'prompt_on_exit': False,
              'panes_locked': True,
+              'interface_language': load_lang_conf(),


I think we don't need to add this here because this is dependent on the user system.

The only options that we add in config.py are those that can be changed and/or updated in the future (by bumping CONF_VERSION).

That's why (for example) we don't add here the window ~~size or~~ state.

Another example of things we don't add are the run configuration options per file :-)

Please remove this option from here to finally merge this PR :-)

If I understand the code correctly:

It'll be saved to spyder.ini by the save_lang method of MainConfigPage

It can't be retrieved by CONF directly.

So there's no need to have it here.

@ccordoba12

If I don't add that method to the config, Spyder will not be able to load the preferences after a reset, cause there will be no interface_language setting in the .ini file.

Suggestions?

I think we should leave it as it is, otherwise we would have to made unneded changes either to how the preferences are loaded or do an extra check in spyder.py to see if this is the first time it runs.... here it is just one line of code...

SylvainCorlay · 2015-05-27T12:48:23Z

Is there any blocking point for this one?

goanpeca · 2015-05-27T13:25:32Z

spyderlib/config.py

@@ -724,6 +724,9 @@ def is_ubuntu():
 CONF = UserConfig('spyder', defaults=DEFAULTS, load=True, version=CONF_VERSION,
                  subfolder=SUBFOLDER, backup=True, raw_mode=True)

+# Ensures that the config is present on spyder first run
+CONF.set('main', 'interface_language', load_lang_conf())


@ccordoba12 based on your previous comment on removing the entry from the default config, I need to add this line here to make sure that on first run of spyder the interface_language entry is created. On subsequent starts of spyder that line is harmless so this way is not part of the CONF but ensures the correct behavior.

You think is ok like this?

Yes, I think it's fine :-) But perhaps it's better to move it to configdialog.py. Well, if it's possible because there is where this setting is really needed.

Hmmm ok I will take a look if I find a suitable place there

goanpeca · 2015-05-27T17:36:27Z

@ccordoba12 this one should be ready to merge as well

SylvainCorlay · 2015-05-27T21:00:43Z

👍

ccordoba12 · 2015-05-28T01:27:08Z

spyderlib/plugins/configdialog.py

+            # ensure that when changes are applied, they are copied to a
+            # specific file storing the language value. This only applies to
+            # the main section config.
+            if self.CONF_SECTION == u'main':


I don't understand this change here. Maybe it's better to just move the CONF.set line from config.py here to avoid this.

I mean, what I don't understand is why you're looking for main.

main is the section in charge of setting the interface language, so the _save_lang only belongs to that section, before I was using if getattr(self, "_save_lang", False): but I change it so that it was more explicit.

Since this method runs for every child (any other section or plugin) then I need this to avoid an error of calling _save_lang when it does not exist.

The other way would be to make the save_lang method part of one of the ancestors so that EVERY section would alwyas make that save... but since it is only necessary for main...

Too much work :-) Then leave this part as it is now.

Please see if you can move the CONF.set call from config.py to here so that we can (finally!) merge this PR ;-)

Will do! ;-)

goanpeca · 2015-05-29T17:21:59Z

spyderlib/plugins/configdialog.py

@@ -151,6 +165,9 @@ def __init__(self, parent=None):

        self.setWindowTitle(_("Preferences"))
        self.setWindowIcon(get_icon("configure.png"))
+
+        # Ensures that the config is present on spyder first run
+        CONF.set('main', 'interface_language', load_lang_conf())



Moved here, right at the end of the init :-), should work fine now

@ccordoba12

goanpeca · 2015-05-29T18:11:16Z

Merging :-) @ccordoba12?

ccordoba12 · 2015-05-29T23:45:03Z

Yes!! I'm having a problem with Qt5 but it seems to be with my system rather than with this PR (because I'm also having problems in master :-)

Add support for language selection in preferences

ccordoba12 · 2015-05-29T23:46:27Z

Thanks for your patience by the way ;-)

goanpeca · 2015-05-29T23:49:26Z

No prob ;-)

Ok, @SylvainCorlay, now is your turn :-)

Just add restart=True to the combobox, i.e.

        language_combo = self.create_combobox(_('Language'), choices,
                                              'interface_language',
                                              restart=True)

goanpeca added User Interface (UI) User Experience (UX) labels Apr 22, 2015

goanpeca self-assigned this Apr 22, 2015

goanpeca added this to the v3.0 milestone Apr 22, 2015

goanpeca changed the title ~~Fixes #1001: Add support for language in preferences~~ Fixes #1001: Add support for language selection in preferences Apr 22, 2015

goanpeca added type:Enhancement component:Preferences Spyder-Gui labels Apr 22, 2015

goanpeca changed the title ~~Fixes #1001: Add support for language selection in preferences~~ Add support for language selection in preferences Apr 22, 2015

ccordoba12 reviewed Apr 23, 2015
View reviewed changes

goanpeca added 6 commits May 3, 2015 12:44

Add support for language selection in preferences

f347ebf

Rename LANGCONF file. Minor language display fix.

bdac181

Remove undeed code in preferences manager

3c49cb2

Ask for restart when clicking Apply or Ok only

5d8e05b

Ask for restart only if an option that requires it, is changed

2c7a6a7

Fix docstring

90c2b93

ccordoba12 reviewed May 3, 2015
View reviewed changes

ccordoba12 reviewed May 5, 2015
View reviewed changes

Fix debug_print encoding errors

ea40c03

ccordoba12 reviewed May 13, 2015
View reviewed changes

Create language conf entry on first run

8285af5

goanpeca reviewed May 27, 2015
View reviewed changes

ccordoba12 reviewed May 28, 2015
View reviewed changes

Add lang loading for first spyder run in preferences config dialog

8a3d664

goanpeca reviewed May 29, 2015
View reviewed changes

ccordoba12 added a commit that referenced this pull request May 29, 2015

Merge pull request #2349 from goanpeca/language

79242c4

Add support for language selection in preferences

ccordoba12 merged commit 79242c4 into spyder-ide:master May 29, 2015

ccordoba12 added a commit that referenced this pull request Jun 1, 2015

Fix breakage on Windows after PR #2349

792372f

anderwm mentioned this pull request Jun 5, 2015

Matplotlib Gtk backend is broken in Python consoles #2471

Closed

ccordoba12 mentioned this pull request Jul 13, 2015

Let the user select his/her own localization settings #1394

Closed

Add support for language selection in preferences #2349

Add support for language selection in preferences #2349

Conversation

goanpeca commented Apr 22, 2015

Description

Preferences dialog

Pop up message box

Note:

Todo

For another PR

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goanpeca commented Apr 26, 2015

goanpeca commented May 1, 2015

Nodd commented May 1, 2015

goanpeca commented May 1, 2015

Nodd commented May 1, 2015

goanpeca commented May 2, 2015

goanpeca commented May 3, 2015

ccordoba12 commented May 3, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Nodd commented May 5, 2015

Choose a reason for hiding this comment

ccordoba12 commented May 5, 2015

goanpeca commented May 7, 2015

goanpeca commented May 7, 2015

blink1073 commented May 8, 2015

blink1073 commented May 8, 2015

goanpeca commented May 8, 2015

goanpeca commented May 10, 2015

SylvainCorlay commented May 13, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SylvainCorlay commented May 27, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goanpeca commented May 27, 2015

SylvainCorlay commented May 27, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goanpeca commented May 29, 2015

ccordoba12 commented May 29, 2015

ccordoba12 commented May 29, 2015

goanpeca commented May 29, 2015