Clean up ansible-test pylint configs. (#70129)

* Sort disabled pylint codes in config.
* Fix comments in pylint config.
* Add comments to pylint config.
* Prepare to sort pylint config.
* Fix pylint config indentation.
* Sort pylint good/bad names in config.
* Add changelog fragment.

changelogs/fragments/ansible-test-cleanup-pylint-config.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - ansible-test - Reorganize internal ``pylint`` configuration files for easier comparison and maintenance.

test/lib/ansible_test/_data/sanity/pylint/config/ansible-test.cfg

@@ -1,8 +1,11 @@
 [MESSAGES CONTROL]
 
 disable=
+    consider-using-dict-comprehension,  # requires Python 2.7+, but we still require Python 2.6 support
+    consider-using-set-comprehension,  # requires Python 2.7+, but we still require Python 2.6 support
     cyclic-import,  # consistent results require running with --jobs 1 and testing all files
     duplicate-code,  # consistent results require running with --jobs 1 and testing all files
+    no-self-use,
     too-few-public-methods,
     too-many-arguments,
     too-many-branches,
@@ -12,28 +15,27 @@ disable=
     too-many-nested-blocks,
     too-many-return-statements,
     too-many-statements,
-    no-self-use,
     unused-import,  # pylint does not understand PEP 484 type hints
-    consider-using-dict-comprehension,  # requires Python 2.6, which we still support
-    consider-using-set-comprehension,  # requires Python 2.6, which we still support
 
 [BASIC]
 
-bad-names=foo,
+bad-names=
+    _,
     bar,
     baz,
+    foo,
+    tata,
     toto,
     tutu,
-          tata,
-          _,
 
-good-names=i,
+good-names=
+    __metaclass__,
+    C,
+    ex,
+    i,
     j,
     k,
-           ex,
     Run,
-           C,
-           __metaclass__,
 
 method-rgx=[a-z_][a-z0-9_]{2,40}$
 function-rgx=[a-z_][a-z0-9_]{2,40}$

test/lib/ansible_test/_data/sanity/pylint/config/collection.cfg

@@ -17,11 +17,11 @@ disable=
     comparison-with-callable,
     consider-iterating-dictionary,
     consider-merging-isinstance,
-    consider-using-dict-comprehension,
+    consider-using-dict-comprehension,  # requires Python 2.7+, but we still require Python 2.6 support
     consider-using-enumerate,
     consider-using-get,
     consider-using-in,
-    consider-using-set-comprehension,
+    consider-using-set-comprehension,  # requires Python 2.7+, but we still require Python 2.6 support
     consider-using-ternary,
     cyclic-import,  # consistent results require running with --jobs 1 and testing all files
     deprecated-lambda,
@@ -115,18 +115,20 @@ disable=
 
 [BASIC]
 
-bad-names=foo,
+bad-names=
+    _,
     bar,
     baz,
+    foo,
+    tata,
     toto,
     tutu,
-          tata,
-          _,
 
-good-names=i,
+good-names=
+    ex,
+    i,
     j,
     k,
-           ex,
     Run,
 
 [TYPECHECK]

test/lib/ansible_test/_data/sanity/pylint/config/default.cfg

@@ -17,11 +17,11 @@ disable=
     comparison-with-callable,
     consider-iterating-dictionary,
     consider-merging-isinstance,
-    consider-using-dict-comprehension,
+    consider-using-dict-comprehension,  # requires Python 2.7+, but we still require Python 2.6 support
     consider-using-enumerate,
     consider-using-get,
     consider-using-in,
-    consider-using-set-comprehension,
+    consider-using-set-comprehension,  # requires Python 2.7+, but we still require Python 2.6 support
     consider-using-ternary,
     cyclic-import,  # consistent results require running with --jobs 1 and testing all files
     deprecated-lambda,
@@ -115,18 +115,20 @@ disable=
 
 [BASIC]
 
-bad-names=foo,
+bad-names=
+    _,
     bar,
     baz,
+    foo,
+    tata,
     toto,
     tutu,
-          tata,
-          _,
 
-good-names=i,
+good-names=
+    ex,
+    i,
     j,
     k,
-           ex,
     Run,
 
 [TYPECHECK]

test/lib/ansible_test/_data/sanity/pylint/config/sanity.cfg

@@ -1,8 +1,11 @@
 [MESSAGES CONTROL]
 
 disable=
+    consider-using-dict-comprehension,  # requires Python 2.7+, but we still require Python 2.6 support
+    consider-using-set-comprehension,  # requires Python 2.7+, but we still require Python 2.6 support
     cyclic-import,  # consistent results require running with --jobs 1 and testing all files
     duplicate-code,  # consistent results require running with --jobs 1 and testing all files
+    missing-docstring,
     too-few-public-methods,
     too-many-arguments,
     too-many-branches,
@@ -12,30 +15,29 @@ disable=
     too-many-nested-blocks,
     too-many-return-statements,
     too-many-statements,
-    missing-docstring,
     unused-import,  # pylint does not understand PEP 484 type hints
-    consider-using-dict-comprehension,  # requires Python 2.6, which we still support
-    consider-using-set-comprehension,  # requires Python 2.6, which we still support
 
 [BASIC]
 
-bad-names=foo,
+bad-names=
+    _,
     bar,
     baz,
+    foo,
+    tata,
     toto,
     tutu,
-          tata,
-          _,
 
-good-names=i,
+good-names=
-           j,
+    __metaclass__,
-           k,
+    C,
-           f,
     e,
     ex,
+    f,
+    i,
+    j,
+    k,
     Run,
-           C,
-           __metaclass__,
 
 module-rgx=[a-z_][a-z0-9_-]{2,40}$
 method-rgx=[a-z_][a-z0-9_]{2,40}$