Re-run black

This fixes all the docstrings - neat

Author: dmerejkowsky

cli_ui/__init__.py

@@ -54,7 +54,7 @@ def setup(
     title: str = "auto",
     timestamp: bool = False,
 ) -> None:
-    """ Configure behavior of message functions.
+    """Configure behavior of message functions.
 
     :param verbose: Whether :func:`debug` messages should get printed
     :param quiet: Hide every message except :func:`warning`, :func:`error`, and
@@ -73,7 +73,7 @@ def _setup(**kwargs: ConfigValue) -> None:
 
 
 class Color:
-    """Represent an ANSI escape sequence """
+    """Represent an ANSI escape sequence"""
 
     def __init__(self, name: str, code: str):
         self.name = name
@@ -120,7 +120,7 @@ def __repr__(self) -> str:
 
 # Other nice-to-have characters:
 class UnicodeSequence:
-    """ Represent a sequence containing a color followed by a Unicode symbol """
+    """Represent a sequence containing a color followed by a Unicode symbol"""
 
     def __init__(self, color: Color, as_unicode: str, as_ascii: str):
         if os.name == "nt":
@@ -176,7 +176,7 @@ def write_title_string(mystr: str, fileobj: FileObj) -> None:
 def process_tokens(
     tokens: Sequence[Token], *, end: str = "\n", sep: str = " "
 ) -> Tuple[str, str]:
-    """ Returns two strings from a list of tokens.
+    """Returns two strings from a list of tokens.
     One containing ASCII escape codes, the other
     only the 'normal' characters
 
@@ -238,9 +238,7 @@ def message(
     fileobj: FileObj = sys.stdout,
     update_title: bool = False,
 ) -> None:
-    """ Helper method for error, warning, info, debug
-
-    """
+    """Helper method for error, warning, info, debug"""
     should_use_colors = colors_enabled(fileobj)
     with_color, without_color = process_tokens(tokens, end=end, sep=sep)
     if CONFIG["record"]:
@@ -252,27 +250,27 @@ def message(
 
 
 def fatal(*tokens: Token, **kwargs: Any) -> None:
-    """ Print an error message and call ``sys.exit`` """
+    """Print an error message and call ``sys.exit``"""
     error(*tokens, **kwargs)
     sys.exit(1)
 
 
 def error(*tokens: Token, **kwargs: Any) -> None:
-    """ Print an error message """
+    """Print an error message"""
     tokens = [bold, red, "Error:"] + list(tokens)  # type: ignore
     kwargs["fileobj"] = sys.stderr
     message(*tokens, **kwargs)
 
 
 def warning(*tokens: Token, **kwargs: Any) -> None:
-    """ Print a warning message """
+    """Print a warning message"""
     tokens = [brown, "Warning:"] + list(tokens)  # type: ignore
     kwargs["fileobj"] = sys.stderr
     message(*tokens, **kwargs)
 
 
 def info(*tokens: Token, **kwargs: Any) -> None:
-    r""" Print an informative message
+    r"""Print an informative message
 
     :param tokens: list of `ui` constants or strings, like ``(cli_ui.red, 'this is an error')``
     :param sep: separator, defaults to ``' '``
@@ -286,7 +284,7 @@ def info(*tokens: Token, **kwargs: Any) -> None:
 
 
 def info_section(*tokens: Token, **kwargs: Any) -> None:
-    """ Print an underlined section name """
+    """Print an underlined section name"""
     # We need to know the length of the section:
     process_tokens_kwargs = kwargs.copy()
     process_tokens_kwargs["color"] = False
@@ -296,22 +294,22 @@ def info_section(*tokens: Token, **kwargs: Any) -> None:
 
 
 def info_1(*tokens: Token, **kwargs: Any) -> None:
-    """ Print an important informative message """
+    """Print an important informative message"""
     info(bold, blue, "::", reset, *tokens, **kwargs)
 
 
 def info_2(*tokens: Token, **kwargs: Any) -> None:
-    """ Print an not so important informative message """
+    """Print an not so important informative message"""
     info(bold, blue, "=>", reset, *tokens, **kwargs)
 
 
 def info_3(*tokens: Token, **kwargs: Any) -> None:
-    """ Print an even less important informative message """
+    """Print an even less important informative message"""
     info(bold, blue, "*", reset, *tokens, **kwargs)
 
 
 def dot(*, last: bool = False, fileobj: FileObj = sys.stdout) -> None:
-    """ Print a dot without a newline unless it is the last one.
+    """Print a dot without a newline unless it is the last one.
 
     Useful when you want to display a progress with very little
     knowledge.
@@ -323,7 +321,7 @@ def dot(*, last: bool = False, fileobj: FileObj = sys.stdout) -> None:
 
 
 def info_count(i: int, n: int, *rest: Token, **kwargs: Any) -> None:
-    """ Display a counter before the rest of the message.
+    """Display a counter before the rest of the message.
 
     ``rest`` and ``kwargs`` are passed to :func:`info`
 
@@ -339,7 +337,7 @@ def info_count(i: int, n: int, *rest: Token, **kwargs: Any) -> None:
 
 
 def info_progress(prefix: str, value: float, max_value: float) -> None:
-    """ Display info progress in percent.
+    """Display info progress in percent.
 
     :param value: the current value
     :param max_value: the max value
@@ -354,7 +352,7 @@ def info_progress(prefix: str, value: float, max_value: float) -> None:
 
 
 def debug(*tokens: Token, **kwargs: Any) -> None:
-    """ Print a debug message.
+    """Print a debug message.
 
     Messages are shown only when ``CONFIG["verbose"]`` is true
     """
@@ -375,9 +373,7 @@ def indent(text: str, num: int = 2) -> str:
 
 
 def tabs(num: int) -> str:
-    """ Compute a blank tab
-
-    """
+    """Compute a blank tab"""
     return "  " * num
 
 
@@ -420,7 +416,7 @@ def info_table(
 
 
 def message_for_exception(exception: Exception, message: str) -> Sequence[Token]:
-    """ Returns a tuple suitable for cli_ui.error()
+    """Returns a tuple suitable for cli_ui.error()
     from the given exception.
     (Traceback will be part of the message, after
     the ``message`` argument)
@@ -443,17 +439,13 @@ def message_for_exception(exception: Exception, message: str) -> Sequence[Token]
 
 
 def read_input() -> str:
-    """ Read input from the user
-
-    """
+    """Read input from the user"""
     info(green, "> ", end="")
     return input()
 
 
 def read_password() -> str:
-    """ Read a password from the user
-
-    """
+    """Read a password from the user"""
     info(green, "> ", end="")
     return getpass.getpass(prompt="")
 
@@ -463,8 +455,7 @@ def get_ask_tokens(tokens: Sequence[Token]) -> List[Token]:
 
 
 def ask_string(*question: Token, default: Optional[str] = None) -> Optional[str]:
-    """Ask the user to enter a string.
-    """
+    """Ask the user to enter a string."""
     tokens = get_ask_tokens(question)
     if default:
         tokens.append("(%s)" % default)
@@ -476,8 +467,7 @@ def ask_string(*question: Token, default: Optional[str] = None) -> Optional[str]
 
 
 def ask_password(*question: Token) -> str:
-    """Ask the user to enter a password.
-    """
+    """Ask the user to enter a password."""
     tokens = get_ask_tokens(question)
     info(*tokens)
     answer = read_password()
@@ -563,9 +553,7 @@ def ask_yes_no(*question: Token, default: bool = False) -> bool:
 
 
 class Timer:
-    """ Display time taken when executing a list of statements.
-
-    """
+    """Display time taken when executing a list of statements."""
 
     def __init__(self, description: str):
         self.description = description
@@ -591,11 +579,11 @@ def __exit__(self, *unused: Any) -> None:
         self.stop()
 
     def start(self) -> None:
-        """ Start the timer """
+        """Start the timer"""
         self.start_time = datetime.datetime.now()
 
     def stop(self) -> None:
-        """ Stop the timer and emit a nice log """
+        """Stop the timer and emit a nice log"""
         end_time = datetime.datetime.now()
         elapsed_time = end_time - self.start_time
         elapsed_seconds = elapsed_time.seconds
@@ -611,7 +599,7 @@ def stop(self) -> None:
 
 
 def did_you_mean(message: str, user_input: str, choices: Sequence[str]) -> str:
-    """ Given a list of choices and an invalid user input, display the closest
+    """Given a list of choices and an invalid user input, display the closest
     items in the list that match the input.
 
     """

cli_ui/tests/conftest.py

@@ -7,26 +7,26 @@
 
 
 class MessageRecorder:
-    """ Helper class to tests emitted messages """
+    """Helper class to tests emitted messages"""
 
     def __init__(self) -> None:
         cli_ui._MESSAGES = list()
 
     def start(self) -> None:
-        """ Start recording messages """
+        """Start recording messages"""
         cli_ui.CONFIG["record"] = True
 
     def stop(self) -> None:
-        """ Stop recording messages """
+        """Stop recording messages"""
         cli_ui.CONFIG["record"] = False
         cli_ui._MESSAGES = list()
 
     def reset(self) -> None:
-        """ Reset the list """
+        """Reset the list"""
         cli_ui._MESSAGES = list()
 
     def find(self, pattern: str) -> Optional[str]:
-        """ Find a message in the list of recorded message
+        """Find a message in the list of recorded message
 
         :param pattern: regular expression pattern to use
                         when looking for recorded message

cli_ui/tests/test_cli_ui.py

@@ -166,8 +166,14 @@ def test_table_with_dict_no_color(dumb_tty: DumbTTY) -> None:
 
 def test_table_with_dict_and_color(always_color: None, smart_tty: SmartTTY) -> None:
     data = {
-        (cli_ui.bold, "Name",): [(cli_ui.green, "Alice"), (cli_ui.green, "Bob")],
-        (cli_ui.bold, "Age",): [(cli_ui.blue, 24), (cli_ui.blue, 9)],
+        (
+            cli_ui.bold,
+            "Name",
+        ): [(cli_ui.green, "Alice"), (cli_ui.green, "Bob")],
+        (
+            cli_ui.bold,
+            "Age",
+        ): [(cli_ui.blue, 24), (cli_ui.blue, 9)],
     }
     cli_ui.info_table(data, headers="keys", fileobj=smart_tty)
     actual = smart_tty.getvalue()
@@ -258,7 +264,7 @@ def test_empty_password() -> None:
 
 
 def test_ask_yes_no() -> None:
-    """ Test that you can answer with several types of common answers """
+    """Test that you can answer with several types of common answers"""
     with mock.patch("builtins.input") as m:
         m.side_effect = ["y", "yes", "Yes", "n", "no", "No"]
         expected_res = [True, True, True, False, False, False]
@@ -268,15 +274,15 @@ def test_ask_yes_no() -> None:
 
 
 def test_ask_yes_no_default() -> None:
-    """ Test that just pressing enter returns the default value """
+    """Test that just pressing enter returns the default value"""
     with mock.patch("builtins.input") as m:
         m.side_effect = ["", ""]
         assert cli_ui.ask_yes_no("coffee?", default=True) is True
         assert cli_ui.ask_yes_no("coffee?", default=False) is False
 
 
 def test_ask_yes_no_wrong_input() -> None:
-    """ Test that we keep asking when answer does not make sense """
+    """Test that we keep asking when answer does not make sense"""
     with mock.patch("builtins.input") as m:
         m.side_effect = ["coffee!", "n"]
         assert cli_ui.ask_yes_no("tea?") is False