Method __repr__

Lib/pagebot/elements/page.py:192–231

Page as string. Similar to general Element.__repr__, except showing the (pageNumber, index) as it is stored in the parent document. And not showing (self.x, self.y), as most pages will not be part of another page (although it is allowed and there could be situations to do so,

(self)

    index = property(_get_index)

    def __repr__(self):
        """Page as string. Similar to general Element.__repr__, except showing
        the (pageNumber, index) as it is stored in the parent document. And not
        showing (self.x, self.y), as most pages will not be part of another
        page (although it is allowed and there could be situations to do so,
        e.g. if a page is used as illustration in another page.)

        >>> from pagebot.document import Document
        >>> from pagebot.constants import A4
        >>> doc = Document(name='TestDoc', autoPages=8, size=A4)
        >>> doc[5] # Remembers original unit size.
        <Page #5 default (210mm, 297mm)>
        """
        if self.title:
            name = ' ' + self.title
        elif self.name:
            name = ' ' + self.name
        else: # No name
            name = ' Unplaced'

        if self.elements:
            elements = ' E(%d)' % len(self.elements)
        else:
            elements = ''

        pn = ''

        if self.parent: # If there is a parent, get the (pageNumber, index) tuple.
            if self._pn is not None: # Hard coded page number, then ignore document index.
                pn_index = self._pn
            else:
                pn_index = self.parent.getPageNumber(self)

            if pn_index is not None:
                if pn_index[1]: # Index > 1, then show.
                    pn = ' #%d:%d' % pn_index
                else:
                    pn = ' #%d' % pn_index[0]

        return '<%s%s%s (%s, %s)%s>' % (self.__class__.__name__, pn, name, self.w, self.h, elements)

    def _get_isLeft(self):
        """Answers if this is a left page (even pagenumber), unless the