[doc] Apply black on the documentation where it makes sense

.pre-commit-config.yaml

@@ -52,6 +52,27 @@ repos:
       - id: black
         args: [--safe, --quiet]
         exclude: *fixtures
+      - id: black
+        name: black-doc
+        args: [--safe, --quiet]
+        files: doc/data/messages/
+        exclude: |
+          (?x)^(
+            doc/data/messages/b/bad-indentation/bad.py|
+            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/multiple-statements/bad.py|
+            doc/data/messages/r/redundant-u-string-prefix/bad.py|
+            doc/data/messages/s/superfluous-parens/bad.py|
+            doc/data/messages/s/syntax-error/bad.py|
+            doc/data/messages/t/too-many-ancestors/bad.py|
+            doc/data/messages/t/trailing-comma-tuple/bad.py|
+            doc/data/messages/t/trailing-newlines/bad.py|
+            doc/data/messages/t/trailing-whitespace/bad.py|
+            doc/data/messages/u/unnecessary-semicolon/bad.py
+          )$
   - repo: https://github.com/Pierre-Sassoulas/black-disable-checker
     rev: v1.1.3
     hooks:

doc/data/messages/a/arguments-renamed/bad.py

@@ -2,12 +2,15 @@ class Fruit:
     def brew(self, ingredient_name: str):
         print(f"Brewing a {type(self)} with {ingredient_name}")
 
+
 class Apple(Fruit):
     ...
 
+
 class Orange(Fruit):
     def brew(self, flavor: str):  # [arguments-renamed]
         print(f"Brewing an orange with {flavor}")
 
+
 for fruit, ingredient_name in [[Orange(), "thyme"], [Apple(), "cinnamon"]]:
     fruit.brew(ingredient_name=ingredient_name)

doc/data/messages/a/arguments-renamed/good.py

@@ -2,12 +2,15 @@ class Fruit:
     def brew(self, ingredient_name: str):
         print(f"Brewing a {type(self)} with {ingredient_name}")
 
+
 class Apple(Fruit):
     ...
 
+
 class Orange(Fruit):
     def brew(self, ingredient_name: str):
         print(f"Brewing an orange with {ingredient_name}")
 
+
 for fruit, ingredient_name in [[Orange(), "thyme"], [Apple(), "cinnamon"]]:
     fruit.brew(ingredient_name=ingredient_name)

doc/data/messages/a/assigning-non-slot/bad.py

@@ -1,5 +1,5 @@
 class Student:
-    __slots__ = ('name',)
+    __slots__ = ("name",)
 
     def __init__(self, name, surname):
         self.name = name

doc/data/messages/a/assigning-non-slot/good.py

@@ -1,5 +1,5 @@
 class Student:
-    __slots__ = ('name', 'surname')
+    __slots__ = ("name", "surname")
 
     def __init__(self, name, surname):
         self.name = name

doc/data/messages/b/bad-chained-comparison/bad.py

@@ -1,3 +1,5 @@
 def xor_check(*, left=None, right=None):
     if left is None != right is None:  # [bad-chained-comparison]
-        raise ValueError('Either both left= and right= need to be provided or none should.')
+        raise ValueError(
+            "Either both left= and right= need to be provided or none should."
+        )

doc/data/messages/b/bad-chained-comparison/good.py

@@ -1,3 +1,5 @@
 def xor_check(*, left=None, right=None):
     if (left is None) != (right is None):
-        raise ValueError('Either both left= and right= need to be provided or none should.')
+        raise ValueError(
+            "Either both left= and right= need to be provided or none should."
+        )

doc/data/messages/b/bad-classmethod-argument/bad.py

@@ -1,5 +1,4 @@
 class Klass:
-
     @classmethod
     def get_instance(self):  # [bad-classmethod-argument]
         return self()

doc/data/messages/b/bad-classmethod-argument/good.py

@@ -1,5 +1,4 @@
 class Klass:
-
     @classmethod
     def get_instance(cls):
         return cls()

doc/data/messages/b/bad-docstring-quotes/bad.py

@@ -1,3 +1,3 @@
 def foo():  # [bad-docstring-quotes]
-    'Docstring.'
+    "Docstring."
     return

doc/data/messages/b/bad-format-string/bad.py

@@ -1 +1 @@
-print('{a[0] + a[1]}'.format(a=[0, 1])) # [bad-format-string]
+print("{a[0] + a[1]}".format(a=[0, 1]))  # [bad-format-string]

doc/data/messages/b/bad-format-string/good.py

@@ -1 +1 @@
-print('{a[0]} + {a[1]}'.format(a=[0, 1]))
+print("{a[0]} + {a[1]}".format(a=[0, 1]))

doc/data/messages/b/bad-indentation/good.py

@@ -1,2 +1,2 @@
 if input():
-    print('yes')
+    print("yes")

doc/data/messages/b/bad-thread-instantiation/bad.py

@@ -2,7 +2,7 @@
 
 
 def thread_target(n):
-    print(n ** 2)
+    print(n**2)
 
 
 thread = threading.Thread(lambda: None)  # [bad-thread-instantiation]

doc/data/messages/b/bad-thread-instantiation/good.py

@@ -2,7 +2,7 @@
 
 
 def thread_target(n):
-    print(n ** 2)
+    print(n**2)
 
 
 thread = threading.Thread(target=thread_target, args=(10,))

doc/data/messages/c/cell-var-from-loop/bad.py

@@ -1,5 +1,7 @@
 def foo(numbers):
     for i in numbers:
+
         def bar():
             print(i)  # [cell-var-from-loop]
+
         bar()

doc/data/messages/c/class-variable-slots-conflict/good.py

@@ -1,5 +1,5 @@
 class Person:
-    __slots__ = ("_age", "name",)
+    __slots__ = ("_age", "name")
 
     def __init__(self, age, name):
         self._age = age

doc/data/messages/c/compare-to-zero/bad.py

@@ -1,8 +1,8 @@
 x = 0
 y = 1
 
-if x == 0:   # [compare-to-zero]
+if x == 0:  # [compare-to-zero]
     print("x is equal to zero")
 
-if y != 0:   # [compare-to-zero]
+if y != 0:  # [compare-to-zero]
     print("y is not equal to zero")

doc/data/messages/c/comparison-with-callable/bad.py

@@ -1,6 +1,7 @@
 def function_returning_a_fruit() -> str:
     return "orange"
 
+
 def is_an_orange(fruit: str = "apple"):
     # apple == <function function_returning_a_fruit at 0x7f343ff0a1f0>
     return fruit == function_returning_a_fruit  # [comparison-with-callable]

doc/data/messages/c/comparison-with-callable/good.py

@@ -1,6 +1,7 @@
 def function_returning_a_fruit() -> str:
     return "orange"
 
+
 def is_an_orange(fruit: str = "apple"):
     # apple == orange
     return fruit == function_returning_a_fruit()

doc/data/messages/c/confusing-with-statement/bad.py

@@ -1,2 +1,2 @@
-with open('file.txt', 'w') as fh1, fh2:  # [confusing-with-statement]
+with open("file.txt", "w") as fh1, fh2:  # [confusing-with-statement]
     pass

doc/data/messages/c/confusing-with-statement/good.py

@@ -1,3 +1,3 @@
-with open('file.txt', 'w', encoding="utf8") as fh1:
-    with open('file.txt', 'w', encoding="utf8") as fh2:
+with open("file.txt", "w", encoding="utf8") as fh1:
+    with open("file.txt", "w", encoding="utf8") as fh2:
         pass

doc/data/messages/c/consider-merging-isinstance/bad.py

@@ -2,4 +2,5 @@
 
 
 def is_number(value: Any) -> bool:
-    return isinstance(value, int) or isinstance(value, float)  # [consider-merging-isinstance]
+    # +1: [consider-merging-isinstance]
+    return isinstance(value, int) or isinstance(value, float)

doc/data/messages/c/consider-using-any-or-all/good.py

@@ -1,8 +1,8 @@
-
 def any_even(items):
     """Return True if the list contains any even numbers"""
     return any(item % 2 == 0 for item in items)
 
+
 def all_even(items):
     """Return True if the list contains all even numbers"""
     return all(item % 2 == 0 for item in items)

doc/data/messages/c/consider-using-enumerate/bad.py

@@ -1,4 +1,4 @@
-seasons = ['Spring', 'Summer', 'Fall', 'Winter']
+seasons = ["Spring", "Summer", "Fall", "Winter"]
 
 for i in range(len(seasons)):  # [consider-using-enumerate]
     print(i, seasons[i])

doc/data/messages/c/consider-using-enumerate/good.py

@@ -1,4 +1,4 @@
-seasons = ['Spring', 'Summer', 'Fall', 'Winter']
+seasons = ["Spring", "Summer", "Fall", "Winter"]
 
 for i, season in enumerate(seasons):
     print(i, season)

doc/data/messages/c/consider-using-f-string/good.py

@@ -1,3 +1,3 @@
-menu = ('eggs', 'spam', 42.4)
+menu = ("eggs", "spam", 42.4)
 
 f_string_order = f"{menu[0]} and {menu[1]}: {menu[2]:0.2f} ¤"

doc/data/messages/c/consider-using-in/bad.py

@@ -1,2 +1,3 @@
 def fruit_is_round(fruit):
-    return fruit == "apple" or fruit == "orange" or fruit == "melon"  # [consider-using-in]
+    # +1: [consider-using-in]
+    return fruit == "apple" or fruit == "orange" or fruit == "melon"

doc/data/messages/c/consider-using-join/bad.py

@@ -4,4 +4,5 @@ def fruits_to_string(fruits):
         formatted_fruit += fruit  # [consider-using-join]
     return formatted_fruit
 
+
 print(fruits_to_string(["apple", "pear", "peach"]))

doc/data/messages/d/deprecated-method/bad.py

@@ -1,3 +1,3 @@
 import logging
 
-logging.warn("I'm coming, world !") # [deprecated-method]
+logging.warn("I'm coming, world !")  # [deprecated-method]

doc/data/messages/d/dict-init-mutate/bad.py

@@ -1,3 +1,3 @@
 fruit_prices = {}  # [dict-init-mutate]
-fruit_prices['apple'] = 1
-fruit_prices['banana'] = 10
+fruit_prices["apple"] = 1
+fruit_prices["banana"] = 10

doc/data/messages/d/dict-iter-missing-items/bad.py

@@ -1,3 +1,3 @@
-data = {'Paris': 2_165_423, 'New York City': 8_804_190, 'Tokyo': 13_988_129}
+data = {"Paris": 2_165_423, "New York City": 8_804_190, "Tokyo": 13_988_129}
 for city, population in data:  # [dict-iter-missing-items]
     print(f"{city} has population {population}.")

doc/data/messages/d/dict-iter-missing-items/good.py

@@ -1,3 +1,3 @@
-data = {'Paris': 2_165_423, 'New York City': 8_804_190, 'Tokyo': 13_988_129}
+data = {"Paris": 2_165_423, "New York City": 8_804_190, "Tokyo": 13_988_129}
 for city, population in data.items():
     print(f"{city} has population {population}.")

doc/data/messages/d/duplicate-code/bad/orange.py

@@ -1,4 +1,4 @@
-class Orange: # [duplicate-code]
+class Orange:  # [duplicate-code]
     def __init__(self):
         self.remaining_bites = 3
 

doc/data/messages/d/duplicate-value/bad.py

@@ -1 +1 @@
-incorrect_set = {'value1', 23, 5, 'value1'} # [duplicate-value]
+incorrect_set = {"value1", 23, 5, "value1"}  # [duplicate-value]

doc/data/messages/d/duplicate-value/good.py

@@ -1 +1 @@
-correct_set = {'value1', 23, 5}
+correct_set = {"value1", 23, 5}

doc/data/messages/e/exec-used/good.py

@@ -1,8 +1,9 @@
 def get_user_code(name):
-    return input(f'Enter code to be executed please, {name}: ')
+    return input(f"Enter code to be executed please, {name}: ")
 
 
 username = "Ada"
-allowed_globals = {'__builtins__' : None}
-allowed_locals = {'print': print}
-exec(get_user_code(username), allowed_globals, allowed_locals)  # pylint: disable=exec-used
+allowed_globals = {"__builtins__": None}
+allowed_locals = {"print": print}
+# pylint: disable-next=exec-used
+exec(get_user_code(username), allowed_globals, allowed_locals)

doc/data/messages/f/forgotten-debug-statement/bad.py

@@ -3,10 +3,15 @@
 
 def find_the_treasure(clues):
     for clue in clues:
-        pdb.set_trace() # [forgotten-debug-statement]
+        pdb.set_trace()  # [forgotten-debug-statement]
         if "treasure" in clue:
             return True
     return False
 
-treasure_hunt = ["Dead Man's Chest", "X marks the spot", "The treasure is buried near the palm tree"]
+
+treasure_hunt = [
+    "Dead Man's Chest",
+    "X marks the spot",
+    "The treasure is buried near the palm tree",
+]
 find_the_treasure(treasure_hunt)

doc/data/messages/f/forgotten-debug-statement/good.py

@@ -4,5 +4,10 @@ def find_the_treasure(clues):
             return True
     return False
 
-treasure_hunt = ["Dead Man's Chest", "X marks the spot", "The treasure is buried near the palm tree"]
+
+treasure_hunt = [
+    "Dead Man's Chest",
+    "X marks the spot",
+    "The treasure is buried near the palm tree",
+]
 find_the_treasure(treasure_hunt)

doc/data/messages/f/format-combined-specification/bad.py

@@ -1 +1 @@
-print('{} {1}'.format('hello', 'world'))  # [format-combined-specification]
+print("{} {1}".format("hello", "world"))  # [format-combined-specification]

doc/data/messages/f/format-combined-specification/good.py

@@ -1,3 +1,3 @@
-print('{0} {1}'.format('hello', 'world'))
+print("{0} {1}".format("hello", "world"))
 # or
-print('{} {}'.format('hello', 'world'))
+print("{} {}".format("hello", "world"))

doc/data/messages/i/import-outside-toplevel/bad.py

@@ -1,3 +1,4 @@
 def print_python_version():
     import sys  # [import-outside-toplevel]
+
     print(sys.version_info)

doc/data/messages/i/import-private-name/bad.py

@@ -2,6 +2,7 @@
 
 attr_holder = _AttributeHolder()
 
+
 def add_sub_parser(sub_parsers: _SubParsersAction):
-    sub_parsers.add_parser('my_subparser')
+    sub_parsers.add_parser("my_subparser")
     # ...

doc/data/messages/i/import-private-name/good.py

@@ -4,5 +4,5 @@
 
 
 def add_sub_parser(sub_parsers: _SubParsersAction):
-    sub_parsers.add_parser('my_subparser')
+    sub_parsers.add_parser("my_subparser")
     # ...

doc/data/messages/i/init-is-generator/bad.py

@@ -2,4 +2,5 @@ class Fruit:
     def __init__(self, worms):  # [init-is-generator]
         yield from worms
 
+
 apple = Fruit(["Fahad", "Anisha", "Tabatha"])

doc/data/messages/i/init-is-generator/good.py

@@ -5,6 +5,7 @@ def __init__(self, worms):
     def worms(self):
         yield from self.__worms
 
+
 apple = Fruit(["Fahad", "Anisha", "Tabatha"])
 for worm in apple.worms():
     pass

doc/data/messages/i/invalid-all-format/bad.py

@@ -1,3 +1,3 @@
-__all__ = ("CONST")  # [invalid-all-format]
+__all__ = "CONST"  # [invalid-all-format]
 
 CONST = 42

doc/data/messages/i/invalid-all-object/bad.py

@@ -4,8 +4,10 @@
     Worm,
 )
 
+
 class Fruit:
     pass
 
+
 class Worm:
     pass

doc/data/messages/i/invalid-all-object/good.py

@@ -1,7 +1,9 @@
-__all__ = ['Fruit', 'Worm']
+__all__ = ["Fruit", "Worm"]
+
 
 class Fruit:
     pass
 
+
 class Worm:
     pass

doc/data/messages/i/invalid-character-backspace/bad.py

@@ -1 +1 @@
-STRING = "Invalid character backspace " # [invalid-character-backspace]
+STRING = "Invalid character backspace "  # [invalid-character-backspace]

doc/data/messages/i/invalid-character-esc/bad.py

@@ -1 +1 @@
-STRING = "Invalid escape character " # [invalid-character-esc]
+STRING = "Invalid escape character "  # [invalid-character-esc]

doc/data/messages/i/invalid-character-sub/bad.py

@@ -1 +1 @@
-STRING = "Invalid character sub " # [invalid-character-sub]
+STRING = "Invalid character sub "  # [invalid-character-sub]

doc/data/messages/i/invalid-character-zero-width-space/bad.py

@@ -1 +1 @@
-STRING = "Invalid character zero-width-space ​" # [invalid-character-zero-width-space]
+STRING = "Invalid character zero-width-space ​"  # [invalid-character-zero-width-space]

doc/data/messages/i/invalid-envvar-default/bad.py

@@ -1,3 +1,3 @@
 import os
 
-env = os.getenv('SECRET_KEY', 1)  # [invalid-envvar-default]
+env = os.getenv("SECRET_KEY", 1)  # [invalid-envvar-default]

doc/data/messages/i/invalid-envvar-default/good.py

@@ -1,3 +1,3 @@
 import os
 
-env = os.getenv('SECRET_KEY', '1')
+env = os.getenv("SECRET_KEY", "1")