[checkmk-commits] Added pylint checker for not working localized strings

Module: check_mk Branch: master Commit: a03dca43bb92baf28d37b9b3e5dde2ba7745f113 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=a03dca43bb92ba… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Tue Sep 6 19:50:56 2016 +0200 Added pylint checker for not working localized strings --- tests/testlib/pylint_checker_wrong_i18n.py | 78 ++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/tests/testlib/pylint_checker_wrong_i18n.py b/tests/testlib/pylint_checker_wrong_i18n.py new file mode 100644 index 0000000..3cc6405 --- /dev/null +++ b/tests/testlib/pylint_checker_wrong_i18n.py @@ -0,0 +1,78 @@ +"""Checker for incorrect string translation functions.""" + +import six + +import astroid + +from pylint.checkers import BaseChecker, utils +from pylint.interfaces import IAstroidChecker + +BASE_ID = 76 + +def register(linter): + """Register checkers.""" + linter.register_checker(TranslationStringConstantsChecker(linter)) + + +class TranslationStringConstantsChecker(BaseChecker): + """ + Checks for i18n translation functions (_, ugettext, ungettext, and many + others) being called on something that isn't a string literal. + + Bad: + _("hello {}".format(name)) + ugettext("Hello " + name) + ugettext(value_from_database) + + OK: + _("hello {}").format(name) + + The message id is `translation-of-non-string`. + + """ + + __implements__ = (IAstroidChecker,) + + name = 'translation-string-checker' + + TRANSLATION_FUNCTIONS = set([ + '_', + 'gettext', + 'ngettext', 'ngettext_lazy', + 'npgettext', 'npgettext_lazy', + 'pgettext', 'pgettext_lazy', + 'ugettext', 'ugettext_lazy', 'ugettext_noop', + 'ungettext', 'ungettext_lazy', + ]) + + MESSAGE_ID = 'translation-of-non-string' + msgs = { + 'E%d10' % BASE_ID: ( + "i18n function %s() must be called with a literal string", + MESSAGE_ID, + "i18n functions must be called with a literal string", + ), + } + + @utils.check_messages(MESSAGE_ID) + def visit_callfunc(self, node): + """Called for every function call in the source code.""" + if not isinstance(node.func, astroid.Name): + # It isn't a simple name, can't deduce what function it is. + return + + if node.func.name not in self.TRANSLATION_FUNCTIONS: + # Not a function we care about. + return + + if not self.linter.is_message_enabled(self.MESSAGE_ID, line=node.fromlineno): + return + + first = node.args[0] + if isinstance(first, astroid.Const): + if isinstance(first.value, six.string_types): + # The first argument is a constant string! All is well! + return + + # Bad! + self.add_message(self.MESSAGE_ID, args=node.func.name, node=node)