Merge branch 'main' of github.com:yassun7010/pptxr

Author: ya7010

examples/formatted_text.py

@@ -24,7 +24,7 @@ def functional_text(
         text: str,
         bold: bool = False,
         italic: bool = False,
-        color: tppt.types.RGBColor | tppt.types.LiteralColor | None = None,
+        color: tppt.types.Color | tppt.types.LiteralColor | None = None,
     ) -> tppt.pptx.Text:
         run = text_obj.text_frame.add_paragraph().add_run()
         run.text = text

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tppt"
-version = "0.1.0"
+version = "0.2.0"
 description = "Typed Python PowerPoint Tool"
 readme = "README.md"
 requires-python = ">=3.11.0"

src/tppt/exception.py

@@ -1,5 +1,5 @@
 from abc import abstractmethod
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, Literal
 
 if TYPE_CHECKING:
     from pptx.slide import SlideLayouts as PptxSlideLayouts
@@ -31,6 +31,17 @@ def message(self) -> str:
         return f"Invalid color format: {self.color}"
 
 
+class ColorInvalidTupleSizeError(TpptException, ValueError):
+    """Color tuple size is invalid."""
+
+    def __init__(self, color: tuple[Any, ...]) -> None:
+        self.color = color
+
+    @property
+    def message(self) -> str:
+        return f"Invalid color tuple size: {self.color}, expected 3(RGB) or 4(RGBA) elements."
+
+
 class SlideLayoutIndexError(TpptException, IndexError):
     """Slide layout index is out of range."""
 
@@ -87,3 +98,17 @@ def __init__(
     @property
     def message(self) -> str:
         return f"Invalid setter type. Expected type: {self.expected_type}, but got: {self.actual_type}."
+
+
+class InvalidColorValueError(TpptException, ValueError):
+    """Invalid color value."""
+
+    def __init__(
+        self, type: Literal["red", "green", "blue", "alpha"], value: int
+    ) -> None:
+        self.type = type
+        self.value = value
+
+    @property
+    def message(self) -> str:
+        return f"Invalid {self.type} value: {self.value}. It must be between 0 and 255."

src/tppt/pptx/action.py

@@ -0,0 +1,40 @@
+from pptx.action import ActionSetting as _PptxActionSetting
+from pptx.action import Hyperlink as _PptxHyperlink
+from pptx.enum.action import PP_ACTION_TYPE
+
+from tppt.pptx.converter import PptxConvertible
+from tppt.pptx.shape import SubShape
+from tppt.pptx.slide import Slide
+
+
+class Hyperlink(SubShape[_PptxHyperlink]):
+    @property
+    def address(self) -> str | None:
+        return self._pptx.address
+
+    @address.setter
+    def address(self, value: str | None):
+        self._pptx.address = value
+
+
+class ActionSetting(PptxConvertible[_PptxActionSetting]):
+    @property
+    def action(self) -> PP_ACTION_TYPE:
+        return self._pptx.action
+
+    @property
+    def hyperlink(self) -> Hyperlink:
+        return Hyperlink(self._pptx.hyperlink)
+
+    @property
+    def target_slide(self) -> Slide | None:
+        if target_slide := self._pptx.target_slide:
+            return Slide(target_slide)
+        return None
+
+    @target_slide.setter
+    def target_slide(self, value: Slide | None):
+        if value is None:
+            self._pptx.target_slide = None
+        else:
+            self._pptx.target_slide = value._pptx

src/tppt/pptx/chart/chart.py

@@ -1,4 +1,4 @@
-from typing import Literal, Self, TypedDict, assert_never
+from typing import Literal, TypedDict, assert_never
 
 from pptx.chart.chart import Chart as PptxChart
 from pptx.chart.data import ChartData as PptxChartData
@@ -258,18 +258,5 @@ class ChartData(ChartProps):
 class Chart(PptxConvertible[PptxChart]):
     """Chart data class."""
 
-    def __init__(
-        self,
-        pptx_obj: PptxChart,
-        /,
-    ) -> None:
-        self._pptx = pptx_obj
-
-    def to_pptx(self) -> PptxChart:
-        """Convert to pptx shape."""
-        return self._pptx
-
-    @classmethod
-    def from_pptx(cls, pptx_obj: PptxChart) -> Self:
-        """Create from pptx shape."""
-        return cls(pptx_obj)
+    def __init__(self, pptx_obj: PptxChart, /) -> None:
+        super().__init__(pptx_obj)

src/tppt/pptx/converter.py

@@ -1,13 +1,12 @@
 """Type definitions for pptx wrapper."""
 
 from typing import (
-    Protocol,
+    Generic,
     Self,
     TypeAlias,
     TypeVar,
     assert_never,
     overload,
-    runtime_checkable,
 )
 
 from pptx.dml.color import RGBColor as PptxRGBColor
@@ -19,7 +18,7 @@
 from pptx.util import Pt as PptxPt
 
 from tppt.types._angle import Angle, Degrees, LiteralAngle
-from tppt.types._color import LiteralColor, RGBColor, to_rgb_color
+from tppt.types._color import Color, LiteralColor, to_color
 from tppt.types._length import (
     CentiMeters,
     EnglishMetricUnits,
@@ -34,29 +33,35 @@
 PT = TypeVar("PT")
 
 
-@runtime_checkable
-class PptxConvertible(Protocol[PT]):
+class PptxConvertible(Generic[PT]):
     """Protocol for objects that can be converted to and from pptx objects."""
 
+    def __init__(self, pptx_obj: PT, /) -> None:
+        self._pptx: PT = pptx_obj
+
     def to_pptx(self) -> PT:
         """Convert to pptx object."""
-        ...
+        return self._pptx
 
     @classmethod
     def from_pptx(cls, pptx_obj: PT) -> Self:
         """Create from pptx object."""
-        ...
+        return cls(pptx_obj)
 
 
 @overload
-def to_pptx_length(length: Length | LiteralLength) -> PptxLength: ...
+def to_pptx_length(length: Length | LiteralLength | PptxLength) -> PptxLength: ...
 
 
 @overload
-def to_pptx_length(length: Length | LiteralLength | None) -> PptxLength | None: ...
+def to_pptx_length(
+    length: Length | LiteralLength | PptxLength | None,
+) -> PptxLength | None: ...
 
 
-def to_pptx_length(length: Length | LiteralLength | None) -> PptxLength | None:
+def to_pptx_length(
+    length: Length | LiteralLength | PptxLength | None,
+) -> PptxLength | None:
     if isinstance(length, tuple):
         length = to_length(length)
 
@@ -71,6 +76,8 @@ def to_pptx_length(length: Length | LiteralLength | None) -> PptxLength | None:
             return PptxMm(length.value)
         case EnglishMetricUnits():
             return PptxEmu(length.value)
+        case PptxLength():
+            return length
         case None:
             return None
         case _:
@@ -90,32 +97,46 @@ def to_tppt_length(length: PptxLength | None) -> Length | None:
 
 
 @overload
-def to_pptx_rgb_color(color: RGBColor | LiteralColor) -> PptxRGBColor: ...
+def to_pptx_rgb_color(
+    color: Color | LiteralColor | PptxRGBColor,
+) -> tuple[PptxRGBColor, int | None]: ...
 
 
 @overload
-def to_pptx_rgb_color(color: RGBColor | LiteralColor | None) -> PptxRGBColor | None: ...
-
-
-def to_pptx_rgb_color(color: RGBColor | LiteralColor | None) -> PptxRGBColor | None:
+def to_pptx_rgb_color(
+    color: Color | LiteralColor | PptxRGBColor | None,
+) -> tuple[PptxRGBColor, int | None] | None: ...
+
+
+def to_pptx_rgb_color(
+    color: Color | LiteralColor | PptxRGBColor | None,
+) -> (
+    tuple[
+        PptxRGBColor,
+        int | None,
+    ]
+    | None
+):
     if color is None:
         return None
 
-    color = to_rgb_color(color)
+    color = to_color(color)
 
-    return PptxRGBColor(color.r, color.g, color.b)
+    return PptxRGBColor(color.r, color.g, color.b), color.a
 
 
 @overload
-def to_tppt_rgb_color(color: PptxRGBColor) -> RGBColor: ...
+def to_tppt_rgb_color(color: PptxRGBColor, alpha: int | None) -> Color: ...
 
 
 @overload
-def to_tppt_rgb_color(color: PptxRGBColor | None) -> RGBColor | None: ...
+def to_tppt_rgb_color(
+    color: PptxRGBColor | None, alpha: int | None
+) -> Color | None: ...
 
 
-def to_tppt_rgb_color(color: PptxRGBColor | None) -> RGBColor | None:
-    return RGBColor(*color) if color else None
+def to_tppt_rgb_color(color: PptxRGBColor | None, alpha: int | None) -> Color | None:
+    return Color(color[0], color[1], color[2], alpha) if color else None
 
 
 PptxAngle: TypeAlias = float