1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
from __future__ import with_statement
import sys
from nose.plugins.skip import SkipTest
from paver.deps.six import print_
from paver.easy import *
from paver import doctools, tasks, options
def _no25():
if sys.version_info[:2] == (2, 5):
raise SkipTest('No cog integration in Python 2.5')
def test_sections_from_file():
simpletext = """# [[[section foo]]]
#Foo!
# [[[endsection]]]
"""
f = doctools.SectionedFile(from_string=simpletext)
assert len(f) == 1, "Sections found: %s" % f
assert f['foo'] == "#Foo!\n", "Foo section contained: '%s'" % f['foo']
def display(msg, *args):
print_(msg % args)
doctools.debug = display
def test_nested_sections():
myfile = """
[[[section bar]]]
Hi there.
[[[section baz]]]
Yo.
[[[endsection]]]
[[[endsection]]]
"""
f = doctools.SectionedFile(from_string=myfile)
assert len(f) == 2
assert f['bar'] == """ Hi there.
Yo.
""", "Bar was: '%s'" % (f['bar'])
assert f['bar.baz'] == """ Yo.
"""
def test_section_doesnt_end():
myfile = """
[[[section bar]]]
Yo.
"""
try:
f = doctools.SectionedFile(from_string=myfile)
assert False, "Expected a BuildFailure"
except BuildFailure:
e = sys.exc_info()[1]
assert str(e) == """No end marker for section 'bar'
(in file 'None', starts at line 2)""", "error was: %s" % (str(e))
def test_section_already_defined():
myfile = """
[[[section foo]]]
First one.
[[[endsection]]]
[[[section foo]]]
Second one.
[[[endsection]]]
"""
try:
f = doctools.SectionedFile(from_string=myfile)
assert False, "Expected a BuildFailure"
except BuildFailure:
e = sys.exc_info()[1]
assert str(e) == """section 'foo' redefined
(in file 'None', first section at line 2, second at line 6)""", \
"error was: %s" % (str(e))
def test_endmarker_without_start():
myfile = """
[[[section foo]]]
This is a good section.
[[[endsection]]]
[[[endsection]]]
"""
try:
f = doctools.SectionedFile(from_string=myfile)
assert False, "Expected a BuildFailure"
except BuildFailure:
e = sys.exc_info()[1]
assert str(e) == """End section marker with no starting marker
(in file 'None', at line 6)""", \
"error was: %s" % (str(e))
def test_whole_file():
myfile = """
[[[section bar]]]
Hi there.
[[[section baz]]]
Yo.
[[[endsection]]]
[[[endsection]]]
"""
f = doctools.SectionedFile(from_string=myfile)
assert f.all == """
Hi there.
Yo.
""", "All was: %s" % (f.all)
def test_bad_section():
f = doctools.SectionedFile(from_string="")
try:
f['foo']
assert False, "Should have a BuildFailure"
except BuildFailure:
e = sys.exc_info()[1]
assert str(e) == "No section 'foo' in file 'None'", \
"Error: '%s'" % (str(e))
def test_include_lookup():
basedir = path(__file__).dirname() / "data"
include = doctools.Includer(basedir, include_markers={})
everything = include("t1.py")
assert everything == """# file 't1.py'
print "Hi!"
print "More"
""", "Everything was: '%s'" % (everything)
first = include("t1.py", "first")
assert first == """# section 'first' in file 't1.py'
print "Hi!"
""", "First was '%s'" % (first)
second = include("t2.py", "second.inner")
assert second == """# section 'second.inner' in file 't2.py'
print sys.path
""", "Second was '%s'" % (second)
def test_cogging():
if not paver.doctools.has_cog:
raise SkipTest("Cog must be installed for this test")
_no25()
env = tasks.Environment(doctools)
tasks.environment = env
opt = env.options
opt.cog = options.Bunch()
basedir = path(__file__).dirname()
opt.cog.basedir = basedir
opt.cog.pattern = "*.rst"
opt.cog.includedir = basedir / "data"
env.options = opt
doctools.cog()
textfile = basedir / "data/textfile.rst"
with open(textfile) as f:
data = f.read()
print_(data)
assert "print sys.path" in data
doctools.uncog()
with open(textfile) as f:
data = f.read()
assert "print sys.path" not in data
def test_cogging_with_markers_removed():
if not paver.doctools.has_cog:
raise SkipTest("Cog must be installed for this test")
_no25()
env = tasks.Environment(doctools)
tasks.environment = env
opt = env.options
opt.cog = Bunch()
basedir = path(__file__).dirname()
opt.cog.basedir = basedir
opt.cog.pattern = "*.rst"
opt.cog.includedir = basedir / "data"
opt.cog.delete_code = True
env.options = opt
textfile = basedir / "data/textfile.rst"
with open(textfile) as f:
original_data = f.read()
try:
doctools.cog()
with open(textfile) as f:
data = f.read()
print_(data)
assert "[[[cog" not in data
finally:
with open(textfile, "w") as f:
f.write(original_data)
|
