third_party.pylibs.pylint.src/pylint/test/extensions/test_docstyle.py

# Copyright (c) 2016 Luis Escobar <lescobar@vauxoo.com>
# Copyright (c) 2016 Claudiu Popa <pcmanticore@gmail.com>

# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/master/COPYING

"""Tests for the pylint checker in :mod:`pylint.extensions.check_docstring
"""

import os.path as osp

from pylint import checkers
from pylint.extensions.docstyle import DocStringStyleChecker
from pylint.lint import PyLinter
from pylint.testutils import MinimalTestReporter


class TestCheckDocStringStyle(object):

    expected_msg = [
        'First line empty in function docstring',
        'First line empty in class docstring',
        'First line empty in method docstring',
        'Bad docstring quotes in method, expected """, given \'\'\'',
        'Bad docstring quotes in method, expected """, given "',
        'Bad docstring quotes in method, expected """, given \'',
        'Bad docstring quotes in method, expected """, given \'',
    ]
    expected_symbol = [
        'docstring-first-line-empty',
        'docstring-first-line-empty',
        'docstring-first-line-empty',
        'bad-docstring-quotes',
        'bad-docstring-quotes',
        'bad-docstring-quotes',
        'bad-docstring-quotes',
    ]

    @classmethod
    def setup_class(cls):
        cls._linter = PyLinter()
        cls._linter.set_reporter(MinimalTestReporter())
        checkers.initialize(cls._linter)
        cls._linter.register_checker(DocStringStyleChecker(cls._linter))

    def test_docstring_message(self):
        docstring_test = osp.join(osp.dirname(osp.abspath(__file__)), 'data',
                                  'docstring.py')
        self._linter.check([docstring_test])
        msgs = self._linter.reporter.messages
        assert len(msgs) == 7
        for msg, expected_symbol, expected_msg in zip(msgs,
                                                      self.expected_symbol,
                                                      self.expected_msg):
            assert msg.symbol == expected_symbol
            assert msg.msg == expected_msg


if __name__ == '__main__':
    import sys
    import pytest
    pytest.main(sys.argv)