chromatic-python 0.1.0__py3-none-any.whl

chromatic/color/palette.pyi

@@ -0,0 +1,330 @@
+__all__ = [
+    'Back',
+    'ColorNamespace',
+    'Fore',
+    'Style',
+    'color_str_wrapper',
+]
+
+from collections.abc import Sequence
+from types import MappingProxyType
+from typing import Callable, Iterator, overload, TypedDict, Union, Unpack
+
+from chromatic._typing import AnsiColorAlias, Int3Tuple
+from chromatic.color.core import AnsiColorFormat, Color, ColorStr, SgrParameter, SgrSequence
+
+type _ColorLike = Union[Color, int, tuple[int, int, int]]
+
+
+def display_ansi256_color_range() -> list[list[ColorStr]]: ...
+
+
+def display_named_colors() -> list[ColorStr]: ...
+
+
+class AnsiBack(ColorNamespace[color_str_wrapper]):
+    RESET: color_str_wrapper
+
+    def __call__(self, bg: _ColorLike) -> color_str_wrapper: ...
+
+
+class AnsiFore(ColorNamespace[color_str_wrapper]):
+    RESET: color_str_wrapper
+
+    def __call__(self, fg: _ColorLike) -> color_str_wrapper: ...
+
+
+class AnsiStyle[StyleStr: color_str_wrapper](DynamicNamespace[StyleStr]):
+    RESET: StyleStr
+    BOLD: StyleStr
+    FAINT: StyleStr
+    ITALICS: StyleStr
+    SINGLE_UNDERLINE: StyleStr
+    SLOW_BLINK: StyleStr
+    RAPID_BLINK: StyleStr
+    NEGATIVE: StyleStr
+    CONCEALED_CHARS: StyleStr
+    CROSSED_OUT: StyleStr
+    PRIMARY: StyleStr
+    FIRST_ALT: StyleStr
+    SECOND_ALT: StyleStr
+    THIRD_ALT: StyleStr
+    FOURTH_ALT: StyleStr
+    FIFTH_ALT: StyleStr
+    SIXTH_ALT: StyleStr
+    SEVENTH_ALT: StyleStr
+    EIGHTH_ALT: StyleStr
+    NINTH_ALT: StyleStr
+    GOTHIC: StyleStr
+    DOUBLE_UNDERLINE: StyleStr
+    RESET_BOLD_AND_FAINT: StyleStr
+    RESET_ITALIC_AND_GOTHIC: StyleStr
+    RESET_UNDERLINES: StyleStr
+    RESET_BLINKING: StyleStr
+    POSITIVE: StyleStr
+    REVEALED_CHARS: StyleStr
+    RESET_CROSSED_OUT: StyleStr
+    BLACK_FG: StyleStr
+    RED_FG: StyleStr
+    GREEN_FG: StyleStr
+    YELLOW_FG: StyleStr
+    BLUE_FG: StyleStr
+    MAGENTA_FG: StyleStr
+    CYAN_FG: StyleStr
+    WHITE_FG: StyleStr
+    ANSI_256_SET_FG: StyleStr
+    DEFAULT_FG_COLOR: StyleStr
+    BLACK_BG: StyleStr
+    RED_BG: StyleStr
+    GREEN_BG: StyleStr
+    YELLOW_BG: StyleStr
+    BLUE_BG: StyleStr
+    MAGENTA_BG: StyleStr
+    CYAN_BG: StyleStr
+    WHITE_BG: StyleStr
+    ANSI_256_SET_BG: StyleStr
+    DEFAULT_BG_COLOR: StyleStr
+    FRAMED: StyleStr
+    ENCIRCLED: StyleStr
+    OVERLINED: StyleStr
+    NOT_FRAMED_OR_CIRCLED: StyleStr
+    IDEOGRAM_UNDER_OR_RIGHT: StyleStr
+    IDEOGRAM_2UNDER_OR_2RIGHT: StyleStr
+    IDEOGRAM_OVER_OR_LEFT: StyleStr
+    IDEOGRAM_2OVER_OR_2LEFT: StyleStr
+    CANCEL: StyleStr
+    BLACK_BRIGHT_FG: StyleStr
+    RED_BRIGHT_FG: StyleStr
+    GREEN_BRIGHT_FG: StyleStr
+    YELLOW_BRIGHT_FG: StyleStr
+    BLUE_BRIGHT_FG: StyleStr
+    MAGENTA_BRIGHT_FG: StyleStr
+    CYAN_BRIGHT_FG: StyleStr
+    WHITE_BRIGHT_FG: StyleStr
+    BLACK_BRIGHT_BG: StyleStr
+    RED_BRIGHT_BG: StyleStr
+    GREEN_BRIGHT_BG: StyleStr
+    YELLOW_BRIGHT_BG: StyleStr
+    BLUE_BRIGHT_BG: StyleStr
+    MAGENTA_BRIGHT_BG: StyleStr
+    CYAN_BRIGHT_BG: StyleStr
+    WHITE_BRIGHT_BG: StyleStr
+
+
+class color_str_wrapper:
+
+    def __add__(self, other) -> ColorStr: ...
+
+    def __call__(self, __obj=None) -> color_str_wrapper | ColorStr: ...
+
+    def __init__(self, **kwargs: Unpack[_ColorStrWrapperKwargs]) -> None: ...
+
+    def __repr__(self) -> str: ...
+
+    def __str__(self) -> str: ...
+
+    _ansi_type_: type[AnsiColorFormat]
+    _sgr_: SgrSequence
+
+
+class DynamicNamespace[_VT](metaclass=DynamicNSMeta[_VT]):
+
+    def as_dict(self) -> dict[str, _VT]: ...
+
+    def __init__[_KT](self, **kwargs: dict[_KT, _VT]) -> None: ...
+
+    def __init_subclass__(cls, **kwargs) -> DynamicNamespace[_VT]: ...
+
+    def __iter__(self) -> Iterator[_VT]: ...
+
+    def __new__(cls, *args, **kwargs) -> DynamicNamespace[_VT]: ...
+
+    def __setattr__(self, name, value) -> None: ...
+
+    __members__: list[_VT]
+
+
+class DynamicNSMeta[_VT](type):
+
+    def __new__(
+        mcls,
+        clsname: str,
+        bases: tuple[type, ...],
+        mapping: dict[str, ...],
+        **kwargs
+    ) -> DynamicNSMeta[_VT]: ...
+
+
+class ColorNamespace[NamedColor: Color](DynamicNamespace[NamedColor]):
+    BLACK: NamedColor
+    DIM_GREY: NamedColor
+    GREY: NamedColor
+    DARK_GREY: NamedColor
+    SILVER: NamedColor
+    LIGHT_GREY: NamedColor
+    WHITE_SMOKE: NamedColor
+    WHITE: NamedColor
+    ROSY_BROWN: NamedColor
+    INDIAN_RED: NamedColor
+    BROWN: NamedColor
+    FIREBRICK: NamedColor
+    LIGHT_CORAL: NamedColor
+    MAROON: NamedColor
+    DARK_RED: NamedColor
+    RED: NamedColor
+    SNOW: NamedColor
+    MISTY_ROSE: NamedColor
+    SALMON: NamedColor
+    TOMATO: NamedColor
+    BURNT_SIENNA: NamedColor
+    DARK_SALMON: NamedColor
+    CORAL: NamedColor
+    ORANGE_RED: NamedColor
+    LIGHT_SALMON: NamedColor
+    SIENNA: NamedColor
+    SEASHELL: NamedColor
+    CHOCOLATE: NamedColor
+    SADDLE_BROWN: NamedColor
+    SANDY_BROWN: NamedColor
+    PEACH_PUFF: NamedColor
+    PERU: NamedColor
+    LINEN: NamedColor
+    BISQUE: NamedColor
+    DARK_ORANGE: NamedColor
+    BURLY_WOOD: NamedColor
+    ANTIQUE_WHITE: NamedColor
+    TAN: NamedColor
+    NAVAJO_WHITE: NamedColor
+    BLANCHED_ALMOND: NamedColor
+    PAPAYA_WHIP: NamedColor
+    MOCCASIN: NamedColor
+    ORANGE: NamedColor
+    WHEAT: NamedColor
+    OLD_LACE: NamedColor
+    FLORAL_WHITE: NamedColor
+    DARK_GOLDENROD: NamedColor
+    GOLDENROD: NamedColor
+    CORNSILK: NamedColor
+    GOLD: NamedColor
+    LEMON_CHIFFON: NamedColor
+    KHAKI: NamedColor
+    PALE_GOLDENROD: NamedColor
+    DARK_KHAKI: NamedColor
+    BEIGE: NamedColor
+    LIGHT_GOLDENROD_YELLOW: NamedColor
+    OLIVE: NamedColor
+    YELLOW: NamedColor
+    LIGHT_YELLOW: NamedColor
+    IVORY: NamedColor
+    OLIVE_DRAB: NamedColor
+    YELLOW_GREEN: NamedColor
+    DARK_OLIVE_GREEN: NamedColor
+    GREEN_YELLOW: NamedColor
+    CHARTREUSE: NamedColor
+    LAWN_GREEN: NamedColor
+    DARK_SEA_GREEN: NamedColor
+    FOREST_GREEN: NamedColor
+    LIME_GREEN: NamedColor
+    LIGHT_GREEN: NamedColor
+    PALE_GREEN: NamedColor
+    DARK_GREEN: NamedColor
+    GREEN: NamedColor
+    LIME: NamedColor
+    HONEYDEW: NamedColor
+    SEA_GREEN: NamedColor
+    MEDIUM_SEA_GREEN: NamedColor
+    SPRING_GREEN: NamedColor
+    MINT_CREAM: NamedColor
+    MEDIUM_SPRING_GREEN: NamedColor
+    MEDIUM_AQUAMARINE: NamedColor
+    AQUAMARINE: NamedColor
+    TURQUOISE: NamedColor
+    LIGHT_SEA_GREEN: NamedColor
+    MEDIUM_TURQUOISE: NamedColor
+    DARK_SLATE_GREY: NamedColor
+    PALE_TURQUOISE: NamedColor
+    TEAL: NamedColor
+    DARK_CYAN: NamedColor
+    CYAN: NamedColor
+    LIGHT_CYAN: NamedColor
+    AZURE: NamedColor
+    DARK_TURQUOISE: NamedColor
+    CADET_BLUE: NamedColor
+    POWDER_BLUE: NamedColor
+    LIGHT_BLUE: NamedColor
+    DEEP_SKY_BLUE: NamedColor
+    SKY_BLUE: NamedColor
+    LIGHT_SKY_BLUE: NamedColor
+    STEEL_BLUE: NamedColor
+    ALICE_BLUE: NamedColor
+    DODGER_BLUE: NamedColor
+    SLATE_GREY: NamedColor
+    LIGHT_SLATE_GREY: NamedColor
+    LIGHT_STEEL_BLUE: NamedColor
+    CORNFLOWER_BLUE: NamedColor
+    ROYAL_BLUE: NamedColor
+    MIDNIGHT_BLUE: NamedColor
+    LAVENDER: NamedColor
+    NAVY: NamedColor
+    DARK_BLUE: NamedColor
+    MEDIUM_BLUE: NamedColor
+    BLUE: NamedColor
+    GHOST_WHITE: NamedColor
+    SLATE_BLUE: NamedColor
+    DARK_SLATE_BLUE: NamedColor
+    MEDIUM_SLATE_BLUE: NamedColor
+    MEDIUM_PURPLE: NamedColor
+    REBECCA_PURPLE: NamedColor
+    BLUE_VIOLET: NamedColor
+    INDIGO: NamedColor
+    DARK_ORCHID: NamedColor
+    DARK_VIOLET: NamedColor
+    MEDIUM_ORCHID: NamedColor
+    THISTLE: NamedColor
+    PLUM: NamedColor
+    VIOLET: NamedColor
+    PURPLE: NamedColor
+    DARK_MAGENTA: NamedColor
+    FUCHSIA: NamedColor
+    ORCHID: NamedColor
+    MEDIUM_VIOLET_RED: NamedColor
+    DEEP_PINK: NamedColor
+    HOT_PINK: NamedColor
+    LAVENDER_BLUSH: NamedColor
+    PALE_VIOLET_RED: NamedColor
+    CRIMSON: NamedColor
+    PINK: NamedColor
+    LIGHT_PINK: NamedColor
+
+
+# noinspection PyTypedDict
+class _ColorStrWrapperKwargs(TypedDict, total=False):
+    ansi_type: Union[AnsiColorAlias, type[AnsiColorFormat]]
+    bg: _ColorLike
+    fg: _ColorLike
+    sgr_params: Sequence[Union[int, SgrParameter]]
+
+
+class rgb_dispatch[** P, R]:
+    color_ns: MappingProxyType[str, Int3Tuple]
+
+    @overload
+    def __new__(
+        cls,
+        func: Callable[P, R], /, *, args: Sequence[str] = ()
+    ):
+        return func
+
+    @overload
+    def __new__(
+        cls,
+        func: None = None, /, *, args: Sequence[str] = ()
+    ) -> type[rgb_dispatch]:
+        ...
+
+    def __call__(self, *args: P.args, **kwargs: P.kwargs) -> R: ...
+
+
+Back = AnsiBack()
+Fore = AnsiFore()
+Style = AnsiStyle()

chromatic/data/__init__.py

@@ -0,0 +1,189 @@
+import json
+import os
+from enum import IntEnum
+from functools import partial
+from hashlib import sha256
+from pathlib import Path
+from typing import Iterable, Literal, TYPE_CHECKING
+
+from PIL import Image
+
+if TYPE_CHECKING:
+    from _typeshed import SupportsWrite
+
+data_root = Path(os.path.dirname(__file__))
+stub = data_root / (__file__ + 'i')
+config = data_root / 'config.json'
+fonts = data_root / 'fonts'
+images = data_root / 'images'
+
+
+def _get_checksum(__fp_iter: Iterable[str]) -> str:
+    return sha256(';'.join(sorted(__fp_iter)).encode()).hexdigest()
+
+
+def _is_img_ext(__fp: str):
+    return __fp.endswith(('.png', '.jpg', '.jpeg', '.webp'))
+
+
+def _is_ttf_ext(__fp: str):
+    return __fp.endswith(('.ttf', '.ttc'))
+
+
+def _build_config():
+    from string import printable
+
+    f: SupportsWrite
+    d: dict[Literal['fonts', 'images'] | Literal['__hash__'], dict[str, str] | str]
+    d = {
+        'fonts': {},
+        'images': {},
+        '__hash__': ''
+    }
+    printable = ''.join(c for c in printable if any((c.isalnum(), c.isidentifier(), c == '.')))
+    for font_fp in ((Path(fonts) / x).absolute() for x in
+                    filter(_is_ttf_ext, os.listdir(fonts))):
+        font_name = font_fp.stem
+        for c in set(font_name):
+            if c not in printable:
+                font_name = font_name.replace(c, '_')
+        d['fonts'][font_name.upper()] = str(font_fp.relative_to(data_root))
+    for image_fp in ((Path(images) / x).absolute() for x in
+                     filter(_is_img_ext, os.listdir(images))):
+        img_name = image_fp.stem
+        for c in set(img_name):
+            if c not in printable:
+                img_name = img_name.replace(c, '_')
+        d['images'][img_name.lower()] = str(image_fp.relative_to(data_root))
+    d['__hash__'] = _get_checksum((d['fonts'] | d['images']).values())
+    with config.open('w', encoding='utf-8') as f:
+        json.dump(d, f, indent='\t')
+    return d
+
+
+def _validate(**kwargs):
+    need_new_stub = kwargs.get('update_stub', False)
+    if need_new_stub or not config.exists():
+        json_data = _build_config()
+        need_new_stub = True
+    else:
+        json_data = json.load(config.open('r'))
+        s1, s2 = (set(
+            str(fp.relative_to(data_root)) for fp in
+            ((Path(subdir) / x).absolute() for x in filter(f, os.listdir(subdir))))
+            for f, subdir in zip((_is_ttf_ext, _is_img_ext), (fonts, images)))
+        if json_data['__hash__'] != _get_checksum(s1 | s2):
+            json_data = _build_config()
+            need_new_stub = True
+    font_data, img_data = json_data['fonts'], json_data['images']
+    if need_new_stub or not stub.exists():
+        exports = ['register_user_font', 'UserFont']
+        img_funcdefs = []
+        for img_name in img_data.keys():
+            exports.append(img_name)
+            img_funcdefs.append(f"def {img_name}() -> ImageFile: ...")
+        body = [
+                   f"__all__ = [{', '.join(map(repr, exports))}]",
+                   'from PIL.ImageFile import ImageFile',
+                   'from enum import IntEnum',
+                   'from os import PathLike',
+                   'from pathlib import Path',
+                   'def register_user_font[AnyStr: (str, bytes)]'
+                   '(__path: AnyStr | PathLike[AnyStr]) -> None: ...',
+               ] + img_funcdefs
+        body.extend(
+            '\n\t'.join(
+                ('class UserFont(IntEnum):',
+                 *(f'{x} = {i}' for i, x in enumerate(sorted(font_data))),
+                 '@property',
+                 'def path(self) -> Path: ...')).replace('\t', ' ' * 4).splitlines())
+        stub.open('w', encoding='utf-8').write('\n'.join(body))
+    return font_data, img_data
+
+
+_font_data_, _img_data_ = _validate()
+
+
+def _create_font_enum() -> type['UserFont']:
+    def path(self):
+        return data_root / Path(_font_data_[self.name])
+
+    enum_cls = IntEnum(
+        'UserFont',
+        {k: i for (i, k) in enumerate(sorted(_font_data_.keys()))})
+    enum_cls.path = property(path)
+    return enum_cls
+
+
+UserFont = _create_font_enum()
+
+def register_user_font[AnyStr: (str, bytes)](
+    __path: AnyStr | os.PathLike[AnyStr]
+):
+    """Register a .ttf font file as a new :class:`UserFont` enum member.
+
+    If the source file is on the same drive :mod:`chromatic.data`,
+    a symlink to it is added to the ``data/fonts`` package subdirectory.
+
+    Parameters
+    ----------
+    __path : AnyStr | PathLike[AnyStr]
+        Path to the .ttf font file being registered.
+
+    Raises
+    ------
+    FileNotFoundError
+        If the specified path does not exist.
+    ValueError
+        If the file is not a .ttf font.
+    OSError
+        If the font file is invalid or cannot be loaded.
+    """
+    path = os.fspath(__path)
+    if not os.path.exists(path):
+        raise FileNotFoundError(
+            f"{__path!r}")
+    path_obj = Path(path)
+    if path_obj.is_symlink():
+        path_obj = path_obj.readlink()
+    if path_obj.suffix != '.ttf':
+        raise ValueError(
+            f"Expected '.ttf' file, "
+            f"got filetype {path_obj.suffix!r} instead")
+    from PIL.ImageFont import FreeTypeFont
+
+    try:
+        _ = FreeTypeFont(path_obj)
+    except OSError as err:
+        if path_obj.exists():
+            err.add_note(f"{path_obj.resolve()!r}")
+        raise err
+    src = path_obj.absolute().relative_to(data_root)
+    src_pardir = src.parent if not src.is_dir() else src
+    if fonts.samefile(src_pardir):
+        is_link = False
+    else:
+        is_link = src.drive == fonts.drive
+        path_obj = Path(fonts / (src.stem + ('.ttf' if not is_link else '.lnk')))
+    ttf_obj = FreeTypeFont(path_obj)
+    ttf_name = ttf_obj.getname()
+    if any(ttf_name == FreeTypeFont(v.path).getname() for v in UserFont):
+        return print(f"{ttf_name} is already a UserFont member")
+    if is_link:
+        if path_obj.exists():
+            path_obj.unlink()
+        path_obj.symlink_to(src)
+    else:
+        path_obj.write_bytes(src.read_bytes())
+    return print(f"Successfully registered new UserFont: {ttf_name}")
+
+def __getattr__(name) -> ...:
+    if name.startswith('_'):
+        pass
+    elif name in _img_data_:
+        return partial(Image.open, fp=data_root / Path(_img_data_[name]))
+    raise AttributeError(
+        f"Module '{__name__}' has no attribute '{name}'")
+
+
+__all__ = ['UserFont', *_img_data_, 'register_user_font']

chromatic/data/__init__.pyi

@@ -0,0 +1,15 @@
+__all__ = ['register_user_font', 'UserFont', 'butterfly', 'escher', 'goblin_virus', 'hotdog']
+from PIL.ImageFile import ImageFile
+from enum import IntEnum
+from os import PathLike
+from pathlib import Path
+def register_user_font[AnyStr: (str, bytes)](__path: AnyStr | PathLike[AnyStr]) -> None: ...
+def butterfly() -> ImageFile: ...
+def escher() -> ImageFile: ...
+def goblin_virus() -> ImageFile: ...
+def hotdog() -> ImageFile: ...
+class UserFont(IntEnum):
+    CONSOLAS = 0
+    IBM_VGA_437_8X16 = 1
+    @property
+    def path(self) -> Path: ...