Merge pull request #68 from SethMichaelLarson/flake8

Start Flake8 testing the virtualbox package

Author: SethMichaelLarson

.gitignore

@@ -1,8 +1,102 @@
-*.pyc
-*.xidl
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
 *.egg
-*.zip
-*.swp
 
-# PyCharm / IntelliJ projects
-.idea/**
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# PyCharm
+.idea/
+
+# Benchmarks
+.benchmarks/
+
+# PyCharm
+.idea/
+
+*.swp
+*.zip
+*.xidl

setup.cfg

@@ -5,3 +5,8 @@ all_files  = 1
 
 [upload_sphinx]
 upload-dir = docs/build/html
+
+[flake8]
+exclude = virtualbox/library.py
+ignore = E502,E241
+max-line-length = 100

tox.ini

@@ -0,0 +1,7 @@
+[tox]
+envlist = lint
+
+[testenv:lint]
+commands =
+    python -m pip install flake8
+    flake8 virtualbox/

virtualbox/__init__.py

@@ -22,7 +22,6 @@
 import copy
 import atexit
 from multiprocessing import current_process
-from threading import current_thread
 
 from virtualbox.library_ext import library
 
@@ -34,6 +33,7 @@
 VirtualBox = library.IVirtualBox
 Session = library.ISession
 
+
 @contextmanager
 def import_vboxapi():
     """This import is designed to help when loading vboxapi inside of
@@ -47,28 +47,26 @@ def import_vboxapi():
         system = platform.system()
         py_mm_ver = sys.version_info[:2]
         packages = ['vboxapi']
+
         if system == 'Windows':
             packages.extend(['win32com', 'win32', 'win32api', 'pywintypes', 'win32comext'])
-            search = [
-                        'C:\\Python%s%s\\Lib\\site-packages' % py_mm_ver,
-                        'C:\\Python%s%s\\Lib\\site-packages\\win32' % py_mm_ver,
-                        'C:\\Python%s%s\\Lib\\site-packages\\win32\\lib' % py_mm_ver,
-                        'C:\\Program Files\\Oracle\\VirtualBox\\sdk\\install',
-                        'C:\\Program Files (x86)\\Oracle\\VirtualBox\\sdk\\install',
-                     ]
+            search = ['C:\\Python%s%s\\Lib\\site-packages' % py_mm_ver,
+                      'C:\\Python%s%s\\Lib\\site-packages\\win32' % py_mm_ver,
+                      'C:\\Python%s%s\\Lib\\site-packages\\win32\\lib' % py_mm_ver,
+                      'C:\\Program Files\\Oracle\\VirtualBox\\sdk\\install',
+                      'C:\\Program Files (x86)\\Oracle\\VirtualBox\\sdk\\install']
+
         elif system == 'Linux':
-            search = [
-                        '/usr/lib/python%s.%s/dist-packages' % py_mm_ver,
-                        '/usr/lib/python%s.%s/site-packages' % py_mm_ver,
-                        '/usr/share/pyshared',
-                     ]
+            search = ['/usr/lib/python%s.%s/dist-packages' % py_mm_ver,
+                      '/usr/lib/python%s.%s/site-packages' % py_mm_ver,
+                      '/usr/share/pyshared']
+
         elif system == 'Darwin':
-            search = [
-                        '/Library/Python/%s.%s/site-packages' % py_mm_ver,
-                     ]
+            search = ['/Library/Python/%s.%s/site-packages' % py_mm_ver]
         else:
             # No idea where to look...
             raise
+
         packages = set(packages)
         original_path = copy.copy(sys.path)
         for path in search:
@@ -81,7 +79,7 @@ def import_vboxapi():
             if not packages:
                 break
         else:
-            # After search each path we still failed to find 
+            # After search each path we still failed to find
             # the required set of packages.
             raise
         import vboxapi
@@ -93,13 +91,15 @@ def import_vboxapi():
         yield vboxapi
 
 
-_managers = {} 
+_managers = {}
+
+
 class Manager(object):
     """The Manager maintains a single point of entry into vboxapi.
-    
+
     This object is responsible for the construction of
     :py:class:`virtualbox.library_ext.ISession` and
-    :py:class:`virtualbox.library_ext.IVirtualBox`.  
+    :py:class:`virtualbox.library_ext.IVirtualBox`.
 
     :param mtype: Type of manager i.e. WEBSERVICE.
     :type mtype: str (Default None)
@@ -117,12 +117,12 @@ def __init__(self, mtype=None, mparams=None):
     @property
     def manager(self):
         """Create a default Manager object
-        
+
         Builds a singleton VirtualBoxManager object.
 
         Note: It is not necessary to build this object when defining a
         Session or VirtualBox object as both of these classes will default
-        to this object's global singleton during construction. 
+        to this object's global singleton during construction.
         """
         if _managers is None:
             raise RuntimeError("Can not get the manager following a system exit.")
@@ -135,20 +135,20 @@ def manager(self, value):
         if _managers is None:
             raise RuntimeError("Can not set the manager following a system exit.")
         if pid not in _managers:
-            _managers[pid] = value 
+            _managers[pid] = value
         else:
             raise Exception("Manager already set for pid %s" % pid)
 
     def get_virtualbox(self):
         """Return a VirtualBox interface
-        
+
         :rtype: library.IVirtualBox
         """
         return VirtualBox(interface=self.manager.getVirtualBox())
 
     def get_session(self):
         """Return a Session interface
-        
+
         :rtype: library.ISession
         """
         # The inconsistent vboxapi implementation makes this annoying...
@@ -160,7 +160,7 @@ def get_session(self):
 
     def cast_object(self, interface_object, interface_class):
         """Cast the obj to the interface class
-        
+
         :rtype: interface_class(interface_object)
         """
         name = interface_class.__name__
@@ -170,17 +170,17 @@ def cast_object(self, interface_object, interface_class):
     @property
     def bin_path(self):
         """return the virtualbox install directory
-        
+
         :rtype: str
         """
         return self.manager.getBinDir()
 
 
-# Attempt to close left over manager objects cleanly. 
+# Attempt to close left over manager objects cleanly.
 def _cleanup_managers():
     global _managers
     managers = _managers
-    _managers = None 
+    _managers = None
     for manager in managers.values():
         try:
             del manager
@@ -198,9 +198,9 @@ class WebServiceManager(Manager):
     """
     def __init__(self, url='http://localhost/', user='', password=''):
         """Create a VirtualBoxManager WEBSERVICE manager for IVirtualBox
-        
+
         Options:
-            url - url to connect with the VirtualBox server 
+            url - url to connect with the VirtualBox server
             user - username used to auth to the VirtualBox server service
             password - password used to auth to the VirtualBox server service
 
@@ -209,11 +209,11 @@ def __init__(self, url='http://localhost/', user='', password=''):
             vbox = VirtualBox(manager=manager)
             ...
         """
-        params = {"url":url, "user":user, "password":password}
+        params = {"url": url, "user": user, "password": password}
         super(WebServiceManager, self).__init__("WEBSERVICE", params)
 
 
 # Lazy include...
-from virtualbox import pool
-from virtualbox import events
-from virtualbox import version
+from virtualbox import pool  # noqa: F401
+from virtualbox import events  # noqa: F401
+from virtualbox import version  # noqa: F401

virtualbox/events.py

@@ -5,16 +5,17 @@
 """
 from __future__ import print_function
 import sys
-import atexit 
-import inspect 
+import atexit
+import inspect
 import traceback
 import threading
 
-import virtualbox
 from virtualbox import library
 
 
-_lookup = {} 
+_lookup = {}
+
+
 def type_to_interface(event_type):
     """Return the event interface object that corresponds to the event type
     enumeration"""
@@ -38,6 +39,8 @@ def type_to_interface(event_type):
 
 
 _callbacks = {}
+
+
 def _event_monitor(callback, event_source, listener, event_interface, quit):
     global _callbacks
     try:
@@ -46,27 +49,27 @@ def _event_monitor(callback, event_source, listener, event_interface, quit):
                 event = event_source.get_event(listener, 1000)
             except library.VBoxError:
                 print("Unregistering %s due to VBoxError on get_event" %
-                        listener, file=sys.stderr)
+                      listener, file=sys.stderr)
                 break
             if event:
                 try:
                     callback(event_interface(event))
                 except:
-                    print("Unhanded exception in callback: \n%s" % \
-                            traceback.format_exc(), file=sys.stderr)
+                    print("Unhanded exception in callback: \n%s" %
+                          traceback.format_exc(), file=sys.stderr)
                 event_source.event_processed(listener, event)
     finally:
         _callbacks.pop(threading.current_thread().ident, None)
         try:
             event_source.unregister_listener(listener)
-        except Exception as exc:
+        except Exception:
             print("Failed to unregister listener %s" % listener,
-                    file=sys.stderr)
+                  file=sys.stderr)
 
 
 def register_callback(callback, event_source, event_type):
     """register a callback function against an event_source for a given
-    event_type.  
+    event_type.
 
     Arguments:
         callback - function to call when the event occurs
@@ -77,11 +80,11 @@ def register_callback(callback, event_source, event_type):
     """
     global _callbacks
     event_interface = type_to_interface(event_type)
-    listener = event_source.create_listener() 
+    listener = event_source.create_listener()
     event_source.register_listener(listener, [event_type], False)
     quit = threading.Event()
-    t = threading.Thread(target=_event_monitor, args=(callback, 
-                                                      event_source, 
+    t = threading.Thread(target=_event_monitor, args=(callback,
+                                                      event_source,
                                                       listener,
                                                       event_interface,
                                                       quit))
@@ -113,7 +116,3 @@ def _remove_all_callbacks():
 
 
 atexit.register(_remove_all_callbacks)
-
-
-
-