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
|
# -*- coding: utf-8 -*-
"""
Command line test
~~~~~~~~~~~~~~~~~
:copyright: Copyright 2006-2017 by the Pygments team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
from __future__ import print_function
import io
import os
import re
import sys
import tempfile
import unittest
import support
from pygments import cmdline, highlight
from pygments.util import BytesIO, StringIO
TESTFILE, TESTDIR = support.location(__file__)
TESTCODE = '''\
def func(args):
pass
'''
def run_cmdline(*args, **kwds):
saved_stdin = sys.stdin
saved_stdout = sys.stdout
saved_stderr = sys.stderr
if sys.version_info > (3,):
stdin_buffer = BytesIO()
stdout_buffer = BytesIO()
stderr_buffer = BytesIO()
new_stdin = sys.stdin = io.TextIOWrapper(stdin_buffer, 'utf-8')
new_stdout = sys.stdout = io.TextIOWrapper(stdout_buffer, 'utf-8')
new_stderr = sys.stderr = io.TextIOWrapper(stderr_buffer, 'utf-8')
else:
stdin_buffer = new_stdin = sys.stdin = StringIO()
stdout_buffer = new_stdout = sys.stdout = StringIO()
stderr_buffer = new_stderr = sys.stderr = StringIO()
new_stdin.write(kwds.get('stdin', ''))
new_stdin.seek(0, 0)
try:
ret = cmdline.main(['pygmentize'] + list(args))
finally:
sys.stdin = saved_stdin
sys.stdout = saved_stdout
sys.stderr = saved_stderr
new_stdout.flush()
new_stderr.flush()
out, err = stdout_buffer.getvalue().decode('utf-8'), \
stderr_buffer.getvalue().decode('utf-8')
return (ret, out, err)
class CmdLineTest(unittest.TestCase):
def check_success(self, *cmdline, **kwds):
code, out, err = run_cmdline(*cmdline, **kwds)
self.assertEqual(code, 0)
self.assertEqual(err, '')
return out
def check_failure(self, *cmdline, **kwds):
expected_code = kwds.pop('code', 1)
code, out, err = run_cmdline(*cmdline, **kwds)
self.assertEqual(code, expected_code)
self.assertEqual(out, '')
return err
def test_normal(self):
# test that cmdline gives the same output as library api
from pygments.lexers import PythonLexer
from pygments.formatters import HtmlFormatter
filename = TESTFILE
with open(filename, 'rb') as fp:
code = fp.read()
output = highlight(code, PythonLexer(), HtmlFormatter())
o = self.check_success('-lpython', '-fhtml', filename)
self.assertEqual(o, output)
def test_stdin(self):
o = self.check_success('-lpython', '-fhtml', stdin=TESTCODE)
o = re.sub('<[^>]*>', '', o)
# rstrip is necessary since HTML inserts a \n after the last </div>
self.assertEqual(o.rstrip(), TESTCODE.rstrip())
# guess if no lexer given
o = self.check_success('-fhtml', stdin=TESTCODE)
o = re.sub('<[^>]*>', '', o)
# rstrip is necessary since HTML inserts a \n after the last </div>
self.assertEqual(o.rstrip(), TESTCODE.rstrip())
def test_outfile(self):
# test that output file works with and without encoding
fd, name = tempfile.mkstemp()
os.close(fd)
for opts in [['-fhtml', '-o', name, TESTFILE],
['-flatex', '-o', name, TESTFILE],
['-fhtml', '-o', name, '-O', 'encoding=utf-8', TESTFILE]]:
try:
self.check_success(*opts)
finally:
os.unlink(name)
def test_load_from_file(self):
lexer_file = os.path.join(TESTDIR, 'support', 'python_lexer.py')
formatter_file = os.path.join(TESTDIR, 'support', 'html_formatter.py')
# By default, use CustomLexer
o = self.check_success('-l', lexer_file, '-f', 'html',
'-x', stdin=TESTCODE)
o = re.sub('<[^>]*>', '', o)
# rstrip is necessary since HTML inserts a \n after the last </div>
self.assertEqual(o.rstrip(), TESTCODE.rstrip())
# If user specifies a name, use it
o = self.check_success('-f', 'html', '-x', '-l',
lexer_file + ':LexerWrapper', stdin=TESTCODE)
o = re.sub('<[^>]*>', '', o)
# rstrip is necessary since HTML inserts a \n after the last </div>
self.assertEqual(o.rstrip(), TESTCODE.rstrip())
# Should also work for formatters
o = self.check_success('-lpython', '-f',
formatter_file + ':HtmlFormatterWrapper',
'-x', stdin=TESTCODE)
o = re.sub('<[^>]*>', '', o)
# rstrip is necessary since HTML inserts a \n after the last </div>
self.assertEqual(o.rstrip(), TESTCODE.rstrip())
def test_stream_opt(self):
o = self.check_success('-lpython', '-s', '-fterminal', stdin=TESTCODE)
o = re.sub(r'\x1b\[.*?m', '', o)
self.assertEqual(o.replace('\r\n', '\n'), TESTCODE)
def test_h_opt(self):
o = self.check_success('-h')
self.assertTrue('Usage:' in o)
def test_L_opt(self):
o = self.check_success('-L')
self.assertTrue('Lexers' in o and 'Formatters' in o and
'Filters' in o and 'Styles' in o)
o = self.check_success('-L', 'lexer')
self.assertTrue('Lexers' in o and 'Formatters' not in o)
self.check_success('-L', 'lexers')
def test_O_opt(self):
filename = TESTFILE
o = self.check_success('-Ofull=1,linenos=true,foo=bar',
'-fhtml', filename)
self.assertTrue('<html' in o)
self.assertTrue('class="linenos"' in o)
# "foobar" is invalid for a bool option
e = self.check_failure('-Ostripnl=foobar', TESTFILE)
self.assertTrue('Error: Invalid value' in e)
e = self.check_failure('-Ostripnl=foobar', '-lpy')
self.assertTrue('Error: Invalid value' in e)
def test_P_opt(self):
filename = TESTFILE
o = self.check_success('-Pfull', '-Ptitle=foo, bar=baz=,',
'-fhtml', filename)
self.assertTrue('<title>foo, bar=baz=,</title>' in o)
def test_F_opt(self):
filename = TESTFILE
o = self.check_success('-Fhighlight:tokentype=Name.Blubb,'
'names=TESTFILE filename',
'-fhtml', filename)
self.assertTrue('<span class="n n-Blubb' in o)
def test_H_opt(self):
o = self.check_success('-H', 'formatter', 'html')
self.assertTrue('HTML' in o)
o = self.check_success('-H', 'lexer', 'python')
self.assertTrue('Python' in o)
o = self.check_success('-H', 'filter', 'raiseonerror')
self.assertTrue('raiseonerror', o)
e = self.check_failure('-H', 'lexer', 'foobar')
self.assertTrue('not found' in e)
def test_S_opt(self):
o = self.check_success('-S', 'default', '-f', 'html', '-O', 'linenos=1')
lines = o.splitlines()
for line in lines:
# every line is for a token class
parts = line.split()
self.assertTrue(parts[0].startswith('.'))
self.assertTrue(parts[1] == '{')
if parts[0] != '.hll':
self.assertTrue(parts[-4] == '}')
self.assertTrue(parts[-3] == '/*')
self.assertTrue(parts[-1] == '*/')
self.check_failure('-S', 'default', '-f', 'foobar')
def test_N_opt(self):
o = self.check_success('-N', 'test.py')
self.assertEqual('python', o.strip())
o = self.check_success('-N', 'test.unknown')
self.assertEqual('text', o.strip())
def test_invalid_opts(self):
for opts in [
('-X',),
('-L', '-lpy'),
('-L', '-fhtml'),
('-L', '-Ox'),
('-S', 'default', '-l', 'py', '-f', 'html'),
('-S', 'default'),
('-a', 'arg'),
('-H',),
(TESTFILE, TESTFILE),
('-H', 'formatter'),
('-H', 'foo', 'bar'),
('-s',),
('-s', TESTFILE),
]:
self.check_failure(*opts, code=2)
def test_errors(self):
# input file not found
e = self.check_failure('-lpython', 'nonexistent.py')
self.assertTrue('Error: cannot read infile' in e)
self.assertTrue('nonexistent.py' in e)
# lexer not found
e = self.check_failure('-lfooo', TESTFILE)
self.assertTrue('Error: no lexer for alias' in e)
# cannot load .py file without load_from_file flag
e = self.check_failure('-l', 'nonexistent.py', TESTFILE)
self.assertTrue('Error: no lexer for alias' in e)
# lexer file is missing/unreadable
e = self.check_failure('-l', 'nonexistent.py',
'-x', TESTFILE)
self.assertTrue('Error: cannot read' in e)
# lexer file is malformed
e = self.check_failure('-l', 'support/empty.py',
'-x', TESTFILE)
self.assertTrue('Error: no valid CustomLexer class found' in e)
# formatter not found
e = self.check_failure('-lpython', '-ffoo', TESTFILE)
self.assertTrue('Error: no formatter found for name' in e)
# formatter for outfile not found
e = self.check_failure('-ofoo.foo', TESTFILE)
self.assertTrue('Error: no formatter found for file name' in e)
# cannot load .py file without load_from_file flag
e = self.check_failure('-f', 'nonexistent.py', TESTFILE)
self.assertTrue('Error: no formatter found for name' in e)
# formatter file is missing/unreadable
e = self.check_failure('-f', 'nonexistent.py',
'-x', TESTFILE)
self.assertTrue('Error: cannot read' in e)
# formatter file is malformed
e = self.check_failure('-f', 'support/empty.py',
'-x', TESTFILE)
self.assertTrue('Error: no valid CustomFormatter class found' in e)
# output file not writable
e = self.check_failure('-o', os.path.join('nonexistent', 'dir', 'out.html'),
'-lpython', TESTFILE)
self.assertTrue('Error: cannot open outfile' in e)
self.assertTrue('out.html' in e)
# unknown filter
e = self.check_failure('-F', 'foo', TESTFILE)
self.assertTrue('Error: filter \'foo\' not found' in e)
def test_exception(self):
cmdline.highlight = None # override callable to provoke TypeError
try:
# unexpected exception while highlighting
e = self.check_failure('-lpython', TESTFILE)
self.assertTrue('*** Error while highlighting:' in e)
self.assertTrue('TypeError' in e)
# same with -v: should reraise the exception
try:
self.check_failure('-lpython', '-v', TESTFILE)
except Exception:
pass
else:
self.fail('exception not reraised')
finally:
cmdline.highlight = highlight
def test_parse_opts(self):
self.assertEqual(cmdline._parse_options([' ', 'keyonly,key = value ']),
{'keyonly': True, 'key': 'value'})
|