annotate Lib/idlelib/FormatParagraph.py @ 80661:94de77bd0b4b 2.7

Issue #16194: document imp.load_dynamic problems when read several extension modules from the same binary object file.
author Andrew Svetlov <andrew.svetlov@gmail.com>
date Thu, 29 Nov 2012 19:51:28 +0200
parents cd8d3c2d3bce
children 133f87a7dbf5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
1 # Extension to format a paragraph
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
2
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
3 # Does basic, standard text formatting, and also understands Python
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
4 # comment blocks. Thus, for editing Python source code, this
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
5 # extension is really only suitable for reformatting these comment
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
6 # blocks or triple-quoted strings.
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
7
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
8 # Known problems with comment reformatting:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
9 # * If there is a selection marked, and the first line of the
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
10 # selection is not complete, the block will probably not be detected
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
11 # as comments, and will have the normal "text formatting" rules
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
12 # applied.
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
13 # * If a comment block has leading whitespace that mixes tabs and
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
14 # spaces, they will not be considered part of the same block.
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
15 # * Fancy comments, like this bulleted list, arent handled :-)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
16
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
17 import re
60144
eab361617f6a #7092: Fix additional "-3" warnings in the idlelib package, and convert to absolute imports.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 45327
diff changeset
18 from idlelib.configHandler import idleConf
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
19
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
20 class FormatParagraph:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
21
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
22 menudefs = [
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
23 ('format', [ # /s/edit/format dscherer@cmu.edu
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
24 ('Format Paragraph', '<<format-paragraph>>'),
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
25 ])
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
26 ]
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
27
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
28 def __init__(self, editwin):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
29 self.editwin = editwin
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
30
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
31 def close(self):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
32 self.editwin = None
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
33
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
34 def format_paragraph_event(self, event):
32241
b9345c355f04 SF patch #961387: Make IDLE's paragraph reformatting width configurable
Raymond Hettinger <python@rcn.com>
parents: 25287
diff changeset
35 maxformatwidth = int(idleConf.GetOption('main','FormatParagraph','paragraph'))
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
36 text = self.editwin.text
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
37 first, last = self.editwin.get_selection_indices()
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
38 if first and last:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
39 data = text.get(first, last)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
40 comment_header = ''
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
41 else:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
42 first, last, comment_header, data = \
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
43 find_paragraph(text, text.index("insert"))
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
44 if comment_header:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
45 # Reformat the comment lines - convert to text sans header.
25287
c45564768f52 Merge Py Idle changes:
Kurt B. Kaiser <kbk@shore.net>
parents: 21765
diff changeset
46 lines = data.split("\n")
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
47 lines = map(lambda st, l=len(comment_header): st[l:], lines)
25287
c45564768f52 Merge Py Idle changes:
Kurt B. Kaiser <kbk@shore.net>
parents: 21765
diff changeset
48 data = "\n".join(lines)
32241
b9345c355f04 SF patch #961387: Make IDLE's paragraph reformatting width configurable
Raymond Hettinger <python@rcn.com>
parents: 25287
diff changeset
49 # Reformat to maxformatwidth chars or a 20 char width, whichever is greater.
33824
29b945bc0a17 format_paragraph_event(): Patch 961387 introduced a bug here, causing
Tim Peters <tim.peters@gmail.com>
parents: 32241
diff changeset
50 format_width = max(maxformatwidth - len(comment_header), 20)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
51 newdata = reformat_paragraph(data, format_width)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
52 # re-split and re-insert the comment header.
25287
c45564768f52 Merge Py Idle changes:
Kurt B. Kaiser <kbk@shore.net>
parents: 21765
diff changeset
53 newdata = newdata.split("\n")
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
54 # If the block ends in a \n, we dont want the comment
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
55 # prefix inserted after it. (Im not sure it makes sense to
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
56 # reformat a comment block that isnt made of complete
68588
cd8d3c2d3bce #11565: Fix several typos. Patch by Piotr Kasprzyk.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 60144
diff changeset
57 # lines, but whatever!) Can't think of a clean solution,
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
58 # so we hack away
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
59 block_suffix = ""
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
60 if not newdata[-1]:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
61 block_suffix = "\n"
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
62 newdata = newdata[:-1]
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
63 builder = lambda item, prefix=comment_header: prefix+item
25287
c45564768f52 Merge Py Idle changes:
Kurt B. Kaiser <kbk@shore.net>
parents: 21765
diff changeset
64 newdata = '\n'.join(map(builder, newdata)) + block_suffix
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
65 else:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
66 # Just a normal text format
32241
b9345c355f04 SF patch #961387: Make IDLE's paragraph reformatting width configurable
Raymond Hettinger <python@rcn.com>
parents: 25287
diff changeset
67 newdata = reformat_paragraph(data, maxformatwidth)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
68 text.tag_remove("sel", "1.0", "end")
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
69 if newdata != data:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
70 text.mark_set("insert", first)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
71 text.undo_block_start()
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
72 text.delete(first, last)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
73 text.insert(first, newdata)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
74 text.undo_block_stop()
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
75 else:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
76 text.mark_set("insert", last)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
77 text.see("insert")
45327
083bf6e0ae50 format_paragraph_event wasn't returning 'break'
Kurt B. Kaiser <kbk@shore.net>
parents: 33824
diff changeset
78 return "break"
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
79
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
80 def find_paragraph(text, mark):
25287
c45564768f52 Merge Py Idle changes:
Kurt B. Kaiser <kbk@shore.net>
parents: 21765
diff changeset
81 lineno, col = map(int, mark.split("."))
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
82 line = text.get("%d.0" % lineno, "%d.0 lineend" % lineno)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
83 while text.compare("%d.0" % lineno, "<", "end") and is_all_white(line):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
84 lineno = lineno + 1
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
85 line = text.get("%d.0" % lineno, "%d.0 lineend" % lineno)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
86 first_lineno = lineno
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
87 comment_header = get_comment_header(line)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
88 comment_header_len = len(comment_header)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
89 while get_comment_header(line)==comment_header and \
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
90 not is_all_white(line[comment_header_len:]):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
91 lineno = lineno + 1
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
92 line = text.get("%d.0" % lineno, "%d.0 lineend" % lineno)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
93 last = "%d.0" % lineno
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
94 # Search back to beginning of paragraph
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
95 lineno = first_lineno - 1
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
96 line = text.get("%d.0" % lineno, "%d.0 lineend" % lineno)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
97 while lineno > 0 and \
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
98 get_comment_header(line)==comment_header and \
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
99 not is_all_white(line[comment_header_len:]):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
100 lineno = lineno - 1
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
101 line = text.get("%d.0" % lineno, "%d.0 lineend" % lineno)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
102 first = "%d.0" % (lineno+1)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
103 return first, last, comment_header, text.get(first, last)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
104
32241
b9345c355f04 SF patch #961387: Make IDLE's paragraph reformatting width configurable
Raymond Hettinger <python@rcn.com>
parents: 25287
diff changeset
105 def reformat_paragraph(data, limit):
25287
c45564768f52 Merge Py Idle changes:
Kurt B. Kaiser <kbk@shore.net>
parents: 21765
diff changeset
106 lines = data.split("\n")
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
107 i = 0
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
108 n = len(lines)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
109 while i < n and is_all_white(lines[i]):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
110 i = i+1
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
111 if i >= n:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
112 return data
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
113 indent1 = get_indent(lines[i])
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
114 if i+1 < n and not is_all_white(lines[i+1]):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
115 indent2 = get_indent(lines[i+1])
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
116 else:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
117 indent2 = indent1
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
118 new = lines[:i]
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
119 partial = indent1
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
120 while i < n and not is_all_white(lines[i]):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
121 # XXX Should take double space after period (etc.) into account
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
122 words = re.split("(\s+)", lines[i])
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
123 for j in range(0, len(words), 2):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
124 word = words[j]
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
125 if not word:
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
126 continue # Can happen when line ends in whitespace
25287
c45564768f52 Merge Py Idle changes:
Kurt B. Kaiser <kbk@shore.net>
parents: 21765
diff changeset
127 if len((partial + word).expandtabs()) > limit and \
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
128 partial != indent1:
25287
c45564768f52 Merge Py Idle changes:
Kurt B. Kaiser <kbk@shore.net>
parents: 21765
diff changeset
129 new.append(partial.rstrip())
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
130 partial = indent2
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
131 partial = partial + word + " "
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
132 if j+1 < len(words) and words[j+1] != " ":
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
133 partial = partial + " "
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
134 i = i+1
25287
c45564768f52 Merge Py Idle changes:
Kurt B. Kaiser <kbk@shore.net>
parents: 21765
diff changeset
135 new.append(partial.rstrip())
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
136 # XXX Should reformat remaining paragraphs as well
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
137 new.extend(lines[i:])
25287
c45564768f52 Merge Py Idle changes:
Kurt B. Kaiser <kbk@shore.net>
parents: 21765
diff changeset
138 return "\n".join(new)
13975
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
139
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
140 def is_all_white(line):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
141 return re.match(r"^\s*$", line) is not None
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
142
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
143 def get_indent(line):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
144 return re.match(r"^(\s*)", line).group()
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
145
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
146 def get_comment_header(line):
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
147 m = re.match(r"^(\s*#*)", line)
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
148 if m is None: return ""
30713d5288df Initial revision
David Scherer <dscherer@cmu.edu>
parents:
diff changeset
149 return m.group(1)