Skip to content

NestedItem

⋔ Inheritance diagram

graph TD
  1473245678288["itemmodels.NestedItem"]
  140713234304496["builtins.object"]
  140713234304496 --> 1473245678288

🛈 DocStrings

Source code in prettyqt\itemmodels\nesteditem.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
class NestedItem:
    item_name = "not_defined"

    def __init__(
        self,
        parent: Self | None = None,
        dynamic_name: str | None = None,
        count: int | None = None,
        children: Sequence[Self] | None = None,
    ):
        self.parent = parent
        self.dynamic_name = dynamic_name or self.item_name
        self.count = count
        # self.timestamp = kwargs.pop("timestamp", time.time())
        self.children: Sequence[Self] = []
        if children:
            self.add_children(children)

    def __iter__(self) -> Iterator[Self]:
        return iter(self.children)

    def add_children(self, children: Sequence[Self]):
        for child in children:
            child.parent = self
        self.children.extend(children)

    def append_child(self, item: Self):
        item.parent_item = self
        self.children.append(item)

    def insert_children(self, idx: int, items: Sequence[Self]):
        self.children[idx:idx] = items
        for item in items:
            item.parent_item = self

    def child(self, row: int) -> Self:
        return self.children[row]

    def row(self) -> int:
        """Return row number.

        returns row position of item inside parent`s children
        returns 0 if no parent available

        Returns:
            row number
        """
        return self.parent.children.index(self) if self.parent else 0

    def iter_tree(
        self,
        name: str | None = None,
        yield_self: bool = True,
        recursive: bool = True,
        level: int = 0,
        count: int = 0,
        assign_names: bool = True,
    ):
        """Yield children from bottom to top, yield self at end.

        assigns dynamic vars count, level and dynamic name
        """
        if name is None:
            name = self.item_name
        for i, c in enumerate(self.children, start=1):
            count += 1
            level += 1
            with_suffix = f"{name}_{i}" if len(self.children) > 1 else name
            if recursive:
                yield from c.iter_tree(
                    with_suffix, yield_self=False, level=level, count=count
                )
            if assign_names:
                c.dynamic_name, c.count = with_suffix, count
            yield c
            level -= 1
        if yield_self:
            if assign_names:
                self.dynamic_name, self.count = name, 0
            yield self

iter_tree(name: str | None = None, yield_self: bool = True, recursive: bool = True, level: int = 0, count: int = 0, assign_names: bool = True)

Yield children from bottom to top, yield self at end.

assigns dynamic vars count, level and dynamic name

Source code in prettyqt\itemmodels\nesteditem.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def iter_tree(
    self,
    name: str | None = None,
    yield_self: bool = True,
    recursive: bool = True,
    level: int = 0,
    count: int = 0,
    assign_names: bool = True,
):
    """Yield children from bottom to top, yield self at end.

    assigns dynamic vars count, level and dynamic name
    """
    if name is None:
        name = self.item_name
    for i, c in enumerate(self.children, start=1):
        count += 1
        level += 1
        with_suffix = f"{name}_{i}" if len(self.children) > 1 else name
        if recursive:
            yield from c.iter_tree(
                with_suffix, yield_self=False, level=level, count=count
            )
        if assign_names:
            c.dynamic_name, c.count = with_suffix, count
        yield c
        level -= 1
    if yield_self:
        if assign_names:
            self.dynamic_name, self.count = name, 0
        yield self

row() -> int

Return row number.

returns row position of item inside parent`s children returns 0 if no parent available

Source code in prettyqt\itemmodels\nesteditem.py 
46
47
48
49
50
51
52
53
54
55
def row(self) -> int:
    """Return row number.

    returns row position of item inside parent`s children
    returns 0 if no parent available

    Returns:
        row number
    """
    return self.parent.children.index(self) if self.parent else 0