[GitHub] BasPH opened a new pull request #4511: Replace Flake8 by Pylint

[GitBox <gi...@apache.org>]

BasPH opened a new pull request #4511: Replace Flake8 by Pylint
URL: https://github.com/apache/airflow/pull/4511
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-3695
     - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   
   Following the [dev mailing list about AIP-6](https://lists.apache.org/thread.html/90c3f38fbda49eca772b32cb55a6274ff2c536e6ecdcaf706ea87826@%3Cdev.airflow.apache.org%3E), I replaced Flake8 by Pylint. I choose Pylint because it's a widely used tool, very configurable and is already used here and there [in Airflow itself](https://github.com/apache/airflow/search?q=pylint&unscoped_q=pylint).
   
   On top of the default Pylint configuration (see .pylintrc), I set some sensible defaults:
   ```
   disable=comprehension-escape,
           pointless-statement,
           invalid-name,
           duplicate-code,
           abstract-method,
           bad-continuation
   
   ignored-argument-names=_.*|^ignored_|^unused_|args|kwargs (added args & kwargs)
   
   max-args=15
   
   min-public-methods=1
   ```
   
   Pylint is much stricter than Flake8 and I'm sure it will lead to some discussion about the configuration in the beginning. However I'm convinced in the long run it will lead to much more consistent code. This PR adds and applies Pylint only on changed lines compared to master with the help of [diff-cover](https://github.com/Bachmann1234/diff-cover). I see it as an intermediate solution, until the entire Airflow codebase is Pylint-compliant and we can simply run Pylint on complete changed files.
   
   ### Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   ### Commits
   
   - [x] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [x] In case of new functionality, my PR adds documentation that describes how to use it.
     - When adding new operators/hooks/sensors, the autoclass documentation generation needs to be added.
     - All the public functions and the classes in the PR contain docstrings that explain what it does
   
   ### Code Quality
   
   - [x] Passes `Pylint`
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services