Version 0.7.5

- Adding loading default options to config window
- Trasnparency and Theme settings will not be automatically saved in
  Config window
- Canceling theme selection will restore saved theme (not in config)
- Adding empty space around Config second level Help windows
- Done a bit of refactoring
- Updating docs

Author: s-n-g

Changelog

@@ -1,6 +1,9 @@
-2019-04-16  s-n-g
+2019-04-18  s-n-g
+    * Version 0.7.5
     * Minimum python version supported changed. Now it's 2.7+/3.5+
     * Added configuration window (opens with "c").
+    * Canceling theme selection (not in config) will restore saved theme.
+    * Done a bit of refactoring.
 
 2019-02-14  s-n-g
 

README.html

@@ -116,8 +116,9 @@ <h2 id="controls">Controls</h2>
 <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 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>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 and finally save them by pressing “<strong><em>s</em></strong>”.</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>
+<p>If saving the configuration file fails, <strong>PyRadio</strong> will create a back up file and terminate. When restarted, <strong>PyRadio</strong> will try to restore previously used settings from the said back up file.</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>
@@ -185,17 +186,9 @@ <h3 id="global-encoding-declaration">Global encoding declaration</h3>
 <p>Setting this parameter to a different encoding, will permit <strong>PyRadio</strong> to successfully decode such stations.</p>
 <p>This would be useful in the case where most of your stations do not use <strong>utf-8</strong>. Instead of editing the playlist and add the encoding to each and every affected station, you just set it globally.</p>
 <h3 id="finding-the-right-encoding">Finding the right encoding</h3>
-<p>A valid encoding list can be found (depends on python version):</p>
-<ul>
-<li><a href="https://docs.python.org/2.3/lib/node130.html">https://docs.python.org/2.3/lib/node130.html</a></p></li>
-<li><a href="https://docs.python.org/2.4/lib/standard-encodings.html">https://docs.python.org/2.4/lib/standard-encodings.html</a></p></li>
-<li><a href="https://docs.python.org/2.5/lib/standard-encodings.html">https://docs.python.org/2.5/lib/standard-encodings.html</a></p></li>
-</ul>
-<p>Or use this URL</p>
-<ul>
-<li><a href="https://docs.python.org/2.6/library/codecs.html#standard-encodings">https://docs.python.org/2.6/library/codecs.html#standard-encodings</a></li>
-</ul>
-<p>replacing <strong>2.6</strong> with specific version: <strong>2.7</strong>, <strong>3.0</strong> up to current python version.</p>
+<p>A valid encoding list can be found at:</p>
+<p><a href="https://docs.python.org/2.7/library/codecs.html#standard-encodings">https://docs.python.org/2.7/library/codecs.html#standard-encodings</a></p>
+<p>replacing <strong>2.7</strong> with specific version: <strong>3.0</strong> up to current python version.</p>
 <h2 id="player-detection-selection">Player detection / selection</h2>
 <p><strong>PyRadio</strong> is basically built around the existence of a valid media player it can use. Thus, it will auto detect the existence of its supported players upon its execution.</p>
 <p>Currently, it supports MPV, MPlayer and VLC, and it will look for them in that order. If none of them is found, the program will terminate with an error.</p>

README.md

@@ -109,10 +109,12 @@ The same logic applies to all **PyRadio** windows.
 
 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 by pressing "***c***", which will open the "***Configuration window***". This window presents all **PyRadio** options and provide the way to change them.
+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 and finally save them by pressing "***s***".
 
 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).
 
+If saving the configuration file fails, **PyRadio** will create a back up file and terminate. When restarted, **PyRadio** will try to restore previously used settings from the said back up file.
+
 ## About Playlist files
 
 **PyRadio** 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.
@@ -247,19 +249,11 @@ This would be useful in the case where most of your stations do not use **utf-8*
 
 ### Finding the right encoding
 
-A valid encoding list can be found (depends on python version):
-
-* [https://docs.python.org/2.3/lib/node130.html](https://docs.python.org/2.3/lib/node130.html)
-
-* [https://docs.python.org/2.4/lib/standard-encodings.html](https://docs.python.org/2.4/lib/standard-encodings.html)
-
-* [https://docs.python.org/2.5/lib/standard-encodings.html](https://docs.python.org/2.5/lib/standard-encodings.html)
-
-Or use this URL
+A valid encoding list can be found at:
 
-* [https://docs.python.org/2.6/library/codecs.html#standard-encodings](https://docs.python.org/2.6/library/codecs.html#standard-encodings)
+[https://docs.python.org/2.7/library/codecs.html#standard-encodings](https://docs.python.org/2.7/library/codecs.html#standard-encodings)
 
-replacing **2.6** with specific version: **2.7**, **3.0** up to current python version.
+replacing **2.7** with specific version: **3.0** up to current python version.
 
 
 ## Player detection / selection

pyradio.1

@@ -92,10 +92,12 @@ All windows support changing the volume and muting / unmuting the player (provid
 
 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, 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.
+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 and finally save them by pressing "\fIs\fR".
 
 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).
 
+If saving the configuration file fails, \fBpyradio\fR will create a back up file and terminate. When restarted, \fBpyradio\fR will try to restore previously used settings from the said back up file.
+
 .SH ABOUT PLAYLIST FILES
 .PP
 \fBpyradio\fR 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.
@@ -262,26 +264,11 @@ This would be useful in the case where most of your stations do not use \fIutf-8
 .B
 FINDING THE RIGHT ENCODING
 
-A valid encoding list can be found (depends on python version):
-
-.HP
-
-\fIhttps://docs.python.org/2.3/lib/node130.html
-
-https://docs.python.org/2.4/lib/standard-encodings.html
-
-https://docs.python.org/2.5/lib/standard-encodings.html
+A valid encoding list can be found at:
 
-.PP
-
-Or use this URL
-
-.HP
-
-\fIhttps://docs.python.org/2.6/library/codecs.html#standard-encodings
+\fIhttps://docs.python.org/2.7/library/codecs.html#standard-encodings
 
-.PP
-replacing \fI2.6\fR with specific version: \fI2.7\fR, \fI3.0\fR up to current python version.
+\fRreplacing \fI2.7\fR with specific version: \fI3.0\fR up to current python version.
 
 .SH PLAYER DETECTION / SELECTION
 .PP

pyradio/__init__.py

@@ -1,6 +1,6 @@
 " pyradio -- Console radio player. "
 
-version_info = (0, 7, 4)
+version_info = (0, 7, 5)
 
 __version__ = version = '.'.join(map(str, version_info))
 __project__ = __name__

pyradio/common.py

@@ -15,8 +15,8 @@
 ASK_TO_SAVE_PLAYLIST_MODE = 52
 MAIN_HELP_MODE = 100
 PLAYLIST_HELP_MODE = 101
-THEME_HELP_MODE = 102
-CONFIG_HELP_MODE = 103
+CONFIG_HELP_MODE = 102
+THEME_HELP_MODE = 103
 SELECT_PLAYER_HELP_MODE = 104
 SELECT_ENCODING_HELP_MODE = 105
 SELECT_PLAYLIST_HELP_MODE = 106
@@ -31,6 +31,7 @@
 FOREIGN_PLAYLIST_ASK_MODE = 300
 FOREIGN_PLAYLIST_MESSAGE_MODE = 301
 FOREIGN_PLAYLIST_COPY_ERROR_MODE = 302
+CONFIG_SAVE_ERROR_MODE = 303
 THEME_MODE = 400
 NOT_IMPLEMENTED_YET_MODE = 1000
 

pyradio/config

@@ -19,23 +19,19 @@ default_playlist = stations
 # Default station
 # This is the equivalent to the -p , --play command line parameter
 # The station number within the default playlist to play
-# Value is 1..number of stations, -1 means no auto play
-# "0" or "random" means play a random station
-default_station = -1
+# Value is 1..number of stations, "-1" or "False" means no auto play,
+# "0" or "Random" means play a random station
+default_station = False
 
 # Default encoding
 # This is the encoding used by default when reading data provided by
 # a station (such as song title, etc.) If reading said data ends up
 # in an error, 'utf-8' will be used instead.
 #
-# A valid encoding list can be found (depends on python version):
-#   https://docs.python.org/2.3/lib/node130.html
-#   https://docs.python.org/2.4/lib/standard-encodings.html
-#   https://docs.python.org/2.5/lib/standard-encodings.html
-# Or use this URL
-#   https://docs.python.org/2.6/library/codecs.html#standard-encodings
-# replacing 2.6 with specific version:
-#   2.7, 3.0 up to current python version.
+# A valid encoding list can be found at:
+#   https://docs.python.org/2.7/library/codecs.html#standard-encodings
+# replacing 2.7 with specific version:
+#   3.0 up to current python version.
 #
 # Default value: utf-8
 default_encoding = utf-8

pyradio/config.py

@@ -552,10 +552,8 @@ def theme(self):
 
     @theme.setter
     def theme(self, val):
-        logger.info('{}, {}'.format(self.opts['theme'], self.opts['dirty_config']))
         self.opts['theme'][1] = val
         self.opts['dirty_config'][1] = True
-        logger.info('{}, {}'.format(self.opts['theme'], self.opts['dirty_config']))
 
     @property
     def dirty_config(self):
@@ -611,7 +609,7 @@ def read_config(self):
                 st = sp[1].strip()
                 if st == '-1' or st.lower() == 'false':
                     self.opts['default_station'][1] = 'False'
-                elif st == 'random':
+                elif st == "0" or st == 'random':
                     self.opts['default_station'][1] = None
                 else:
                     self.opts['default_station'][1] = st
@@ -638,11 +636,18 @@ def read_config(self):
         self.opts['dirty_config'][1] = False
         return 0
 
-    def _save_config(self):
+    def save_config(self):
+        """ Save config file
+
+            Creates config.restore (back up file)
+            Returns:
+                -1: Error saving config
+                 0: Config saved successfully
+                 1: Config not saved (not modified"""
         if not self.opts['dirty_config'][1]:
             if logger.isEnabledFor(logging.INFO):
                 logger.info('Config not saved (not modified)')
-            return 0
+            return 1
         txt ='''# PyRadio Configuration File
 
 # Player selection
@@ -666,24 +671,20 @@ def _save_config(self):
 # Default station
 # This is the equivalent to the -p , --play command line parameter
 # The station number within the default playlist to play
-# Value is 0..number of stations, -1 means no auto play
-# "random" means play a random station
-# Default value: -1
+# Value is 1..number of stations, "-1" or "False" means no auto play
+# "0" or "Random" means play a random station
+# Default value: False
 default_station = {2}
 
 # Default encoding
 # This is the encoding used by default when reading data provided by
 # a station (such as song title, etc.) If reading said data ends up
 # in an error, 'utf-8' will be used instead.
 #
-# A valid encoding list can be found (depends on python version):
-#   https://docs.python.org/2.3/lib/node130.html
-#   https://docs.python.org/2.4/lib/standard-encodings.html
-#   https://docs.python.org/2.5/lib/standard-encodings.html
-# Or use this URL
-#   https://docs.python.org/2.6/library/codecs.html#standard-encodings
-# replacing 2.6 with specific version:
-#   2.7, 3.0 up to current python version.
+# A valid encoding list can be found at:
+#   https://docs.python.org/2.7/library/codecs.html#standard-encodings
+# replacing 2.7 with specific version:
+#   3.0 up to current python version.
 #
 # Default value: utf-8
 default_encoding = {3}
@@ -768,6 +769,7 @@ def _save_config(self):
             pass
         if logger.isEnabledFor(logging.INFO):
             logger.info('Config saved')
+        self.opts['dirty_config'][1] = False
         return 0
 
     def read_playlist_file(self, stationFile=''):