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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# $Id: test_settings.py 8068 2017-05-08 22:10:39Z milde $
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Tests of runtime settings.
"""
import sys
import os
import difflib
import pprint
import warnings
import unittest
import DocutilsTestSupport # must be imported before docutils
from docutils import frontend, utils
from docutils.writers import html4css1, pep_html
from docutils.parsers import rst
warnings.filterwarnings(action='ignore',
category=frontend.ConfigDeprecationWarning)
def fixpath(path):
return os.path.abspath(os.path.join(*(path.split('/'))))
class ConfigFileTests(unittest.TestCase):
config_files = {'old': fixpath('data/config_old.txt'),
'one': fixpath('data/config_1.txt'),
'two': fixpath('data/config_2.txt'),
'list': fixpath('data/config_list.txt'),
'list2': fixpath('data/config_list_2.txt'),
'error': fixpath('data/config_error_handler.txt')}
settings = {
'old': {u'datestamp': u'%Y-%m-%d %H:%M UTC',
u'generator': True,
u'no_random': True,
u'python_home': u'http://www.python.org',
u'source_link': True,
'stylesheet': None,
u'stylesheet_path': [u'stylesheets/pep.css'],
'template': fixpath(u'data/pep-html-template')},
'one': {u'datestamp': u'%Y-%m-%d %H:%M UTC',
u'generator': True,
u'no_random': True,
u'python_home': u'http://www.python.org',
u'raw_enabled': False,
'record_dependencies': utils.DependencyList(),
u'source_link': True,
'stylesheet': None,
u'stylesheet_path': [u'stylesheets/pep.css'],
u'tab_width': 8,
u'template': fixpath(u'data/pep-html-template'),
u'trim_footnote_reference_space': True,
},
'two': {u'footnote_references': u'superscript',
u'generator': False,
'record_dependencies': utils.DependencyList(),
u'stylesheet': None,
u'stylesheet_path': [u'test.css'],
'trim_footnote_reference_space': None},
'list': {u'expose_internals': [u'a', u'b', u'c', u'd', u'e'],
u'strip_classes': [u'spam', u'pan', u'fun', u'parrot'],
u'strip_elements_with_classes': [u'sugar', u'flour', u'milk',
u'safran']},
'list2': {u'expose_internals': [u'a', u'b', u'c', u'd', u'e', u'f'],
u'strip_classes': [u'spam', u'pan', u'fun', u'parrot',
u'ham', u'eggs'],
u'strip_elements_with_classes': [u'sugar', u'flour',
u'milk', u'safran',
u'eggs', u'salt']},
'error': {u'error_encoding': u'ascii',
u'error_encoding_error_handler': u'strict'},
}
compare = difflib.Differ().compare
"""Comparison method shared by all tests."""
def setUp(self):
self.option_parser = frontend.OptionParser(
components=(pep_html.Writer, rst.Parser), read_config_files=None)
def files_settings(self, *names):
settings = frontend.Values()
for name in names:
settings.update(self.option_parser.get_config_file_settings(
self.config_files[name]), self.option_parser)
return settings.__dict__
def expected_settings(self, *names):
expected = {}
for name in names:
expected.update(self.settings[name])
return expected
def compare_output(self, result, expected):
"""`result` and `expected` should both be dicts."""
self.assertTrue('record_dependencies' in result)
if 'record_dependencies' not in expected:
# Delete it if we don't want to test it.
del result['record_dependencies']
result = pprint.pformat(result) + '\n'
expected = pprint.pformat(expected) + '\n'
try:
self.assertEqual(result, expected)
except AssertionError:
print >>sys.stderr, '\n%s\n' % (self,)
print >>sys.stderr, '-: expected\n+: result'
print >>sys.stderr, ''.join(self.compare(expected.splitlines(1),
result.splitlines(1)))
raise
def test_nofiles(self):
self.compare_output(self.files_settings(),
self.expected_settings())
def test_old(self):
self.compare_output(self.files_settings('old'),
self.expected_settings('old'))
def test_one(self):
self.compare_output(self.files_settings('one'),
self.expected_settings('one'))
def test_multiple(self):
self.compare_output(self.files_settings('one', 'two'),
self.expected_settings('one', 'two'))
def test_old_and_new(self):
self.compare_output(self.files_settings('old', 'two'),
self.expected_settings('old', 'two'))
def test_list(self):
self.compare_output(self.files_settings('list'),
self.expected_settings('list'))
def test_list2(self):
self.compare_output(self.files_settings('list', 'list2'),
self.expected_settings('list2'))
def test_error_handler(self):
self.compare_output(self.files_settings('error'),
self.expected_settings('error'))
class ConfigEnvVarFileTests(ConfigFileTests):
"""
Repeats the tests of `ConfigFileTests` using the ``DOCUTILSCONFIG``
environment variable and the standard Docutils config file mechanism.
"""
def setUp(self):
ConfigFileTests.setUp(self)
self.orig_environ = os.environ
os.environ = os.environ.copy()
def files_settings(self, *names):
files = [self.config_files[name] for name in names]
os.environ['DOCUTILSCONFIG'] = os.pathsep.join(files)
settings = self.option_parser.get_standard_config_settings()
return settings.__dict__
def tearDown(self):
os.environ = self.orig_environ
class HelperFunctionsTests(unittest.TestCase):
pathdict = {'foo': 'hallo', 'ham': u'h\xE4m', 'spam': u'spam'}
keys = ['foo', 'ham']
def setUp(self):
self.option_parser = frontend.OptionParser(
components=(rst.Parser,), read_config_files=None)
def test_make_paths_absolute(self):
pathdict = self.pathdict.copy()
frontend.make_paths_absolute(pathdict, self.keys, base_path='base')
self.assertEqual(pathdict['foo'], os.path.abspath('base/hallo'))
self.assertEqual(pathdict['ham'], os.path.abspath(u'base/h\xE4m'))
# not touched, because key not in keys:
self.assertEqual(pathdict['spam'], u'spam')
def test_make_paths_absolute_cwd(self):
# With base_path None, the cwd is used as base path.
# Settings values may-be `unicode` instances, therefore
# os.getcwdu() is used and the converted path is a unicode instance:
pathdict = self.pathdict.copy()
frontend.make_paths_absolute(pathdict, self.keys)
self.assertEqual(pathdict['foo'], os.path.abspath(u'hallo'))
self.assertEqual(pathdict['ham'], os.path.abspath(u'h\xE4m'))
# not touched, because key not in keys:
self.assertEqual(pathdict['spam'], u'spam')
boolean_settings = (
(True, True ),
('1', True ),
(u'on', True ),
('yes', True ),
(u'true', True ),
(u'0', False ),
('off', False ),
(u'no', False ),
('false', False ),
)
def test_validate_boolean(self):
for t in self.boolean_settings:
self.assertEqual(
frontend.validate_boolean(None, t[0], self.option_parser),
t[1])
def test_validate_ternary(self):
tests = (
('500V', '500V'),
(u'parrot', u'parrot'),
)
for t in self.boolean_settings + tests:
self.assertEqual(
frontend.validate_ternary(None, t[0], self.option_parser),
t[1])
def test_validate_colon_separated_string_list(self):
tests = (
(u'a', ['a',] ),
('a', ['a',] ),
(u'a:b', ['a', 'b'] ),
('a:b', ['a', 'b'] ),
([u'a',], ['a',] ),
([u'a', u'b:c'], ['a', 'b', 'c'] ),
)
for t in tests:
self.assertEqual(
frontend.validate_colon_separated_string_list(None, t[0], None),
t[1])
def test_validate_comma_separated_list(self):
tests = (
(u'a', ['a',] ),
('a', ['a',] ),
(u'a,b', ['a', 'b'] ),
('a,b', ['a', 'b'] ),
([u'a',], ['a',] ),
([u'a', u'b,c'], ['a', 'b', 'c'] ),
(['a', 'b,c'], ['a', 'b', 'c'] ),
)
for t in tests:
self.assertEqual(
frontend.validate_comma_separated_list(None, t[0], None),
t[1])
def test_validate_url_trailing_slash(self):
tests = (
('', './' ),
(None, './' ),
(u'http://example.org', u'http://example.org/' ),
('http://example.org/', 'http://example.org/' ),
)
for t in tests:
self.assertEqual(
frontend.validate_url_trailing_slash(None, t[0], None),
t[1])
def test_validate_smartquotes_locales(self):
tests = (
('en:ssvv', [('en', 'ssvv')]),
(u'sd:«»°°', [(u'sd', u'«»°°')]),
([('sd', u'«»°°'), u'ds:°°«»'], [('sd', u'«»°°'),
('ds', u'°°«»')]),
(u'frs:« : »:((:))', [(u'frs', [u'« ', u' »',
u'((', u'))'])]),
)
for t in tests:
self.assertEqual(
frontend.validate_smartquotes_locales(None, t[0], None),
t[1])
if __name__ == '__main__':
unittest.main()
|
