Add type annotations to the project and run mypy on CI

.pre-commit-config.yaml

@@ -58,5 +58,12 @@ repos:
       - id: prettier
         args: [--prose-wrap=always, --print-width=88]
 
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.961
+    hooks:
+      - id: mypy
+        args: [--strict, --pretty, --show-error-codes]
+        additional_dependencies: [pytest, types-setuptools]
+
 ci:
   autoupdate_schedule: quarterly

setup.cfg

@@ -40,6 +40,7 @@ project_urls =
 [options]
 packages = find:
 python_requires = >=3.7
+include_package_data = true
 package_dir = =src
 setup_requires =
     setuptools-scm

setup.py

@@ -21,6 +21,8 @@
 #
 # Author: Konstantin Lepa <konstantin.lepa@gmail.com>
 
+from __future__ import annotations
+
 from setuptools import setup
 
 

src/termcolor/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from termcolor.termcolor import (
     ATTRIBUTES,
     COLORS,

src/termcolor/termcolor.py

@@ -22,7 +22,10 @@
 
 """ANSI color formatting for output in terminal."""
 
+from __future__ import annotations
+
 import os
+from typing import Any, Iterable
 
 __ALL__ = ["colored", "cprint"]
 
@@ -89,7 +92,12 @@
 RESET = "\033[0m"
 
 
-def colored(text, color=None, on_color=None, attrs=None):
+def colored(
+    text: str,
+    color: str | None = None,
+    on_color: str | None = None,
+    attrs: Iterable[str] | None = None,
+) -> str:
     """Colorize text.
 
     Available text colors:
@@ -122,7 +130,13 @@ def colored(text, color=None, on_color=None, attrs=None):
     return text + RESET
 
 
-def cprint(text, color=None, on_color=None, attrs=None, **kwargs):
+def cprint(
+    text: str,
+    color: str | None = None,
+    on_color: str | None = None,
+    attrs: Iterable[str] | None = None,
+    **kwargs: Any,
+) -> None:
     """Print colorize text.
 
     It accepts arguments of print function.

tests/test_termcolor.py

@@ -1,27 +1,30 @@
+from __future__ import annotations
+
 import os
+from typing import Any
 
 import pytest
 
 from termcolor import ATTRIBUTES, COLORS, HIGHLIGHTS, colored, cprint
 
-ALL_COLORS = list(COLORS) + [None]
-ALL_HIGHLIGHTS = list(HIGHLIGHTS) + [None]
-ALL_ATTRIBUTES = list(ATTRIBUTES) + [None]
+ALL_COLORS = [*COLORS, None]
+ALL_HIGHLIGHTS = [*HIGHLIGHTS, None]
+ALL_ATTRIBUTES = [*ATTRIBUTES, None]
 
 
-def setup_module():
+def setup_module() -> None:
     # By default, make sure no env vars already set for tests
     try:
         del os.environ["ANSI_COLORS_DISABLED"]
     except KeyError:  # pragma: no cover
         pass
 
 
-def test_basic():
+def test_basic() -> None:
     assert colored("text") == "text\x1b[0m"
 
 
-def test_sanity():
+def test_sanity() -> None:
     for color in ALL_COLORS:
         for highlight in ALL_HIGHLIGHTS:
             for attribute in ALL_ATTRIBUTES:
@@ -31,8 +34,14 @@ def test_sanity():
 
 
 def assert_cprint(
-    capsys, expected, text, color=None, on_color=None, attrs=None, **kwargs
-):
+    capsys: pytest.CaptureFixture[str],
+    expected: str,
+    text: str,
+    color: str | None = None,
+    on_color: str | None = None,
+    attrs: list[str] | None = None,
+    **kwargs: Any,
+) -> None:
     cprint(text, color, on_color, attrs, **kwargs)
     captured = capsys.readouterr()
     print(captured.out)
@@ -52,7 +61,7 @@ def assert_cprint(
         ("white", "\x1b[37mtext\x1b[0m"),
     ],
 )
-def test_color(capsys, color, expected):
+def test_color(capsys: pytest.CaptureFixture[str], color: str, expected: str) -> None:
     assert colored("text", color=color) == expected
     assert_cprint(capsys, expected, "text", color=color)
 
@@ -70,7 +79,9 @@ def test_color(capsys, color, expected):
         ("on_white", "\x1b[47mtext\x1b[0m"),
     ],
 )
-def test_on_color(capsys, on_color, expected):
+def test_on_color(
+    capsys: pytest.CaptureFixture[str], on_color: str, expected: str
+) -> None:
     assert colored("text", on_color=on_color) == expected
     assert_cprint(capsys, expected, "text", on_color=on_color)
 
@@ -86,7 +97,7 @@ def test_on_color(capsys, on_color, expected):
         ("concealed", "\x1b[8mtext\x1b[0m"),
     ],
 )
-def test_attrs(capsys, attr, expected):
+def test_attrs(capsys: pytest.CaptureFixture[str], attr: str, expected: str) -> None:
     assert colored("text", attrs=[attr]) == expected
     assert_cprint(capsys, expected, "text", attrs=[attr])
 
@@ -108,7 +119,9 @@ def test_attrs(capsys, attr, expected):
         "",
     ],
 )
-def test_env_var(monkeypatch, test_env_var, test_value):
+def test_env_var(
+    monkeypatch: pytest.MonkeyPatch, test_env_var: str, test_value: str
+) -> None:
     """Assert nothing applied when this env var set, regardless of value."""
     monkeypatch.setenv(test_env_var, test_value)
     assert colored("text", color="red") == "text"