feat: refactor and add pygments integration

Author: backwardspy

README.md

@@ -73,9 +73,9 @@ ensure consistency in the codebase.
 ```bash
 isort .
 black .
-pylint catppuccin.py
+pylint catppuccin
 mypy .
-pytest --cov
+pytest --cov catppuccin
 ```
 
 These tools are all installed as part of the `dev` dependency group with

catppuccin/__init__.py

@@ -0,0 +1,3 @@
+"""🐍 Soothing pastel theme for Python."""
+from catppuccin.colour import Colour as Colour
+from catppuccin.flavour import Flavour as Flavour

catppuccin/colour.py

@@ -0,0 +1,24 @@
+"""
+Functionality relating to individual colours.
+"""
+from dataclasses import dataclass
+from typing import Tuple
+
+
+@dataclass(frozen=True)
+class Colour:
+    """A colour with three channels; red, green, and blue."""
+
+    red: int
+    green: int
+    blue: int
+
+    @property
+    def rgb(self) -> Tuple[int, int, int]:
+        """Get the colour as a 3-tuple of red, green, and blue."""
+        return (self.red, self.green, self.blue)
+
+    @property
+    def hex(self) -> str:
+        """Get the colour as a lowercase hex string."""
+        return f"{self.red:02x}{self.green:02x}{self.blue:02x}"

catppuccin/extras/__init__.py

@@ -0,0 +1,73 @@
+"""
+Pygments styles for all Catppuccin flavours.
+"""
+from pygments.style import Style
+from pygments.token import (
+    Comment,
+    Error,
+    Keyword,
+    Literal,
+    Name,
+    Number,
+    Operator,
+    Punctuation,
+    String,
+    Text,
+    Token,
+    _TokenType,
+)
+
+from catppuccin.flavour import Flavour
+
+
+def _make_styles(flavour: Flavour) -> dict[_TokenType, str]:
+    return {
+        Token: f"#{flavour.text.hex}",
+        Text: f"#{flavour.text.hex}",
+        Error: f"#{flavour.red.hex}",
+        Keyword: f"#{flavour.mauve.hex}",
+        Keyword.Constant: f"#{flavour.peach.hex}",
+        Keyword.Declaration: f"#{flavour.blue.hex}",
+        Keyword.Namespace: f"#{flavour.teal.hex}",
+        Keyword.Pseudo: f"#{flavour.mauve.hex}",
+        Keyword.Reserved: f"#{flavour.mauve.hex}",
+        Keyword.Type: f"#{flavour.blue.hex}",
+        Name: f"#{flavour.peach.hex}",
+        Name.Attribute: f"#{flavour.blue.hex}",
+        Name.Constant: f"#{flavour.yellow.hex}",
+        Name.Decorator: f"#{flavour.blue.hex}",
+        Name.Function: f"#{flavour.blue.hex}",
+        Name.Function.Magic: f"#{flavour.sky.hex}",
+        Name.Label: f"#{flavour.blue.hex}",
+        Name.Tag: f"#{flavour.mauve.hex}",
+        Literal: f"#{flavour.text.hex}",
+        String: f"#{flavour.green.hex}",
+        Number: f"#{flavour.peach.hex}",
+        Punctuation: f"#{flavour.text.hex}",
+        Operator: f"#{flavour.sky.hex}",
+        Comment: f"#{flavour.overlay0.hex}",
+    }
+
+
+class LatteStyle(Style):  # pylint: disable=too-few-public-methods
+    """Catppuccin Latte pygments style."""
+
+    styles = _make_styles(Flavour.latte())
+
+
+class FrappeStyle(Style):  # pylint: disable=too-few-public-methods
+    """Catppuccin Frappé pygments style."""
+
+    styles = _make_styles(Flavour.frappe())
+
+
+class MacchiatoStyle(Style):  # pylint: disable=too-few-public-methods
+    """Catppuccin Macchiato pygments style."""
+
+    styles = _make_styles(Flavour.macchiato())
+
+
+class MochaStyle(Style):  # pylint: disable=too-few-public-methods
+    """Catppuccin Mocha pygments style."""
+
+    styles = _make_styles(Flavour.mocha())

catppuccin/extras/pygments.py

@@ -1,25 +1,10 @@
-"""🐍 Soothing pastel theme for Python."""
+"""
+Functionality relating to Catppuccin flavours.
+A flavour is a collection of colours.
+"""
 from dataclasses import dataclass
-from typing import Tuple
 
-
-@dataclass(frozen=True)
-class Colour:
-    """A colour with three channels; red, green, and blue."""
-
-    red: int
-    green: int
-    blue: int
-
-    @property
-    def rgb(self) -> Tuple[int, int, int]:
-        """Get the colour as a 3-tuple of red, green, and blue."""
-        return (self.red, self.green, self.blue)
-
-    @property
-    def hex(self) -> str:
-        """Get the colour as a lowercase hex string."""
-        return f"{self.red:02x}{self.green:02x}{self.blue:02x}"
+from catppuccin.colour import Colour
 
 
 @dataclass(frozen=True)

catppuccin.py catppuccin/flavour.pycatppuccin.py renamed to catppuccin/flavour.py

@@ -11,6 +11,10 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.7.2"
+pygments = { version = "^2.13.0", optional = true }
+
+[tool.poetry.extras]
+pygments = ["pygments"]
 
 [tool.poetry.group.dev.dependencies]
 pylint = "^2.15.5"
@@ -19,6 +23,13 @@ black = "^22.10.0"
 isort = "^5.10.1"
 pytest = "^7.2.0"
 pytest-cov = "^4.0.0"
+types-setuptools = "^65.5.0.3"
+types-pygments = "^2.13.1.1"
+
+[tool.pylint.messages_control]
+disable = [
+    "useless-import-alias", # pyright compatibility
+]
 
-[too.isort]
+[tool.isort]
 profile = "black"

poetry.lock

@@ -1,4 +1,4 @@
-from catppuccin import Colour
+from catppuccin.colour import Colour
 
 
 def test_colour_to_rgb():

pyproject.toml

@@ -1,8 +1,7 @@
 from typing import cast
 
-from catppuccin import Flavour
-
-from .conftest import ColourJSON, FlavourJSON, PaletteJSON
+from catppuccin.flavour import Flavour
+from tests.conftest import ColourJSON, FlavourJSON, PaletteJSON
 
 
 def validate_flavour(flavour: Flavour, flavour_json: FlavourJSON) -> None: