Folder

Folder dataclass

Folder(comment: str, item_id: int, label: Label, name: str, parent_folder: FolderItem | None, type_name: str, folder_items: list[int])

Bases: Item

Folder item.

Attributes:

Name	Type	Description
folder_items	list[int]	The IDs of items in this folder.

__iter__

__iter__() -> Iterator[int]

Return an iterator over the folder item IDs.

Source code in src/aep_parser/models/items/folder.py

def __iter__(self) -> typing.Iterator[int]:
    """Return an iterator over the folder item IDs."""
    return iter(self.folder_items)

item

item(index: int) -> int

Get a folder item ID by index.

Parameters:

Name	Type	Description	Default
index	int	The index of the item to return.	required

Source code in src/aep_parser/models/items/folder.py

def item(self, index: int) -> int:
    """
    Get a folder item ID by index.

    Args:
        index: The index of the item to return.
    """
    return self.folder_items[index]