1 files changed, 83 insertions, 0 deletions
diff --git a/.config/qutebrowser/scripts/dev/pylint_checkers/qute_pylint/openencoding.py b/.config/qutebrowser/scripts/dev/pylint_checkers/qute_pylint/openencoding.py
new file mode 100644
index 0000000..f577011
--- /dev/null
+++ b/.config/qutebrowser/scripts/dev/pylint_checkers/qute_pylint/openencoding.py
@@ -0,0 +1,83 @@
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+# Copyright 2014-2018 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+
+# This file is part of qutebrowser.
+#
+# qutebrowser is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# qutebrowser is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Make sure open() has an encoding set."""
+
+import astroid
+from pylint import interfaces, checkers
+from pylint.checkers import utils
+
+
+class OpenEncodingChecker(checkers.BaseChecker):
+
+    """Checker to check open() has an encoding set."""
+
+    __implements__ = interfaces.IAstroidChecker
+    name = 'open-encoding'
+
+    msgs = {
+        'W9400': ('open() called without encoding', 'open-without-encoding',
+                  None),
+    }
+
+    @utils.check_messages('open-without-encoding')
+    def visit_call(self, node):
+        """Visit a Call node."""
+        if hasattr(node, 'func'):
+            infer = utils.safe_infer(node.func)
+            if infer and infer.root().name == '_io':
+                if getattr(node.func, 'name', None) in ['open', 'file']:
+                    self._check_open_encoding(node)
+
+    def _check_open_encoding(self, node):
+        """Check that an open() call always has an encoding set."""
+        try:
+            mode_arg = utils.get_argument_from_call(node, position=1,
+                                                    keyword='mode')
+        except utils.NoSuchArgumentError:
+            mode_arg = None
+        _encoding = None
+        try:
+            _encoding = utils.get_argument_from_call(node, position=2)
+        except utils.NoSuchArgumentError:
+            try:
+                _encoding = utils.get_argument_from_call(node,
+                                                         keyword='encoding')
+            except utils.NoSuchArgumentError:
+                pass
+        if _encoding is None:
+            if mode_arg is None:
+                mode = None
+            else:
+                mode = utils.safe_infer(mode_arg)
+            if mode is not None and not isinstance(mode, astroid.Const):
+                # We can't say what mode is exactly.
+                return
+            if mode is None:
+                self.add_message('open-without-encoding', node=node)
+            elif 'b' in getattr(mode, 'value', ''):
+                # Files opened as binary don't need an encoding.
+                return
+            else:
+                self.add_message('open-without-encoding', node=node)
+
+
+def register(linter):
+    """Register this checker."""
+    linter.register_checker(OpenEncodingChecker(linter))