[Checkins] SVN: manuel/trunk/src/manuel/ rename poorly named function
Benji York
benji at zope.com
Wed Jun 24 08:00:29 EDT 2009
Log message for revision 101259:
rename poorly named function
Changed:
U manuel/trunk/src/manuel/README.txt
U manuel/trunk/src/manuel/__init__.py
U manuel/trunk/src/manuel/capture.py
U manuel/trunk/src/manuel/codeblock.py
U manuel/trunk/src/manuel/doctest.py
U manuel/trunk/src/manuel/footnote.py
U manuel/trunk/src/manuel/ignore.py
U manuel/trunk/src/manuel/isolation.py
U manuel/trunk/src/manuel/table-example.txt
-=-
Modified: manuel/trunk/src/manuel/README.txt
===================================================================
--- manuel/trunk/src/manuel/README.txt 2009-06-24 11:49:23 UTC (rev 101258)
+++ manuel/trunk/src/manuel/README.txt 2009-06-24 12:00:29 UTC (rev 101259)
@@ -112,7 +112,8 @@
... numbers = map(
... int, region.start_match.group('numbers').split(','))
... test = NumbersTest(description, numbers)
- ... document.replace_region(region, test)
+ ... document.claim_region(region)
+ ... region.parsed = test
>>> parse(document)
>>> [region.source for region in document]
Modified: manuel/trunk/src/manuel/__init__.py
===================================================================
--- manuel/trunk/src/manuel/__init__.py 2009-06-24 11:49:23 UTC (rev 101258)
+++ manuel/trunk/src/manuel/__init__.py 2009-06-24 12:00:29 UTC (rev 101259)
@@ -86,7 +86,7 @@
return lines
-def break_up_region(original, new, parsed):
+def break_up_region(original, new):
assert original.parsed is None
lines = make_string_into_lines(original.source)
@@ -99,7 +99,6 @@
Region(original.lineno, lines_to_string(before_lines)))
# put in the parsed
- new.parsed = parsed
new_regions.append(new)
# figure out if there are any lines after the given region
@@ -202,25 +201,21 @@
'not equal the input')
return region1, region2
- # XXX this method needs a better name
- def replace_region(self, to_be_replaced, parsed):
- if parsed is None:
- raise RuntimeError('None is not a valid value for "parsed"')
+ def claim_region(self, to_be_replaced):
new_regions = []
old_regions = list(self.regions)
while old_regions:
region = old_regions.pop(0)
if region.lineno == to_be_replaced.lineno:
assert not region.parsed
- new_regions.extend(break_up_region(
- region, to_be_replaced, parsed))
+ new_regions.extend(break_up_region(region, to_be_replaced))
break
elif region.lineno > to_be_replaced.lineno: # we "overshot"
assert not new_regions[-1].parsed
to_be_broken = new_regions[-1]
del new_regions[-1]
new_regions.extend(break_up_region(
- to_be_broken, to_be_replaced, parsed))
+ to_be_broken, to_be_replaced))
new_regions.append(region)
break
@@ -230,8 +225,7 @@
# the very last region, which also must not have been parsed yet
assert not region.parsed
del new_regions[-1]
- new_regions.extend(break_up_region(
- region, to_be_replaced, parsed))
+ new_regions.extend(break_up_region(region, to_be_replaced))
new_regions.extend(old_regions)
self.regions = new_regions
@@ -243,7 +237,7 @@
if new_region in self.shadow_regions:
raise ValueError(
'Regions returned by "find_regions" can not be directly '
- 'inserted into a document. Use "replace_region" instead.')
+ 'inserted into a document. Use "claim_region" instead.')
for index, region in enumerate(self.regions):
if region is marker_region:
Modified: manuel/trunk/src/manuel/capture.py
===================================================================
--- manuel/trunk/src/manuel/capture.py 2009-06-24 11:49:23 UTC (rev 101258)
+++ manuel/trunk/src/manuel/capture.py 2009-06-24 12:00:29 UTC (rev 101259)
@@ -51,7 +51,8 @@
name = region.start_match.group('name')
block = textwrap.dedent(final_region.source)
- document.replace_region(region, Capture(name, block))
+ document.claim_region(region)
+ region.parsed = Capture(name, block)
def store_capture(region, document, globs):
Modified: manuel/trunk/src/manuel/codeblock.py
===================================================================
--- manuel/trunk/src/manuel/codeblock.py 2009-06-24 11:49:23 UTC (rev 101258)
+++ manuel/trunk/src/manuel/codeblock.py 2009-06-24 12:00:29 UTC (rev 101259)
@@ -16,7 +16,8 @@
source = textwrap.dedent('\n'.join(region.source.splitlines()[1:]))
source_location = '%s:%d' % (document.location, region.lineno)
code = compile(source, source_location, 'exec', 0, True)
- document.replace_region(region, CodeBlock(code))
+ document.claim_region(region)
+ region.parsed = CodeBlock(code)
def execute_code_block(region, document, globs):
Modified: manuel/trunk/src/manuel/doctest.py
===================================================================
--- manuel/trunk/src/manuel/doctest.py 2009-06-24 11:49:23 UTC (rev 101258)
+++ manuel/trunk/src/manuel/doctest.py 2009-06-24 12:00:29 UTC (rev 101259)
@@ -33,7 +33,8 @@
else:
found = region
- document.replace_region(found, chunk)
+ document.claim_region(found)
+ found.parsed = chunk
assert region in document
Modified: manuel/trunk/src/manuel/footnote.py
===================================================================
--- manuel/trunk/src/manuel/footnote.py 2009-06-24 11:49:23 UTC (rev 101258)
+++ manuel/trunk/src/manuel/footnote.py 2009-06-24 12:00:29 UTC (rev 101259)
@@ -24,7 +24,8 @@
footnote_names = []
for region in document.find_regions(FOOTNOTE_DEFINITION_RE):
name = region.start_match.group(1)
- document.replace_region(region, FootnoteDefinition(name))
+ document.claim_region(region)
+ region.parsed = FootnoteDefinition(name)
footnote_names.append(name)
# find the markers that show where footnotes have been referenced.
@@ -36,7 +37,8 @@
raise RuntimeError('Unknown footnote: %r' % name)
assert names
- document.replace_region(region, FootnoteReference(names))
+ document.claim_region(region)
+ region.parsed = FootnoteReference(names)
@manuel.timing(manuel.LATE)
Modified: manuel/trunk/src/manuel/ignore.py
===================================================================
--- manuel/trunk/src/manuel/ignore.py 2009-06-24 11:49:23 UTC (rev 101258)
+++ manuel/trunk/src/manuel/ignore.py 2009-06-24 12:00:29 UTC (rev 101259)
@@ -9,7 +9,8 @@
def find_ignores(document):
for region in document.find_regions(IGNORE_START, IGNORE_END):
- document.replace_region(region, object())
+ document.claim_region(region)
+ region.parsed = object()
document.remove_region(region)
Modified: manuel/trunk/src/manuel/isolation.py
===================================================================
--- manuel/trunk/src/manuel/isolation.py 2009-06-24 11:49:23 UTC (rev 101258)
+++ manuel/trunk/src/manuel/isolation.py 2009-06-24 12:00:29 UTC (rev 101259)
@@ -13,7 +13,8 @@
def find_reset(document):
for region in document.find_regions(RESET):
- document.replace_region(region, Reset())
+ document.claim_region(region)
+ region.parsed = Reset()
def execute_reset(region, document, globs):
@@ -33,7 +34,8 @@
baseline.clear()
for region in document.find_regions(CAPTURE):
- document.replace_region(region, Capture())
+ document.claim_region(region)
+ region.parsed = Capture()
def execute_baseline(region, document, globs):
Modified: manuel/trunk/src/manuel/table-example.txt
===================================================================
--- manuel/trunk/src/manuel/table-example.txt 2009-06-24 11:49:23 UTC (rev 101258)
+++ manuel/trunk/src/manuel/table-example.txt 2009-06-24 12:00:29 UTC (rev 101259)
@@ -136,7 +136,8 @@
examples.append((inputs, output, lineno_offset))
table = Table(expression, variables, examples)
- document.replace_region(region, table)
+ document.claim_region(region)
+ region.parsed = table
If we parse the Docuement we can see that the table was recognized.
More information about the Checkins
mailing list