Class CT_Relationships

src/pptx/opc/oxml.py:123–151

` ` element, the root element in a .rels file.

class CT_Relationships(BaseOxmlElement):
    """`<Relationships>` element, the root element in a .rels file."""

    relationship_lst: list[CT_Relationship]
    _insert_relationship: Callable[[CT_Relationship], CT_Relationship]

    relationship = ZeroOrMore("pr:Relationship")

    def add_rel(
        self, rId: str, reltype: str, target: str, is_external: bool = False
    ) -> CT_Relationship:
        """Add a child `<Relationship>` element with attributes set as specified."""
        target_mode = RTM.EXTERNAL if is_external else RTM.INTERNAL
        relationship = CT_Relationship.new(rId, reltype, target, target_mode)
        return self._insert_relationship(relationship)

    @classmethod
    def new(cls) -> CT_Relationships:
        """Return a new `<Relationships>` element."""
        return cast(CT_Relationships, parse_xml(f'<Relationships xmlns="{nsmap["pr"]}"/>'))

    @property
    def xml_file_bytes(self) -> bytes:
        """Return XML bytes, with XML-declaration, for this `<Relationships>` element.

        Suitable for saving in a .rels stream, not pretty printed and with an XML declaration at
        the top.
        """
        return oxml_to_encoded_bytes(self, encoding="UTF-8", standalone=True)


class CT_Types(BaseOxmlElement):