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 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
|
import os
import re
import subprocess
import sys
import shlex
import tempfile
import pytest
import ubelt as ub
def test_single_function_autoprofile():
"""
Test that every function in a file is profiled when autoprofile is
enabled.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
code = ub.codeblock(
'''
def func1(a):
return a + 1
func1(1)
''')
with ub.ChDir(temp_dpath):
script_fpath = ub.Path('script.py')
script_fpath.write_text(code)
args = [sys.executable, '-m', 'kernprof', '-p', 'script.py', '-l',
os.fspath(script_fpath)]
proc = ub.cmd(args)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
args = [sys.executable, '-m', 'line_profiler',
os.fspath(script_fpath) + '.lprof']
proc = ub.cmd(args)
raw_output = proc.stdout
proc.check_returncode()
assert 'func1' in raw_output
def test_multi_function_autoprofile():
"""
Test that every function in a file is profiled when autoprofile is
enabled.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
code = ub.codeblock(
'''
def func1(a):
return a + 1
def func2(a):
return a * 2 + 2
def func3(a):
return a / 10 + 3
def func4(a):
return a % 2 + 4
func1(1)
''')
with ub.ChDir(temp_dpath):
script_fpath = ub.Path('script.py')
script_fpath.write_text(code)
args = [sys.executable, '-m', 'kernprof', '-p', 'script.py', '-l',
os.fspath(script_fpath)]
proc = ub.cmd(args)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
args = [sys.executable, '-m', 'line_profiler',
os.fspath(script_fpath) + '.lprof']
proc = ub.cmd(args)
raw_output = proc.stdout
proc.check_returncode()
assert 'func1' in raw_output
assert 'func2' in raw_output
assert 'func3' in raw_output
assert 'func4' in raw_output
def test_duplicate_function_autoprofile():
"""
Test that every function in a file is profiled when autoprofile is
enabled.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
code = ub.codeblock(
'''
def func1(a):
return a + 1
def func2(a):
return a + 1
def func3(a):
return a + 1
def func4(a):
return a + 1
func1(1)
func2(1)
func3(1)
''')
with ub.ChDir(temp_dpath):
script_fpath = ub.Path('script.py')
script_fpath.write_text(code)
args = [sys.executable, '-m', 'kernprof', '-p', 'script.py', '-l',
os.fspath(script_fpath)]
proc = ub.cmd(args)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
args = [sys.executable, '-m', 'line_profiler',
os.fspath(script_fpath) + '.lprof']
proc = ub.cmd(args)
raw_output = proc.stdout
print(raw_output)
proc.check_returncode()
assert 'Function: func1' in raw_output
assert 'Function: func2' in raw_output
assert 'Function: func3' in raw_output
assert 'Function: func4' in raw_output
def test_async_func_autoprofile():
"""
Test the profiling of async functions when autoprofile is enabled.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
code = ub.codeblock(
'''
import asyncio
async def foo(l, x, delay=.0625):
delay *= x
result = (await asyncio.sleep(delay, result=x))
l.append(result)
return result
async def bar():
l = []
coroutines = [foo(l, x) for x in range(5, -1, -1)]
return (await asyncio.gather(*coroutines)), l
def main(debug=None):
(in_scheduling_order,
in_finishing_order) = asyncio.run(bar(), debug=debug)
print(in_scheduling_order, # [5, 4, 3, 2, 1, 0]
in_finishing_order) # [0, 1, 2, 3, 4, 5]
if __name__ == '__main__':
main(debug=True)
''')
with ub.ChDir(temp_dpath):
script_fpath = ub.Path('script.py')
script_fpath.write_text(code)
args = [sys.executable, '-m', 'kernprof',
'-p', 'script.py', '-v', '-l', os.fspath(script_fpath)]
proc = ub.cmd(args)
raw_output = proc.stdout
print(raw_output)
print(proc.stderr)
proc.check_returncode()
assert raw_output.startswith('[5, 4, 3, 2, 1, 0] '
'[0, 1, 2, 3, 4, 5]')
assert 'Function: main' in raw_output
assert 'Function: foo' in raw_output
assert 'Function: bar' in raw_output
def _write_demo_module(temp_dpath):
"""
Make a dummy test module structure
"""
(temp_dpath / 'test_mod').ensuredir()
(temp_dpath / 'test_mod/subpkg').ensuredir()
(temp_dpath / 'test_mod/__init__.py').touch()
(temp_dpath / 'test_mod/subpkg/__init__.py').write_text(ub.codeblock(
'''
from .submod3 import add_three
'''))
(temp_dpath / 'test_mod/__main__.py').write_text(ub.codeblock(
'''
import argparse
from .submod1 import add_one
from . import submod2
def _main(args=None):
parser = argparse.ArgumentParser()
parser.add_argument('a', nargs='*', type=int)
print(add_one(parser.parse_args(args).a))
print(submod2.add_two(parser.parse_args(args).a))
if __name__ == '__main__':
_main()
'''))
(temp_dpath / 'test_mod/util.py').write_text(ub.codeblock(
'''
def add_operator(a, b):
return a + b
'''))
(temp_dpath / 'test_mod/submod1.py').write_text(ub.codeblock(
'''
from test_mod.util import add_operator
def add_one(items):
new_items = []
for item in items:
new_item = add_operator(item, 1)
new_items.append(new_item)
return new_items
'''))
(temp_dpath / 'test_mod/submod2.py').write_text(ub.codeblock(
'''
from test_mod.util import add_operator
def add_two(items):
new_items = [add_operator(item, 2) for item in items]
return new_items
'''))
(temp_dpath / 'test_mod/subpkg/submod3.py').write_text(ub.codeblock(
'''
from test_mod.util import add_operator
def add_three(items):
new_items = [add_operator(item, 3) for item in items]
return new_items
'''))
(temp_dpath / 'test_mod/subpkg/submod4.py').write_text(ub.codeblock(
'''
import argparse
from test_mod import submod1
from ..submod2 import add_two
def add_four(items):
add_one = submod1.add_one
return add_two(add_one(add_one(items)))
def _main(args=None):
parser = argparse.ArgumentParser()
parser.add_argument('a', nargs='*', type=int)
print(submod1.add_one(parser.parse_args(args).a))
print(add_four(parser.parse_args(args).a))
if __name__ == '__main__':
_main()
'''))
script_fpath = (temp_dpath / 'script.py')
script_fpath.write_text(ub.codeblock(
'''
from test_mod import submod1
from test_mod import submod2
from test_mod.subpkg import submod3
import statistics
def main():
data = [1, 2, 3]
val = submod1.add_one(data)
val = submod2.add_two(val)
val = submod3.add_three(val)
result = statistics.harmonic_mean(val)
print(result)
main()
'''))
return script_fpath
def test_autoprofile_script_with_module():
"""
Test that every function in a file is profiled when autoprofile is
enabled.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
script_fpath = _write_demo_module(temp_dpath)
# args = [sys.executable, '-m', 'kernprof', '--prof-imports',
# '-p', 'script.py', '-l', os.fspath(script_fpath)]
args = [sys.executable, '-m', 'kernprof', '-p', 'script.py', '-l',
os.fspath(script_fpath)]
proc = ub.cmd(args, cwd=temp_dpath, verbose=2)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
args = [sys.executable, '-m', 'line_profiler',
os.fspath(script_fpath) + '.lprof']
proc = ub.cmd(args, cwd=temp_dpath)
raw_output = proc.stdout
print(raw_output)
proc.check_returncode()
assert 'Function: add_one' not in raw_output
assert 'Function: main' in raw_output
def test_autoprofile_module():
"""
Test that every function in a file is profiled when autoprofile is
enabled.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
script_fpath = _write_demo_module(temp_dpath)
# args = [sys.executable, '-m', 'kernprof', '--prof-imports',
# '-p', 'script.py', '-l', os.fspath(script_fpath)]
args = [sys.executable, '-m', 'kernprof', '-p', 'test_mod', '-l',
os.fspath(script_fpath)]
proc = ub.cmd(args, cwd=temp_dpath, verbose=2)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
args = [sys.executable, '-m', 'line_profiler',
os.fspath(script_fpath) + '.lprof']
proc = ub.cmd(args, cwd=temp_dpath)
raw_output = proc.stdout
print(raw_output)
proc.check_returncode()
assert 'Function: add_one' in raw_output
assert 'Function: main' not in raw_output
def test_autoprofile_module_list():
"""
Test only modules specified are autoprofiled.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
script_fpath = _write_demo_module(temp_dpath)
# args = [sys.executable, '-m', 'kernprof', '--prof-imports',
# '-p', 'script.py', '-l', os.fspath(script_fpath)]
args = [sys.executable, '-m', 'kernprof',
'-p', 'test_mod.submod1,test_mod.subpkg.submod3', '-l',
os.fspath(script_fpath)]
proc = ub.cmd(args, cwd=temp_dpath, verbose=2)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
args = [sys.executable, '-m', 'line_profiler',
os.fspath(script_fpath) + '.lprof']
proc = ub.cmd(args, cwd=temp_dpath)
raw_output = proc.stdout
print(raw_output)
proc.check_returncode()
assert 'Function: add_one' in raw_output
assert 'Function: add_two' not in raw_output
assert 'Function: add_three' in raw_output
assert 'Function: main' not in raw_output
def test_autoprofile_module_with_prof_imports():
"""
Test the imports of the specified modules are profiled as well.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
script_fpath = _write_demo_module(temp_dpath)
args = [sys.executable, '-m', 'kernprof', '--prof-imports',
'-p', 'test_mod.submod1', '-l', os.fspath(script_fpath)]
proc = ub.cmd(args, cwd=temp_dpath, verbose=2)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
args = [sys.executable, '-m', 'line_profiler',
os.fspath(script_fpath) + '.lprof']
proc = ub.cmd(args, cwd=temp_dpath)
raw_output = proc.stdout
print(raw_output)
proc.check_returncode()
assert 'Function: add_one' in raw_output
assert 'Function: add_operator' in raw_output
assert 'Function: add_three' not in raw_output
assert 'Function: main' not in raw_output
def test_autoprofile_script_with_prof_imports():
"""
Test the imports of the specified modules are profiled as well.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
script_fpath = _write_demo_module(temp_dpath)
# import sys
# if sys.version_info[0:2] >= (3, 11):
# import pytest
# pytest.skip('Failing due to the noop bug')
args = [sys.executable, '-m', 'kernprof', '--prof-imports',
'-p', 'script.py', '-l', os.fspath(script_fpath)]
proc = ub.cmd(args, cwd=temp_dpath, verbose=0)
print('Kernprof Stdout:')
print(proc.stdout)
print('Kernprof Stderr:')
print(proc.stderr)
print('About to check kernprof return code')
proc.check_returncode()
args = [sys.executable, '-m', 'line_profiler',
os.fspath(script_fpath) + '.lprof']
proc = ub.cmd(args, cwd=temp_dpath, verbose=0)
raw_output = proc.stdout
print('Line_profile Stdout:')
print(raw_output)
print('Line_profile Stderr:')
print(proc.stderr)
print('About to check line_profiler return code')
proc.check_returncode()
assert 'Function: add_one' in raw_output
assert 'Function: harmonic_mean' in raw_output
assert 'Function: main' in raw_output
@pytest.mark.parametrize(
('use_kernprof_exec', 'prof_mod', 'flags', 'profiled_funcs'),
[(False, ['test_mod.submod1'], '', {'add_one', 'add_operator'}),
# By not using `--no-preimports`, the entirety of `.submod1` is
# passed to `add_imported_function_or_module()`
(False, ['test_mod.submod1'], '--no-preimports', {'add_one'}),
(False, ['test_mod.submod2'],
'--prof-imports', {'add_two', 'add_operator'}),
(False, ['test_mod'],
'--prof-imports', {'add_one', 'add_two', 'add_operator', '_main'}),
# Explicitly add all the modules via multiple `-p` flags, without
# using the `--prof-imports` flag
(False, ['test_mod', 'test_mod.submod1,test_mod.submod2'],
'', {'add_one', 'add_two', 'add_operator', '_main'}),
(False, [], '--prof-imports', set()),
(True, [], '--prof-imports', set())])
def test_autoprofile_exec_package(use_kernprof_exec, prof_mod,
flags, profiled_funcs):
"""
Test the execution of a package.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
_write_demo_module(temp_dpath)
# Sanity check
all_checked_funcs = {'add_one', 'add_two', 'add_operator', '_main'}
profiled_funcs = set(profiled_funcs)
assert profiled_funcs <= all_checked_funcs
if use_kernprof_exec:
args = ['kernprof']
else:
args = [sys.executable, '-m', 'kernprof']
for pm in prof_mod:
args.extend(['-p', pm])
args.extend(shlex.split(flags))
args.extend(['-l', '-m', 'test_mod', '1', '2', '3'])
proc = ub.cmd(args, cwd=temp_dpath, verbose=2)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
prof = temp_dpath / 'test_mod.lprof'
args = [sys.executable, '-m', 'line_profiler', os.fspath(prof)]
proc = ub.cmd(args, cwd=temp_dpath)
raw_output = proc.stdout
print(raw_output)
proc.check_returncode()
for func in all_checked_funcs:
assert (f'Function: {func}' in raw_output) == (func in profiled_funcs)
@pytest.mark.parametrize(
('use_kernprof_exec', 'prof_mod', 'flags', 'profiled_funcs'),
[(False, 'test_mod.submod2,test_mod.subpkg.submod3.add_three',
'--no-preimports', {'add_two'}),
# By not using `--no-preimports`:
# - The entirety of `.submod2` is passed to
# `add_imported_function_or_module()`
# - Despite not having been imported anywhere, `add_three()` is
# still profiled
(False, 'test_mod.submod2,test_mod.subpkg.submod3.add_three',
'', {'add_two', 'add_three', 'add_operator'}),
(False, 'test_mod.submod1', '', {'add_one', 'add_operator'}),
(False, 'test_mod.subpkg.submod4',
'--prof-imports',
{'add_one', 'add_two', 'add_four', 'add_operator', '_main'}),
(False, None, '--prof-imports', {}),
(True, None, '--prof-imports', {}),
# Packages are descended into by default, unless they are specified
# with `<pkg>.__init__`
(False, 'test_mod', '',
{'add_one', 'add_two', 'add_three', 'add_four', 'add_operator',
'_main'}),
(False, 'test_mod.subpkg', '', {'add_three', 'add_four', '_main'}),
(False, 'test_mod.subpkg.__init__', '', {'add_three'})])
def test_autoprofile_exec_module(use_kernprof_exec, prof_mod,
flags, profiled_funcs):
"""
Test the execution of a module.
"""
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
_write_demo_module(temp_dpath)
# Sanity check
all_checked_funcs = {'add_one', 'add_two', 'add_three', 'add_four',
'add_operator', '_main'}
profiled_funcs = set(profiled_funcs)
assert profiled_funcs <= all_checked_funcs
if use_kernprof_exec:
args = ['kernprof']
else:
args = [sys.executable, '-m', 'kernprof']
if prof_mod is not None:
args.extend(['-p', prof_mod])
args.extend(shlex.split(flags))
args.extend(['-l', '-m', 'test_mod.subpkg.submod4', '1', '2', '3'])
proc = ub.cmd(args, cwd=temp_dpath, verbose=2)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
prof = temp_dpath / 'test_mod.subpkg.submod4.lprof'
args = [sys.executable, '-m', 'line_profiler', os.fspath(prof)]
proc = ub.cmd(args, cwd=temp_dpath)
raw_output = proc.stdout
print(raw_output)
proc.check_returncode()
for func in all_checked_funcs:
assert (f'Function: {func}' in raw_output) == (func in profiled_funcs)
@pytest.mark.parametrize('view', [True, False])
@pytest.mark.parametrize('prof_mod', [True, False])
@pytest.mark.parametrize(
('outfile', 'expected_outfile'),
[(None, 'kernprof-stdin-*.lprof'),
('test-stdin.lprof', 'test-stdin.lprof')])
def test_autoprofile_from_stdin(
outfile, expected_outfile, prof_mod, view) -> None:
"""
Test the profiling of a script read from stdin.
"""
with tempfile.TemporaryDirectory() as tmpdir:
temp_dpath = ub.Path(tmpdir)
kp_cmd = [sys.executable, '-m', 'kernprof', '-l']
if prof_mod:
kp_cmd += ['-p' 'test_mod.submod1,test_mod.subpkg.submod3']
if outfile:
kp_cmd += ['-o', outfile]
if view:
kp_cmd += ['-v']
kp_cmd += ['-']
with ub.ChDir(temp_dpath):
script_fpath = _write_demo_module(ub.Path())
proc = subprocess.run(kp_cmd,
input=script_fpath.read_text(),
text=True,
capture_output=True)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
outfile, = temp_dpath.glob(expected_outfile)
lp_cmd = [sys.executable, '-m', 'line_profiler', str(outfile)]
lp_proc = ub.cmd(lp_cmd)
lp_proc.check_returncode()
if view:
raw_output = proc.stdout
else:
raw_output = lp_proc.stdout
print(raw_output)
assert ('Function: add_one' in raw_output) == prof_mod
assert 'Function: add_two' not in raw_output
assert ('Function: add_three' in raw_output) == prof_mod
# If we're calling a separate process to view the results, the
# script file will already have been deleted
assert ('Function: main' in raw_output) == view
# Check that `main()` is scrubbed from the written file and doesn't
# result in spurious error messages
assert 'Could not find file' not in lp_proc.stdout
@pytest.mark.parametrize(
('outfile', 'expected_outfile'),
[(None, 'kernprof-command-*.lprof'),
('test-command.lprof', 'test-command.lprof')])
def test_autoprofile_from_inlined_script(outfile, expected_outfile) -> None:
"""
Test the profiling of an inlined script (supplied with the `-c`
flag).
"""
with tempfile.TemporaryDirectory() as tmpdir:
temp_dpath = ub.Path(tmpdir)
_write_demo_module(temp_dpath)
inlined_script = ('from test_mod import submod1, submod2; '
'from test_mod.subpkg import submod3; '
'import statistics; '
'data = [1, 2, 3]; '
'val = submod1.add_one(data); '
'val = submod2.add_two(val); '
'val = submod3.add_three(val); '
'result = statistics.harmonic_mean(val); '
'print(result);')
kp_cmd = [sys.executable, '-m', 'kernprof',
'-p', 'test_mod.submod1,test_mod.subpkg.submod3', '-l']
if outfile:
kp_cmd += ['-o', outfile]
kp_cmd += ['-c', inlined_script]
proc = ub.cmd(kp_cmd, cwd=temp_dpath, verbose=2)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
outfile, = temp_dpath.glob(expected_outfile)
lp_cmd = [sys.executable, '-m', 'line_profiler', str(outfile)]
proc = ub.cmd(lp_cmd)
raw_output = proc.stdout
print(raw_output)
proc.check_returncode()
assert 'Function: add_one' in raw_output
assert 'Function: add_two' not in raw_output
assert 'Function: add_three' in raw_output
@pytest.mark.parametrize(
('explicit_config', 'prof_mod', 'prof_imports', 'profiled_funcs'),
[(True, 'test_mod.submod2', False, {'add_two', 'add_operator'}),
(False, None, False, {'add_one', 'add_operator'}),
(True, 'test_mod.subpkg.submod4', None,
{'add_one', 'add_two', 'add_four', 'add_operator', '_main'}),
(False,
'', # This negates the `prof-mod` configued in the TOML file
True, {})])
def test_autoprofile_with_customized_config(
explicit_config, prof_mod, prof_imports, profiled_funcs):
"""
Test autoprofiling a module with a customized TOML config file.
TOML file
---------
> [tool.line_profiler.kernprof]
> line-by-line = true
> prof-imports = true
> prof-mod = ['test_mod.submod1']
> outfile = 'my_output.lprof'
>
> [tool.line_profiler.cli]
> summarize = true
>
> [tool.line_profiler.show.column_widths]
> line = 8 # 2 wider than the default
"""
docstring = test_autoprofile_with_customized_config.__doc__
toml_content = ub.codeblock('\n'.join(
line.lstrip('>')
for line in (ub.codeblock(docstring).strip('\n')
.partition('----\n')[-1].splitlines())))
lineno_col_width = 8
# Sanity check
all_checked_funcs = {'add_one', 'add_two', 'add_four',
'add_operator', '_main'}
profiled_funcs = set(profiled_funcs)
assert profiled_funcs <= all_checked_funcs
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
_write_demo_module(temp_dpath)
toml = (temp_dpath / 'config.toml').absolute()
toml.write_text(toml_content)
prof = temp_dpath / 'my_output.lprof'
kernprof_cmd = ['kernprof']
lp_cmd = [sys.executable, '-m', 'line_profiler', os.fspath(prof)]
env = os.environ.copy()
if explicit_config:
kernprof_cmd.append('--config=' + str(toml))
lp_cmd.append('--config=' + str(toml))
else:
env['LINE_PROFILER_RC'] = str(toml)
if prof_mod is not None:
kernprof_cmd.extend(['-p', prof_mod])
if prof_imports in (True, False):
kernprof_cmd.append('--{}prof-imports'
.format('' if prof_imports else 'no-'))
kernprof_cmd.extend(['-m', 'test_mod.subpkg.submod4', '1', '2', '3'])
proc = ub.cmd(kernprof_cmd, cwd=temp_dpath, env=env, verbose=2)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
# `outfile` is configured by `tool.line_profiler.kernprof`
assert prof.is_file()
proc = ub.cmd(lp_cmd, cwd=temp_dpath, env=env)
raw_output = proc.stdout
print(raw_output)
proc.check_returncode()
for func in all_checked_funcs:
assert (f'Function: {func}' in raw_output) == (func in profiled_funcs)
# `summarize` is configured by `tool.line_profiler.cli`
assert (f'- {func}' in raw_output) == (func in profiled_funcs)
# Check the column width of the line numbers. which is configured in
# `tool.line_profiler.show.column_widths`
for line in raw_output.splitlines():
if not line:
continue
if line.isspace():
continue
first, *_ = line.split()
if not first.isdecimal():
continue
assert line.index(first) + len(first) == lineno_col_width
@pytest.mark.parametrize('view_in_process', [True, False])
@pytest.mark.parametrize('no_config', [True, False])
def test_autoprofile_with_no_config(no_config, view_in_process):
"""
Test disabling config lookup with the `--no-config` flag.
"""
toml_content = ub.codeblock('''
[tool.line_profiler.show.column_widths]
line = 8 # 2 wider than the default
''')
lineno_col_width = 6 if no_config else 8
with tempfile.TemporaryDirectory() as tmp:
temp_dpath = ub.Path(tmp)
_write_demo_module(temp_dpath)
toml = (temp_dpath / 'line_profiler.toml').absolute()
toml.write_text(toml_content)
prof = temp_dpath / 'my_output.lprof'
kernprof_cmd = ['kernprof',
'-p', 'test_mod.subpkg.submod4',
'-o', 'my_output.lprof',
'-l']
lp_cmd = [sys.executable, '-m', 'line_profiler', os.fspath(prof)]
if view_in_process:
kernprof_cmd.append('--view')
if no_config:
if view_in_process:
kernprof_cmd.append('--no-config')
else:
lp_cmd.insert(-1, '--no-config')
kernprof_cmd.extend(['-m', 'test_mod.subpkg.submod4', '1', '2', '3'])
proc = ub.cmd(kernprof_cmd, cwd=temp_dpath, verbose=2)
print(proc.stdout)
print(proc.stderr)
proc.check_returncode()
assert prof.is_file()
if view_in_process:
raw_output = proc.stdout
else:
proc = ub.cmd(lp_cmd, cwd=temp_dpath)
raw_output = proc.stdout
print(raw_output)
proc.check_returncode()
assert 'Function: add_one' not in raw_output
assert 'Function: add_two' not in raw_output
assert 'Function: add_four' in raw_output
assert 'Function: add_operator' not in raw_output
assert 'Function: _main' in raw_output
# Check the column width of the line numbers. which is configured in
# `tool.line_profiler.show.column_widths`
for line in raw_output.splitlines():
if not line:
continue
if line.isspace():
continue
first, *_ = line.split()
if not first.isdecimal():
continue
assert line.index(first) + len(first) == lineno_col_width
@pytest.mark.parametrize(
('prof_mod', 'profiled_funcs'),
[('my_module',
{'function', 'method', 'class_method', 'static_method', 'descriptor'}),
# `function()` included in profiling via `Class.partial_method()`
('my_module.Class',
{'function', 'method', 'class_method', 'static_method', 'descriptor'}),
('my_module.Class.descriptor', {'descriptor'})])
def test_autoprofile_callable_wrapper_objects(prof_mod, profiled_funcs):
"""
Test that on-import profiling catches various callable-wrapper
object types:
- properties
- staticmethod
- classmethod
- partialmethod
Like it does regular methods and functions.
"""
# Sanity check
all_checked_funcs = {'function', 'method',
'partial_method', 'class_method', 'static_method',
'descriptor'}
profiled_funcs = set(profiled_funcs)
assert profiled_funcs <= all_checked_funcs
# Note: `partial_method()` not to be included as its own item
# because it's a wrapper around `function()`
assert 'partial_method' not in profiled_funcs
with tempfile.TemporaryDirectory() as tmpdir:
temp_dpath = ub.Path(tmpdir)
path = temp_dpath / 'path'
path.mkdir()
(path / 'my_module.py').write_text(ub.codeblock("""
import functools
def function(x):
return
class Class:
def method(self):
return
@classmethod
def class_method(cls):
return
@staticmethod
def static_method():
return
partial_method = functools.partial(function)
@property
def descriptor(self):
return
"""))
(temp_dpath / 'script.py').write_text(ub.codeblock("""
import my_module
if __name__ == '__main__':
pass
"""))
with ub.ChDir(temp_dpath):
args = [sys.executable, '-m', 'kernprof',
'-p', prof_mod, '-lv', 'script.py']
python_path = os.environ.get('PYTHONPATH')
if python_path:
python_path = '{}:{}'.format(path, python_path)
else:
python_path = str(path)
proc = ub.cmd(args,
env={**os.environ, 'PYTHONPATH': python_path},
verbose=2)
raw_output = proc.stdout
print(raw_output)
print(proc.stderr)
proc.check_returncode()
for func in all_checked_funcs:
if sys.version_info[:2] >= (3, 11) and func != 'function':
# Match qualnames, see PR #345
prefix = r'.*\.'
else:
prefix = ''
in_output = re.search(f'^Function: {prefix}{func}',
raw_output,
re.MULTILINE)
assert bool(in_output) == (func in profiled_funcs)
|