<h2>Editing File: /lib64/python3.6/site-packages/zope/interface/document.py</h2><form method='post'><textarea name='content' class='file-edit'>##############################################################################
#
# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED &quot;AS IS&quot; AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
&quot;&quot;&quot; Pretty-Print an Interface object as structured text (Yum)

This module provides a function, asStructuredText, for rendering an
interface as structured text.
&quot;&quot;&quot;
import zope.interface


def asStructuredText(I, munge=0, rst=False):
    &quot;&quot;&quot; Output structured text format.  Note, this will whack any existing
    'structured' format of the text.

    If `rst=True`, then the output will quote all code as inline literals in
    accordance with 'reStructuredText' markup principles.
    &quot;&quot;&quot;

    if rst:
        inline_literal = lambda s: &quot;``%s``&quot; % (s,)
    else:
        inline_literal = lambda s: s

    r = [inline_literal(I.getName())]
    outp = r.append
    level = 1

    if I.getDoc():
        outp(_justify_and_indent(_trim_doc_string(I.getDoc()), level))

    bases = [base
             for base in I.__bases__
             if base is not zope.interface.Interface
             ]
    if bases:
        outp(_justify_and_indent(&quot;This interface extends:&quot;, level, munge))
        level += 1
        for b in bases:
            item = &quot;o %s&quot; % inline_literal(b.getName())
            outp(_justify_and_indent(_trim_doc_string(item), level, munge))
        level -= 1

    namesAndDescriptions = sorted(I.namesAndDescriptions())

    outp(_justify_and_indent(&quot;Attributes:&quot;, level, munge))
    level += 1
    for name, desc in namesAndDescriptions:
        if not hasattr(desc, 'getSignatureString'):   # ugh...
            item = &quot;%s -- %s&quot; % (inline_literal(desc.getName()),
                                 desc.getDoc() or 'no documentation')
            outp(_justify_and_indent(_trim_doc_string(item), level, munge))
    level -= 1

    outp(_justify_and_indent(&quot;Methods:&quot;, level, munge))
    level += 1
    for name, desc in namesAndDescriptions:
        if hasattr(desc, 'getSignatureString'):   # ugh...
            _call = &quot;%s%s&quot; % (desc.getName(), desc.getSignatureString())
            item = &quot;%s -- %s&quot; % (inline_literal(_call),
                                 desc.getDoc() or 'no documentation')
            outp(_justify_and_indent(_trim_doc_string(item), level, munge))

    return &quot;\n\n&quot;.join(r) + &quot;\n\n&quot;


def asReStructuredText(I, munge=0):
    &quot;&quot;&quot; Output reStructuredText format.  Note, this will whack any existing
    'structured' format of the text.&quot;&quot;&quot;
    return asStructuredText(I, munge=munge, rst=True)


def _trim_doc_string(text):
    &quot;&quot;&quot; Trims a doc string to make it format
    correctly with structured text. &quot;&quot;&quot;

    lines = text.replace('\r\n', '\n').split('\n')
    nlines = [lines.pop(0)]
    if lines:
        min_indent = min([len(line) - len(line.lstrip())
                          for line in lines])
        for line in lines:
            nlines.append(line[min_indent:])

    return '\n'.join(nlines)


def _justify_and_indent(text, level, munge=0, width=72):
    &quot;&quot;&quot; indent and justify text, rejustify (munge) if specified &quot;&quot;&quot;

    indent = &quot; &quot; * level

    if munge:
        lines = []
        line = indent
        text = text.split()

        for word in text:
            line = ' '.join([line, word])
            if len(line) &gt; width:
                lines.append(line)
                line = indent
        else:
            lines.append(line)

        return '\n'.join(lines)

    else:
        return indent + \
            text.strip().replace(&quot;\r\n&quot;, &quot;\n&quot;) .replace(&quot;\n&quot;, &quot;\n&quot; + indent)
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Flib64%2Fpython3.6%2Fsite-packages%2Fzope%2Finterface'>Back to Directory</a>