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
|
#! /usr/bin/env python3
# $Id: test_dependencies.py 9068 2022-06-13 12:05:08Z milde $
# Author: Lea Wiemann <LeWiemann@gmail.com>
# Copyright: This module has been placed in the public domain.
"""
Test module for the --record-dependencies option.
"""
import os.path
import unittest
import DocutilsTestSupport # must be imported before docutils
import docutils.core
import docutils.utils
import docutils.io
from docutils.parsers.rst.directives.images import PIL
# docutils.utils.DependencyList records POSIX paths,
# i.e. "/" as a path separator even on Windows (not os.path.join).
paths = {'include': 'data/include.txt', # included rst file
'raw': 'data/raw.txt', # included raw "HTML file"
'scaled-image': '../docs/user/rst/images/biohazard.png',
'figure-image': '../docs/user/rst/images/title.png',
'stylesheet': 'data/stylesheet.txt',
}
# avoid latex writer future warnings:
latex_settings_overwrites = {'legacy_column_widths': False,
'use_latex_citations': True}
class RecordDependenciesTests(unittest.TestCase):
def get_record(self, **settings):
recordfile = 'record.txt'
recorder = docutils.utils.DependencyList(recordfile)
# (Re) create the record file by running a conversion:
settings.setdefault('source_path',
os.path.join('data', 'dependencies.txt'))
settings.setdefault('settings_overrides', {})
settings['settings_overrides'].update(_disable_config=True,
record_dependencies=recorder)
docutils.core.publish_file(destination=DocutilsTestSupport.DevNull(),
**settings)
recorder.close()
# Read the record file:
record = docutils.io.FileInput(source_path=recordfile,
encoding='utf-8')
return record.read().splitlines()
def test_dependencies_xml(self):
# Note: currently, raw input files are read (and hence recorded) while
# parsing even if not used in the chosen output format.
# This should change (see parsers/rst/directives/misc.py).
keys = ['include', 'raw']
if PIL:
keys += ['figure-image']
expected = [paths[key] for key in keys]
record = sorted(self.get_record(writer_name='xml'))
# the order of the files is arbitrary
expected.sort()
self.assertEqual(record, expected)
def test_dependencies_html(self):
keys = ['include', 'raw']
if PIL:
keys += ['figure-image', 'scaled-image']
expected = [paths[key] for key in keys]
# stylesheets are tested separately in test_stylesheet_dependencies():
so = {'stylesheet_path': None, 'stylesheet': None}
record = sorted(self.get_record(writer_name='html',
settings_overrides=so))
# the order of the files is arbitrary
expected.sort()
self.assertEqual(record, expected)
def test_dependencies_latex(self):
# since 0.9, the latex writer records only really accessed files, too.
# Note: currently, raw input files are read (and hence recorded) while
# parsing even if not used in the chosen output format.
# This should change (see parsers/rst/directives/misc.py).
keys = ['include', 'raw']
if PIL:
keys += ['figure-image']
expected = [paths[key] for key in keys]
record = sorted(self.get_record(
writer_name='latex',
settings_overrides=latex_settings_overwrites))
# the order of the files is arbitrary
expected.sort()
self.assertEqual(record, expected)
def test_csv_dependencies(self):
csvsource = os.path.join('data', 'csv_dep.txt')
self.assertEqual(self.get_record(source_path=csvsource),
['data/csv_data.txt'])
def test_stylesheet_dependencies(self):
stylesheet = paths['stylesheet']
so = {'stylesheet_path': paths['stylesheet'],
'stylesheet': None}
so.update(latex_settings_overwrites)
so['embed_stylesheet'] = False
record = self.get_record(writer_name='html', settings_overrides=so)
self.assertTrue(stylesheet not in record,
'%r should not be in %r' % (stylesheet, record))
record = self.get_record(writer_name='latex', settings_overrides=so)
self.assertTrue(stylesheet not in record,
'%r should not be in %r' % (stylesheet, record))
so['embed_stylesheet'] = True
record = self.get_record(writer_name='html', settings_overrides=so)
self.assertTrue(stylesheet in record,
'%r should be in %r' % (stylesheet, record))
so['embed_stylesheet'] = True
record = self.get_record(writer_name='latex', settings_overrides=so)
self.assertTrue(stylesheet in record,
'%r should be in %r' % (stylesheet, record))
if __name__ == '__main__':
unittest.main()
|
