Fix whitespaces and typos (#42)

* setup.py (config): This file contained a salad from tabs and spaces.
  I wonder how that even worked -- AFAIK Python 3 blows up with syntax
  error on mixed indents.

  (description): Fix typos in word "graphical".

* snapper-gui.desktop: Remove trailing whitespace.

* snappergui/*.py:

  Conformance to PEP8:
  - Remove redundant parentheses around `if` conditions.
  - Fix whitespaces between classes and methods.
  - Fix whitespaces around start of comments: 2+1 (__#_).
  - Other whitespace and indentation fixes.

  (changesWindow::get_treestore_from_tree::get_childs):
  - Rename inner local function to get_children().
  - Rename argument `tree` to `subtree` to prevent variable shadowing.

  (changesWindow::_on_pathstree_selection_changed): Never compare to
  None though equality (==, !=); only through `is` and `is not`
  operators.

* changesWindow.py (StatusFlags): Align to the right and disable
  PyCharm formatter via comments.

Author: ratijas

setup.py

@@ -2,24 +2,24 @@
     from setuptools import setup
 except ImportError:
     from distutils.core import setup
- 
+
 # from options["setup"] in build.vel
 
 config = {
- 'name': 'snappergui',
- 'version': '0.1',
- 'packages': ['snappergui'],
- 'description': 'snapper-gui grafical user interface for snapper btrfs snapshot manager',
- 'author': 'Ricardo Vieira',
- 'url': 'https://github.com/ricardo-vieira/snapper-gui',
- 'download_url': 'https://github.com/ricardo-vieira/snapper-gui',
- 'author_email': 'ricardo.vieira@ist.utl.pt',
- 'package_data' : {"snappergui": ["glade/*.glade",
- 								"icons/*.svg",
- 								"ui/*.ui"]},
- 'data_files': [ ('share/applications', ['snapper-gui.desktop'])],
- 'entry_points' : { 'gui_scripts' : 
-                    [ 'snapper-gui = snappergui.application:start_ui' ] }
+    'name': 'snappergui',
+    'version': '0.1',
+    'packages': ['snappergui'],
+    'description': 'snapper-gui graphical user interface for snapper btrfs snapshot manager',
+    'author': 'Ricardo Vieira',
+    'url': 'https://github.com/ricardo-vieira/snapper-gui',
+    'download_url': 'https://github.com/ricardo-vieira/snapper-gui',
+    'author_email': 'ricardo.vieira@ist.utl.pt',
+    'package_data': {"snappergui": ["glade/*.glade",
+                                    "icons/*.svg",
+                                    "ui/*.ui"]},
+    'data_files': [('share/applications', ['snapper-gui.desktop'])],
+    'entry_points': {'gui_scripts':
+                         ['snapper-gui = snappergui.application:start_ui']}
 }
 
 setup(**config)

snapper-gui.desktop

@@ -7,4 +7,3 @@ Terminal=false
 Type=Application
 StartupNotify=true
 Categories=Utilities;
-	

snappergui/application.py

@@ -3,12 +3,14 @@
 from snappergui.mainWindow import SnapperGUI
 from snappergui.propertiesDialog import propertiesDialog
 
+
 def start_ui():
     app = Application()
     signal.signal(signal.SIGINT, signal.SIG_DFL)
     exit_status = app.run(sys.argv)
     sys.exit(exit_status)
 
+
 class Application(Gtk.Application):
     def __init__(self):
         Gtk.Application.__init__(self)

snappergui/changesWindow.py

@@ -6,16 +6,18 @@
 class StatusFlags(object):
     """File status flags from https://github.com/openSUSE/snapper/blob/master/snapper/File.h#L39-L51"""
 
-    CREATED = 1        # created
-    DELETED = 2        # deleted
-    TYPE = 4           # type has changed
-    CONTENT = 8        # content has changed
-    PERMISSIONS = 16   # permissions have changed, see chmod(2)
-    OWNER = 32         # owner has changed, see chown(2)
-    USER = 32          # deprecated - alias for OWNER
-    GROUP = 64         # group has changed, see chown(2)
-    XATTRS = 128       # extended attributes changed, see attr(5)
-    ACL = 256          # access control list changed, see acl(5)
+    # @formatter:off
+    CREATED     =   1  # created
+    DELETED     =   2  # deleted
+    TYPE        =   4  # type has changed
+    CONTENT     =   8  # content has changed
+    PERMISSIONS =  16  # permissions have changed, see chmod(2)
+    OWNER       =  32  # owner has changed, see chown(2)
+    USER        =  32  # deprecated - alias for OWNER
+    GROUP       =  64  # group has changed, see chown(2)
+    XATTRS      = 128  # extended attributes changed, see attr(5)
+    ACL         = 256  # access control list changed, see acl(5)
+    # @formatter:on
 
 
 class changesWindow(object):
@@ -30,7 +32,7 @@ def __init__(self, config, begin, end):
         builder.add_from_file(pkg_resources.resource_filename("snappergui",
                                                               "glade/changesWindow.glade"))
 
-        builder.get_object("titlelabel").set_text("%s -> %s"%(begin, end))
+        builder.get_object("titlelabel").set_text("%s -> %s" % (begin, end))
         self.window = builder.get_object("changesWindow")
         self.statusbar = builder.get_object("statusbar1")
         self.pathstreeview = builder.get_object("pathstreeview")
@@ -102,8 +104,9 @@ def file_status_to_string(self, status):
     def get_treestore_from_tree(self, tree):
         # Row: [gtk-stock-icon, file name, file complete path, entry color, tooltip]
         treestore = Gtk.TreeStore(str, str, str, Gdk.RGBA, str)
-        def get_childs(tree, parent=None):
-            for file_name, child in tree.children.items():
+
+        def get_children(subtree, parent=None):
+            for file_name, child in subtree.children.items():
                 color = Gdk.RGBA(0.0, 0.0, 0.0)
                 if child.status & StatusFlags.CREATED:  # Created file
                     color = Gdk.RGBA(0.0, 0.57, 0.0)
@@ -112,14 +115,15 @@ def get_childs(tree, parent=None):
                 elif child.status > 0:  # Modified file
                     color = Gdk.RGBA(0.49, 0.47, 0.0)
 
-                node = treestore.append(parent,[
+                node = treestore.append(parent, [
                     Gtk.STOCK_DIRECTORY if child.is_dir else Gtk.STOCK_FILE,
                     file_name, child.path, color, self.file_status_to_string(child.status)
-                    ])
+                ])
                 # if this child is a directory get childs
                 if child.children is not None:
-                    get_childs(child, node)
-        get_childs(tree)
+                    get_children(child, node)
+
+        get_children(tree)
         return treestore
 
     def on_query_tooltip(self, widget, x, y, keyboard_tip, tooltip):
@@ -135,23 +139,23 @@ def on_query_tooltip(self, widget, x, y, keyboard_tip, tooltip):
                 return False
 
     def on_idle_init_paths_tree(self):
-        snapper.CreateComparison(self.config,self.snapshot_begin,self.snapshot_end)
+        snapper.CreateComparison(self.config, self.snapshot_begin, self.snapshot_end)
 
-        dbus_array = snapper.GetFiles(self.config,self.snapshot_begin,self.snapshot_end)
+        dbus_array = snapper.GetFiles(self.config, self.snapshot_begin, self.snapshot_end)
 
         # create structure to sort paths into tree
         files_tree = changesWindow.TreeNode("/", {}, 0, True)
         for entry in dbus_array:
             self.add_path_to_tree(str(entry[0]), int(entry[1]), files_tree)
 
-        #self.print_tree(files_tree)
+        # self.print_tree(files_tree)
         self.pathstreeview.set_model(self.get_treestore_from_tree(files_tree))
-        #self.pathstreeview.expand_all()
+        # self.pathstreeview.expand_all()
 
         # display in statusbar how many files have changed
-        self.statusbar.push(1,"%d files"%len(dbus_array))
+        self.statusbar.push(1, "%d files" % len(dbus_array))
 
-        snapper.DeleteComparison(self.config,self.snapshot_begin,self.snapshot_end)
+        snapper.DeleteComparison(self.config, self.snapshot_begin, self.snapshot_end)
 
         # we dont want this function to be called anymore
         return False
@@ -167,18 +171,18 @@ def get_lines_from_file(self, path):
             pass
         except PermissionError:
             print("PermissionError")
-            pass # TODO maybe display a dialog with the error?
+            pass  # TODO maybe display a dialog with the error?
         return None
 
     def _on_pathstree_selection_changed(self, selection):
         (model, treeiter) = selection.get_selected()
-        if treeiter != None and model[treeiter] != "":
+        if treeiter is not None and model[treeiter] != "":
             # append file path to snapshot mountpoint
-            fromfile = self.beginpath+model[treeiter][2]
-            tofile = self.endpath+model[treeiter][2]
+            fromfile = self.beginpath + model[treeiter][2]
+            tofile = self.endpath + model[treeiter][2]
 
             fromlines = self.get_lines_from_file(fromfile)
-            if fromlines == None:
+            if fromlines is None:
                 return
             elif fromlines == "":
                 fromfile = "New File"
@@ -187,7 +191,7 @@ def _on_pathstree_selection_changed(self, selection):
                 fromdate = time.ctime(os.stat(fromfile).st_mtime)
 
             tolines = self.get_lines_from_file(tofile)
-            if tolines == None:
+            if tolines is None:
                 return
             elif tolines == "":
                 tofile = "Deleted File"
@@ -198,10 +202,10 @@ def _on_pathstree_selection_changed(self, selection):
             languagemanager = GtkSource.LanguageManager()
             currentview = self.choicesviewgroup.get_action("end").get_current_value()
 
-            if currentview == 0: # show file from begin snapshot
+            if currentview == 0:  # show file from begin snapshot
                 self.sourcebuffer.set_language(languagemanager.get_language("text"))
                 self.sourcebuffer.set_text("".join(fromlines))
-            elif currentview == 1: # show diff of file changes between snapshots
+            elif currentview == 1:  # show diff of file changes between snapshots
                 self.sourcebuffer.set_language(languagemanager.get_language("diff"))
                 difflines = difflib.unified_diff(fromlines,
                                                  tolines,

snappergui/createConfig.py

@@ -2,8 +2,10 @@
 import pkg_resources
 from gi.repository import Gtk
 
+
 class createConfig(object):
     """docstring for createConfig"""
+
     def __init__(self, parent):
         super(createConfig, self).__init__()
         builder = Gtk.Builder()
@@ -21,20 +23,19 @@ def __init__(self, parent):
         builder.get_object("fsTypeCombo").set_active(0)
 
     def on_name_changed(self, widget):
-        self.name = widget.get_chars(0,-1)
+        self.name = widget.get_chars(0, -1)
 
     def on_subvolume_changed(self, widget):
-        self.subvolume = widget.get_chars(0,-1)
+        self.subvolume = widget.get_chars(0, -1)
 
     def on_fstype_changed(self, widget):
         self.fstype = widget.get_active_text()
 
     def on_template_changed(self, widget):
-        self.template = widget.get_chars(0,-1)
+        self.template = widget.get_chars(0, -1)
 
     def run(self):
         return self.dialog.run()
 
     def destroy(self):
         self.dialog.destroy()
-

snappergui/createSnapshot.py

@@ -2,6 +2,7 @@
 import pkg_resources
 from gi.repository import Gtk, Gdk
 
+
 class createSnapshot(object):
     TYPE_HERE = "<Type here>"
 
@@ -34,8 +35,6 @@ def __init__(self, parent, config_name):
 
         builder.get_object("cleanupcombo").set_active(0)
 
-
-
     def on_config_changed(self,widget):
         self.config = widget.get_model()[widget.get_active()][0]
 
@@ -66,7 +65,6 @@ def _on_name_edited(self, renderer, path, new_text):
         else:
             userdatamodel[path][0] = new_text
 
-
     def _on_value_edited(self, renderer, path, new_text):
         userdatamodel = self.userdataTree.get_model()
         userdatamodel[path][1] = new_text

snappergui/deleteDialog.py

@@ -6,6 +6,7 @@
 
 class deleteDialog(object):
     """docstring for deleteDialog"""
+
     def __init__(self, parent, config, snapshots):
         super(deleteDialog, self).__init__()
         builder = Gtk.Builder()
@@ -21,21 +22,21 @@ def __init__(self, parent, config, snapshots):
         self.to_delete = snapshots
 
         parents = []
-        self.deleteTreeStore = Gtk.TreeStore(bool, int, str,  str)
+        self.deleteTreeStore = Gtk.TreeStore(bool, int, str, str)
         for snapshot in snapshots:
-            snapinfo = snapper.GetSnapshot(config,snapshot)
-            #self.deleteTreeStore.append(self.get_row(snapinfo))
-            if (snapinfo[1] == 1): # Pre Snapshot
+            snapinfo = snapper.GetSnapshot(config, snapshot)
+            # self.deleteTreeStore.append(self.get_row(snapinfo))
+            if snapinfo[1] == 1:  # Pre snapshot
                 parents.append(self.deleteTreeStore.append(None, self.get_row(snapinfo)))
-            elif (snapinfo[1] == 2): # Post snappshot
+            elif snapinfo[1] == 2:  # Post snapshot
                 parent_node = None
                 for parent in parents:
-                    if (self.deleteTreeStore.get_value(parent, 1) == snapinfo[2]):
+                    if self.deleteTreeStore.get_value(parent, 1) == snapinfo[2]:
                         parent_node = parent
                         break
-                self.deleteTreeStore.append(parent_node, )
+                self.deleteTreeStore.append(parent_node)
             else:  # Single snapshot
-                self.deleteTreeStore.append(None , self.get_row(snapinfo))
+                self.deleteTreeStore.append(None, self.get_row(snapinfo))
         self.deletetreeview.set_model(self.deleteTreeStore)
         self.deletetreeview.expand_all()
 
@@ -47,13 +48,13 @@ def run(self):
         self.dialog.destroy()
         return response
 
-    def on_toggle_delete_snapshot(self,widget,path):
+    def on_toggle_delete_snapshot(self, widget, path):
         treeiter = self.deleteTreeStore.get_iter(path)
         self.deleteTreeStore.set_value(treeiter,
                                        False,
-                                       not(self.deleteTreeStore.get_value(treeiter, False)))
+                                       not (self.deleteTreeStore.get_value(treeiter, False)))
         snapshot_num = self.deleteTreeStore.get_value(treeiter, True)
-        if self.deleteTreeStore.get_value(treeiter,False):
+        if self.deleteTreeStore.get_value(treeiter, False):
             if snapshot_num not in self.to_delete:
                 self.to_delete.append(snapshot_num)
         else: