Merge PR 1253 into v0.6

src/bmconfigparser.py

@@ -1,10 +1,14 @@
+"""
+BMConfigParser class definition and default configuration settings
+"""
+
 import ConfigParser
-import datetime
 import shutil
 import os
+from datetime import datetime
 
-from singleton import Singleton
 import state
+from singleton import Singleton
 
 BMConfigDefaults = {
     "bitmessagesettings": {
@@ -36,23 +40,30 @@ BMConfigDefaults = {
     }
 }
 
+
 @Singleton
 class BMConfigParser(ConfigParser.SafeConfigParser):
+    """Singleton class inherited from ConfigParser.SafeConfigParser
+    with additional methods specific to bitmessage config."""
+
     def set(self, section, option, value=None):
         if self._optcre is self.OPTCRE or value:
             if not isinstance(value, basestring):
                 raise TypeError("option values must be strings")
         if not self.validate(section, option, value):
-            raise ValueError("Invalid value %s" % str(value))
+            raise ValueError("Invalid value %s" % value)
         return ConfigParser.ConfigParser.set(self, section, option, value)
 
     def get(self, section, option, raw=False, variables=None):
         try:
             if section == "bitmessagesettings" and option == "timeformat":
-                return ConfigParser.ConfigParser.get(self, section, option, raw, variables)
-            return ConfigParser.ConfigParser.get(self, section, option, True, variables)
+                return ConfigParser.ConfigParser.get(
+                    self, section, option, raw, variables)
+            return ConfigParser.ConfigParser.get(
+                self, section, option, True, variables)
         except ConfigParser.InterpolationError:
-            return ConfigParser.ConfigParser.get(self, section, option, True, variables)
+            return ConfigParser.ConfigParser.get(
+                self, section, option, True, variables)
         except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) as e:
             try:
                 return BMConfigDefaults[section][option]
@@ -62,51 +73,62 @@ class BMConfigParser(ConfigParser.SafeConfigParser):
     def safeGetBoolean(self, section, field):
         try:
             return self.getboolean(section, field)
-        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError, ValueError, AttributeError):
+        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError,
+                ValueError, AttributeError):
             return False
 
     def safeGetInt(self, section, field, default=0):
         try:
             return self.getint(section, field)
-        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError, ValueError, AttributeError):
+        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError,
+                ValueError, AttributeError):
             return default
 
-    def safeGet(self, section, option, default = None):
+    def safeGet(self, section, option, default=None):
         try:
             return self.get(section, option)
-        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError, ValueError, AttributeError):
+        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError,
+                ValueError, AttributeError):
             return default
 
     def items(self, section, raw=False, variables=None):
         return ConfigParser.ConfigParser.items(self, section, True, variables)
 
     def addresses(self):
-        return filter(lambda x: x.startswith('BM-'), BMConfigParser().sections())
+        return filter(
+            lambda x: x.startswith('BM-'), BMConfigParser().sections())
 
     def read(self, filenames):
         ConfigParser.ConfigParser.read(self, filenames)
         for section in self.sections():
             for option in self.options(section):
                 try:
-                    if not self.validate(section, option, ConfigParser.ConfigParser.get(self, section, option)):
+                    if not self.validate(
+                        section, option,
+                        ConfigParser.ConfigParser.get(self, section, option)
+                    ):
                         try:
                             newVal = BMConfigDefaults[section][option]
                         except KeyError:
                             continue
-                        ConfigParser.ConfigParser.set(self, section, option, newVal)
+                        ConfigParser.ConfigParser.set(
+                            self, section, option, newVal)
                 except ConfigParser.InterpolationError:
                     continue
 
     def save(self):
         fileName = os.path.join(state.appdata, 'keys.dat')
-        fileNameBak = fileName + "." + datetime.datetime.now().strftime("%Y%j%H%M%S%f") + '.bak'
-        # create a backup copy to prevent the accidental loss due to the disk write failure
+        fileNameBak = '.'.join([
+            fileName, datetime.now().strftime("%Y%j%H%M%S%f"), 'bak'])
+        # create a backup copy to prevent the accidental loss due to
+        # the disk write failure
         try:
             shutil.copyfile(fileName, fileNameBak)
             # The backup succeeded.
             fileNameExisted = True
         except (IOError, Exception):
-            # The backup failed. This can happen if the file didn't exist before.
+            # The backup failed. This can happen if the file
+            # didn't exist before.
             fileNameExisted = False
         # write the file
         with open(fileName, 'wb') as configfile:
@@ -117,7 +139,7 @@ class BMConfigParser(ConfigParser.SafeConfigParser):
 
     def validate(self, section, option, value):
         try:
-            return getattr(self, "validate_%s_%s" % (section, option))(value)
+            return getattr(self, 'validate_%s_%s' % (section, option))(value)
         except AttributeError:
             return True