de-glob mypy whitelist and improve type annotations (#139)

Author: danieleades

cleo/_utils.py

@@ -1,6 +1,7 @@
 import math
 
 from html.parser import HTMLParser
+from typing import Any
 from typing import List
 
 from pylev import levenshtein
@@ -34,7 +35,7 @@ def _strip(value) -> str:
     return s.get_data()
 
 
-def strip_tags(value):
+def strip_tags(value: Any) -> str:
     value = str(value)
     while "<" in value and ">" in value:
         new_value = _strip(value)
@@ -46,7 +47,7 @@ def strip_tags(value):
     return value
 
 
-def find_similar_names(name, names):  # type: (str, List[str]) -> List[str]
+def find_similar_names(name: str, names: List[str]) -> List[str]:
     """
     Finds names similar to a given command name.
     """

cleo/application.py

@@ -60,21 +60,21 @@ class Application:
     def __init__(self, name: str = "console", version: str = "") -> None:
         self._name = name
         self._version = version
-        self._display_name = None
+        self._display_name: Optional[str] = None
         self._terminal = Terminal()
         self._default_command = "list"
         self._single_command = False
         self._commands: Dict[str, Command] = {}
         self._running_command = None
         self._want_helps = False
-        self._definition = None
+        self._definition: Optional[Definition] = None
         self._catch_exceptions = True
         self._auto_exit = True
         self._initialized = False
-        self._ui = None
+        self._ui: Optional[UI] = None
 
         # TODO: signals support
-        self._event_dispatcher = None
+        self._event_dispatcher: Optional[EventDispatcher] = None
 
         self._command_loader: Optional[CommandLoader] = None
 
@@ -185,7 +185,7 @@ def add(self, command: Command) -> Optional[Command]:
         if not command.enabled:
             command.set_application()
 
-            return
+            return None
 
         if not command.name:
             raise LogicException(

cleo/color.py

@@ -141,12 +141,12 @@ def _degrade_hex_color_to_ansi(self, r: int, g: int, b: int) -> int:
         return (round(b / 255) << 2) | (round(g / 255) << 1) | round(r / 255)
 
     def _get_saturation(self, r: int, g: int, b: int) -> int:
-        r = r / 255
-        g = g / 255
-        b = b / 255
-        v = max(r, g, b)
+        r_float = r / 255
+        g_float = g / 255
+        b_float = b / 255
+        v = max(r_float, g_float, b_float)
 
-        diff = v - min(r, g, b)
+        diff = v - min(r_float, g_float, b_float)
         if diff == 0:
             return 0
 

cleo/commands/base_command.py

@@ -1,6 +1,8 @@
 import inspect
 
 from typing import TYPE_CHECKING
+from typing import Dict
+from typing import List
 from typing import Optional
 
 from cleo.exceptions import CleoException
@@ -14,7 +16,7 @@
 
 class BaseCommand:
 
-    name = None
+    name: Optional[str] = None
 
     description = ""
 
@@ -23,14 +25,14 @@ class BaseCommand:
     enabled = True
     hidden = False
 
-    usages = []
+    usages: List[str] = []
 
     def __init__(self) -> None:
         self._definition = Definition()
         self._full_definition = None
         self._application = None
         self._ignore_validation_errors = False
-        self._synopsis = {}
+        self._synopsis: Dict[str, str] = {}
 
         self.configure()
 

cleo/commands/command.py

@@ -13,6 +13,7 @@
 from cleo.io.null_io import NullIO
 from cleo.io.outputs.output import Verbosity
 from cleo.parser import Parser
+from cleo.ui.table_separator import TableSeparator
 
 from .base_command import BaseCommand
 
@@ -34,7 +35,7 @@ class Command(BaseCommand):
 
     commands = []
 
-    def __init__(self):
+    def __init__(self) -> None:
         self._io: Optional[IO] = None
         super().__init__()
 
@@ -222,23 +223,23 @@ def table(self, header=None, rows=None, style=None):
 
         return table
 
-    def table_separator(self):
+    def table_separator(self) -> "TableSeparator":
         """
         Return a TableSeparator instance.
         """
         from cleo.ui.table_separator import TableSeparator
 
         return TableSeparator()
 
-    def render_table(self, headers, rows, style=None):
+    def render_table(self, headers, rows, style=None) -> None:
         """
         Format input to textual table.
         """
         table = self.table(headers, rows, style)
 
         table.render()
 
-    def write(self, text, style=None):
+    def write(self, text: str, style: Optional[str] = None) -> None:
         """
         Writes a string without a new line.
         Useful if you want to use overwrite().
@@ -255,7 +256,7 @@ def line(
         text: str,
         style: Optional[str] = None,
         verbosity: Verbosity = Verbosity.NORMAL,
-    ):
+    ) -> None:
         """
         Write a string as information output.
         """
@@ -271,7 +272,7 @@ def line_error(
         text: str,
         style: Optional[str] = None,
         verbosity: Verbosity = Verbosity.NORMAL,
-    ):
+    ) -> None:
         """
         Write a string as information output to stderr.
         """
@@ -282,7 +283,7 @@ def line_error(
 
         self._io.write_error_line(styled, verbosity)
 
-    def info(self, text):
+    def info(self, text: str) -> None:
         """
         Write a string as information output.
 
@@ -291,7 +292,7 @@ def info(self, text):
         """
         self.line(text, "info")
 
-    def comment(self, text):
+    def comment(self, text: str) -> None:
         """
         Write a string as comment output.
 
@@ -300,7 +301,7 @@ def comment(self, text):
         """
         self.line(text, "comment")
 
-    def question(self, text):
+    def question(self, text: str) -> None:
         """
         Write a string as question output.
 
@@ -330,15 +331,28 @@ def progress_indicator(
 
         return ProgressIndicator(self.io, fmt, interval, values)
 
-    def spin(self, start_message, end_message, fmt=None, interval=100, values=None):
+    def spin(
+        self,
+        start_message: str,
+        end_message: str,
+        fmt: Optional[str] = None,
+        interval=100,
+        values: Optional[List[str]] = None,
+    ):
         """
         Automatically spin a progress indicator.
         """
         spinner = ProgressIndicator(self.io, fmt, interval, values)
 
         return spinner.auto(start_message, end_message)
 
-    def add_style(self, name, fg=None, bg=None, options=None):
+    def add_style(
+        self,
+        name: str,
+        fg: Optional[str] = None,
+        bg: Optional[str] = None,
+        options: Optional[List[str]] = None,
+    ) -> None:
         """
         Adds a new style
         """
@@ -359,7 +373,7 @@ def add_style(self, name, fg=None, bg=None, options=None):
         self._io.output.formatter.add_style(style)
         self._io.error_output.formatter.add_style(style)
 
-    def overwrite(self, text):
+    def overwrite(self, text: str) -> None:
         """
         Overwrites the current line.
 

cleo/commands/completions_command.py

@@ -5,6 +5,8 @@
 import re
 import subprocess
 
+from typing import Optional
+
 from .. import helpers
 from .command import Command
 from .completions.templates import TEMPLATES
@@ -381,7 +383,7 @@ def render_fish(self):
 
         return output
 
-    def get_shell_type(self):
+    def get_shell_type(self) -> str:
         shell = os.getenv("SHELL")
         if not shell:
             raise RuntimeError(
@@ -391,18 +393,18 @@ def get_shell_type(self):
 
         return os.path.basename(shell)
 
-    def _generate_function_name(self, script_name, script_path):
+    def _generate_function_name(self, script_name: str, script_path: str) -> str:
         return "_{}_{}_complete".format(
             self._sanitize_for_function_name(script_name),
             hashlib.md5(script_path.encode()).hexdigest()[0:16],
         )
 
-    def _sanitize_for_function_name(self, name):
+    def _sanitize_for_function_name(self, name: str) -> str:
         name = name.replace("-", "_")
 
         return re.sub("[^A-Za-z0-9_]+", "", name)
 
-    def _zsh_describe(self, value, description=None):
+    def _zsh_describe(self, value: str, description: Optional[str] = None) -> str:
         value = '"' + value.replace(":", "\\:")
         if description:
             description = re.sub(

cleo/descriptors/application_description.py

@@ -42,7 +42,7 @@ def command(self, name: str) -> Command:
 
         return self._commands.get(name, self._aliases.get(name))
 
-    def _inspect_application(self):
+    def _inspect_application(self) -> None:
         namespace = None
         if self._namespace:
             namespace = self._application.find_namespace(self._namespace)

cleo/descriptors/text_descriptor.py

@@ -3,6 +3,7 @@
 
 from typing import Any
 from typing import List
+from typing import Sequence
 from typing import Union
 
 from cleo.application import Application
@@ -263,7 +264,7 @@ def _calculate_total_width_for_options(self, options: List[Option]) -> int:
 
         return total_width
 
-    def _get_column_width(self, commands: List[Union[Command, str]]) -> int:
+    def _get_column_width(self, commands: Sequence[Union[Command, str]]) -> int:
         widths = []
 
         for command in commands:

cleo/events/console_error_event.py

@@ -20,7 +20,7 @@ def __init__(self, command: Optional["Command"], io: IO, error: Exception) -> No
         super().__init__(command, io)
 
         self._error = error
-        self._exit_code = None
+        self._exit_code: Optional[int] = None
 
     @property
     def error(self) -> Exception:

cleo/formatters/formatter.py

@@ -14,13 +14,13 @@ class Formatter:
 
     TAG_REGEX = re.compile(r"(?ix)<(([a-z](?:[^<>]*)) | /([a-z](?:[^<>]*))?)>")
 
-    _inline_styles_cache = {}
+    _inline_styles_cache: Dict[str, Style] = {}
 
     def __init__(
         self, decorated: bool = False, styles: Optional[Dict[str, Style]] = None
     ) -> None:
         self._decorated = decorated
-        self._styles = {}
+        self._styles: Dict[str, Style] = {}
 
         self.set_style("error", Style("red", options=["bold"]))
         self.set_style("info", Style("blue"))