From eab9198f4c5e52c4bbc1caea2034db2e343f8838 Mon Sep 17 00:00:00 2001 From: Sergey Fedoseev Date: Fri, 18 Oct 2019 16:59:55 +0500 Subject: [PATCH] Move flake8 config to setup.cfg --- CHANGELOG.txt | 1 + docs/contributing/python_guidelines.rst | 2 +- docs/releases/2.8.rst | 2 +- setup.cfg | 19 ++++++++++++++++++- tox.ini | 20 -------------------- 5 files changed, 21 insertions(+), 23 deletions(-) diff --git a/CHANGELOG.txt b/CHANGELOG.txt index cb35ba0c27..caacad91d7 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -5,6 +5,7 @@ Changelog ~~~~~~~~~~~~~~~~ * Removed leftover Python 2.x compatibility code (Sergey Fedoseev) + * Combine flake8 configurations (Sergey Fedoseev) 2.7 LTS (xx.xx.xxxx) - IN DEVELOPMENT ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/contributing/python_guidelines.rst b/docs/contributing/python_guidelines.rst index c6b08ea4be..970e3be386 100644 --- a/docs/contributing/python_guidelines.rst +++ b/docs/contributing/python_guidelines.rst @@ -5,7 +5,7 @@ PEP8 ~~~~ We ask that all Python contributions adhere to the `PEP8 `_ style guide, apart from the restriction on line length (E501) and some minor docstring-related issues. -The list of PEP8 violations to ignore is in the ``tox.ini`` file, under the ``[flake8]`` header. +The list of PEP8 violations to ignore is in the ``setup.cfg`` file, under the ``[flake8]`` header. You might want to configure the flake8 linter in your editor/IDE to use the configuration in this file. In addition, import lines should be sorted according to `isort `_ 4.2.5 rules. If you have installed Wagtail's testing dependencies (``pip install -e .[testing]``), you can check your code by running ``make lint``. diff --git a/docs/releases/2.8.rst b/docs/releases/2.8.rst index 29a6d5c03f..c2908ca2d7 100644 --- a/docs/releases/2.8.rst +++ b/docs/releases/2.8.rst @@ -21,7 +21,7 @@ Bug fixes ~~~~~~~~~ * Removed leftover Python 2.x compatibility code (Sergey Fedoseev) - + * Combine flake8 configurations (Sergey Fedoseev) Upgrade considerations ====================== diff --git a/setup.cfg b/setup.cfg index 508b5e7aa3..e7e80ce24c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,7 +2,24 @@ python-tag = py3 [flake8] -ignore = E501,E303,W503 +# D100: Missing docstring in public module +# D101: Missing docstring in public class +# D102: Missing docstring in public method +# D103: Missing docstring in public function +# D105: Missing docstring in magic method +# D200: One-line docstring should fit on one line with quotes +# D202: No blank lines allowed after function docstring +# D204: 1 blank line required after docstring +# D205: 1 blank line required between summary line and description +# D209: Multi-line docstring closing quotes should be on a separate line +# D400: First line should end with a period +# D401: First line should be in imperative mood +# E303: Too many blank lines +# E501: Line too long +# W503: line break before binary operator (superseded by W504 line break after binary operator) +# N805: First argument of a method should be named 'self' +# N806: Variable in function should be lowercase +ignore = D100,D101,D102,D103,D105,D200,D202,D204,D205,D209,D400,D401,E303,E501,W503,N805,N806 exclude = wagtail/project_template/*,wagtail/utils/l18n/* max-line-length = 120 diff --git a/tox.ini b/tox.ini index 29e9a2f197..84ac573c88 100644 --- a/tox.ini +++ b/tox.ini @@ -4,26 +4,6 @@ usedevelop = True envlist = py{35,36,37}-dj{20,21,22,master}-{sqlite,postgres,mysql,mssql}-{elasticsearch7,elasticsearch6,elasticsearch5,elasticsearch2,noelasticsearch}, -[flake8] -# D100: Missing docstring in public module -# D101: Missing docstring in public class -# D102: Missing docstring in public method -# D103: Missing docstring in public function -# D105: Missing docstring in magic method -# D200: One-line docstring should fit on one line with quotes -# D202: No blank lines allowed after function docstring -# D204: 1 blank line required after docstring -# D205: 1 blank line required between summary line and description -# D209: Multi-line docstring cloasing quotes should be on a separate line -# D400: First line should end with a period -# D401: First line should be in imperative mood -# E303: Too many blank lines -# E501: Line too long -# W503: line break before binary operator (superseded by W504 line break after binary operator) -# N805: First argument of a method should be named 'self' -# N806: Variable in function should be lowercase -ignore = D100,D101,D102,D103,D105,D200,D202,D204,D205,D209,D400,D401,E303,E501,W503,N805,N806 - [testenv] install_command = pip install -e ".[testing]" -U {opts} {packages} commands =