Class ElementProxy

src/pptx/shared.py:13–43

Base class for lxml element proxy classes. An element proxy class is one whose primary responsibilities are fulfilled by manipulating the attributes and child elements of an XML element. They are the most common type of class in python-pptx other than custom element (oxml) classes.

class ElementProxy(object):
    """Base class for lxml element proxy classes.

    An element proxy class is one whose primary responsibilities are fulfilled by manipulating the
    attributes and child elements of an XML element. They are the most common type of class in
    python-pptx other than custom element (oxml) classes.
    """

    def __init__(self, element: BaseOxmlElement):
        self._element = element

    def __eq__(self, other: object) -> bool:
        """Return |True| if this proxy object refers to the same oxml element as does *other*.

        ElementProxy objects are value objects and should maintain no mutable local state.
        Equality for proxy objects is defined as referring to the same XML element, whether or not
        they are the same proxy object instance.
        """
        if not isinstance(other, ElementProxy):
            return False
        return self._element is other._element

    def __ne__(self, other: object) -> bool:
        if not isinstance(other, ElementProxy):
            return True
        return self._element is not other._element

    @property
    def element(self):
        """The lxml element proxied by this object."""
        return self._element


class ParentedElementProxy(ElementProxy):