qutebrowser/.pylintrc

# vim: ft=dosini fileencoding=utf-8:

[MASTER]
ignore=resources.py
extension-pkg-whitelist=PyQt5,sip
load-plugins=qute_pylint.config,
             qute_pylint.modeline,
             qute_pylint.openencoding,
             qute_pylint.settrace,
             pylint.extensions.bad_builtin,
             pylint.extensions.docstyle
persistent=n

[MESSAGES CONTROL]
enable=all
disable=no-self-use,
        fixme,
        global-statement,
        locally-disabled,
        locally-enabled,
        too-many-ancestors,
        too-few-public-methods,
        too-many-public-methods,
        cyclic-import,
        bad-continuation,
        too-many-instance-attributes,
        blacklisted-name,
        too-many-lines,
        logging-format-interpolation,
        broad-except,
        bare-except,
        eval-used,
        exec-used,
        file-ignored,
        wrong-import-order,
        ungrouped-imports,
        redefined-variable-type,
        suppressed-message,
        too-many-return-statements,
        duplicate-code,
        wrong-import-position,
        no-else-return

[BASIC]
function-rgx=[a-z_][a-z0-9_]{2,50}$
const-rgx=[A-Za-z_][A-Za-z0-9_]{0,30}$
method-rgx=[a-z_][A-Za-z0-9_]{1,50}$
attr-rgx=[a-z_][a-z0-9_]{0,30}$
argument-rgx=[a-z_][a-z0-9_]{0,30}$
variable-rgx=[a-z_][a-z0-9_]{0,30}$
docstring-min-length=3
no-docstring-rgx=(^_|^main$)

[FORMAT]
max-line-length=79
ignore-long-lines=(<?https?://|^# Copyright 201\d|# (pylint|flake8): disable=)
expected-line-ending-format=LF

[SIMILARITIES]
min-similarity-lines=8

[VARIABLES]
dummy-variables-rgx=_.*

[DESIGN]
max-args=10

[CLASSES]
valid-metaclass-classmethod-first-arg=cls

[TYPECHECK]
# WORKAROUND for https://github.com/PyCQA/astroid/pull/357
ignored-modules=pytest,PyQt5,PyQt5.QtWebKit
# MsgType added as WORKAROUND for
# https://bitbucket.org/logilab/pylint/issues/690/
# UnsetObject because pylint infers any objreg.get(...) as UnsetObject.
ignored-classes=qutebrowser.utils.objreg.UnsetObject,
                qutebrowser.browser.webkit.webelem.WebElementWrapper,
                scripts.dev.check_coverage.MsgType,
                qutebrowser.browser.downloads.UnsupportedAttribute
Add vim modelines to all files. 2014-06-19 09:04:37 +02:00			`# vim: ft=dosini fileencoding=utf-8:`

Ignore ez_setup.py properly 2014-05-15 08:11:00 +02:00			`[MASTER]`
lint: Move options from parameters to config files. This is needed for tox support as we get rid of run_checks.py. 2015-03-26 07:56:29 +01:00			`ignore=resources.py`
Stop pinning pylint/astroid to 1.3.1/1.2.1. 2015-01-20 00:02:35 +01:00			`extension-pkg-whitelist=PyQt5,sip`
Move pylint plugins to an installed package. This means we can now run things like running pylint --version without having to set PYTHONPATH correctly now. When using skip_install=true, the plugins wouldn't work as they need to import qutebrowser. We have to keep setting PYTHONPATH in run_pylint_on_tests.py, otherwise we get this error I don't quite understand: F: 1, 0: error while code parsing: Unable to load file '/home/florian/proj/qutebrowser/git/__init__.py' ([Errno 2] No such file or directory: '...') (parse-error) 2016-02-19 07:09:13 +01:00			`load-plugins=qute_pylint.config,`
			`qute_pylint.modeline,`
			`qute_pylint.openencoding,`
pylint: Reenable bad-builtin extension 2016-07-11 13:12:52 +02:00			`qute_pylint.settrace,`
pylint: Enable docstyle extension 2016-07-11 13:47:18 +02:00			`pylint.extensions.bad_builtin,`
			`pylint.extensions.docstyle`
pylint: Set persistent=n See #1637 2016-07-20 15:51:57 +02:00			`persistent=n`
Ignore ez_setup.py properly 2014-05-15 08:11:00 +02:00
Better linting with config files 2014-04-16 11:05:58 +02:00			`[MESSAGES CONTROL]`
pylint: Enable useless-suppression globally. We deactivate it locally where needed, i.e. where we are sure it's some platform-specific thing. 2015-12-01 23:01:09 +01:00			`enable=all`
Better linting with config files 2014-04-16 11:05:58 +02:00			`disable=no-self-use,`
			`fixme,`
			`global-statement,`
			`locally-disabled,`
Fix pylint without QtWebEngine available 2016-07-07 14:41:39 +02:00			`locally-enabled,`
Better linting with config files 2014-04-16 11:05:58 +02:00			`too-many-ancestors,`
			`too-few-public-methods,`
Fix/silence checks 2014-04-28 00:05:14 +02:00			`too-many-public-methods,`
Fix some checks 2014-04-29 08:38:01 +02:00			`cyclic-import,`
pylint: disable too-many-instance-attributes 2014-05-19 04:10:56 +02:00			`bad-continuation,`
pylint: completely disable unnecessary-lambda 2014-06-17 07:19:16 +02:00			`too-many-instance-attributes,`
pylint: Disable too-many-lines. 2014-08-05 21:09:55 +02:00			`blacklisted-name,`
Stop pinning pylint/astroid to 1.3.1/1.2.1. 2015-01-20 00:02:35 +01:00			`too-many-lines,`
pylint: Disable some messages again. See https://bitbucket.org/logilab/pylint/issues/713/ This partially reverts a42d99a8b705997d90b655253e9345b0a4251e8c. 2015-12-01 06:53:05 +01:00			`logging-format-interpolation,`
Adjust pylint exceptions. 2015-03-11 20:14:39 +01:00			`broad-except,`
pylint: Disable some messages again. See https://bitbucket.org/logilab/pylint/issues/713/ This partially reverts a42d99a8b705997d90b655253e9345b0a4251e8c. 2015-12-01 06:53:05 +01:00			`bare-except,`
			`eval-used,`
			`exec-used,`
Disable some new pylint checks. 2015-11-30 07:16:24 +01:00			`file-ignored,`
			`wrong-import-order,`
			`ungrouped-imports,`
pylint: Enable useless-suppression globally. We deactivate it locally where needed, i.e. where we are sure it's some platform-specific thing. 2015-12-01 23:01:09 +01:00			`redefined-variable-type,`
pylint: Disable too-many-return-statements 2016-05-26 07:39:47 +02:00			`suppressed-message,`
pylint: Disable duplicate-code globally We can't disable it more fine-grained: https://github.com/PyCQA/pylint/issues/214 I think for the shown duplicate (histroy in webkittab/webenginetab) it makes no sense to refactor things as a Mixin... 2016-07-08 11:03:27 +02:00			`too-many-return-statements,`
pylint: ignore wrong-import-position project-wide While it's more accurate with isort now, we get a wrong-import-position for everything in scripts/ where we have to do the sys.path magic first. 2016-07-11 13:00:37 +02:00			`duplicate-code,`
pylint: Ignore no-else-return This will be added in the next pylint release, and it seems we can already add it without getting an error. 2017-03-23 20:51:37 +01:00			`wrong-import-position,`
			`no-else-return`
Better linting with config files 2014-04-16 11:05:58 +02:00
			`[BASIC]`
pylint: Get rid of some customizations in pylintrc 2015-11-30 21:07:44 +01:00			`function-rgx=[a-z_][a-z0-9_]{2,50}$`
Better linting with config files 2014-04-16 11:05:58 +02:00			`const-rgx=[A-Za-z_][A-Za-z0-9_]{0,30}$`
Fix some lint 2016-07-05 20:11:42 +02:00			`method-rgx=[a-z_][A-Za-z0-9_]{1,50}$`
Better linting with config files 2014-04-16 11:05:58 +02:00			`attr-rgx=[a-z_][a-z0-9_]{0,30}$`
			`argument-rgx=[a-z_][a-z0-9_]{0,30}$`
			`variable-rgx=[a-z_][a-z0-9_]{0,30}$`
pylint: Change minimal length for docstrings to 3. 2015-07-23 11:32:19 +02:00			`docstring-min-length=3`
pylint: Don't require docstring for main() funcs. 2016-02-01 20:06:24 +01:00			`no-docstring-rgx=(^_\|^main$)`
Better linting with config files 2014-04-16 11:05:58 +02:00
			`[FORMAT]`
			`max-line-length=79`
pylint: Allow long lines with # pylint: disable=... 2016-01-22 19:38:53 +01:00			`ignore-long-lines=(<?https?://\|^# Copyright 201\d\|# (pylint\|flake8): disable=)`
pylint: Move expected-line-ending-format to config. 2015-11-30 20:17:27 +01:00			`expected-line-ending-format=LF`
Better linting with config files 2014-04-16 11:05:58 +02:00
Increase pylint min-similarity-lines 2014-04-16 16:16:29 +02:00			`[SIMILARITIES]`
pylint: Less stricter similiarity checking. 2014-08-07 14:37:35 +02:00			`min-similarity-lines=8`
Increase pylint min-similarity-lines 2014-04-16 16:16:29 +02:00
Better linting with config files 2014-04-16 11:05:58 +02:00			`[VARIABLES]`
linting cleanup 2014-04-22 17:53:27 +02:00			`dummy-variables-rgx=_.*`
Better linting with config files 2014-04-16 11:05:58 +02:00
			`[DESIGN]`
			`max-args=10`
Improve webelement API 2014-09-04 08:00:05 +02:00
Use typing.py-like annotations for command args This means: - An annotation like (int, str) is now typing.Union[int, str]. - utils.typing got expanded so it acts like the real typing.py, with issubclass() working properly with typing.Union and __union_params__ being set. - A literal string doesn't exist anymore as annotation, instead @cmdutils.argument now has a 'choices' argument which can be used like @cmdutils.argument('arg', choices=['val1', 'val2']). - Argument validating/converting is now entirely handled by argparser.type_conv instead of relying on python's argparse, i.e. type/choices is now not passed to argparse anymore. 2016-05-11 08:01:25 +02:00			`[CLASSES]`
			`valid-metaclass-classmethod-first-arg=cls`

Improve webelement API 2014-09-04 08:00:05 +02:00			`[TYPECHECK]`
pylint: Use ignored-modules for pytest See https://github.com/PyCQA/astroid/pull/357 2016-08-23 07:45:31 +02:00			`# WORKAROUND for https://github.com/PyCQA/astroid/pull/357`
Install PyQt from PyPI for pylint This means we can be sure to have QtWebEngine available and won't have QtWebKit. 2017-05-17 19:08:59 +02:00			`ignored-modules=pytest,PyQt5,PyQt5.QtWebKit`
Add workarounds for pylint/astroid update. 2015-11-30 07:16:12 +01:00			`# MsgType added as WORKAROUND for`
			`# https://bitbucket.org/logilab/pylint/issues/690/`
pylint: Improve ignored-classes list. 2015-11-30 20:31:49 +01:00			`# UnsetObject because pylint infers any objreg.get(...) as UnsetObject.`
			`ignored-classes=qutebrowser.utils.objreg.UnsetObject,`
Split browser into browser/browser.webkit 2016-06-13 10:49:58 +02:00			`qutebrowser.browser.webkit.webelem.WebElementWrapper,`
Fix lint 2016-11-01 19:42:09 +01:00			`scripts.dev.check_coverage.MsgType,`
			`qutebrowser.browser.downloads.UnsupportedAttribute`