Added some docs, code formatted (autopep8), trimmed whitespaces, added helper files to import on Eclipse.

Author: fabioz

.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>pytest-qt</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.python.pydev.PyDevBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.python.pydev.pythonNature</nature>
+	</natures>
+</projectDescription>

.pydevproject

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<?eclipse-pydev version="1.0"?><pydev_project>
+<pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
+<path>/${PROJECT_DIR_NAME}</path>
+</pydev_pathproperty>
+<pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 2.7</pydev_property>
+<pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Default</pydev_property>
+</pydev_project>

docs/index.rst

@@ -43,9 +43,14 @@ Or alternatively, download the package from pypi_, extract and execute::
    python setup.py install
 
 .. _pypi: http://pypi.python.org/pypi/pytest-qt/
+.. _`pytest.ini`: http://pytest.org/latest/customize.html
 
 Both methods will automatically register it for usage in ``py.test``.
 
+Alternatively, to develop pytest-qt itself, it's possible to grab it's sources through ``git clone https://github.com/nicoddemus/pytest-qt.git``, 
+add it to the PYTHONPATH and enable it by adding ``-p pytestqt.plugin``
+to the command line (ideally, add it to your `pytest.ini`_).
+
 
 Quick Tutorial
 ==============

pytestqt/plugin.py

@@ -25,7 +25,7 @@ def result(*args, **kwargs):
             functools.update_wrapper(result, qtest_method)
             return staticmethod(result)
         else:
-            return None # pragma: no cover
+            return None  # pragma: no cover
 
     # inject methods from QTest into QtBot
     method_names = [
@@ -54,15 +54,16 @@ def result(*args, **kwargs):
 
 @_inject_qtest_methods
 class QtBot(object):
+
     """
-    Instances of this class are responsible for sending events to `Qt` objects (usually widgets), 
-    simulating user input. 
-    
-    .. important:: Instances of this class should be accessed only by using a ``qtbot`` fixture, 
+    Instances of this class are responsible for sending events to `Qt` objects (usually widgets),
+    simulating user input.
+
+    .. important:: Instances of this class should be accessed only by using a ``qtbot`` fixture,
                     never instantiated directly.
-    
+
     **Widgets**
-    
+
     .. automethod:: addWidget
     .. automethod:: waitForWindowShown
     .. automethod:: stopForInteraction
@@ -72,155 +73,150 @@ class QtBot(object):
     .. automethod:: waitSignal
 
     **Raw QTest API**
-    
+
     Methods below provide very low level functions, as sending a single mouse click or a key event.
     Thos methods are just forwarded directly to the `QTest API`_. Consult the documentation for more
     information.
-    
+
     ---
-    
+
     Below are methods used to simulate sending key events to widgets:
-    
+
     .. staticmethod:: keyPress(widget, key[, modifier=Qt.NoModifier[, delay=-1]])
     .. staticmethod:: keyClick (widget, key[, modifier=Qt.NoModifier[, delay=-1]])
     .. staticmethod:: keyClicks (widget, key sequence[, modifier=Qt.NoModifier[, delay=-1]])
     .. staticmethod:: keyEvent (action, widget, key[, modifier=Qt.NoModifier[, delay=-1]])
     .. staticmethod:: keyPress (widget, key[, modifier=Qt.NoModifier[, delay=-1]])
     .. staticmethod:: keyRelease (widget, key[, modifier=Qt.NoModifier[, delay=-1]])
-    
+
         Sends one or more keyword events to a widget.
-    
+
         :param QWidget widget: the widget that will receive the event
-        
+
         :param str|int key: key to send, it can be either a Qt.Key_* constant or a single character string.
-        
+
         .. _keyboard modifiers:
-        
+
         :param Qt.KeyboardModifier modifier: flags OR'ed together representing other modifier keys
             also pressed. Possible flags are:
-        
+
             * ``Qt.NoModifier``: No modifier key is pressed.
             * ``Qt.ShiftModifier``: A Shift key on the keyboard is pressed.
             * ``Qt.ControlModifier``: A Ctrl key on the keyboard is pressed.
             * ``Qt.AltModifier``: An Alt key on the keyboard is pressed.
             * ``Qt.MetaModifier``: A Meta key on the keyboard is pressed.
             * ``Qt.KeypadModifier``: A keypad button is pressed.
             * ``Qt.GroupSwitchModifier``: X11 only. A Mode_switch key on the keyboard is pressed.
-            
+
         :param int delay: after the event, delay the test for this miliseconds (if > 0).
-        
-    
+
+
     .. staticmethod:: keyToAscii (key)
-        
+
         Auxilliary method that converts the given constant ot its equivalent ascii.
-        
+
         :param Qt.Key_* key: one of the constants for keys in the Qt namespace.
-        
-        :return type: str 
+
+        :return type: str
         :returns: the equivalent character string.
 
         .. note:: this method is not available in PyQt.
-    
+
     ---
-    
+
     Below are methods used to simulate sending mouse events to widgets.
-    
+
     .. staticmethod:: mouseClick (widget, button[, stateKey=0[, pos=QPoint()[, delay=-1]]])
     .. staticmethod:: mouseDClick (widget, button[, stateKey=0[, pos=QPoint()[, delay=-1]]])
     .. staticmethod:: mouseEvent (action, widget, button, stateKey, pos[, delay=-1])
     .. staticmethod:: mouseMove (widget[, pos=QPoint()[, delay=-1]])
     .. staticmethod:: mousePress (widget, button[, stateKey=0[, pos=QPoint()[, delay=-1]]])
     .. staticmethod:: mouseRelease (widget, button[, stateKey=0[, pos=QPoint()[, delay=-1]]])
-    
+
         Sends a mouse moves and clicks to a widget.
-        
+
         :param QWidget widget: the widget that will receive the event
-        
-        :param Qt.MouseButton button: flags OR'ed together representing the button pressed. 
+
+        :param Qt.MouseButton button: flags OR'ed together representing the button pressed.
             Possible flags are:
-        
+
             * ``Qt.NoButton``: The button state does not refer to any button (see QMouseEvent.button()).
             * ``Qt.LeftButton``: The left button is pressed, or an event refers to the left button. (The left button may be the right button on left-handed mice.)
             * ``Qt.RightButton``: The right button.
             * ``Qt.MidButton``: The middle button.
             * ``Qt.MiddleButton``: The middle button.
             * ``Qt.XButton1``: The first X button.
             * ``Qt.XButton2``: The second X button.
-            
+
         :param Qt.KeyboardModifier modifier: flags OR'ed together representing other modifier keys
             also pressed. See `keyboard modifiers`_.
-            
+
         :param QPoint position: position of the mouse pointer.
-        
+
         :param int delay: after the event, delay the test for this miliseconds (if > 0).
-            
-    
+
+
     .. _QTest API: http://doc.qt.digia.com/4.8/qtest.html
-    
+
     """
-    
+
     def __init__(self, app):
         """
-        :param QApplication app: 
+        :param QApplication app:
             The current QApplication instance.
         """
         self._app = app
         self._widgets = []
-        
-        
+
     def _close(self):
         """
         Clear up method. Called at the end of each test that uses a ``qtbot`` fixture.
         """
         for w in self._widgets:
             w.close()
         self._widgets[:] = []
-        
-        
+
     def addWidget(self, widget):
         """
         Adds a widget to be tracked by this bot. This is not required, but will ensure that the
         widget gets closed by the end of the test, so it is highly recommended.
-        
-        :param QWidget widget: 
+
+        :param QWidget widget:
             Widget to keep track of.
         """
         self._widgets.append(widget)
-        
-        
+
     def waitForWindowShown(self, widget):
         """
-        Waits until the window is shown in the screen. This is mainly useful for asynchronous 
-        systems like X11, where a window will be mapped to screen some time after being asked to 
-        show itself on the screen. 
-        
+        Waits until the window is shown in the screen. This is mainly useful for asynchronous
+        systems like X11, where a window will be mapped to screen some time after being asked to
+        show itself on the screen.
+
         :param QWidget widget:
             Widget to wait on.
         """
         QtTest.QTest.qWaitForWindowShown(widget)
-        
-        
+
     def stopForInteraction(self):
         """
         Stops the current test flow, letting the user interact with any visible widget.
-        
+
         This is mainly useful so that you can verify the current state of the program while writing
         tests.
-        
+
         Closing the windows should resume the test run, with ``qtbot`` attempting to restore visibility
         of the widgets as they were before this call.
 
         .. note:: As a convenience, it is also aliased as `stop`.
         """
         widget_visibility = [widget.isVisible() for widget in self._widgets]
-        
-        self._app.exec_()    
+
+        self._app.exec_()
 
         for index, visible in enumerate(widget_visibility):
             widget = self._widgets[index]
             widget.setVisible(visible)
 
-
     stop = stopForInteraction
 
     def waitSignal(self, signal=None, timeout=1000):
@@ -251,7 +247,7 @@ def waitSignal(self, signal=None, timeout=1000):
             ``SignalBlocker`` object. Call ``SignalBlocker.wait()`` to wait.
 
         .. note::
-           Cannot have both ``signals`` and ``timeout`` equal ``None``, or 
+           Cannot have both ``signals`` and ``timeout`` equal ``None``, or
            else you will block indefinitely. We throw an error if this occurs.
 
         """
@@ -262,6 +258,7 @@ def waitSignal(self, signal=None, timeout=1000):
 
 
 class SignalBlocker(object):
+
     """
     Returned by :meth:`QtBot.waitSignal` method.
 
@@ -373,8 +370,8 @@ def qapp():
 @pytest.yield_fixture
 def qtbot(qapp):
     """
-    Fixture used to create a QtBot instance for using during testing. 
-    
+    Fixture used to create a QtBot instance for using during testing.
+
     Make sure to call addWidget for each top-level widget you create to ensure
     that they are properly closed after the test ends.
     """
@@ -386,4 +383,3 @@ def qtbot(qapp):
         pytest.fail(format_captured_exceptions(exceptions))
 
     result._close()
-