/usr/lib/python2.7/dist-packages/sphinx_gallery/tests/test_gen_rst.py is in python-sphinx-gallery 0.1.13-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 | # -*- coding: utf-8 -*-
# Author: Óscar Nájera
# License: 3-clause BSD
"""
Testing the rst files generator
"""
from __future__ import (division, absolute_import, print_function,
unicode_literals)
import ast
import codecs
import copy
import tempfile
import re
import os
import shutil
import zipfile
import pytest
import sphinx_gallery.gen_rst as sg
from sphinx_gallery import gen_gallery, downloads
from sphinx_gallery.gen_gallery import generate_dir_rst
from sphinx_gallery.utils import _TempDir
# Need to import gen_rst before matplotlib.pyplot to set backend to 'Agg'
import matplotlib.pyplot as plt
CONTENT = [
'"""',
'================',
'Docstring header',
'================',
'',
'This is the description of the example',
'which goes on and on, Óscar',
'',
'',
'And this is a second paragraph',
'"""',
'',
'# and now comes the module code',
'import logging',
'import sys',
'x, y = 1, 2',
'print(u"Óscar output") # need some code output',
'logger = logging.getLogger()',
'logger.setLevel(logging.INFO)',
'lh = logging.StreamHandler(sys.stdout)',
'lh.setFormatter(logging.Formatter("log:%(message)s"))',
'logger.addHandler(lh)',
'logger.info(u"Óscar")',
'print(r"$\\langle n_\\uparrow n_\\downarrow \\rangle$")',
]
def test_split_code_and_text_blocks():
"""Test if a known example file gets properly split"""
file_conf, blocks = sg.split_code_and_text_blocks(
'examples/no_output/just_code.py')
assert file_conf == {}
assert blocks[0][0] == 'text'
assert blocks[1][0] == 'code'
def test_bug_cases_of_notebook_syntax():
"""Test over the known requirements of supported syntax in the
notebook styled comments"""
with open('sphinx_gallery/tests/reference_parse.txt') as reference:
ref_blocks = ast.literal_eval(reference.read())
file_conf, blocks = sg.split_code_and_text_blocks(
'tutorials/plot_parse.py')
assert file_conf == {}
assert blocks == ref_blocks
def test_direct_comment_after_docstring():
# For more details see
# https://github.com/sphinx-gallery/sphinx-gallery/pull/49
with tempfile.NamedTemporaryFile('w', delete=False) as f:
f.write('\n'.join(['"Docstring"',
'# and now comes the module code',
'# with a second line of comment',
'x, y = 1, 2',
'']))
try:
file_conf, result = sg.split_code_and_text_blocks(f.name)
finally:
os.remove(f.name)
assert file_conf == {}
expected_result = [
('text', 'Docstring', 1),
('code', '\n'.join(['# and now comes the module code',
'# with a second line of comment',
'x, y = 1, 2',
'']), 2)]
assert result == expected_result
def test_codestr2rst():
"""Test the correct translation of a code block into rst"""
output = sg.codestr2rst('print("hello world")')
reference = """
.. code-block:: python
print("hello world")"""
assert reference == output
def test_extract_intro_and_title():
intro, title = sg.extract_intro_and_title('<string>',
'\n'.join(CONTENT[1:10]))
assert title == 'Docstring header'
assert 'Docstring' not in intro
assert intro == 'This is the description of the example which goes on and on, Óscar' # noqa
assert 'second paragraph' not in intro
def test_md5sums():
"""Test md5sum check functions work on know file content"""
with tempfile.NamedTemporaryFile('wb', delete=False) as f:
f.write(b'Local test\n')
try:
file_md5 = sg.get_md5sum(f.name)
# verify correct md5sum
assert 'ea8a570e9f3afc0a7c3f2a17a48b8047' == file_md5
# False because is a new file
assert not sg.md5sum_is_current(f.name)
# Write md5sum to file to check is current
with open(f.name + '.md5', 'w') as file_checksum:
file_checksum.write(file_md5)
try:
assert sg.md5sum_is_current(f.name)
finally:
os.remove(f.name + '.md5')
finally:
os.remove(f.name)
@pytest.fixture
def gallery_conf():
"""Sets up a test sphinx-gallery configuration"""
gallery_conf = copy.deepcopy(gen_gallery.DEFAULT_GALLERY_CONF)
gallery_conf.update(examples_dir=_TempDir(), gallery_dir=_TempDir())
gallery_conf['src_dir'] = gallery_conf['gallery_dir']
return gallery_conf
def test_fail_example(gallery_conf, log_collector):
"""Test that failing examples are only executed until failing block"""
gallery_conf.update(filename_pattern='raise.py')
failing_code = CONTENT + ['#' * 79,
'First_test_fail', '#' * 79, 'second_fail']
with codecs.open(os.path.join(gallery_conf['examples_dir'], 'raise.py'),
mode='w', encoding='utf-8') as f:
f.write('\n'.join(failing_code))
sg.generate_file_rst('raise.py', gallery_conf['gallery_dir'],
gallery_conf['examples_dir'], gallery_conf)
assert len(log_collector.calls['warning']) == 1
assert 'not defined' in log_collector.calls['warning'][0].args[2]
# read rst file and check if it contains traceback output
with codecs.open(os.path.join(gallery_conf['gallery_dir'], 'raise.rst'),
mode='r', encoding='utf-8') as f:
ex_failing_blocks = f.read().count('pytb')
if ex_failing_blocks == 0:
raise ValueError('Did not run into errors in bad code')
elif ex_failing_blocks > 1:
raise ValueError('Did not stop executing script after error')
def test_gen_dir_rst(gallery_conf, fakesphinxapp):
"""Test gen_dir_rst."""
print(os.listdir(gallery_conf['examples_dir']))
fname_readme = os.path.join(gallery_conf['src_dir'], 'README.txt')
with open(fname_readme, 'wb') as fid:
fid.write(u"Testing\n=======\n\nÓscar here.".encode('utf-8'))
args = (gallery_conf['src_dir'], gallery_conf['gallery_dir'],
gallery_conf, [])
out = generate_dir_rst(*args)
assert u"Óscar here" in out[0]
def test_pattern_matching(gallery_conf, log_collector):
"""Test if only examples matching pattern are executed"""
gallery_conf.update(filename_pattern=re.escape(os.sep) + 'plot_0')
code_output = ('\n Out::\n'
'\n'
' Óscar output\n'
' log:Óscar\n'
' $\\langle n_\\uparrow n_\\downarrow \\rangle$\n\n'
)
# create three files in tempdir (only one matches the pattern)
fnames = ['plot_0.py', 'plot_1.py', 'plot_2.py']
for fname in fnames:
with codecs.open(os.path.join(gallery_conf['examples_dir'], fname),
mode='w', encoding='utf-8') as f:
f.write('\n'.join(CONTENT))
# generate rst file
sg.generate_file_rst(fname, gallery_conf['gallery_dir'],
gallery_conf['examples_dir'], gallery_conf)
# read rst file and check if it contains code output
rst_fname = os.path.splitext(fname)[0] + '.rst'
with codecs.open(os.path.join(gallery_conf['gallery_dir'], rst_fname),
mode='r', encoding='utf-8') as f:
rst = f.read()
if re.search(gallery_conf['filename_pattern'],
os.path.join(gallery_conf['gallery_dir'], rst_fname)):
assert code_output in rst
else:
assert code_output not in rst
@pytest.mark.parametrize('test_str', [
'# sphinx_gallery_thumbnail_number= 2',
'# sphinx_gallery_thumbnail_number=2',
'#sphinx_gallery_thumbnail_number = 2',
' # sphinx_gallery_thumbnail_number=2'])
def test_thumbnail_number(test_str):
# which plot to show as the thumbnail image
with tempfile.NamedTemporaryFile('w', delete=False) as f:
f.write('\n'.join(['"Docstring"',
test_str]))
try:
file_conf, blocks = sg.split_code_and_text_blocks(f.name)
finally:
os.remove(f.name)
assert file_conf == {'thumbnail_number': 2}
def test_save_figures(gallery_conf):
"""Test file naming when saving figures. Requires mayavi."""
try:
from mayavi import mlab
except ImportError:
raise pytest.skip('Mayavi not installed')
mlab.options.offscreen = True
gallery_conf.update(find_mayavi_figures=True)
mlab.test_plot3d()
plt.plot(1, 1)
fname_template = os.path.join(gallery_conf['gallery_dir'], 'image{0}.png')
image_rst, fig_num = sg.save_figures(fname_template, 0, gallery_conf)
assert fig_num == 2
assert '/image1.png' in image_rst
assert '/image2.png' in image_rst
mlab.test_plot3d()
plt.plot(1, 1)
image_rst, fig_num = sg.save_figures(fname_template, 2, gallery_conf)
assert fig_num == 2
assert '/image2.png' not in image_rst
assert '/image3.png' in image_rst
assert '/image4.png' in image_rst
shutil.rmtree(gallery_conf['gallery_dir'])
def test_zip_notebooks(gallery_conf):
"""Test generated zipfiles are not corrupt"""
gallery_conf.update(examples_dir='examples')
examples = downloads.list_downloadable_sources(
gallery_conf['examples_dir'])
zipfilepath = downloads.python_zip(examples, gallery_conf['gallery_dir'])
zipf = zipfile.ZipFile(zipfilepath)
check = zipf.testzip()
if check:
raise OSError("Bad file in zipfile: {0}".format(check))
def test_figure_rst():
"""Testing rst of images"""
figure_list = ['sphx_glr_plot_1.png']
image_rst, fig_num = sg.figure_rst(figure_list, '.')
single_image = """
.. image:: /sphx_glr_plot_1.png
:align: center
"""
assert image_rst == single_image
assert fig_num == 1
image_rst, fig_num = sg.figure_rst(figure_list + ['second.png'], '.')
image_list_rst = """
.. rst-class:: sphx-glr-horizontal
*
.. image:: /sphx_glr_plot_1.png
:scale: 47
*
.. image:: /second.png
:scale: 47
"""
assert image_rst == image_list_rst
assert fig_num == 2
# test issue #229
local_img = [os.path.join(os.getcwd(), 'third.png')]
image_rst, fig_num = sg.figure_rst(local_img, '.')
single_image = sg.SINGLE_IMAGE % "third.png"
assert image_rst == single_image
assert fig_num == 1
# TODO: test that broken thumbnail does appear when needed
# TODO: test that examples are not executed twice
# TODO: test that examples are executed after a no-plot and produce
# the correct image in the thumbnail
|