?HAMA

Navigation

Breadcrumbs

/ / opt / alt / python35 / lib64 / python3.5 / idlelib

Create

Create File | Create Folder | Upload Files | Run Command

Edit File Size: 7.12 KB

//opt/alt/python35/lib64/python3.5/idlelib/FormatParagraph.py

Text Base64

"""Extension to format a paragraph or selection to a max width.

Does basic, standard text formatting, and also understands Python
comment blocks. Thus, for editing Python source code, this
extension is really only suitable for reformatting these comment
blocks or triple-quoted strings.

Known problems with comment reformatting:
* If there is a selection marked, and the first line of the
  selection is not complete, the block will probably not be detected
  as comments, and will have the normal "text formatting" rules
  applied.
* If a comment block has leading whitespace that mixes tabs and
  spaces, they will not be considered part of the same block.
* Fancy comments, like this bulleted list, aren't handled :-)
"""

import re
from idlelib.configHandler import idleConf

class FormatParagraph:

menudefs = [
        ('format', [   # /s/edit/format   dscherer@cmu.edu
            ('Format Paragraph', '<<format-paragraph>>'),
         ])
    ]

def __init__(self, editwin):
        self.editwin = editwin

def close(self):
        self.editwin = None

def format_paragraph_event(self, event, limit=None):
        """Formats paragraph to a max width specified in idleConf.

If text is selected, format_paragraph_event will start breaking lines
        at the max width, starting from the beginning selection.

If no text is selected, format_paragraph_event uses the current
        cursor location to determine the paragraph (lines of text surrounded
        by blank lines) and formats it.

The length limit parameter is for testing with a known value.
        """
        if limit is None:
            # The default length limit is that defined by pep8
            limit = idleConf.GetOption(
                'extensions', 'FormatParagraph', 'max-width',
                type='int', default=72)
        text = self.editwin.text
        first, last = self.editwin.get_selection_indices()
        if first and last:
            data = text.get(first, last)
            comment_header = get_comment_header(data)
        else:
            first, last, comment_header, data = \
                    find_paragraph(text, text.index("insert"))
        if comment_header:
            newdata = reformat_comment(data, limit, comment_header)
        else:
            newdata = reformat_paragraph(data, limit)
        text.tag_remove("sel", "1.0", "end")

if newdata != data:
            text.mark_set("insert", first)
            text.undo_block_start()
            text.delete(first, last)
            text.insert(first, newdata)
            text.undo_block_stop()
        else:
            text.mark_set("insert", last)
        text.see("insert")
        return "break"

def find_paragraph(text, mark):
    """Returns the start/stop indices enclosing the paragraph that mark is in.

Also returns the comment format string, if any, and paragraph of text
    between the start/stop indices.
    """
    lineno, col = map(int, mark.split("."))
    line = text.get("%d.0" % lineno, "%d.end" % lineno)

# Look for start of next paragraph if the index passed in is a blank line
    while text.compare("%d.0" % lineno, "<", "end") and is_all_white(line):
        lineno = lineno + 1
        line = text.get("%d.0" % lineno, "%d.end" % lineno)
    first_lineno = lineno
    comment_header = get_comment_header(line)
    comment_header_len = len(comment_header)

# Once start line found, search for end of paragraph (a blank line)
    while get_comment_header(line)==comment_header and \
              not is_all_white(line[comment_header_len:]):
        lineno = lineno + 1
        line = text.get("%d.0" % lineno, "%d.end" % lineno)
    last = "%d.0" % lineno

# Search back to beginning of paragraph (first blank line before)
    lineno = first_lineno - 1
    line = text.get("%d.0" % lineno, "%d.end" % lineno)
    while lineno > 0 and \
              get_comment_header(line)==comment_header and \
              not is_all_white(line[comment_header_len:]):
        lineno = lineno - 1
        line = text.get("%d.0" % lineno, "%d.end" % lineno)
    first = "%d.0" % (lineno+1)

return first, last, comment_header, text.get(first, last)

# This should perhaps be replaced with textwrap.wrap
def reformat_paragraph(data, limit):
    """Return data reformatted to specified width (limit)."""
    lines = data.split("\n")
    i = 0
    n = len(lines)
    while i < n and is_all_white(lines[i]):
        i = i+1
    if i >= n:
        return data
    indent1 = get_indent(lines[i])
    if i+1 < n and not is_all_white(lines[i+1]):
        indent2 = get_indent(lines[i+1])
    else:
        indent2 = indent1
    new = lines[:i]
    partial = indent1
    while i < n and not is_all_white(lines[i]):
        # XXX Should take double space after period (etc.) into account
        words = re.split("(\s+)", lines[i])
        for j in range(0, len(words), 2):
            word = words[j]
            if not word:
                continue # Can happen when line ends in whitespace
            if len((partial + word).expandtabs()) > limit and \
                   partial != indent1:
                new.append(partial.rstrip())
                partial = indent2
            partial = partial + word + " "
            if j+1 < len(words) and words[j+1] != " ":
                partial = partial + " "
        i = i+1
    new.append(partial.rstrip())
    # XXX Should reformat remaining paragraphs as well
    new.extend(lines[i:])
    return "\n".join(new)

def reformat_comment(data, limit, comment_header):
    """Return data reformatted to specified width with comment header."""

# Remove header from the comment lines
    lc = len(comment_header)
    data = "\n".join(line[lc:] for line in data.split("\n"))
    # Reformat to maxformatwidth chars or a 20 char width,
    # whichever is greater.
    format_width = max(limit - len(comment_header), 20)
    newdata = reformat_paragraph(data, format_width)
    # re-split and re-insert the comment header.
    newdata = newdata.split("\n")
    # If the block ends in a \n, we dont want the comment prefix
    # inserted after it. (Im not sure it makes sense to reformat a
    # comment block that is not made of complete lines, but whatever!)
    # Can't think of a clean solution, so we hack away
    block_suffix = ""
    if not newdata[-1]:
        block_suffix = "\n"
        newdata = newdata[:-1]
    return '\n'.join(comment_header+line for line in newdata) + block_suffix

def is_all_white(line):
    """Return True if line is empty or all whitespace."""

return re.match(r"^\s*$", line) is not None

def get_indent(line):
    """Return the initial space or tab indent of line."""
    return re.match(r"^([ \t]*)", line).group()

def get_comment_header(line):
    """Return string with leading whitespace and '#' from line or ''.

A null return indicates that the line is not a comment line. A non-
    null return, such as '    #', will be used to find the other lines of
    a comment block with the same  indent.
    """
    m = re.match(r"^([ \t]*#*)", line)
    if m is None: return ""
    return m.group(1)

if __name__ == "__main__":
    import unittest
    unittest.main('idlelib.idle_test.test_formatparagraph',
            verbosity=2, exit=False)

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Directory Contents

Dirs: 3 × Files: 75

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
Icons DIR	-	drwxr-xr-x	2024-08-13 07:01:37	Edit Download recursive recursive
idle_test DIR	-	drwxr-xr-x	2024-08-13 07:01:37	Edit Download recursive recursive
__pycache__ DIR	-	drwxr-xr-x	2024-08-13 07:01:37	Edit Download recursive recursive
aboutDialog.py	6.82 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
AutoComplete.py	8.99 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
AutoCompleteWindow.py	17.32 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
AutoExpand.py	3.32 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
Bindings.py	3.04 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
CallTips.py	5.79 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
CallTipWindow.py	5.89 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
ChangeLog	55.07 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
ClassBrowser.py	6.83 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
CodeContext.py	8.16 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
ColorDelegator.py	10.35 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
config-extensions.def	2.90 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
config-highlight.def	2.46 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
config-keys.def	7.59 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
config-main.def	2.50 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
configDialog.py	63.54 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
configHandler.py	31.69 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
configHelpSourceEdit.py	6.66 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
configSectionNameDialog.py	3.91 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
CREDITS.txt	1.82 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
Debugger.py	18.32 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
Delegator.py	1.02 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
dynOptionMenuWidget.py	1.94 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
EditorWindow.py	64.06 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
extend.txt	3.56 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
FileList.py	3.72 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
FormatParagraph.py	7.12 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
GrepDialog.py	5.00 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
help.html	42.39 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
help.py	10.70 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
help.txt	17.48 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
HISTORY.txt	10.07 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
HyperParser.py	12.58 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
idle.py	453 B	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
idle.pyw	570 B	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
IdleHistory.py	3.96 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
idlever.py	415 B	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
IOBinding.py	20.12 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
keybindingDialog.py	12.13 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
macosxSupport.py	8.48 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
MultiCall.py	18.14 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
MultiStatusBar.py	1.32 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
NEWS.txt	15.17 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
NEWS2x.txt	26.54 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
ObjectBrowser.py	3.88 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
OutputWindow.py	4.29 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
ParenMatch.py	6.56 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
PathBrowser.py	3.13 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
Percolator.py	3.10 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
PyParse.py	19.98 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
PyShell.py	57.47 KB	lrwxr-xr-x	2024-05-31 13:51:41	Edit Download recursive recursive
README.txt	7.71 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
RemoteDebugger.py	11.73 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
RemoteObjectBrowser.py	964 B	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
ReplaceDialog.py	7.31 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
rpc.py	20.30 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
RstripExtension.py	1.03 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
run.py	13.54 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
ScriptBinding.py	7.87 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
ScrolledList.py	4.27 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
SearchDialog.py	3.05 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
SearchDialogBase.py	6.84 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
SearchEngine.py	7.31 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
StackViewer.py	4.32 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
tabbedpages.py	17.99 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
textView.py	3.34 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
TODO.txt	8.28 KB	lrw-r--r--	2019-11-01 23:02:34	Edit Download recursive recursive
ToolTip.py	3.10 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
TreeWidget.py	14.67 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
UndoDelegator.py	10.72 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
WidgetRedirector.py	6.78 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
WindowList.py	2.41 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
ZoomHeight.py	1.27 KB	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
__init__.py	335 B	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive
__main__.py	159 B	lrw-r--r--	2024-05-31 13:51:41	Edit Download recursive recursive