feat: add MasterLayoutNotFoundError exception and implement get_master_layout and get_layouts functions

Author: ya7010

src/tppt/exception.py

@@ -62,3 +62,14 @@ def __init__(self, slide_layout_name: str) -> None:
     @property
     def message(self) -> str:
         return f"The slide master does not have an attribute for the {self.slide_layout_name} layout"
+
+
+class MasterLayoutNotFoundError(TpptException, ValueError):
+    """Slide with MasterLayout tag not found."""
+
+    def __init__(self, slide_master_name: str) -> None:
+        self.slide_master_name = slide_master_name
+
+    @property
+    def message(self) -> str:
+        return f"No slide with MasterLayout tag found in {self.slide_master_name}"

src/tppt/slide_master.py

@@ -3,6 +3,7 @@
 from typing_extensions import TypeVar, dataclass_transform
 
 from tppt.exception import (
+    MasterLayoutNotFoundError,
     SlideMasterAttributeMustBeSlideLayoutError,
     SlideMasterAttributeNotFoundError,
 )
@@ -27,17 +28,17 @@
 
 class _SlideMasterMeta(type):
     def __getattr__(self, key: str) -> "type[SlideLayout]":
-        # 1. クラス自身の属性を確認
+        # 1. Check the class's own attributes
         if key in self.__dict__:
             value = self.__dict__[key]
             if isinstance(value, type) and issubclass(value, SlideLayout):
                 return value
 
-        # 2. アノテーションを確認
+        # 2. Check annotations
         if hasattr(self, "__annotations__") and key in self.__annotations__:
             annotation = self.__annotations__[key]
 
-            # Annotated型からの抽出
+            # Extract from Annotated type
             origin = get_origin(annotation)
             if origin is Annotated:
                 args = get_args(annotation)
@@ -49,7 +50,7 @@ def __getattr__(self, key: str) -> "type[SlideLayout]":
                     return args[0]
                 else:
                     raise SlideMasterAttributeMustBeSlideLayoutError(key)
-            # クラスの場合は直接チェック
+            # Direct check for class type
             elif isinstance(annotation, type) and issubclass(annotation, SlideLayout):
                 return annotation
             else:
@@ -103,3 +104,34 @@ class DefaultSlideMaster(SlideMaster):
     "GenericTpptSlideMaster",
     bound=SlideMaster,
 )
+
+def get_master_layout(slide_master: type[SlideMaster]) -> type[SlideLayout]:
+    """Get the slide tagged with MasterLayout."""
+    for attr_name, annotation in slide_master.__annotations__.items():
+        origin = get_origin(annotation)
+        if origin is Annotated:
+            args = get_args(annotation)
+            # Check the class name instead of directly checking the type of args[1]
+            if len(args) > 1 and args[1].__class__.__name__ == "MasterLayout":
+                return getattr(slide_master, attr_name)
+
+    raise MasterLayoutNotFoundError(slide_master.__name__)
+
+
+def get_layouts(slide_master: type[SlideMaster]) -> list[type[SlideLayout]]:
+    """Get an array of slides tagged with Layout."""
+    layouts = []
+
+    for attr_name, annotation in slide_master.__annotations__.items():
+        origin = get_origin(annotation)
+        if origin is Annotated:
+            args = get_args(annotation)
+            # Identify Layout and MasterLayout using class names
+            if len(args) > 1:
+                if args[1].__class__.__name__ == "Layout":
+                    layouts.append(getattr(slide_master, attr_name))
+                elif args[1].__class__.__name__ == "MasterLayout":
+                    # Exclude MasterLayout
+                    pass
+
+    return layouts

tests/test_slide_master.py

@@ -0,0 +1,48 @@
+
+from tppt.slide_layout import (
+    DefaultBlankSlide,
+    DefaultComparisonSlide,
+    DefaultContentWithCaptionSlide,
+    DefaultMasterSlide,
+    DefaultPictureWithCaptionSlide,
+    DefaultSectionHeaderSlide,
+    DefaultTitleAndContentSlide,
+    DefaultTitleAndVerticalTextSlide,
+    DefaultTitleOnlySlide,
+    DefaultTitleSlide,
+    DefaultTwoContentSlide,
+    DefaultVerticalTitleAndTextSlide,
+)
+from tppt.slide_master import DefaultSlideMaster, get_layouts, get_master_layout
+
+
+def test_get_master_layout():
+    """Test that get_master_layout function correctly retrieves the MasterLayout"""
+    master_layout = get_master_layout(DefaultSlideMaster)
+    assert master_layout == DefaultMasterSlide
+
+
+def test_get_layouts():
+    """Test that get_layouts function correctly retrieves the list of Layouts"""
+    layouts = get_layouts(DefaultSlideMaster)
+
+    # Verify that all Layouts are included
+    expected_layouts = [
+        DefaultTitleSlide,
+        DefaultTitleAndContentSlide,
+        DefaultSectionHeaderSlide,
+        DefaultTwoContentSlide,
+        DefaultComparisonSlide,
+        DefaultTitleOnlySlide,
+        DefaultBlankSlide,
+        DefaultContentWithCaptionSlide,
+        DefaultPictureWithCaptionSlide,
+        DefaultTitleAndVerticalTextSlide,
+        DefaultVerticalTitleAndTextSlide,
+    ]
+
+    # Convert to sets for comparison as the order is not guaranteed
+    assert set(layouts) == set(expected_layouts)
+
+    # Verify that MasterLayout is not included
+    assert DefaultMasterSlide not in layouts