pylint-dev · Pierre-Sassoulas · Sep 12, 2023 · Sep 12, 2023 · Sep 12, 2023 · Sep 12, 2023
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -13,7 +13,8 @@ repos:
             tests(/\w*)*/functional/m/missing/missing_final_newline.py|
             tests/functional/t/trailing_newlines.py|
             doc/data/messages/t/trailing-newlines/bad.py|
-            doc/data/messages/m/missing-final-newline/bad.py|
+            doc/data/messages/m/missing-final-newline/bad/lf.py|
+            doc/data/messages/m/missing-final-newline/bad/crlf.py
           )$
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: "v0.0.288"
@@ -59,7 +60,8 @@ repos:
             doc/data/messages/i/inconsistent-quotes/bad.py|
             doc/data/messages/i/invalid-format-index/bad.py|
             doc/data/messages/l/line-too-long/bad.py|
-            doc/data/messages/m/missing-final-newline/bad.py|
+            doc/data/messages/m/missing-final-newline/bad/crlf.py|
+            doc/data/messages/m/missing-final-newline/bad/lf.py|
             doc/data/messages/m/multiple-statements/bad.py|
             doc/data/messages/r/redundant-u-string-prefix/bad.py|
             doc/data/messages/s/superfluous-parens/bad.py|

diff --git a/doc/data/messages/i/implicit-str-concat/bad/list.py b/doc/data/messages/i/implicit-str-concat/bad/list.py
@@ -0,0 +1 @@
+x = ["a" "b"]  # [implicit-str-concat]
diff --git a/...ata/messages/i/implicit-str-concat/bad.py → ...essages/i/implicit-str-concat/bad/open.py b/...ata/messages/i/implicit-str-concat/bad.py → ...essages/i/implicit-str-concat/bad/open.py
@@ -1,4 +1,2 @@
-x = ["a" "b"]  # [implicit-str-concat]
-
 with open("hello.txt" "r") as f:  # [implicit-str-concat]
     print(f.read())
diff --git a/doc/data/messages/i/implicit-str-concat/good/list.py b/doc/data/messages/i/implicit-str-concat/good/list.py
@@ -0,0 +1 @@
+x = ["a", "b"]
diff --git a/...ta/messages/i/implicit-str-concat/good.py → ...ssages/i/implicit-str-concat/good/open.py b/...ta/messages/i/implicit-str-concat/good.py → ...ssages/i/implicit-str-concat/good/open.py
@@ -1,4 +1,2 @@
-x = ["a", "b"]
-
 with open("hello.txt", "r") as f:
     print(f.read())
diff --git a/doc/data/messages/i/inconsistent-mro/good.py b/doc/data/messages/i/inconsistent-mro/good.py
@@ -6,5 +6,5 @@ class B(A):
     pass
 
 
-class C(B):  # or B, A or A but not A, B
+class C(B):  # or 'B, A' or 'A' but not 'A, B'
     pass
diff --git a/doc/data/messages/i/invalid-bool-returned/bad.py b/doc/data/messages/i/invalid-bool-returned/bad.py
@@ -1,4 +1,4 @@
-class BadBool:
+class CustomBool:
     """__bool__ returns an int"""
 
     def __bool__(self):  # [invalid-bool-returned]

diff --git a/doc/data/messages/i/invalid-bool-returned/good.py b/doc/data/messages/i/invalid-bool-returned/good.py
@@ -1,4 +1,4 @@
-class GoodBool:
+class CustomBool:
     """__bool__ returns `bool`"""
 
     def __bool__(self):

diff --git a/doc/data/messages/i/invalid-bytes-returned/bad.py b/doc/data/messages/i/invalid-bytes-returned/bad.py
@@ -1,4 +1,4 @@
-class BadBytes:
+class CustomBytes:
     """__bytes__ returns <type 'str'>"""
 
     def __bytes__(self):  # [invalid-bytes-returned]

diff --git a/doc/data/messages/i/invalid-bytes-returned/good.py b/doc/data/messages/i/invalid-bytes-returned/good.py
@@ -1,4 +1,4 @@
-class GoodBytes:
+class CustomBytes:
     """__bytes__ returns <type 'bytes'>"""
 
     def __bytes__(self):

diff --git a/doc/data/messages/i/invalid-format-returned/bad.py b/doc/data/messages/i/invalid-format-returned/bad.py
@@ -1,4 +1,4 @@
-class BadFormat:
+class CustomFormat:
     """__format__ returns <type 'int'>"""
 
     def __format__(self, format_spec):  # [invalid-format-returned]

diff --git a/doc/data/messages/i/invalid-format-returned/good.py b/doc/data/messages/i/invalid-format-returned/good.py
@@ -1,4 +1,4 @@
-class GoodFormat:
+class CustomFormat:
     """__format__ returns <type 'str'>"""
 
     def __format__(self, format_spec):

diff --git a/doc/data/messages/i/invalid-getnewargs-ex-returned/bad.py b/doc/data/messages/i/invalid-getnewargs-ex-returned/bad.py
@@ -1,4 +1,4 @@
-class BadGetNewArgsEx:
+class CustomGetNewArgsEx:
     """__getnewargs_ex__ returns tuple with incorrect arg length"""
 
     def __getnewargs_ex__(self):  # [invalid-getnewargs-ex-returned]

diff --git a/doc/data/messages/i/invalid-getnewargs-ex-returned/good.py b/doc/data/messages/i/invalid-getnewargs-ex-returned/good.py
@@ -1,4 +1,4 @@
-class GoodGetNewArgsEx:
+class CustomGetNewArgsEx:
     """__getnewargs_ex__ returns <type 'tuple'>"""
 
     def __getnewargs_ex__(self):

diff --git a/doc/data/messages/i/invalid-getnewargs-returned/bad.py b/doc/data/messages/i/invalid-getnewargs-returned/bad.py
@@ -1,4 +1,4 @@
-class BadGetNewArgs:
+class CustomGetNewArgs:
     """__getnewargs__ returns an integer"""
 
     def __getnewargs__(self):  # [invalid-getnewargs-returned]

diff --git a/doc/data/messages/i/invalid-getnewargs-returned/good.py b/doc/data/messages/i/invalid-getnewargs-returned/good.py
@@ -1,4 +1,4 @@
-class GoodGetNewArgs:
+class CustomGetNewArgs:
     """__getnewargs__ returns <type 'tuple'>"""
 
     def __getnewargs__(self):

diff --git a/doc/data/messages/i/invalid-hash-returned/bad.py b/doc/data/messages/i/invalid-hash-returned/bad.py
@@ -1,4 +1,4 @@
-class BadHash:
+class CustomHash:
     """__hash__ returns dict"""
 
     def __hash__(self):  # [invalid-hash-returned]

diff --git a/doc/data/messages/i/invalid-hash-returned/good.py b/doc/data/messages/i/invalid-hash-returned/good.py
@@ -1,4 +1,4 @@
-class GoodHash:
+class CustomHash:
     """__hash__ returns `int`"""
 
     def __hash__(self):

diff --git a/doc/data/messages/i/invalid-index-returned/bad.py b/doc/data/messages/i/invalid-index-returned/bad.py
@@ -1,4 +1,4 @@
-class BadIndex:
+class CustomIndex:
     """__index__ returns a dict"""
 
     def __index__(self):  # [invalid-index-returned]

diff --git a/doc/data/messages/i/invalid-index-returned/good.py b/doc/data/messages/i/invalid-index-returned/good.py
@@ -1,4 +1,4 @@
-class GoodIndex:
+class CustomIndex:
     """__index__ returns <type 'int'>"""
 
     def __index__(self):

diff --git a/doc/data/messages/i/invalid-length-hint-returned/bad.py b/doc/data/messages/i/invalid-length-hint-returned/bad.py
@@ -1,4 +1,4 @@
-class BadLengthHint:
+class CustomLengthHint:
     """__length_hint__ returns non-int"""
 
     def __length_hint__(self):  # [invalid-length-hint-returned]

diff --git a/doc/data/messages/i/invalid-length-hint-returned/good.py b/doc/data/messages/i/invalid-length-hint-returned/good.py
@@ -1,4 +1,4 @@
-class GoodLengthHint:
+class CustomLengthHint:
     """__length_hint__ returns <type 'int'>"""
 
     def __length_hint__(self):

diff --git a/doc/data/messages/i/invalid-repr-returned/bad.py b/doc/data/messages/i/invalid-repr-returned/bad.py
@@ -1,4 +1,4 @@
-class Repr:
+class CustomRepr:
     """__repr__ returns <type 'int'>"""
 
     def __repr__(self):  # [invalid-repr-returned]

diff --git a/doc/data/messages/i/invalid-repr-returned/good.py b/doc/data/messages/i/invalid-repr-returned/good.py
@@ -1,4 +1,4 @@
-class Repr:
+class CustomRepr:
     """__repr__ returns <type 'str'>"""
 
     def __repr__(self):

diff --git a/doc/data/messages/i/invalid-str-returned/bad.py b/doc/data/messages/i/invalid-str-returned/bad.py
@@ -1,4 +1,4 @@
-class Str:
+class CustomStr:
     """__str__ returns int"""
 
     def __str__(self):  # [invalid-str-returned]

diff --git a/doc/data/messages/i/invalid-str-returned/good.py b/doc/data/messages/i/invalid-str-returned/good.py
@@ -1,4 +1,4 @@
-class Str:
+class CustomStr:
     """__str__ returns <type 'str'>"""
 
     def __str__(self):

diff --git a/doc/data/messages/k/kwarg-superseded-by-positional-arg/bad.py b/doc/data/messages/k/kwarg-superseded-by-positional-arg/bad.py
@@ -3,3 +3,4 @@ def print_name(name="Sarah", /, **kwds):
 
 
 print_name(name="Jacob")  # [kwarg-superseded-by-positional-arg]
+# Will print "Sarah"
diff --git a/doc/data/messages/k/kwarg-superseded-by-positional-arg/good.py b/doc/data/messages/k/kwarg-superseded-by-positional-arg/good.py
@@ -3,3 +3,4 @@ def print_name(name="Sarah", /, **kwds):
 
 
 print_name("Jacob")
+# Will print "Jacob"
diff --git a/doc/data/messages/l/logging-format-truncated/bad.py b/doc/data/messages/l/logging-format-truncated/bad.py
@@ -1,3 +1,4 @@
 import logging
+import sys
 
-logging.warning("Here is a variable: %", my_var)  # [logging-format-truncated]
+logging.warning("Python version: %", sys.version)  # [logging-format-truncated]
diff --git a/doc/data/messages/l/logging-format-truncated/good.py b/doc/data/messages/l/logging-format-truncated/good.py
@@ -1,3 +1,4 @@
 import logging
+import sys
 
-logging.warning("Here is a variable: %s", my_var)
+logging.warning("Python version: %s", sys.version)
diff --git a/doc/data/messages/m/missing-final-newline/bad.py b/doc/data/messages/m/missing-final-newline/bad.py
diff --git a/doc/data/messages/m/missing-final-newline/bad/crlf.py b/doc/data/messages/m/missing-final-newline/bad/crlf.py
@@ -0,0 +1,3 @@
+print("Hello")  # CRLF (\r\n)
+print("world")  # End-of-file (EOF)
+# [missing-final-newline]
diff --git a/doc/data/messages/m/missing-final-newline/bad/lf.py b/doc/data/messages/m/missing-final-newline/bad/lf.py
@@ -0,0 +1,3 @@
+print("Hello")  # LF (\n)
+print("world")  # End-of-file (EOF)
+# [missing-final-newline]
diff --git a/doc/data/messages/m/missing-final-newline/good.py b/doc/data/messages/m/missing-final-newline/good.py
diff --git a/doc/data/messages/m/missing-final-newline/good/crlf.py b/doc/data/messages/m/missing-final-newline/good/crlf.py
@@ -0,0 +1,3 @@
+print("Hello")  # CRLF (\r\n)
+print("world")  # CRLF (\r\n)
+# End-of-file (EOF)
diff --git a/doc/data/messages/m/missing-final-newline/good/lf.py b/doc/data/messages/m/missing-final-newline/good/lf.py
@@ -0,0 +1,3 @@
+print("Hello")  # LF (\n)
+print("world")  # LF (\n)
+# End-of-file (EOF)
diff --git a/doc/data/messages/m/missing-module-docstring/good.py b/doc/data/messages/m/missing-module-docstring/good.py
@@ -1,4 +1,4 @@
-"""Module providingFunction printing python version."""
+"""Module providing a function printing python version."""
 import sys
 
 

diff --git a/...ta/messages/m/mixed-format-string/good.py → .../m/mixed-format-string/good/only_named.py b/...ta/messages/m/mixed-format-string/good.py → .../m/mixed-format-string/good/only_named.py
@@ -1,2 +1 @@
-print("x=%d, y=%d" % (0, 1))
 print("x=%(x)d, y=%(y)d" % {"x": 0, "y": 1})
diff --git a/doc/data/messages/m/mixed-format-string/good/only_ordered.py b/doc/data/messages/m/mixed-format-string/good/only_ordered.py
@@ -0,0 +1 @@
+print("x=%d, y=%d" % (0, 1))
diff --git a/doc/test_messages_documentation.py b/doc/test_messages_documentation.py
@@ -221,7 +221,8 @@ def assert_message_bad(self, bad_files: list[Path], messages: list[Message]) ->
         missing_files = set(bad_files) - raised_files
         for missing_file in missing_files:
             msg += f"- Missing warning in {missing_file}\n"
-        msg += f"'{messages[0].symbol}' might need to be added in 'known_multiple_file_messages'.\n\n"
+        if messages:
+            msg += f"'{messages[0].symbol}' might need to be added in 'known_multiple_file_messages'.\n\n"
         return msg
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,5 +6,5 @@ class B(A): @@
         pass
-    class C(B):  # or B, A or A but not A, B
+    class C(B):  # or 'B, A' or 'A' but not 'A, B'
         pass
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,3 +3,4 @@ def print_name(name="Sarah", /, **kwds):


		print_name(name="Jacob") # [kwarg-superseded-by-positional-arg]
		# Will print "Sarah"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,3 +3,4 @@ def print_name(name="Sarah", /, **kwds):


		print_name("Jacob")
		# Will print "Jacob"
Original file line number	Diff line number	Diff line change
		@@ -1,2 +1 @@
		print("x=%d, y=%d" % (0, 1))
		print("x=%(x)d, y=%(y)d" % {"x": 0, "y": 1})