refactor: rename Shape class to BaseShape and update related references for clarity

Author: ya7010

src/tppt/pptx/shape/__init__.py

@@ -1,32 +1,53 @@
 """Shape wrapper implementation."""
 
-from typing import Self, TypedDict
+from typing import TYPE_CHECKING, Self, TypedDict
 
+from pptx.shapes.autoshape import Shape as PptxShape
 from pptx.shapes.base import BaseShape as PptxBaseShape
 from typing_extensions import TypeVar
 
 from tppt.pptx.converter import PptxConvertible
 from tppt.types._length import Length, LiteralLength
 
-GenericPptxShape = TypeVar(
-    "GenericPptxShape",
+if TYPE_CHECKING:
+    from ..text.text_frame import TextFrame
+
+GenericPptxBaseShape = TypeVar(
+    "GenericPptxBaseShape",
     bound=PptxBaseShape,
     default=PptxBaseShape,
 )
 
+GenericPptxShape = TypeVar(
+    "GenericPptxShape",
+    bound=PptxShape,
+    default=PptxShape,
+)
 
-class Shape(PptxConvertible[GenericPptxShape]):
-    def __init__(self, pptx_shape: GenericPptxShape) -> None:
-        self._pptx: GenericPptxShape = pptx_shape
 
-    def to_pptx(self) -> GenericPptxShape:
+class BaseShape(PptxConvertible[GenericPptxBaseShape]):
+    def __init__(self, pptx_shape: GenericPptxBaseShape) -> None:
+        self._pptx: GenericPptxBaseShape = pptx_shape
+
+    def to_pptx(self) -> GenericPptxBaseShape:
         return self._pptx
 
     @classmethod
-    def from_pptx(cls, pptx_obj: GenericPptxShape) -> Self:
+    def from_pptx(cls, pptx_obj: GenericPptxBaseShape) -> Self:
         return cls(pptx_obj)
 
 
+class Shape(BaseShape[GenericPptxShape]):
+    def __init__(self, pptx_shape: GenericPptxShape) -> None:
+        self._pptx: GenericPptxShape = pptx_shape
+
+    @property
+    def text_frame(self) -> "TextFrame":
+        from ..text.text_frame import TextFrame
+
+        return TextFrame(self._pptx.text_frame)
+
+
 class RangeProps(TypedDict):
     """Range properties."""
 

src/tppt/pptx/shape/picture.py

@@ -4,7 +4,7 @@
 
 from tppt.types import FilePath
 
-from . import RangeProps, Shape
+from . import BaseShape, RangeProps
 
 
 class PictureProps(RangeProps):
@@ -19,7 +19,7 @@ class PictureData(PictureProps):
     image_file: FilePath | IO[bytes]
 
 
-class Picture(Shape[PptxPicture]):
+class Picture(BaseShape[PptxPicture]):
     """Picture data class."""
 
     def __init__(

src/tppt/pptx/placeholder.py renamed to src/tppt/pptx/shape/placeholder.py

@@ -7,8 +7,10 @@
 from tppt.exception import InvalidSetterTypeError
 from tppt.pptx.presentation import PptxConvertible
 
+from . import BaseShape
 
-class SlidePlaceholder(PptxConvertible[PptxSlidePlaceholder]):
+
+class SlidePlaceholder(BaseShape[PptxSlidePlaceholder]):
     def __init__(self, pptx_obj: PptxSlidePlaceholder) -> None:
         self._pptx = pptx_obj
 

src/tppt/pptx/shape/text.py

@@ -35,7 +35,7 @@ class TextData(TextProps):
     text: str
 
 
-class Text(Shape[PptxShape]):
+class Text(Shape):
     """Text data class."""
 
     def __init__(self, pptx_obj: PptxShape, data: TextData | None = None, /) -> None:

src/tppt/pptx/slide.py

@@ -8,9 +8,9 @@
 from tppt.types import FilePath
 
 from .converter import PptxConvertible, to_pptx_length
-from .placeholder import SlidePlaceholder
-from .shape import RangeProps, Shape
+from .shape import BaseShape, RangeProps
 from .shape.picture import Picture, PictureData, PictureProps
+from .shape.placeholder import SlidePlaceholder
 from .shape.text import Text, TextData, TextProps
 from .slide_layout import SlideLayout
 from .snotes_slide import NotesSlide
@@ -43,9 +43,9 @@ def slide_id(self) -> int:
         return self._pptx.slide_id
 
     @property
-    def shapes(self) -> list[Shape]:
+    def shapes(self) -> list[BaseShape]:
         """Get all shapes in the slide."""
-        return [Shape(shape) for shape in self._pptx.shapes]
+        return [BaseShape(shape) for shape in self._pptx.shapes]
 
     @property
     def placeholders(self) -> list[SlidePlaceholder]:

src/tppt/pptx/slide_layout.py

@@ -3,9 +3,9 @@
 from pptx.slide import SlideLayout as PptxSlideLayout
 
 from .converter import PptxConvertible
-from .placeholder import LayoutPlaceholder
-from .shape import Shape
+from .shape import BaseShape
 from .shape.background import Background
+from .shape.placeholder import LayoutPlaceholder
 
 
 class SlideLayout(PptxConvertible[PptxSlideLayout]):
@@ -39,9 +39,9 @@ def placeholders(self) -> list[LayoutPlaceholder]:
         ]
 
     @property
-    def shapes(self) -> list[Shape]:
+    def shapes(self) -> list[BaseShape]:
         """Get the shapes."""
-        return [Shape.from_pptx(shape) for shape in self._pptx.shapes]
+        return [BaseShape.from_pptx(shape) for shape in self._pptx.shapes]
 
     def to_pptx(self) -> PptxSlideLayout:
         """Convert to pptx slide layout."""

src/tppt/template/default.py

@@ -1,7 +1,8 @@
 import datetime
 from typing import Literal
 
-from ..types import FilePath
+from tppt.types import FilePath
+
 from .slide_layout import Placeholder, SlideLayout
 from .slide_master import Layout, SlideMaster, slide_master
 

tests/test_slide.py

@@ -4,7 +4,7 @@
 
 import tppt
 import tppt.pptx.slide
-from tppt.pptx.placeholder import LayoutPlaceholder, SlidePlaceholder
+from tppt.pptx.shape.placeholder import LayoutPlaceholder, SlidePlaceholder
 from tppt.pptx.slide_layout import SlideLayout as PptxSlideLayout
 
 

tests/test_text.py

@@ -3,7 +3,6 @@
 from pptx.enum.text import MSO_ANCHOR, MSO_AUTO_SIZE, PP_ALIGN
 
 import tppt
-import tppt.pptx.table.table
 from tppt.types._color import Color
 
 
@@ -27,7 +26,7 @@ def test_text_with_options(output) -> None:
                 size=(24, "pt"),
                 bold=True,
                 italic=True,
-                color=Color("#FF0000"),
+                color=Color("#0000FF"),
                 margin_bottom=(10, "pt"),
                 margin_left=(10, "pt"),
                 vertical_anchor=MSO_ANCHOR.MIDDLE,