New D210 check for surrounding whitespaces.

Signed-off-by: Jiri Kuncar <[email protected]>
Reviewed-by: Amir Rachum <[email protected]>

Author: jirikuncar

README.rst

@@ -114,6 +114,8 @@ are grouped as follows:
 +--------------+--------------------------------------------------------------+
 | D209         | Put multi-line docstring closing quotes on separate line.    |
 +--------------+--------------------------------------------------------------+
+| D210         | No whitespaces allowed surrounding docstring text.           |
++--------------+--------------------------------------------------------------+
 | **Quotes issues**                                                           |
 +--------------+--------------------------------------------------------------+
 | D300         | Use """triple double quotes""".                              |

pep257.py

@@ -777,6 +777,16 @@ def check_newline_after_last_paragraph(self, definition, docstring):
                     return Error('D209: Put multi-line docstring closing '
                                  'quotes on separate line')
 
+    @check_for(Definition)
+    def check_surrounding_whitespaces(self, definition, docstring):
+        """D210: No whitespaces allowed surrounding docstring text."""
+        if docstring:
+            lines = eval(docstring).split('\n')
+            if lines[0].startswith(' ') or \
+                    len(lines) == 1 and lines[0].endswith(' '):
+                return Error("D210: No whitespaces allowed surrounding "
+                             "docstring text.")
+
     @check_for(Definition)
     def check_triple_double_quotes(self, definition, docstring):
         r'''D300: Use """triple double quotes""".

test.py

@@ -165,6 +165,24 @@ def asdfljdf24():
     Description."""
 
 
+@expect('D210: No whitespaces allowed surrounding docstring text.')
+def endswith():
+    """Whitespace at the end. """
+
+
+@expect('D210: No whitespaces allowed surrounding docstring text.')
+def around():
+    """ Whitespace at everywhere. """
+
+
+@expect('D210: No whitespaces allowed surrounding docstring text.')
+def multiline():
+    """ Whitespace at the begining.
+
+    This is the end.
+    """
+
+
 @expect('D300: Expected """-quotes, got \'\'\'-quotes')
 def lsfklkjllkjl():
     r'''Summary.'''

test_pep257.py

@@ -1,5 +1,7 @@
-"""Use tox or py.test to run the test-suite."""
 # -*- coding: utf-8 -*-
+
+"""Use tox or py.test to run the test-suite."""
+
 from __future__ import with_statement
 
 import os
@@ -76,7 +78,8 @@ def test_ignore_list():
     no blank line after one-liner is bad. Also this - \"\"\"
     return foo
     """
-    expected_error_codes = set(('D100', 'D400', 'D401', 'D205', 'D209'))
+    expected_error_codes = set(('D100', 'D400', 'D401', 'D205', 'D209',
+                                'D210'))
     mock_open = mock.mock_open(read_data=function_to_check)
     with mock.patch('pep257.open', mock_open, create=True):
         errors = tuple(pep257.check(['filepath']))