PyCQA#129 - Added UT

Author: shacharoo

src/pydocstyle/checker.py

@@ -517,7 +517,7 @@ def _check_section(cls, docstring, definition, context):
 
         suffix = context.line.strip().lstrip(context.section_name)
         if suffix != '':
-            yield violations.D406(capitalized_section, suffix)
+            yield violations.D406(capitalized_section, context.line.strip())
 
         if context.previous_line.strip() != '':
             yield violations.D411(capitalized_section)

src/pydocstyle/violations.py

@@ -212,7 +212,7 @@ def to_rst(cls):
 D405 = D4xx.create_error('D405', 'Section name should be properly capitalized',
                          '{0!r}, not {1!r}')
 D406 = D4xx.create_error('D406', 'Section name should end with a newline',
-                         '{0!r}, found {1!r}')
+                         '{0!r}, not {1!r}')
 D407 = D4xx.create_error('D407', 'Missing dashed underline after section',
                          '{0!r}')
 D408 = D4xx.create_error('D408', 'Section underline should be in the line '

src/tests/test_cases/sections.py

@@ -0,0 +1,164 @@
+"""A valid module docstring."""
+
+from .expected import Expectation
+
+expectation = Expectation()
+expect = expectation.expect
+
+
+_D213 = 'D213: Multi-line docstring summary should start at the second line'
+
+
+@expect(_D213)
+@expect("D405: Section name should be properly capitalized "
+        "('Returns', not 'returns')")
+def not_capitalized():
+    """Valid headline.
+
+    returns
+    -------
+
+    """
+
+
+@expect(_D213)
+@expect("D406: Section name should end with a newline "
+        "('Returns', not 'Returns:')")
+def superfluous_suffix():
+    """Valid headline.
+
+    Returns:
+    -------
+
+    """
+
+
+@expect(_D213)
+@expect("D407: Missing dashed underline after section ('Returns')")
+def no_underline():
+    """Valid headline.
+
+    Returns
+
+    """
+
+
+@expect(_D213)
+@expect("D408: Section underline should be in the line following the "
+        "section\'s name ('Returns')")
+def blank_line_before_underline():
+    """Valid headline.
+
+    Returns
+
+    -------
+
+    """
+
+
+@expect(_D213)
+@expect("D409: Section underline should match the length of its name "
+        "(len('Returns') == 7, got 2 dashes)")
+def bad_underline_length():
+    """Valid headline.
+
+    Returns
+    --
+
+    """
+
+
+@expect(_D213)
+@expect("D410: Missing blank line after section ('Returns')")
+def no_blank_line_after_section():
+    """Valid headline.
+
+    Returns
+    -------
+    A whole lot of values.
+    """
+
+@expect(_D213)
+@expect("D411: Missing blank line before section ('Returns')")
+def no_blank_line_before_section():
+    """Valid headline.
+
+    The function's description.
+    Returns
+    -------
+
+    """
+
+
+@expect(_D213)
+@expect("D214: Section is over-indented ('Returns')")
+def section_overindented():
+    """Valid headline.
+
+        Returns
+    -------
+
+    """
+
+
+@expect(_D213)
+@expect("D215: Section underline is over-indented (in section 'Returns')")
+def section_underline_overindented():
+    """Valid headline.
+
+    Returns
+        -------
+
+    """
+
+
+@expect(_D213)
+def ignore_non_actual_section():
+    """Valid headline.
+
+    This is the function's description, which will also specify what it
+    returns
+
+    """
+
+
+@expect(_D213)
+@expect("D401: First line should be in imperative mood "
+        "('Return', not 'Returns')")
+@expect("D400: First line should end with a period (not 's')")
+@expect("D205: 1 blank line required between summary line and description "
+        "(found 0)")
+def section_name_in_first_line():
+    """Returns
+    -------
+
+    """
+
+
+@expect(_D213)
+@expect("D405: Section name should be properly capitalized "
+        "('Short Summary', not 'Short summary')")
+@expect("D409: Section underline should match the length of its name "
+        "(len('Returns') == 7, got 6 dashes)")
+@expect("D410: Missing blank line after section ('Returns')")
+@expect("D411: Missing blank line before section ('Raises')")
+@expect("D406: Section name should end with a newline "
+        "('Raises', not 'Raises:')")
+@expect("D407: Missing dashed underline after section ('Raises')")
+@expect("D410: Missing blank line after section ('Raises')")
+def multiple_sections():
+    """Valid headline.
+
+    Short summary
+    -------------
+
+    This is the function's description, which will also specify what it
+    returns.
+
+    Returns
+    ------
+    Many many wonderful things.
+    Raises:
+    My attention.
+
+    """

src/tests/test_definitions.py

@@ -278,6 +278,7 @@ def test_token_stream():
     'all_import',
     'all_import_as',
     'superfluous_quotes',
+    'sections',
 ])
 def test_pep257(test_case):
     """Run domain-specific tests from test.py file."""

src/tests/test_integration.py

@@ -501,6 +501,28 @@ def foo():
     assert 'D213' not in out
 
 
+def test_numpy_convention(env):
+    """Test that the 'numpy' convention options has the correct errors."""
+    with env.open('example.py', 'wt') as example:
+        example.write(textwrap.dedent('''
+            class Foo(object):
+                """Docstring for this class.
+
+                returns
+                 ------
+                """
+        '''))
+
+    env.write_config(convention="numpy")
+    out, err, code = env.invoke()
+    assert code == 1
+    assert 'D213' not in out
+    assert 'D215' in out
+    assert 'D405' in out
+    assert 'D409' in out
+    assert 'D410' in out
+
+
 def test_config_file_inheritance(env):
     """Test configuration files inheritance.