classes.c10_font

  1from typing import TYPE_CHECKING
  2import drawBot
  3import colorama
  4from loguru import logger
  5from icecream import ic
  6
  7from lib import fonts as libFonts
  8
  9# Avoid circular import issues, hide from runtime, but keep for type checking
 10if TYPE_CHECKING:
 11    from .c11_family import KFamily
 12
 13
 14class KFont:
 15    """
 16    Represents a single font and provides methods for font analysis and manipulation.
 17
 18    Usually grouped into `classes.c11_family.KFamily`.
 19    """
 20
 21    fullName: str
 22    """Full name of font: `Stabil Grotesk 400 Regular`"""
 23    familyName: str
 24    """Family name of font: `Stabil Grotesk`"""
 25    styleName: str
 26    """Style name of font: `Regular`"""
 27    shortName: str
 28    """Short name of font: `400 Regular`"""
 29    styleNumber: int
 30    """Style number of font: `400`"""
 31
 32    def __init__(self, path: str, family: "KFamily" = None):
 33        """
 34        Initialize a KFont instance.
 35
 36        Args:
 37            path: Path to the font file.
 38            family: Family this font belongs to (optional). See `classes.c11_family.KFamily`.
 39        """
 40        self.path = path
 41        """File system path to the font file"""
 42
 43        if family:
 44            self.family = family
 45
 46        names = libFonts.parseNameObject(path, separate=True)
 47        for [name, value] in names.items():
 48            setattr(self, name, value)
 49
 50    def __str__(self) -> str:
 51        """Return a string representation of the KFont instance."""
 52        return f"{colorama.Fore.BLACK}{colorama.Back.LIGHTGREEN_EX}KFont{colorama.Style.RESET_ALL} {self.fullName}"
 53
 54    @property
 55    def fontType(self):
 56        """
 57        Get the font type based on the style number.
 58
 59        Returns:
 60            The font type as determined by `lib.fonts.getFontType`.
 61        """
 62        try:
 63            return libFonts.getFontType(self.styleNumber)
 64        except:
 65            logger.warning("[KFont] Error getting font type!")
 66
 67    def isType(self, criteria: libFonts.FontType) -> bool:
 68        """
 69        Check if the font matches given `lib.fonts.FontType` criteria:
 70
 71        ```
 72        upright \\d0
 73        italic \\d5
 74        display [^4-6]
 75        text [4-6]
 76        thin [1-3]
 77        thick [7-9]
 78        ```
 79
 80        Args:
 81            criteria: The font type to check (e.g., 'upright', 'italic', etc.).
 82
 83        Returns:
 84            True if the font matches the criteria, False otherwise.
 85        """
 86        return criteria in self.fontType
 87
 88    def getSibling(self) -> "KFont":
 89        """
 90        Get the sibling font with a related style number.
 91
 92        Example:
 93            `400` => `450`
 94
 95        Returns:
 96            The sibling KFont instance if found, otherwise None.
 97        """
 98        prefix = self.styleNumber[0]
 99        suffix = "5" if self.isType("upright") else "0"
100        # Adjust to correct length: 40 => 45, 400 => 450
101        adjusted = (prefix + suffix).ljust(len(self.styleNumber), "0")
102        siblingNumber = int(adjusted)
103        try:
104            return self.family.getFonts(criteria=siblingNumber)
105        except:
106            logger.warning("[KFont] Error getting sibling!")
107
108    def getWeightClass(self, numeric=False) -> str | int:
109        """
110        Get the weight class of the font.
111
112        Example:
113            `400` => `4`
114
115        Args:
116            numeric: If True, return as integer; as string otherwise.
117
118        Returns:
119            The weight class as string or integer.
120        """
121        numberString = self.styleNumber[0]
122        return int(numberString) if numeric else numberString
123
124    def activate(self):
125        """
126        Activate this font for use in DrawBot.
127
128        Returns:
129            The KFont instance (self).
130        """
131        logger.trace("Activating KFont: {}", self.fullName)
132        drawBot.font(self.path)
133        return self