Compare commits

...

3 Commits

Author SHA1 Message Date
1c2d1abb2a add --style validation
add Disabled class to style registry

patch bump
2025-06-22 12:36:29 +01:00
fe3a975ba3 leave it up to rich... if no style is set we still get colour on stderr, but this can be overriden with NO_COLOR manually
patch bump
2025-06-22 11:33:52 +01:00
d8622ab037 set default values for no_colour style to 'none'.
This fixes rich markup error

ensure errors are written without colour if NO_COLOR is set
2025-06-22 10:49:05 +01:00
5 changed files with 57 additions and 20 deletions

View File

@ -1,3 +1,3 @@
"""module for package metadata.""" """module for package metadata."""
__version__ = '0.11.0' __version__ = '0.11.3'

View File

@ -8,6 +8,15 @@ from . import styles
from .__about__ import __version__ as version from .__about__ import __version__ as version
def validate_style(ctx: click.Context, param: click.Parameter, value: str) -> str:
"""Validate the style option."""
if value not in styles.registry:
raise click.BadParameter(
f"Invalid style '{value}'. Available styles: {', '.join(styles.registry.keys())}"
)
return value
@click.group() @click.group()
@click.option( @click.option(
'-d', '-d',
@ -43,6 +52,7 @@ from .__about__ import __version__ as version
show_default=True, show_default=True,
show_envvar=True, show_envvar=True,
help='The style to use for output.', help='The style to use for output.',
callback=validate_style,
) )
@click.option( @click.option(
'-b', '-b',

View File

@ -9,13 +9,9 @@ err = Console(stderr=True, style='bold red')
def highlight(ctx: click.Context, text: str) -> str: def highlight(ctx: click.Context, text: str) -> str:
"""Highlight text for console output.""" """Highlight text for console output."""
if ctx.obj['style'].name == 'no_colour':
return text
return f'[{ctx.obj["style"].highlight}]{text}[/{ctx.obj["style"].highlight}]' return f'[{ctx.obj["style"].highlight}]{text}[/{ctx.obj["style"].highlight}]'
def warning(ctx: click.Context, text: str) -> str: def warning(ctx: click.Context, text: str) -> str:
"""Format warning text for console output.""" """Format warning text for console output."""
if ctx.obj['style'].name == 'no_colour': return f'[{ctx.obj["style"].warning}]{text}[/{ctx.obj["style"].warning}]'
return text
return f'[magenta]{text}[/magenta]'

View File

@ -3,15 +3,15 @@
import os import os
from dataclasses import dataclass from dataclasses import dataclass
_registry = {} registry = {}
def register_style(cls): def register_style(cls):
"""Register a style class.""" """Register a style class."""
key = cls.__name__.lower() key = cls.__name__.lower()
if key in _registry: if key in registry:
raise ValueError(f'Style {key} is already registered.') raise ValueError(f'Style {key} is already registered.')
_registry[key] = cls registry[key] = cls
return cls return cls
@ -19,11 +19,12 @@ def register_style(cls):
class Style: class Style:
"""Base class for styles.""" """Base class for styles."""
name: str = 'no_colour' name: str
border: str | None = None border: str
header: str | None = None header: str
cell: str | None = None cell: str
highlight: str | None = None highlight: str
warning: str
no_border: bool = False no_border: bool = False
def __post_init__(self): def __post_init__(self):
@ -33,6 +34,24 @@ class Style:
self.border = None self.border = None
@register_style
@dataclass
class Disabled(Style):
"""Disabled style."""
name: str = 'disabled'
header: str = ''
border: str = 'none'
cell: str = 'none'
highlight: str = 'none'
warning: str = 'none'
def __post__init__(self):
"""Post-initialization to set default values."""
super().__post_init__()
os.environ['NO_COLOR'] = '1'
@register_style @register_style
@dataclass @dataclass
class Red(Style): class Red(Style):
@ -43,6 +62,7 @@ class Red(Style):
border: str = 'dark_red' border: str = 'dark_red'
cell: str = 'red' cell: str = 'red'
highlight: str = 'red3' highlight: str = 'red3'
warning: str = 'magenta'
@register_style @register_style
@ -55,6 +75,7 @@ class Magenta(Style):
border: str = 'dark_magenta' border: str = 'dark_magenta'
cell: str = 'magenta' cell: str = 'magenta'
highlight: str = 'magenta3' highlight: str = 'magenta3'
warning: str = 'magenta'
@register_style @register_style
@ -67,6 +88,7 @@ class Purple(Style):
border: str = 'purple' border: str = 'purple'
cell: str = 'medium_orchid' cell: str = 'medium_orchid'
highlight: str = 'medium_orchid' highlight: str = 'medium_orchid'
warning: str = 'magenta'
@register_style @register_style
@ -79,6 +101,7 @@ class Blue(Style):
border: str = 'dark_blue' border: str = 'dark_blue'
cell: str = 'blue' cell: str = 'blue'
highlight: str = 'blue3' highlight: str = 'blue3'
warning: str = 'magenta'
@register_style @register_style
@ -91,6 +114,7 @@ class Cyan(Style):
border: str = 'dark_cyan' border: str = 'dark_cyan'
cell: str = 'cyan' cell: str = 'cyan'
highlight: str = 'cyan3' highlight: str = 'cyan3'
warning: str = 'magenta'
@register_style @register_style
@ -103,6 +127,7 @@ class Green(Style):
border: str = 'dark_green' border: str = 'dark_green'
cell: str = 'green' cell: str = 'green'
highlight: str = 'green3' highlight: str = 'green3'
warning: str = 'magenta'
@register_style @register_style
@ -115,6 +140,7 @@ class Yellow(Style):
border: str = 'yellow3' border: str = 'yellow3'
cell: str = 'wheat1' cell: str = 'wheat1'
highlight: str = 'yellow3' highlight: str = 'yellow3'
warning: str = 'magenta'
@register_style @register_style
@ -127,6 +153,7 @@ class Orange(Style):
border: str = 'dark_orange' border: str = 'dark_orange'
cell: str = 'orange' cell: str = 'orange'
highlight: str = 'orange3' highlight: str = 'orange3'
warning: str = 'magenta'
@register_style @register_style
@ -139,6 +166,7 @@ class White(Style):
border: str = 'white' border: str = 'white'
cell: str = 'white' cell: str = 'white'
highlight: str = 'white' highlight: str = 'white'
warning: str = 'magenta'
@register_style @register_style
@ -151,6 +179,7 @@ class Grey(Style):
border: str = 'grey50' border: str = 'grey50'
cell: str = 'grey70' cell: str = 'grey70'
highlight: str = 'grey90' highlight: str = 'grey90'
warning: str = 'magenta'
@register_style @register_style
@ -163,6 +192,7 @@ class Navy(Style):
border: str = 'deep_sky_blue4' border: str = 'deep_sky_blue4'
cell: str = 'light_sky_blue3' cell: str = 'light_sky_blue3'
highlight: str = 'light_sky_blue3' highlight: str = 'light_sky_blue3'
warning: str = 'magenta'
@register_style @register_style
@ -175,12 +205,9 @@ class Black(Style):
border: str = 'black' border: str = 'black'
cell: str = 'grey30' cell: str = 'grey30'
highlight: str = 'grey30' highlight: str = 'grey30'
warning: str = 'magenta'
def request_style_obj(style_name: str, no_border: bool) -> Style: def request_style_obj(style_name: str, no_border: bool) -> Style:
"""Request a style object by name.""" """Request a style object by name."""
key = style_name.lower() return registry[style_name.lower()](no_border=no_border)
if key not in _registry:
os.environ['NO_COLOR'] = '1' # Disable colour output
return Style(no_border=no_border)
return _registry[key](no_border=no_border)

View File

@ -10,6 +10,10 @@ def check_mark(ctx: click.Context, value: bool, empty_if_false: bool = False) ->
if empty_if_false and not value: if empty_if_false and not value:
return '' return ''
if os.getenv('NO_COLOR', '') != '' or ctx.obj['style'].name == 'no_colour': # rich gracefully handles the absence of colour throughout the rest of the application,
# but here we must handle it manually.
# If NO_COLOR is set, we return plain text symbols.
# Otherwise, we return coloured symbols.
if os.getenv('NO_COLOR', '') != '':
return '' if value else '' return '' if value else ''
return '' if value else '' return '' if value else ''