Implementing "Save Config"

Author: s-n-g

Changelog

@@ -1,5 +1,6 @@
-2019-03-30  s-n-g
+2019-04-16  s-n-g
     * Minimum python version supported changed. Now it's 2.7+/3.5+
+    * Added configuration window (opens with "c").
 
 2019-02-14  s-n-g
 

README.html

@@ -106,14 +106,16 @@ <h2 id="controls">Controls</h2>
 o s R             Open / Save / Reload playlist             -                                  -
 DEL,x             Delete selected station                   -                                  -
 t T               Load theme / Toggle transparency          [Valid]                            [Valid]
+c                 Open Configuration window.                -                                  -
 ?                 Show keys help                            [Valid]                            [Valid]
 #                 Redraw window                             [Valid]                            [Valid]
 Esc/q             Quit                                      -                                  -
 Esc/q/Left/h      -                                         Cancel / close window              Cancel / close window</pre>
 <h2 id="config-file">Config file</h2>
 <p><strong>PyRadio</strong> upon its execution tries to read its configuration file (i.e. <em>~/.config/pyradio/config</em>). If this file is not found, it will be created. If an error occurs while parsing it, an error message will be displayed and <strong><em>PyRadio</em></strong> will terminate.</p>
 <p>The file contains parameters such as the player to use, the playlist to load etc. It is heavily commented (as you can see <a href="pyradio/config">here</a>), so that manual editing is really easy. The best practice to manually edit this file is executing <strong><em>PyRadio</em></strong> with the <strong>-ocd</strong> command line option, which will open the configuration directory in your file manager, and then edit it using your preferable text editor.</p>
-<p>The file can also be altered while <strong>PyRadio</strong> is running. This process is transparent to the user; <strong>PyRadio</strong> will save the file before exiting (or in case Ctrl-C is pressed) if needed (e.g. if a config parameter has been changed during its execution).</p>
+<p>The file can also be altered while <strong>PyRadio</strong> is running by pressing “<strong><em>c</em></strong>”, which will open the “<strong><em>Configuration window</em></strong>”. This window presents all <strong>PyRadio</strong> options and provide the way to change them.</p>
+<p>In any case, <strong>PyRadio</strong> will save the file before exiting (or in case Ctrl-C is pressed) if needed (e.g. if a config parameter has been changed during its execution).</p>
 <h2 id="about-playlist-files">About Playlist files</h2>
 <p><strong>PyRadio</strong> reads the stations to use from a CSV file, where each line contains two columns, the first being the station name and the second being the stream URL.</p>
 <p>Optionally, a third column can be inserted, stating the encoding used by the station (more on this at <a href="#specifying-stations-encoding">Specifying stations’ encoding</a>).</p>

README.md

@@ -91,6 +91,7 @@ v                 Save volume (not applicable for vlc)      [Valid]
 o s R             Open / Save / Reload playlist             -                                  -
 DEL,x             Delete selected station                   -                                  -
 t T               Load theme / Toggle transparency          [Valid]                            [Valid]
+c                 Open Configuration window.                -                                  -
 ?                 Show keys help                            [Valid]                            [Valid]
 #                 Redraw window                             [Valid]                            [Valid]
 Esc/q             Quit                                      -                                  -
@@ -103,7 +104,9 @@ Esc/q/Left/h      -                                         Cancel / close windo
 
 The file contains parameters such as the player to use, the playlist to load etc. It is heavily commented (as you can see [here](pyradio/config)), so that manual editing is really easy. The best practice to manually edit this file is executing ***PyRadio*** with the **-ocd** command line option, which will open the configuration directory in your file manager, and then edit it using your preferable text editor.
 
-The file can also be altered while **PyRadio** is running. This process is transparent to the user; **PyRadio** will save the file before exiting (or in case Ctrl-C is pressed) if needed (e.g. if a config parameter has been changed during its execution).
+The file can also be altered while **PyRadio** is running by pressing "***c***", which will open the "***Configuration window***". This window presents all **PyRadio** options and provide the way to change them.
+
+In any case, **PyRadio** will save the file before exiting (or in case Ctrl-C is pressed) if needed (e.g. if a config parameter has been changed during its execution).
 
 ## About Playlist files
 

pyradio.1

@@ -1,7 +1,7 @@
 .\" Copyright (C) 2011 Ben Dowling <http://www.coderholic.com/pyradio>
 .\" This manual is freely distributable under the terms of the GPL.
 .\"
-.TH PYRADIO 1 "March 2019"
+.TH PYRADIO 1 "April 2019"
 
 .SH NAME
 .PP
@@ -86,7 +86,9 @@ Quit
 
 The file contains parameters such as the player to use, the playlist to load etc. It is heavily commented, so that manual editing is really easy. The best practice to manually edit this file is executing \fBpyradio\fR with the \fB-ocd\fR command line option, which will open the configuration directory in your file manager, and then edit it using your preferable text editor.
 
-The file can also be altered while \fBpyradio\fR is running. This process is transparent to the user; \fBpyradio\fR will save the file before exiting (or in case Ctrl-C is pressed) if needed (e.g. if a config parameter has been changed during its execution).
+The file can also be altered while \fBpyradio\fR is running, by pressing "\fIc\fR", which will open the "\fIConfiguration window\fR". This window presents all \fBpyradio\fR options and provide the way to change them.
+
+In any case, \fBpyradio\fR will save the file before exiting (or in case Ctrl-C is pressed) if needed (e.g. if a config parameter has been changed during its execution).
 
 .SH ABOUT PLAYLIST FILES
 .PP

pyradio/config_window.py

@@ -295,6 +295,10 @@ def keypress(self, char):
                 """ ESCAPE """
                 return 1, []
         elif char in (ord('s'), ):
+            self._saved_config_options = deepcopy(self._config_options)
+            if self._cnf.opts != self._saved_config_options:
+                self._cnf.opts = deepcopy(self._config_options)
+                self._cnf.dirty_config = True
             # save and exit
             return 0, [1]
         elif char in (curses.KEY_ENTER, ord('\n'),

pyradio/radio.py

@@ -828,7 +828,7 @@ def _print_help(self):
                      o s R            ||O|pen / |S|ave / |R|eload playlist.
                      DEL|,|x            |Delete selected station.
                      t T              |Load |t|heme / |T|oggle transparency.
-                     c                |Configuration.
+                     c                |Open Configuration window.
                      Esc|/|q            |Quit. """
             self._show_help(txt)
             if logger.isEnabledFor(logging.DEBUG):
@@ -1414,6 +1414,7 @@ def keypress(self, char):
                     self.bodyWin.box()
                     self._print_body_header()
                     self.refreshBody()
+                    self.cnf._save_config()
                     # clean up
                     self._player_select_win = None
                     self._encoding_select_win = None