feat: add Color class for RGB and hex color representation

Author: ya7010

examples/simple_example.py

@@ -3,6 +3,7 @@
 from pathlib import Path
 
 import tppt
+from tppt.types import Color
 
 EXAMPLE_DIR = Path(__file__).parent
 
@@ -24,6 +25,7 @@ def main():
                 size=(60, "pt"),
                 bold=True,
                 italic=True,
+                color=Color("#0000FF"),
             )
             .text(
                 "Example of using tppt library",  # Subtitle

src/tppt/__init__.py

@@ -1,5 +1,6 @@
 """Typed Python PowerPoint Tool"""
 
+from tppt import types as types
 from tppt._pptx.presentation import Presentation
 from tppt._pptx.shape import Shape
 from tppt._pptx.slide import Slide, SlideBuilder

src/tppt/types/__init__.py

@@ -4,15 +4,24 @@
 from typing import Literal, TypeAlias
 
 from pptx.enum.shapes import MSO_AUTO_SHAPE_TYPE
-from tppt._pptx.shape.table import TableCellStyle
 
-from ._color import Color
+from tppt._pptx.shape.table import TableCellStyle as TableCellStyle
+
+from ._color import Color as Color
+from ._length import (
+    Length as Length,
+)
+from ._length import (
+    LiteralLength as LiteralLength,
+)
+from ._length import (
+    Point as Point,
+)
 from ._length import (
-    Length,
-    LiteralLength,
-    Point,
-    to_length,
-    to_point,
+    to_length as to_length,
+)
+from ._length import (
+    to_point as to_point,
 )
 
 FilePath = str | pathlib.Path
@@ -31,22 +40,3 @@
     "TITLE_AND_VERTICAL_TEXT",
     "VERTICAL_TITLE_AND_TEXT",
 ]
-
-
-def pt(value: int | float) -> LiteralLength:
-    """Create a point length."""
-    return (int(value), "pt")
-
-
-__all__ = [
-    "Color",
-    "FilePath",
-    "Length",
-    "LiteralLength",
-    "Point",
-    "pt",
-    "to_length",
-    "to_point",
-    "SlideLayoutType",
-    "TableCellStyle",
-]

src/tppt/types/_color.py

@@ -1,40 +1,50 @@
 """Color types for tppt."""
 
-from pptx.dml.color import RGBColor
+from typing import overload
 
 from tppt.exception import ColorInvalidFormatError
 
 
 class Color:
-    """Represents a color in RGB or by name."""
+    """Represents a color in RGB or by hex code.
 
-    def __init__(self, value: str | tuple[int, int, int]):
+    Examples:
+        >>> Color("#00B")
+        >>> Color("#00BB00")
+        >>> Color(255, 0, 0)
+    """
+
+    @overload
+    def __init__(self, r: str): ...
+
+    @overload
+    def __init__(self, r: int, g: int, b: int): ...
+
+    def __init__(self, r: str | int, g: int | None = None, b: int | None = None):
         """Initialize a Color instance."""
-        if isinstance(value, str):
-            if not value.startswith("#"):
-                raise ColorInvalidFormatError(value)
+        if isinstance(r, str):
+            if not r.startswith("#"):
+                raise ColorInvalidFormatError(r)
 
-            match len(value):
+            match len(r):
                 case 4:
-                    r = int(value[1:2], 16)
-                    g = int(value[2:3], 16)
-                    b = int(value[3:4], 16)
+                    # #123 は #112233 と同じであることに注意
+                    self.r = int(r[1:2] * 2, 16)
+                    self.g = int(r[2:3] * 2, 16)
+                    self.b = int(r[3:4] * 2, 16)
 
-                    self.value = RGBColor(r, g, b)
                 case 7:
-                    r = int(value[1:3], 16)
-                    g = int(value[3:5], 16)
-                    b = int(value[5:7], 16)
+                    self.r = int(r[1:3], 16)
+                    self.g = int(r[3:5], 16)
+                    self.b = int(r[5:7], 16)
 
-                    self.value = RGBColor(r, g, b)
                 case _:
-                    raise ColorInvalidFormatError(value)
+                    raise ColorInvalidFormatError(r)
 
         else:
-            r, g, b = value
             self.r = r
-            self.g = g
-            self.b = b
+            self.g = g  # type: ignore
+            self.b = b  # type: ignore
 
     def __repr__(self) -> str:
         """Return string representation."""

tests/test_color.py

@@ -0,0 +1,46 @@
+"""Tests for tppt.types._color module."""
+
+import unittest
+
+from tppt.exception import ColorInvalidFormatError
+from tppt.types._color import Color
+
+
+class TestColor(unittest.TestCase):
+    """Test cases for Color class."""
+
+    def test_init_with_rgb_hex_short(self):
+        """Test initialization with short hex color code (#RGB)."""
+        color = Color("#123")
+        assert color.r == 0x11
+        assert color.g == 0x22
+        assert color.b == 0x33
+
+    def test_init_with_rgb_hex_long(self):
+        """Test initialization with long hex color code (#RRGGBB)."""
+        color = Color("#123456")
+        assert color.r == 0x12
+        assert color.g == 0x34
+        assert color.b == 0x56
+
+    def test_init_with_rgb_tuple(self):
+        """Test initialization with RGB tuple."""
+        color = Color(10, 20, 30)
+        assert color.r == 10
+        assert color.g == 20
+        assert color.b == 30
+
+    def test_invalid_format_no_hash(self):
+        """Test initialization with invalid format (no # prefix)."""
+        with self.assertRaises(ColorInvalidFormatError):
+            Color("123456")
+
+    def test_invalid_format_wrong_length(self):
+        """Test initialization with invalid format (wrong length)."""
+        with self.assertRaises(ColorInvalidFormatError):
+            Color("#12345")  # 6 characters (including #) is invalid
+
+    def test_repr(self):
+        """Test string representation."""
+        color = Color(10, 20, 30)
+        assert repr(color) == "Color(10, 20, 30)"

tests/test_text.py

@@ -24,7 +24,7 @@ def test_text_with_options(output) -> None:
                 size=(24, "pt"),
                 bold=True,
                 italic=True,
-                color=Color((255, 0, 0)),  # 赤色
+                color=Color("#FF0000"),
                 margin_bottom=(10, "pt"),
                 margin_left=(10, "pt"),
                 vertical_anchor=MSO_ANCHOR.MIDDLE,