refactor: rename TpptSlideLayout and TpptSlideMaster to SlideLayout and SlideMaster, respectively

Author: ya7010

examples/custom_slide_master.py

@@ -1,17 +1,18 @@
 from pathlib import Path
 
 import tppt
-from tppt.slide_layout import DefaultMasterSlide, DefaultTitleSlide
 
 
 def main():
-    class CustomMasterSlide(DefaultMasterSlide):
-        pass
+    class CustomMasterSlide(tppt.SlideLayout):
+        title: tppt.Placeholder[str]
+        text: tppt.Placeholder[str]
 
-    class CustomTitleSlide(DefaultTitleSlide):
-        pass
+    class CustomTitleSlide(tppt.SlideLayout):
+        title: tppt.Placeholder[str]
+        subtitle: tppt.Placeholder[str | None] = None
 
-    class CustomSlideMaster(tppt.TpptSlideMaster):
+    class CustomSlideMaster(tppt.SlideMaster):
         Master = CustomMasterSlide
         Title = CustomTitleSlide
 

src/tppt/__init__.py

@@ -1,22 +1,21 @@
 """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
-from tppt.pptx.slide_layout import SlideLayout
-from tppt.pptx.slide_master import SlideMaster
-from tppt.slide_layout import Placeholder, TpptSlideLayout
-from tppt.slide_master import TpptSlideMaster
+from tppt.slide_layout import Placeholder, SlideLayout
+from tppt.slide_master import SlideMaster
+
+from . import pptx as pptx
+from . import types as types
 
 __all__ = [
     "Presentation",
     "Shape",
     "Slide",
     "SlideBuilder",
     "SlideLayout",
-    "SlideMaster",
     "Placeholder",
-    "TpptSlideLayout",
-    "TpptSlideMaster",
+    "SlideLayout",
+    "SlideMaster",
 ]

src/tppt/pptx/__init__.py

@@ -1 +1,7 @@
 """pptx wrapper implementation."""
+
+from .presentation import Presentation as Presentation
+from .shape import Shape as Shape
+from .slide import Slide as Slide
+from .slide import SlideBuilder as SlideBuilder
+from .slide_layout import SlideLayout as SlideLayout

src/tppt/pptx/presentation.py

@@ -6,7 +6,7 @@
 from pptx.presentation import Presentation as PptxPresentation
 
 from tppt.pptx.tree import ppt2dict
-from tppt.slide_layout import TpptSlideLayout
+from tppt.slide_layout import SlideLayout
 from tppt.slide_master import (
     DefaultSlideMaster,
     GenericTpptSlideMaster,
@@ -108,7 +108,7 @@ def __init__(
     def slide(
         self,
         slide: SlideBuilder
-        | Callable[[type[GenericTpptSlideMaster]], SlideBuilder | TpptSlideLayout],
+        | Callable[[type[GenericTpptSlideMaster]], SlideBuilder | SlideLayout],
         /,
     ) -> Self:
         """Add a slide to the presentation."""
@@ -118,7 +118,7 @@ def slide(
             slide_layout = slide(self._slide_master)
             slide_builder = (
                 slide_layout.builder()
-                if isinstance(slide_layout, TpptSlideLayout)
+                if isinstance(slide_layout, SlideLayout)
                 else slide_layout
             )
             slide_builder._build(self)

src/tppt/slide_layout.py

@@ -38,7 +38,7 @@ def __class_getitem__(cls, item: Any) -> Any:
 Placeholder = Annotated[_AnyType, _Placeholder]
 
 
-class TpptSlideLayoutMeta(type):
+class _SlideLayoutMeta(type):
     """Meta class for TpptSlideLayout.
 
     Tracks fields annotated as placeholders.
@@ -92,7 +92,7 @@ def __new__(
     order_default=False,
     field_specifiers=(),
 )
-class TpptSlideLayout(metaclass=TpptSlideLayoutMeta):
+class SlideLayout(metaclass=_SlideLayoutMeta):
     """Base class for slide layouts"""
 
     __placeholders__: ClassVar[dict[str, Any]] = {}
@@ -129,7 +129,7 @@ def builder(self) -> "SlideBuilder":
         return SlideBuilder()
 
 
-class DefaultMasterSlide(TpptSlideLayout):
+class DefaultMasterSlide(SlideLayout):
     """Default master slide layout."""
 
     title: Placeholder[str]
@@ -138,7 +138,7 @@ class DefaultMasterSlide(TpptSlideLayout):
     footer: Placeholder[str | None] = None
 
 
-class DefaultTitleSlide(TpptSlideLayout):
+class DefaultTitleSlide(SlideLayout):
     """Title slide layout."""
 
     title: Placeholder[str]
@@ -147,7 +147,7 @@ class DefaultTitleSlide(TpptSlideLayout):
     footer: Placeholder[str | None] = None
 
 
-class DefaultTitleAndContentSlide(TpptSlideLayout):
+class DefaultTitleAndContentSlide(SlideLayout):
     """Title and content slide layout."""
 
     title: Placeholder[str]
@@ -156,7 +156,7 @@ class DefaultTitleAndContentSlide(TpptSlideLayout):
     footer: Placeholder[str | None] = None
 
 
-class DefaultSectionHeaderSlide(TpptSlideLayout):
+class DefaultSectionHeaderSlide(SlideLayout):
     """Section header slide layout."""
 
     title: Placeholder[str]
@@ -165,7 +165,7 @@ class DefaultSectionHeaderSlide(TpptSlideLayout):
     footer: Placeholder[str | None] = None
 
 
-class DefaultTwoContentSlide(TpptSlideLayout):
+class DefaultTwoContentSlide(SlideLayout):
     """Two content slide layout."""
 
     title: Placeholder[str]
@@ -175,7 +175,7 @@ class DefaultTwoContentSlide(TpptSlideLayout):
     footer: Placeholder[str | None] = None
 
 
-class DefaultComparisonSlide(TpptSlideLayout):
+class DefaultComparisonSlide(SlideLayout):
     """Comparison slide layout."""
 
     title: Placeholder[str]
@@ -187,22 +187,22 @@ class DefaultComparisonSlide(TpptSlideLayout):
     footer: Placeholder[str | None] = None
 
 
-class DefaultTitleOnlySlide(TpptSlideLayout):
+class DefaultTitleOnlySlide(SlideLayout):
     """Title only slide layout."""
 
     title: Placeholder[str]
     date: Placeholder[datetime.date | None] = None
     footer: Placeholder[str | None] = None
 
 
-class DefaultBlankSlide(TpptSlideLayout):
+class DefaultBlankSlide(SlideLayout):
     """Blank slide layout."""
 
     date: Placeholder[datetime.date | None] = None
     footer: Placeholder[str | None] = None
 
 
-class DefaultContentWithCaptionSlide(TpptSlideLayout):
+class DefaultContentWithCaptionSlide(SlideLayout):
     """Content with caption slide layout."""
 
     title: Placeholder[str]
@@ -211,7 +211,7 @@ class DefaultContentWithCaptionSlide(TpptSlideLayout):
     footer: Placeholder[str | None] = None
 
 
-class DefaultPictureWithCaptionSlide(TpptSlideLayout):
+class DefaultPictureWithCaptionSlide(SlideLayout):
     """Picture with caption slide layout."""
 
     title: Placeholder[str]
@@ -220,7 +220,7 @@ class DefaultPictureWithCaptionSlide(TpptSlideLayout):
     footer: Placeholder[str | None] = None
 
 
-class DefaultTitleAndVerticalTextSlide(TpptSlideLayout):
+class DefaultTitleAndVerticalTextSlide(SlideLayout):
     """Title and vertical text slide layout."""
 
     title: Placeholder[str]
@@ -229,7 +229,7 @@ class DefaultTitleAndVerticalTextSlide(TpptSlideLayout):
     footer: Placeholder[str | None] = None
 
 
-class DefaultVerticalTitleAndTextSlide(TpptSlideLayout):
+class DefaultVerticalTitleAndTextSlide(SlideLayout):
     """Vertical title and text slide layout."""
 
     vertical_title: Placeholder[str]

src/tppt/slide_master.py

@@ -18,15 +18,15 @@
     DefaultTitleSlide,
     DefaultTwoContentSlide,
     DefaultVerticalTitleAndTextSlide,
-    TpptSlideLayout,
+    SlideLayout,
 )
 
 
-class TpptSlideMasterMeta(type):
-    def __getattr__(self, key: str) -> "type[TpptSlideLayout]":
+class _SlideMasterMeta(type):
+    def __getattr__(self, key: str) -> "type[SlideLayout]":
         if key in self.__annotations__:
             annotation = self.__annotations__[key]
-            if issubclass(annotation, TpptSlideLayout):
+            if issubclass(annotation, SlideLayout):
                 return annotation
             else:
                 raise SlideMasterAttributeMustBeSlideLayoutError(key)
@@ -39,10 +39,10 @@ def __getattr__(self, key: str) -> "type[TpptSlideLayout]":
     order_default=False,
     field_specifiers=(),
 )
-class TpptSlideMaster(metaclass=TpptSlideMasterMeta): ...
+class SlideMaster(metaclass=_SlideMasterMeta): ...
 
 
-class DefaultSlideMaster(TpptSlideMaster):
+class DefaultSlideMaster(SlideMaster):
     Master: DefaultMasterSlide
     Title: DefaultTitleSlide
     TitleAndContent: DefaultTitleAndContentSlide
@@ -59,5 +59,5 @@ class DefaultSlideMaster(TpptSlideMaster):
 
 GenericTpptSlideMaster = TypeVar(
     "GenericTpptSlideMaster",
-    bound=TpptSlideMaster,
+    bound=SlideMaster,
 )

tests/test_slide.py

@@ -51,7 +51,7 @@ def test_slide_layout_placeholders() -> None:
         pytest.skip("No slide layouts in presentation")
 
     # Get the first slide layout
-    slide_layout = tppt.SlideLayout(pptx_presentation.slide_layouts[0])
+    slide_layout = tppt.pptx.SlideLayout(pptx_presentation.slide_layouts[0])
 
     # Test that we can get placeholders
     placeholders = slide_layout.placeholders