Add tests for clistyle.py

changelog.md

@@ -25,6 +25,7 @@ Internal
 * Improve gitignored files.
 * Continue improve naming for `prompt_toolkit` utilities.
 * Run pytest tests in arbitrary order.
+* Type annotation improvements for `parse_pygments_style()`.
 
 
 1.67.1 (2026/03/28)

mycli/clistyle.py

@@ -1,4 +1,5 @@
 import logging
+from typing import cast
 
 from prompt_toolkit.styles import Style, merge_styles
 from prompt_toolkit.styles.pygments import style_from_pygments_cls
@@ -89,7 +90,7 @@
 
 def parse_pygments_style(
     token_name: str,
-    style_object: PygmentsStyle | str,
+    style_object: type[PygmentsStyle] | PygmentsStyle | dict[object, str] | str,
     style_dict: dict[str, str],
 ) -> tuple[Token, str]:
     """Parse token type and style string.
@@ -100,8 +101,12 @@ def parse_pygments_style(
 
     """
     token_type = string_to_tokentype(token_name)
-    if isinstance(style_object, PygmentsStyle):
+    if isinstance(style_object, type) and issubclass(style_object, PygmentsStyle):
         # When a Pygments Style class is passed, use its "styles" mapping.
+        other_token_type = string_to_tokentype(style_dict[token_name])
+        style_class = cast(type[PygmentsStyle], style_object)
+        return token_type, style_class.styles[other_token_type]
+    elif isinstance(style_object, PygmentsStyle):
         other_token_type = string_to_tokentype(style_dict[token_name])
         return token_type, style_object.styles[other_token_type]
     else:

test/pytests/test_clistyle.py

@@ -1,29 +1,191 @@
 # type: ignore
 
-"""Test the mycli.clistyle module."""
+"""Tests for the mycli.clistyle module."""
 
-from pygments.style import Style
+from types import SimpleNamespace
+
+from prompt_toolkit.styles import Style as PromptStyle
+from pygments.style import Style as PygmentsStyle
 from pygments.token import Token
-import pytest
+from pygments.util import ClassNotFound
+
+from mycli import clistyle
+
+
+def test_parse_pygments_style_handles_style_classes_instances_and_dict_values() -> None:
+    class DemoStyle(PygmentsStyle):
+        default_style = ''
+        styles = {
+            Token.Name: 'bold',
+            Token.String: 'ansired',
+        }
+
+    token_type, style_value = clistyle.parse_pygments_style(
+        'Token.String',
+        DemoStyle,
+        {'Token.String': 'Token.Name'},
+    )
+    assert token_type == Token.String
+    assert style_value == 'bold'
+
+    token_type, style_value = clistyle.parse_pygments_style(
+        'Token.String',
+        DemoStyle(),
+        {'Token.String': 'Token.Name'},
+    )
+    assert token_type == Token.String
+    assert style_value == 'bold'
+
+    token_type, style_value = clistyle.parse_pygments_style(
+        'Token.String',
+        'unused',
+        {'Token.String': 'ansiblue'},
+    )
+    assert token_type == Token.String
+    assert style_value == 'ansiblue'
+
+
+def test_is_valid_pygments_returns_true_and_false(monkeypatch) -> None:
+    assert clistyle.is_valid_pygments('ansired') is True
+
+    class FailingPygmentsStyle:
+        def __init_subclass__(cls, **kwargs) -> None:
+            raise AssertionError('bad style')
+
+    monkeypatch.setattr(clistyle, 'PygmentsStyle', FailingPygmentsStyle)
+
+    assert clistyle.is_valid_pygments('invalid') is False
+
+
+def test_is_valid_ptoolkit_returns_true_and_false(monkeypatch) -> None:
+    assert clistyle.is_valid_ptoolkit('bold') is True
+
+    class FailingPromptStyle:
+        def __init__(self, _rules) -> None:
+            raise ValueError('bad style')
+
+    monkeypatch.setattr(clistyle, 'Style', FailingPromptStyle)
+
+    assert clistyle.is_valid_ptoolkit('invalid') is False
+
+
+def test_style_factory_ptoolkit_builds_styles_and_falls_back(monkeypatch, caplog) -> None:
+    calls: list[str] = []
+    native_style = object()
+
+    def fake_get_style_by_name(name: str):
+        calls.append(name)
+        if name == 'missing':
+            raise ClassNotFound('missing')
+        if name == 'native':
+            return native_style
+        raise AssertionError(f'unexpected style {name}')
+
+    class FakeStyle:
+        def __init__(self, rules) -> None:
+            self.rules = list(rules)
+
+    monkeypatch.setattr(clistyle.pygments.styles, 'get_style_by_name', fake_get_style_by_name)
+    monkeypatch.setattr(
+        clistyle,
+        'parse_pygments_style',
+        lambda token, style, cli_style: {
+            'Token.Prompt': (Token.Prompt, 'token-valid'),
+            'Token.Toolbar': (Token.Toolbar, 'token-invalid'),
+            'Token.Name': (Token.Name, 'token-invalid'),
+        }[token],
+    )
+    monkeypatch.setattr(clistyle, 'is_valid_ptoolkit', lambda value: value in {'token-valid', 'prompt-valid'})
+    monkeypatch.setattr(clistyle, 'Style', FakeStyle)
+    monkeypatch.setattr(clistyle, 'style_from_pygments_cls', lambda style: ('pygments-style', style))
+    monkeypatch.setattr(clistyle, 'merge_styles', lambda styles: styles)
+
+    cli_style = {
+        'Token.Prompt': 'Token.Name',
+        'Token.Toolbar': 'Token.Name',
+        'Token.Name': 'ignored',
+        'prompt': 'prompt-valid',
+        'search': 'prompt-invalid',
+    }
+
+    with caplog.at_level('ERROR', logger='mycli.clistyle'):
+        styles = clistyle.style_factory_ptoolkit('missing', cli_style)
+
+    assert calls == ['missing', 'native']
+    assert styles[0] == ('pygments-style', native_style)
+    assert styles[1].rules == [('bottom-toolbar', 'noreverse')]
+    assert styles[2].rules == [
+        ('prompt', 'token-valid'),
+        ('prompt', 'prompt-valid'),
+    ]
+    assert ('bottom-toolbar', 'token-invalid') not in styles[2].rules
+    assert ('search', 'prompt-invalid') not in styles[2].rules
+    assert 'Unhandled style / class name: Token.Name' in caplog.text
+
+
+def test_style_factory_helpers_updates_known_tokens(monkeypatch, caplog) -> None:
+    base_styles = {Token.Output.Header: 'ansiyellow'}
+    style_class = SimpleNamespace(styles=base_styles)
+
+    monkeypatch.setattr(clistyle.pygments.styles, 'get_style_by_name', lambda name: style_class)
+    monkeypatch.setattr(
+        clistyle,
+        'parse_pygments_style',
+        lambda token, style, cli_style: {
+            'Token.Prompt': (Token.Prompt, 'ansiblue'),
+            'Token.Toolbar': (Token.Toolbar, 'skip-me'),
+        }[token],
+    )
+    monkeypatch.setattr(clistyle, 'is_valid_pygments', lambda value: value != 'skip-me')
+
+    cli_style = {
+        'Token.Prompt': 'Token.Name',
+        'Token.Toolbar': 'Token.Name',
+        'search': 'ansigreen',
+        'search.current': 'skip-me',
+        'sql.keyword': 'ansired',
+        'sql.string': 'skip-me',
+        'unknown': 'skip-me',
+    }
+
+    with caplog.at_level('ERROR', logger='mycli.clistyle'):
+        output_style = clistyle.style_factory_helpers('native', cli_style)
+
+    assert output_style.styles[Token.Prompt] == 'ansiblue'
+    assert output_style.styles[Token.SearchMatch] == 'ansigreen'
+    assert Token.SearchMatch.Current not in output_style.styles
+    assert output_style.styles[Token.Keyword] == 'ansired'
+    assert output_style.styles[Token.Output.Header] == 'ansiyellow'
+    assert Token.Toolbar not in output_style.styles
+    assert output_style.styles[Token.String] != 'skip-me'
+    assert 'Unhandled style / class name: unknown' in caplog.text
+
+
+def test_style_factory_helpers_falls_back_and_copies_warning_styles(monkeypatch) -> None:
+    native_styles = {
+        Token.Text: 'ansiblack',
+        Token.Warnings.Header: 'ansimagenta',
+        Token.Warnings.Status: 'ansicyan',
+    }
 
-from mycli.clistyle import style_factory_ptoolkit
+    def fake_get_style_by_name(name: str):
+        if name == 'missing':
+            raise ClassNotFound('missing')
+        if name == 'native':
+            return SimpleNamespace(styles=native_styles.copy())
+        raise AssertionError(f'unexpected style {name}')
 
+    monkeypatch.setattr(clistyle.pygments.styles, 'get_style_by_name', fake_get_style_by_name)
 
-@pytest.mark.skip(reason="incompatible with new prompt toolkit")
-def test_style_factory_ptoolkit():
-    """Test that a Pygments Style class is created."""
-    header = "bold underline #ansired"
-    cli_style = {"Token.Output.Header": header}
-    style = style_factory_ptoolkit("default", cli_style)
+    output_style = clistyle.style_factory_helpers('missing', {}, warnings=True)
 
-    assert isinstance(style(), Style)
-    assert Token.Output.Header in style.styles
-    assert header == style.styles[Token.Output.Header]
+    assert output_style.styles[Token.Warnings.Header] == 'ansimagenta'
+    assert output_style.styles[Token.Warnings.Status] == 'ansicyan'
+    assert output_style.styles[Token.Output.Header] == 'ansimagenta'
+    assert output_style.styles[Token.Output.Status] == 'ansicyan'
 
 
-@pytest.mark.skip(reason="incompatible with new prompt toolkit")
-def test_style_factory_ptoolkit_unknown_name():
-    """Test that an unrecognized name will not throw an error."""
-    style = style_factory_ptoolkit("foobar", {})
+def test_style_factory_ptoolkit_returns_merged_style_object() -> None:
+    style = clistyle.style_factory_ptoolkit('native', {'prompt': 'bold'})
 
-    assert isinstance(style(), Style)
+    assert style.get_attrs_for_style_str('class:prompt') == PromptStyle([('prompt', 'bold')]).get_attrs_for_style_str('class:prompt')