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 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
|
from os.path import join
import xdoctest
from xdoctest import core
from xdoctest import utils
def _test_status(docstr):
docstr = utils.codeblock(docstr)
try:
temp = utils.util_misc.TempDoctest(docstr=docstr)
except Exception:
raise
# pytest seems to load an older version of xdoctest for some reason
import xdoctest
import inspect
print('xdoctest.__version__ = {!r}'.format(xdoctest.__version__))
print('utils = {!r}'.format(utils))
print('utils.util_misc = {!r}'.format(utils.util_misc))
print('utils.TempDoctest = {!r}'.format(utils.TempDoctest))
print(inspect.getargspec(utils.TempDoctest))
raise
doctests = list(core.parse_doctestables(temp.modpath))
status = doctests[0].run(verbose=0, on_error='return')
return status
def test_mod_lineno():
with utils.TempDir() as temp:
dpath = temp.dpath
modpath = join(dpath, 'test_mod_lineno.py')
source = utils.codeblock(
'''
class Fun: #1
@property
def test(self):
""" # 4
>>> a = 1
>>> 1 / 0
"""
''')
with open(modpath, 'w') as file:
file.write(source)
doctests = list(core.parse_doctestables(modpath, style='freeform'))
assert len(doctests) == 1
self = doctests[0]
# print(self._parts[0])
assert self.lineno == 5
# print(self.format_src())
self.config['colored'] = False
assert self.format_src(offset_linenos=False).strip().startswith('1')
assert self.format_src(offset_linenos=True).strip().startswith('5')
with utils.PythonPathContext(dpath):
status = self.run(verbose=10, on_error='return')
assert not status['passed']
def test_mod_globals():
with utils.TempDir() as temp:
dpath = temp.dpath
modpath = join(dpath, 'test_mod_globals.py')
source = utils.codeblock(
'''
X = 10
def test(self):
"""
>>> X
10
"""
''')
with open(modpath, 'w') as file:
file.write(source)
from xdoctest import core
doctests = list(core.parse_doctestables(modpath, style='freeform'))
assert len(doctests) == 1
self = doctests[0]
with utils.PythonPathContext(dpath):
status = self.run(verbose=0, on_error='return')
assert status['passed']
assert self.logged_evals[0] == 10
def test_show_entire():
"""
pytest tests/test_core.py::test_show_entire
"""
temp = utils.TempDir()
dpath = temp.ensure()
modpath = join(dpath, 'test_show_entire.py')
source = utils.codeblock(
'''
def foo():
"""
Prefix
Example:
>>> x = 4
>>> x = 5 + x
>>> x = 6 + x
>>> x = 7 + x
>>> x
22
>>> x = 8 + x
>>> x = 9 + x
>>> x = 10 + x
>>> x = 11 + x
>>> x = 12 + x
>>> x
42
text-line-after
"""
''')
with open(modpath, 'w') as file:
file.write(source)
from xdoctest import core
# calldefs = core.module_calldefs(modpath)
# docline = calldefs['foo'].doclineno
# docstr = calldefs['foo'].docstr
# all_parts = parser.DoctestParser().parse(docstr)
# assert docline == 2
doctests = list(core.parse_doctestables(modpath, style='freeform'))
assert len(doctests) == 1
self = doctests[0]
self.config['colored'] = False
print(self.lineno)
print(self._parts[0].line_offset)
print(self.format_src())
src_offset = self.format_src(offset_linenos=True).strip()
src_nooffset = self.format_src(offset_linenos=False).strip()
assert src_offset[:4].startswith('6')
assert src_nooffset[:4].startswith('1')
with utils.PythonPathContext(dpath):
status = self.run(verbose=0, on_error='return')
assert not status['passed']
temp.cleanup()
def test_freeform_parse_lineno():
"""
python ~/code/xdoctest/tests/test_core.py test_freeform_parse_lineno
"""
docstr = utils.codeblock(
'''
>>> print('line1') # test.line=1, offset=0
Example:
>>> x = 0 # test.line=4, offset=0
DisableExample:
>>> x = 0 # test.line=7, offset=0
Example:
>>> True # test.line=10, offset=0
True
Example:
>>> False # test.line=14, offset=0
>>> False # test.line=15, offset=1
False
>>> True # test.line=17, offset=3
junk text
>>> x = 4 # line 20, offset 0
>>> x = 5 + x # line 21, offset 1
33
>>> x = 6 + x # line 23, offset 3
text-line-after
''')
from xdoctest import core
doctests = list(core.parse_freeform_docstr_examples(docstr, lineno=1, asone=False))
assert [test.lineno for test in doctests] == [1, 4, 10, 14, 20]
# This asserts if the lines are consecutive. Should we enforce this?
# Perhaps its ok if they are not.
for test in doctests:
assert test._parts[0].line_offset == 0
offset = 0
for p in test._parts:
assert p.line_offset == offset
offset += p.n_lines
doctests = list(core.parse_freeform_docstr_examples(docstr, lineno=1, asone=True))
assert [test.lineno for test in doctests] == [1]
doctests = list(core.parse_google_docstr_examples(docstr, lineno=1))
assert [test.lineno for test in doctests] == [4, 10, 14]
for test in doctests:
test._parse()
assert test._parts[0].line_offset == 0
offset = 0
for p in test._parts:
assert p.line_offset == offset
offset += p.n_lines
def test_collect_module_level():
"""
pytest tests/test_core.py::test_collect_module_level -s -vv
Ignore:
temp = utils.TempDir()
"""
temp = utils.TempDir()
dpath = temp.ensure()
modpath = join(dpath, 'test_collect_module_level.py')
source = utils.codeblock(
'''
"""
>>> pass
"""
''')
with open(modpath, 'w') as file:
file.write(source)
from xdoctest import core
doctests = list(core.parse_doctestables(modpath, style='freeform'))
assert len(doctests) == 1
self = doctests[0]
assert self.callname == '__doc__'
self.config['colored'] = False
src_offset = self.format_src(offset_linenos=True).strip()
src_nooffset = self.format_src(offset_linenos=False).strip()
assert src_offset[:4].startswith('2')
assert src_nooffset[:4].startswith('1')
with utils.PythonPathContext(dpath):
status = self.run(verbose=0, on_error='return')
assert status['passed']
temp.cleanup()
def test_collect_module_level_singleline():
"""
pytest tests/test_core.py::test_collect_module_level
Ignore:
temp = utils.TempDir()
"""
temp = utils.TempDir()
dpath = temp.ensure()
modpath = join(dpath, 'test_collect_module_level_singleline.py')
source = utils.codeblock(
'''">>> pass"''')
with open(modpath, 'w') as file:
file.write(source)
from xdoctest import core
doctests = list(core.parse_doctestables(modpath, style='freeform'))
assert len(doctests) == 1
self = doctests[0]
assert self.callname == '__doc__'
self.config['colored'] = False
assert self.format_src(offset_linenos=True).strip().startswith('1')
assert self.format_src(offset_linenos=False).strip().startswith('1')
with utils.PythonPathContext(dpath):
status = self.run(verbose=0, on_error='return')
assert status['passed']
temp.cleanup()
def test_no_docstr():
"""
CommandLine:
python -m test_core test_no_docstr
"""
with utils.TempDir() as temp:
dpath = temp.dpath
modpath = join(dpath, 'test_no_docstr.py')
source = utils.codeblock(
'''
def get_scales(kpts):
""" Gets average scale (does not take into account elliptical shape """
_scales = np.sqrt(get_sqrd_scales(kpts))
return _scales
''')
with open(modpath, 'w') as file:
file.write(source)
from xdoctest import core
doctests = list(core.parse_doctestables(modpath, style='freeform'))
assert len(doctests) == 0
def test_oneliner():
"""
python ~/code/xdoctest/tests/test_core.py test_oneliner
"""
with utils.TempDir() as temp:
dpath = temp.dpath
modpath = join(dpath, 'test_oneliner.py')
source = utils.codeblock(
'''
def foo():
"""
>>> assert False, 'should fail'
"""
''')
with open(modpath, 'w') as file:
file.write(source)
doctests = list(core.parse_doctestables(modpath))
assert len(doctests) == 1
print('doctests = {!r}'.format(doctests))
import pytest
with pytest.raises(AssertionError, match='should fail'):
doctests[0].run()
def test_delayed_want_pass_cases():
"""
The delayed want algorithm allows a want statement to match trailing
unmatched stdout if it fails to directly match the most recent stdout.
In more mathy terms let $w$ be the current "want", and let $g[-t:]$ be the
trailing $t$ most recent "gots" captured from stdout. We say the "want"
matches "got" if $w matches g[-t:] for t in range(1, n)$, where $n$ is the
index of the last part with a success match.
CommandLine:
python ~/code/xdoctest/tests/test_core.py test_delayed_want_pass_cases
"""
# Pass Case1:
status = _test_status(
"""
>>> print('some text')
>>> print('more text')
some text
more text
""")
assert status['passed']
# Pass Case2:
status = _test_status(
"""
>>> print('some text')
some text
>>> print('more text')
more text
""")
assert status['passed']
# Pass Case3: "its ok to only match more text and ignore some text"
status = _test_status(
"""
>>> print('some text')
>>> print('more text')
more text
""")
assert status['passed']
def test_delayed_want_fail_cases():
"""
CommandLine:
xdoctest -m ~/code/xdoctest/tests/test_core.py test_delayed_want_fail_cases
"""
# Fail Case4: "more text has not been printed yet"
status = _test_status(
"""
>>> print('some text')
some text
more text
>>> print('more text')
""")
assert not status['passed']
# Fail Case5: cannot match "some text" more than once
status = _test_status(
"""
>>> print('some text')
some text
>>> print('more text')
some text
more text
""")
assert not status['passed']
# Fail Case6: Because "more text" was matched, "some text" is forever
# ignored
status = _test_status(
"""
>>> print('some text')
>>> print('more text')
more text
>>> print('even more text')
some text
even more text
""")
assert not status['passed']
# alternate case 6
status = _test_status(
"""
>>> print('some text')
>>> print('more text')
more text
>>> print('even more text')
some text
more text
even more text
""")
assert not status['passed']
def test_indented_grouping():
"""
Initial changes in 0.10.0 broke parsing of some ubelt tests, check to
ensure using `...` in indented blocks is ok (as long as there is no want
string in the indented block).
CommandLine:
xdoctest -m ~/code/xdoctest/tests/test_core.py test_indented_grouping
"""
from xdoctest.doctest_example import DocTest
example = DocTest(
utils.codeblock(r"""
>>> from xdoctest.utils import codeblock
>>> # Simulate an indented part of code
>>> if True:
>>> # notice the indentation on this will be normal
>>> codeblock_version = codeblock(
... '''
... def foo():
... return 'bar'
... '''
... )
>>> # notice the indentation and newlines on this will be odd
>>> normal_version = ('''
... def foo():
... return 'bar'
... ''')
>>> assert normal_version != codeblock_version
"""))
# print(example.format_src())
status = example.run(verbose=0)
assert status['passed']
def test_backwards_compat_eval_in_loop():
"""
Test that changes in 0.10.0 fix backwards compatibility issue.
CommandLine:
xdoctest -m ~/code/xdoctest/tests/test_core.py test_backwards_compat_eval_in_loop
"""
from xdoctest.doctest_example import DocTest
example = DocTest(
utils.codeblock(r"""
>>> for i in range(2):
... '%s' % i
...
'0'
'1'
"""))
# print(example.format_src())
status = example.run(verbose=0)
assert status['passed']
example = DocTest(
utils.codeblock(r"""
>>> for i in range(2):
... '%s' % i
'0'
'1'
"""))
status = example.run(verbose=0)
assert status['passed']
def test_backwards_compat_indent_value():
"""
CommandLine:
xdoctest -m ~/code/xdoctest/tests/test_core.py test_backwards_compat_indent_value
"""
from xdoctest.doctest_example import DocTest
example = DocTest(
utils.codeblock(r"""
>>> b = 3
>>> if True:
... a = 1
... isinstance(1, int)
True
"""))
status = example.run(verbose=0)
assert status['passed']
def test_concise_try_except():
"""
CommandLine:
xdoctest -m ~/code/xdoctest/tests/test_core.py test_concise_try_except
"""
from xdoctest.doctest_example import DocTest
example = DocTest(
utils.codeblock(r"""
>>> # xdoctest: +IGNORE_WANT
>>> try: raise Exception
... except Exception: print(lambda *a, **b: sys.stdout.write(str(a) + "\n" + str(b)))
a bad want string
...
"""))
status = example.run(verbose=0)
assert status['passed']
from xdoctest.doctest_example import DocTest
example = DocTest(
utils.codeblock(r"""
>>> # xdoctest: +IGNORE_WANT
>>> try: raise Exception
>>> except Exception: print(lambda *a, **b: sys.stdout.write(str(a) + "\n" + str(b)))
a bad want string
...
"""))
status = example.run(verbose=0)
assert status['passed']
def test_semicolon_line():
r"""
Test for https://github.com/Erotemic/xdoctest/issues/108
Note:
Notes on the issue:
.. code:: python
# This works
compile("import os; print(os)", filename="", mode='exec')
compile("import os; print(os)", filename="", mode='single')
compile("1; 2", filename="", mode='exec')
compile("1; 2", filename="", mode='single')
compile("print();print()", filename="", mode='single')
compile("print();print()", filename="", mode='exec')
compile("print()", filename="", mode='eval')
compile("print()", filename="", mode='exec')
compile("print()", filename="", mode='single')
# This breaks:
compile("import os; print(os)", filename="", mode='eval')
# I suppose we can't have imports in an eval?
compile("import os\n", filename="", mode='eval')
# Or multiple lines?
compile("print();print()", filename="", mode='eval')
# No imports, no assignments, no semicolons
compile("1; 2", filename="", mode='eval')
CommandLine:
xdoctest -m ~/code/xdoctest/tests/test_core.py test_concise_exceptions
"""
from xdoctest.doctest_example import DocTest
example = DocTest(
utils.codeblock(r"""
>>> import os; print(os.path.abspath('.'))
"""))
status = example.run(verbose=0)
assert status['passed']
# The problem case was when it was compiled with a "want" statement
#
from xdoctest.doctest_example import DocTest
example = DocTest(
utils.codeblock(r"""
>>> import os; print(os.path.abspath('.'))
...
"""))
status = example.run(verbose=0)
assert status['passed']
# Test single import
# import xdoctest
# xdoctest.parser.DEBUG = 100
from xdoctest.doctest_example import DocTest
example = DocTest(
utils.codeblock(r"""
>>> import os
...
"""))
status = example.run(verbose=0)
assert status['passed']
if __name__ == '__main__':
"""
CommandLine:
export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/tests
python ~/code/xdoctest/tests/test_core.py zero
pytest tests/test_core.py -vv
"""
import xdoctest # NOQA
xdoctest.doctest_module(__file__)
|