refactor!: Remove tools.syncfs() (bit-team#1698)

Was used in shutdown() only. Shutodwn cause an unmount which itself cause synfs on OS level. No need for BIT to do it explicit. Behavior of BIT do not change.

Additionally minor PEP8 improvements.

Close bit-team#1685

Author: buhtz

common/test/test_tools.py

@@ -430,9 +430,6 @@ def test_filesystemMountInfo(self):
         self.assertIn('/', mounts)
         self.assertIn('original_uuid', mounts.get('/'))
 
-    def test_syncfs(self):
-        self.assertTrue(tools.syncfs())
-
     def test_isRoot(self):
         self.assertIsInstance(tools.isRoot(), bool)
 

common/tools.py

@@ -89,6 +89,7 @@
 # | Handling paths  |
 # |-----------------|
 
+
 def sharePath():
     """Get path where Back In Time is installed.
 
@@ -111,6 +112,7 @@ def sharePath():
 
     return '/usr/share'
 
+
 def backintimePath(*path):
     """
     Get path inside 'backintime' install folder.
@@ -349,9 +351,11 @@ def registerBackintimePath(*path):
         would need this to actually import :py:mod:`tools`.
     """
     path = backintimePath(*path)
-    if not path in sys.path:
+
+    if path not in sys.path:
         sys.path.insert(0, path)
 
+
 def runningFromSource():
     """
     Check if BackInTime is running from source (without installing).
@@ -361,14 +365,16 @@ def runningFromSource():
     """
     return os.path.isfile(backintimePath('common', 'backintime'))
 
+
 def addSourceToPathEnviron():
     """
     Add 'backintime/common' path to 'PATH' environ variable.
     """
     source = backintimePath('common')
     path = os.getenv('PATH')
     if path and source not in path.split(':'):
-        os.environ['PATH'] = '%s:%s' %(source, path)
+        os.environ['PATH'] = '%s:%s' % (source, path)
+
 
 def get_git_repository_info(path=None, hash_length=None):
     """Return the current branch and last commit hash.
@@ -456,6 +462,7 @@ def readFile(path, default=None):
 
     return ret_val
 
+
 def readFileLines(path, default = None):
     """
     Read the file in ``path`` or its '.gz' compressed variant and return its
@@ -484,6 +491,7 @@ def readFileLines(path, default = None):
 
     return ret_val
 
+
 def checkCommand(cmd):
     """
     Check if command ``cmd`` is a file in 'PATH' environ.
@@ -501,8 +509,10 @@ def checkCommand(cmd):
 
     if os.path.isfile(cmd):
         return True
+
     return not which(cmd) is None
 
+
 def which(cmd):
     """
     Get the fullpath of executable command ``cmd``. Works like
@@ -518,14 +528,19 @@ def which(cmd):
     pathenv = os.getenv('PATH', '')
     path = pathenv.split(":")
     common = backintimePath('common')
+
     if runningFromSource() and common not in path:
         path.insert(0, common)
+
     for directory in path:
         fullpath = os.path.join(directory, cmd)
+
         if os.path.isfile(fullpath) and os.access(fullpath, os.X_OK):
             return fullpath
+
     return None
 
+
 def makeDirs(path):
     """
     Create directories ``path`` recursive and return success.
@@ -542,15 +557,19 @@ def makeDirs(path):
 
     if os.path.isdir(path):
         return True
+
     else:
+
         try:
             os.makedirs(path)
         except Exception as e:
             logger.error("Failed to make dirs '%s': %s"
-                         %(path, str(e)), traceDepth = 1)
+                         % (path, str(e)), traceDepth=1)
+
     return os.path.isdir(path)
 
-def mkdir(path, mode = 0o755, enforce_permissions = True):
+
+def mkdir(path, mode=0o755, enforce_permissions=True):
     """
     Create directory ``path``.
 
@@ -567,14 +586,18 @@ def mkdir(path, mode = 0o755, enforce_permissions = True):
                 os.chmod(path, mode)
         except:
             return False
+
         return True
+
     else:
         os.mkdir(path, mode)
+
         if mode & 0o002 == 0o002:
-            #make file world (other) writable was requested
-            #debian and ubuntu won't set o+w with os.mkdir
-            #this will fix it
+            # make file world (other) writable was requested
+            # debian and ubuntu won't set o+w with os.mkdir
+            # this will fix it
             os.chmod(path, mode)
+
     return os.path.isdir(path)
 
 
@@ -1105,6 +1128,7 @@ def checkCronPattern(s):
     except ValueError:
         return False
 
+
 #TODO: check if this is still necessary
 def checkHomeEncrypt():
     """
@@ -1131,6 +1155,7 @@ def checkHomeEncrypt():
                 return True
     return False
 
+
 def envLoad(f):
     """
     Load environ variables from file ``f`` into current environ.
@@ -1150,6 +1175,7 @@ def envLoad(f):
             os.environ[key] = value
     del(env_file)
 
+
 def envSave(f):
     """
     Save environ variables to file that are needed by cron
@@ -1169,6 +1195,7 @@ def envSave(f):
 
     env_file.save(f)
 
+
 def keyringSupported():
     """
     Checks if a keyring (supported by BiT) is available
@@ -1275,12 +1302,14 @@ def password(*args):
         return keyring.get_password(*args)
     return None
 
+
 def setPassword(*args):
 
     if is_keyring_available:
         return keyring.set_password(*args)
     return False
 
+
 def mountpoint(path):
     """
     Get the mountpoint of ``path``. If your HOME is on a separate partition
@@ -1318,6 +1347,7 @@ def repl(m):
         return chr(int(m.group(1), 8))
     return re.sub(r'\\(\d{3})', repl, s)
 
+
 def mountArgs(path):
     """
     Get all /etc/mtab args for the filesystem of ``path`` as a list.
@@ -1544,16 +1574,6 @@ def filesystemMountInfo():
                 if uuidFromDev(items[0]) != None}
 
 
-def syncfs():
-    """
-    Sync any data buffered in memory to disk.
-
-    Returns:
-        bool:   ``True`` if successful
-    """
-    if checkCommand('sync'):
-        return(Execute(['sync']).run() == 0)
-
 def isRoot():
     """
     Check if we are root.
@@ -1887,6 +1907,7 @@ def fdDup(old, new_fd, mode = 'w'):
     except OSError as e:
         logger.debug('Failed to redirect {}: {}'.format(old, str(e)))
 
+
 class UniquenessSet:
     """
     Check for uniqueness or equality of files.
@@ -2003,6 +2024,7 @@ def checkEqual(self, path):
         else:
             return self.reference == (st.st_size, int(st.st_mtime))
 
+
 class Alarm(object):
     """
     Establish a callback function that is called after a timeout.
@@ -2078,6 +2100,7 @@ def handler(self, signum, frame):
         else:
             self.callback()
 
+
 class ShutDown(object):
     """
     Shutdown the system after the current snapshot has finished.
@@ -2237,7 +2260,6 @@ def shutdown(self):
             return(False)
 
         if self.is_root:
-            syncfs()
             self.started = True
             proc = subprocess.Popen(['shutdown', '-h', 'now'])
             proc.communicate()
@@ -2247,7 +2269,6 @@ def shutdown(self):
             return(False)
 
         else:
-            syncfs()
             self.started = True
 
             return(self.proxy(*self.args))
@@ -2343,6 +2364,7 @@ def clean(self):
             return
         self.iface.clean()
 
+
 class PathHistory(object):
     def __init__(self, path):
         self.history = [path,]
@@ -2377,6 +2399,7 @@ def reset(self, path):
         self.history = [path,]
         self.index = 0
 
+
 class OrderedSet(MutableSet):
     """
     OrderedSet from Python recipe
@@ -2438,6 +2461,7 @@ def __eq__(self, other):
             return len(self) == len(other) and list(self) == list(other)
         return set(self) == set(other)
 
+
 class Execute(object):
     """
     Execute external commands and handle its output.
@@ -2643,6 +2667,7 @@ def kill(self, signum, frame):
             logger.info('Kill process "%s"' %self.printable_cmd, self.parent, 2)
             return self.currentProc.kill()
 
+
 class Daemon:
     """
     A generic daemon class.