Merge pull request #198 from timvaillancourt/flake8_fixes_v0

Flake8 fixes

Author: dbmurphy

Makefile

@@ -22,6 +22,10 @@ install: bin/mongodb-consistent-backup
 	install -m 0644 LICENSE $(SHAREDIR)/$(NAME)/LICENSE
 	install -m 0644 README.rst $(SHAREDIR)/$(NAME)/README.rst
 
+flake8:
+	# Ignore long-lines and space-aligned = and : for now
+	flake8 --ignore E221,E241,E501 $(PWD)/$(NAME)
+
 uninstall:
 	rm -f $(BINDIR)/mongodb-consistent-backup
 	rm -rf $(SHAREDIR)/$(NAME)

README.rst

@@ -218,6 +218,12 @@ Roadmap
 -  Documentation for running under Docker with persistent volumes
 -  Python unit tests
 
+Submitting Code
+~~~~~~~~~~~~~~~
+
+-  Submitted code must pass Python `'flake8' <https://pypi.python.org/pypi/flake8>`__ checks. Run *'make flake8'* to test.
+-  To make review easier, pull requests must address and solve one problem at a time.
+
 Links
 ~~~~~
 

mongodb_consistent_backup/Archive/Archive.py

@@ -1,5 +1,3 @@
-from mongodb_consistent_backup.Archive.Tar import Tar
-from mongodb_consistent_backup.Archive.Zbackup import Zbackup
 from mongodb_consistent_backup.Pipeline import Stage
 
 

mongodb_consistent_backup/Archive/Tar/Tar.py

@@ -7,7 +7,6 @@
 from types import MethodType
 
 from TarThread import TarThread
-from mongodb_consistent_backup.Common import parse_method
 from mongodb_consistent_backup.Errors import Error, OperationError
 from mongodb_consistent_backup.Pipeline import Task
 
@@ -19,6 +18,7 @@ def _reduce_method(m):
     else:
         return getattr, (m.im_self, m.im_func.func_name)
 
+
 pickle(MethodType, _reduce_method)
 
 

mongodb_consistent_backup/Archive/Tar/TarThread.py

@@ -28,20 +28,20 @@ def run(self):
         if os.path.isdir(self.backup_dir):
             if not os.path.isfile(self.output_file):
                 try:
-                     backup_base_dir  = os.path.dirname(self.backup_dir)
-                     backup_base_name = os.path.basename(self.backup_dir)
-        
-                     log_msg   = "Archiving directory: %s" % self.backup_dir
-                     cmd_flags = ["-C", backup_base_dir, "-cf", self.output_file, "--remove-files", backup_base_name]
-        
-                     if self.do_gzip():
-                         log_msg   = "Archiving and compressing directory: %s" % self.backup_dir
-                         cmd_flags = ["-C", backup_base_dir, "-czf", self.output_file, "--remove-files", backup_base_name]
-        
-                     logging.info(log_msg)
-                     self.running  = True
-                     self._command = LocalCommand(self.binary, cmd_flags, self.verbose)
-                     self.exit_code = self._command.run()
+                    backup_base_dir  = os.path.dirname(self.backup_dir)
+                    backup_base_name = os.path.basename(self.backup_dir)
+
+                    log_msg   = "Archiving directory: %s" % self.backup_dir
+                    cmd_flags = ["-C", backup_base_dir, "-cf", self.output_file, "--remove-files", backup_base_name]
+
+                    if self.do_gzip():
+                        log_msg   = "Archiving and compressing directory: %s" % self.backup_dir
+                        cmd_flags = ["-C", backup_base_dir, "-czf", self.output_file, "--remove-files", backup_base_name]
+
+                    logging.info(log_msg)
+                    self.running  = True
+                    self._command = LocalCommand(self.binary, cmd_flags, self.verbose)
+                    self.exit_code = self._command.run()
                 except Exception, e:
                     logging.fatal("Failed archiving file: %s! Error: %s" % (self.output_file, e))
                 finally:

mongodb_consistent_backup/Archive/Tar/__init__.py

@@ -1,9 +1,9 @@
-from Tar import Tar
+from Tar import Tar  # NOQA
 
 
 def config(parser):
     parser.add_argument("--archive.tar.compression", dest="archive.tar.compression",
                         help="Tar archiver compression method (default: gzip)", default='gzip', choices=['gzip', 'none'])
-    parser.add_argument("--archive.tar.threads", dest="archive.tar.threads", 
+    parser.add_argument("--archive.tar.threads", dest="archive.tar.threads",
                         help="Number of Tar archiver threads to use (default: 1-per-CPU)", default=0, type=int)
     return parser

mongodb_consistent_backup/Archive/Zbackup/Zbackup.py

@@ -95,20 +95,20 @@ def version(self):
                 return None
             except Exception, e:
                 raise OperationError("Could not gather ZBackup version: %s" % e)
-    
+
     def has_zbackup(self):
         if self.version():
-           return True
+            return True
         return False
 
     def close(self, exit_code=None, frame=None):
         del exit_code
         del frame
         if not self.stopped:
-            if self._zbackup and self._zbackup.poll() == None:
+            if self._zbackup and self._zbackup.poll() is None:
                 logging.debug("Stopping running ZBackup command")
                 self._zbackup.terminate()
-            if self._tar and self._tar.poll() == None:
+            if self._tar and self._tar.poll() is None:
                 logging.debug("Stopping running ZBackup tar command")
                 self._tar.terminate()
             self.stopped = True
@@ -131,12 +131,12 @@ def wait(self):
                 self.poll()
                 if tar_done:
                     self._zbackup.communicate()
-                    if self._zbackup.poll() != None:
+                    if self._zbackup.poll() is not None:
                         logging.info("ZBackup completed successfully with exit code: %i" % self._zbackup.returncode)
                         if self._zbackup.returncode != 0:
                             raise OperationError("ZBackup exited with code: %i!" % self._zbackup.returncode)
                         break
-                elif self._tar.poll() != None:
+                elif self._tar.poll() is not None:
                     if self._tar.returncode == 0:
                         logging.debug("ZBackup tar command completed successfully with exit code: %i" % self._tar.returncode)
                         tar_done = True
@@ -160,9 +160,9 @@ def run(self):
             lock = Lock(self.zbackup_lock)
             lock.acquire()
             try:
-                logging.info("Starting ZBackup version: %s (options: compression=%s, encryption=%s, threads=%i, cache_mb=%i)" %
-                    (self.version(), self.compression(), self.encrypted, self.threads(), self.zbackup_cache_mb)
-                )
+                logging.info("Starting ZBackup version: %s (options: compression=%s, encryption=%s, threads=%i, cache_mb=%i)" % (
+                    self.version(), self.compression(), self.encrypted, self.threads(), self.zbackup_cache_mb
+                ))
                 self.running = True
                 try:
                     for sub_dir in os.listdir(self.backup_dir):

mongodb_consistent_backup/Archive/Zbackup/__init__.py

@@ -1,4 +1,4 @@
-from Zbackup import Zbackup
+from Zbackup import Zbackup  # NOQA
 
 
 def config(parser):

mongodb_consistent_backup/Archive/__init__.py

@@ -1,6 +1,6 @@
-from Archive import Archive
+from Archive import Archive  # NOQA
 
 
 def config(parser):
-    parser.add_argument("--archive.method", dest="archive.method", help="Archiver method (default: tar)", default='tar', choices=['tar','zbackup','none'])
+    parser.add_argument("--archive.method", dest="archive.method", help="Archiver method (default: tar)", default='tar', choices=['tar', 'zbackup', 'none'])
     return parser

mongodb_consistent_backup/Backup/Backup.py

@@ -1,4 +1,4 @@
-from mongodb_consistent_backup.Backup.Mongodump import Mongodump
+from mongodb_consistent_backup.Backup.Mongodump import Mongodump  # NOQA
 from mongodb_consistent_backup.Pipeline import Stage