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
|
import pytest
import re
from sphinx.application import Sphinx
from sphinx import version_info as sphinx_version
from typer import __version__ as typer_version
import typing as t
import os
from pathlib import Path
import shutil
import subprocess
from bs4 import BeautifulSoup as bs
from sklearn.feature_extraction.text import TfidfVectorizer
from sklearn.metrics.pairwise import cosine_similarity
from skimage import io
from skimage.transform import resize
from pypdf import PdfReader
import numpy as np
import json
TYPER_VERISON = tuple(int(v) for v in typer_version.split("."))
test_callbacks = {}
DOC_DIR = Path(__file__).parent.parent / "doc"
SRC_DIR = DOC_DIR / "source"
BUILD_DIR = DOC_DIR / "build"
CLICK_EXAMPLES = Path(__file__).parent / "click"
TYPER_EXAMPLES = Path(__file__).parent / "typer"
TEST_CALLBACKS = CLICK_EXAMPLES / "callback_record.json"
def check_callback(callback):
if not TEST_CALLBACKS.is_file():
return False
return json.loads(TEST_CALLBACKS.read_text()).get(callback, False)
def clear_callbacks():
if TEST_CALLBACKS.is_file():
os.remove(TEST_CALLBACKS)
def similarity(text1, text2):
"""
Compute the cosine similarity between two texts.
https://en.wikipedia.org/wiki/Cosine_similarity
We use this to lazily evaluate the output of --help to our
renderings.
"""
vectorizer = TfidfVectorizer()
tfidf_matrix = vectorizer.fit_transform([text1, text2])
return cosine_similarity(tfidf_matrix[0:1], tfidf_matrix[1:2])[0][0]
def pdf_text(pdf_path) -> t.List[str]:
"""
Returns a list of page strings.
"""
with open(pdf_path, "rb") as file:
return [page.extract_text() for page in PdfReader(file).pages]
def img_similarity(expected, to_compare):
"""
Calculate the Mean Squared Error between two images.
MSE is a non-negative value, where 0 indicates perfect similarity.
Higher values indicate less similarity.
"""
img_a, img_b = resize_image_to_match(expected, to_compare)
io.imsave(str(expected.parent / f"resized_{expected.name}"), img_a)
err = np.sum((img_a.astype("float") - img_b.astype("float")) ** 2)
err /= float(img_a.shape[0] * img_a.shape[1])
return err
def resize_image_to_match(source_image_path, target_image_path):
target = io.imread(target_image_path)[:, :, :3]
source = io.imread(source_image_path)[:, :, :3]
resized = resize(source, target.shape[0:2], anti_aliasing=True)
return np.clip(resized * 255, 0, 255).astype(np.uint8), target
def replace_in_file(file_path: str, search_string: str, replacement_string: str):
with open(file_path, "r") as file:
file_contents = file.read()
with open(file_path, "w") as file:
file.write(file_contents.replace(search_string, replacement_string))
@pytest.mark.skipif(sphinx_version[0] < 6, reason="Sphinx >=6.0 required to build docs")
def test_sphinx_html_build():
"""
The documentation is extensive and exercises most of the features of the extension so
we just check to see that our documentation builds!
"""
shutil.rmtree(BUILD_DIR / "html", ignore_errors=True)
# Create a Sphinx application instance
app = Sphinx(
SRC_DIR, SRC_DIR, BUILD_DIR / "html", BUILD_DIR / "doctrees", buildername="html"
)
assert app.config.typer_iframe_height_padding == 30
# Build the documentation
app.build()
# Test passes if no Sphinx errors occurred during build
assert not app.statuscode, "Sphinx documentation build failed"
def test_sphinx_text_build():
shutil.rmtree(BUILD_DIR / "text", ignore_errors=True)
# Create a Sphinx application instance
app = Sphinx(
SRC_DIR, SRC_DIR, BUILD_DIR / "text", BUILD_DIR / "doctrees", buildername="text"
)
# Build the documentation
app.build()
assert not app.statuscode, "Sphinx documentation build failed"
def test_sphinx_latex_build():
shutil.rmtree(BUILD_DIR / "latex", ignore_errors=True)
# Create a Sphinx application instance
app = Sphinx(
SRC_DIR,
SRC_DIR,
BUILD_DIR / "latex",
BUILD_DIR / "doctrees",
buildername="latex",
)
# Build the documentation
app.build()
assert not app.statuscode, "Sphinx documentation build failed"
def build_example(
name,
builder,
example_dir=CLICK_EXAMPLES,
clean_first=True,
subprocess=False,
project=None,
):
cwd = os.getcwd()
ex_dir = example_dir / name
bld_dir = ex_dir / "build"
if clean_first and bld_dir.exists():
shutil.rmtree(bld_dir)
os.chdir(example_dir / name)
if not subprocess:
app = Sphinx(
ex_dir,
example_dir,
bld_dir / builder,
bld_dir / "doctrees",
buildername=builder,
)
assert app.config.typer_iframe_height_padding == 40
# Build the documentation
app.build()
else:
assert (
os.system(
f"uv run sphinx-build {ex_dir} {bld_dir / builder} -c {ex_dir.parent}"
)
== 0
)
os.chdir(cwd)
if builder == "html":
result = (bld_dir / builder / "index.html").read_text()
elif builder == "text":
result = (bld_dir / builder / "index.txt").read_text()
elif builder == "latex":
if not project:
from conf import project
result = (
bld_dir / builder / f"{project.lower().replace(' ', '')}.tex"
).read_text()
return bld_dir / builder, result
def scrub(output: str) -> str:
"""Scrub control code characters and ansi escape sequences for terminal colors from output"""
return re.sub(r"\[\d+(?:;\d+)*m", "", output).replace("\t", "")
def get_ex_help(name, *subcommands, example_dir, command_file=None):
ret = subprocess.run(
[
"uv",
"run",
"python",
example_dir / name / f"{command_file or name}.py",
*subcommands,
"--help",
],
capture_output=True,
env={
**os.environ,
"PYTHONPATH": f"{os.environ.get('PYTHONPATH', '$PYTHONPATH')}:{example_dir / name}",
"TERMINAL_WIDTH": str(os.environ.get("TERMINAL_WIDTH", 80)),
},
)
return ret.stdout.decode() or ret.stderr.decode()
def get_click_ex_help(name, *subcommands):
return get_ex_help(name, *subcommands, example_dir=CLICK_EXAMPLES)
def get_typer_ex_help(name, *subcommands, command_file=None):
return scrub(
get_ex_help(
name, *subcommands, example_dir=TYPER_EXAMPLES, command_file=command_file
)
)
def check_html(html, help_txt, iframe_number=0, threshold=0.85):
soup = bs(html, "html.parser")
iframes = soup.find_all("iframe")
iframe = iframes[iframe_number]
assert iframe is not None
iframe_src = bs(iframe.attrs["srcdoc"], "html.parser")
assert iframe_src is not None
code = iframe_src.find("code")
assert code is not None
assert similarity(code.text, help_txt) > threshold
return code.text
def check_svg(html, help_txt, svg_number=0, threshold=0.75):
soup = bs(html, "html.parser")
svg = soup.find_all("svg")[svg_number]
assert svg is not None
txt = svg.text.strip().replace("\xa0", " ")
assert similarity(txt, help_txt) > threshold
return txt
def check_text(html, help_txt, txt_number=0, threshold=0.95):
soup = bs(html, "html.parser")
txt = soup.find_all("pre")[txt_number]
txt = txt.text.strip()
for element in ["<pre>", "<span>", "</span>", "</pre>"]:
txt = txt.strip(element)
assert txt is not None
sim = similarity(txt, help_txt)
assert sim > threshold, f"{sim} is below threshold {threshold}"
return txt
def test_click_ex_validation():
clear_callbacks()
bld_dir, html = build_example("validation", "html")
help_txt = get_click_ex_help("validation")
check_html(html, help_txt)
assert check_callback("typer_render_html")
assert check_callback("typer_get_iframe_height")
assert not check_callback("typer_get_web_driver")
check_svg(html, help_txt, threshold=0.7)
check_text(html, help_txt)
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_click_ex_termui():
"""
tests :make-sections: and :show-nested: options
"""
clear_callbacks()
bld_dir, html = build_example("termui", "html")
help_txt = get_click_ex_help("termui")
clear_help = get_click_ex_help("termui", "clear")
colordemo_help = get_click_ex_help("termui", "colordemo")
edit_help = get_click_ex_help("termui", "edit")
locate_help = get_click_ex_help("termui", "locate")
menu_help = get_click_ex_help("termui", "menu")
open_help = get_click_ex_help("termui", "open")
pager_help = get_click_ex_help("termui", "pager")
pause_help = get_click_ex_help("termui", "pause")
progress_help = get_click_ex_help("termui", "progress")
# verifies :show-nested:
check_html(html, help_txt)
check_html(html, clear_help, 1)
check_html(html, colordemo_help, 2)
check_html(html, edit_help, 3)
check_html(html, locate_help, 4)
check_html(html, menu_help, 5)
check_html(html, open_help, 6)
check_html(html, pager_help, 7)
check_html(html, pause_help, 8)
check_html(html, progress_help, 9)
check_html(html, menu_help, 10)
# verify :make-sections:
soup = bs(html, "html.parser")
assert soup.find("section").find("h1").text.startswith("termui")
assert soup.find_all("section")[1].find("h2").text.startswith("clear")
assert soup.find_all("section")[2].find("h2").text.startswith("colordemo")
assert soup.find_all("section")[3].find("h2").text.startswith("edit")
assert soup.find_all("section")[4].find("h2").text.startswith("locate")
assert soup.find_all("section")[5].find("h2").text.startswith("menu")
assert soup.find_all("section")[6].find("h2").text.startswith("open")
assert soup.find_all("section")[7].find("h2").text.startswith("pager")
assert soup.find_all("section")[8].find("h2").text.startswith("pause")
assert soup.find_all("section")[9].find("h2").text.startswith("progress")
assert soup.find_all("section")[10].find("h1").text.startswith("termui menu")
# verify correct name of subcommand
assert (
"Usage: termui menu [OPTIONS]"
in bs(soup.find_all("iframe")[10].attrs["srcdoc"], "html.parser")
.find("code")
.text
)
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_click_ex_repo():
"""
tests :make-sections: and :show-nested: options
"""
clear_callbacks()
bld_dir, html = build_example("repo", "html")
help_txt = get_click_ex_help("repo")
clone_help = get_click_ex_help("repo", "clone")
commit_help = get_click_ex_help("repo", "commit")
copy_help = get_click_ex_help("repo", "copy")
delete_help = get_click_ex_help("repo", "delete")
setuser_help = get_click_ex_help("repo", "setuser")
# verifies :show-nested:
check_html(html, help_txt)
check_html(html, clone_help, 1)
check_html(html, commit_help, 2)
check_html(html, copy_help, 3)
check_html(html, delete_help, 4)
check_html(html, setuser_help, 5)
# verify :make-sections:
soup = bs(html, "html.parser")
assert len(soup.find_all("section")) == 0, "Should not have rendered any sections"
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_click_ex_naval():
"""
tests :make-sections: and :show-nested: options for multi level hierarchies
"""
clear_callbacks()
bld_dir, html = build_example("naval", "html")
help_txt = get_click_ex_help("naval")
mine_help = get_click_ex_help("naval", "mine")
mine_remove_help = get_click_ex_help("naval", "mine", "remove")
mine_set_help = get_click_ex_help("naval", "mine", "set")
ship_help = get_click_ex_help("naval", "ship")
ship_move_help = get_click_ex_help("naval", "ship", "move")
ship_new_help = get_click_ex_help("naval", "ship", "new")
ship_shoot_help = get_click_ex_help("naval", "ship", "shoot")
# verifies :show-nested:
check_svg(html, help_txt)
check_svg(html, mine_help, 1)
check_svg(html, mine_remove_help, 2, threshold=0.65)
check_svg(html, mine_set_help, 3, threshold=0.60)
check_svg(html, ship_help, 4)
check_svg(html, ship_move_help, 5, threshold=0.52)
check_svg(html, ship_new_help, 6)
check_svg(html, ship_shoot_help, 7, threshold=0.57)
check_svg(html, ship_new_help, 8)
# verify :make-sections:
soup = bs(html, "html.parser")
assert len(soup.find_all("section")) == 9, "Should have rendered 8 sections"
soup = bs(html, "html.parser")
assert soup.find("section").find("h1").text.startswith("naval")
assert soup.find_all("section")[1].find("h2").text.startswith("mine")
assert soup.find_all("section")[2].find("h3").text.startswith("remove")
assert soup.find_all("section")[3].find("h3").text.startswith("set")
assert soup.find_all("section")[4].find("h2").text.startswith("ship")
assert soup.find_all("section")[5].find("h3").text.startswith("move")
assert soup.find_all("section")[6].find("h3").text.startswith("new")
assert soup.find_all("section")[7].find("h3").text.startswith("shoot")
assert soup.find_all("section")[8].find("h1").text.startswith("naval ship new")
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_click_ex_inout():
"""
tests :make-sections: and :show-nested: options for multi level hierarchies
"""
clear_callbacks()
bld_dir, html = build_example("inout", "html")
help_txt = get_click_ex_help("inout")
# verifies :show-nested:
check_html(html, help_txt)
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_click_ex_complex():
"""
tests :make-sections: and :show-nested: options for multi level hierarchies
"""
clear_callbacks()
bld_dir, html = build_example("complex", "html")
check_text(
html,
"""
Usage: complex [OPTIONS] COMMAND [ARGS]...
A complex command line interface.
╭─ Options ─────────────────────────────────────────────────────╮
│ --home DIRECTORY Changes the folder to operate │
│ on. │
│ --verbose -v Enables verbose mode. │
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────╮
│ init Initializes a repo. │
│ status Shows file changes. │
╰───────────────────────────────────────────────────────────────╯
""",
threshold=0.8,
)
check_text(
html,
"""
Usage: complex init [OPTIONS] [PATH]
Initializes a repository.
╭─ Arguments ───────────────────────────────────────────────────╮
│ path [PATH] │
╰───────────────────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────╯
""",
1,
)
check_text(
html,
"""
Usage: complex status [OPTIONS]
Shows file changes in the current working directory.
╭─ Options ─────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────╯
""",
2,
)
soup = bs(html, "html.parser")
assert soup.find("section").find("h1").text.startswith("complex")
for idx, cmd in enumerate(["init", "status"]):
assert soup.find_all("section")[idx + 1].find("h2").text.startswith(cmd)
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_click_ex_completion():
clear_callbacks()
bld_dir, html = build_example("completion", "html")
subcommands = ["group", "group select-user", "ls", "show-env"]
helps = [
get_click_ex_help("completion"),
*[get_click_ex_help("completion", *cmd.split()) for cmd in subcommands],
]
for idx, help in enumerate(helps):
check_text(html, help, idx, threshold=0.82)
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_click_ex_aliases():
clear_callbacks()
bld_dir, html = build_example("aliases", "html")
# we test that list_commands order is honored
subcommands = reversed(["alias", "clone", "commit", "pull", "push", "status"])
helps = [
get_click_ex_help("aliases"),
*[get_click_ex_help("aliases", *cmd.split()) for cmd in subcommands],
]
for idx, help in enumerate(helps):
check_text(html, help, idx, threshold=0.82)
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_click_ex_imagepipe():
"""
tests a chained command
"""
clear_callbacks()
bld_dir, html = build_example("imagepipe", "html")
subcommands = [
"blur",
"crop",
"display",
"emboss",
"open",
"paste",
"resize",
"save",
"sharpen",
"smoothen",
"transpose",
]
helps = [
get_click_ex_help("imagepipe"),
*[get_click_ex_help("imagepipe", cmd) for cmd in subcommands],
]
for idx, help in enumerate(helps):
check_text(html, help, idx, threshold=0.87)
check_svg(html, helps[-3], threshold=0.7)
soup = bs(html, "html.parser")
assert len(soup.find_all("section")) == 15, "Should have rendered 13 sections"
assert soup.find("section").find("h1").text.startswith("imagepipe")
for idx, cmd in enumerate(subcommands):
assert soup.find_all("section")[idx + 1].find("h2").text.startswith(cmd)
assert (
soup.find_all("section")[len(subcommands) + 1]
.find("h1")
.text.startswith("imagepipe sharpen")
)
# check the cross references:
assert soup.find_all("section")[-2].find("h1").text.startswith("References")
def check_refs(section, local):
for li, anchor in zip(
section.find_all("li"),
[
"imagepipe",
"imagepipe-blur",
"imagepipe-crop",
"imagepipe-display",
"imagepipe-emboss",
"imagepipe-open",
"imagepipe-paste",
"imagepipe-resize",
"imagepipe-save",
"imagepipe-smoothen",
"imagepipe-transpose",
"imagepipe-sharpen",
],
):
if local:
assert li.find("a").attrs["href"] == f"#{anchor}"
else:
assert li.find("a").attrs["href"] == f"index.html#{anchor}"
if "sharpen" not in anchor:
assert li.find("a").text == " ".join(anchor.split("-"))
else:
# test special link text
assert li.find("a").text == "sharpen"
check_refs(soup.find_all("section")[-2], local=True)
# check references page
refs = bs((bld_dir / "references.html").read_text(), "html.parser")
check_refs(refs.find_all("section")[1], local=False)
assert (
refs.find_all("section")[1].find_all("a")[-1].text == ":typer:`bad-reference`"
)
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_typer_ex_reference():
clear_callbacks()
html_dir, index_html = build_example(
"reference", "html", example_dir=TYPER_EXAMPLES
)
doc_help = check_svg(
(html_dir / "reference.html").read_text(),
get_typer_ex_help("reference", command_file="cli-ref"),
0,
threshold=0.82,
)
assert "python -m cli-ref.py" in doc_help
index = bs(index_html, "html.parser")
ref1, ref2, ref3 = tuple(
index.find_all("section")[0].find_all("p")[0].find_all("a")
)
for ref in (ref1, ref2):
assert ref.text == "python -m cli-ref.py"
assert ref.attrs["href"] == "reference.html#python-m-cli-ref-py"
assert ref3.text == "command"
assert ref3.attrs["href"] == "reference.html#python-m-cli-ref-py"
def test_typer_ex_composite():
EX_DIR = TYPER_EXAMPLES / "composite/composite"
cli_py = EX_DIR / "cli.py"
group_py = EX_DIR / "group.py"
echo_py = EX_DIR / "echo.py"
try:
clear_callbacks()
def test_build(first=False):
_, html = build_example(
"composite",
"html",
example_dir=TYPER_EXAMPLES,
clean_first=first,
subprocess=True,
)
# we test that list_commands order is honored
subcommands = ["subgroup", "subgroup multiply", "subgroup echo", "repeat"]
helps = [
get_typer_ex_help("composite", command_file="composite/cli"),
*[
get_typer_ex_help(
"composite", *cmd.split(), command_file="composite/cli"
)
for cmd in subcommands
],
]
doc_helps = []
for idx, help in enumerate(helps):
doc_helps.append(check_text(html, help, idx, threshold=0.88))
return doc_helps
index_html = TYPER_EXAMPLES / "composite/build/html/index.html"
composite_html = TYPER_EXAMPLES / "composite/build/html/composite.html"
echo_html = TYPER_EXAMPLES / "composite/build/html/echo.html"
multiply_html = TYPER_EXAMPLES / "composite/build/html/multiply.html"
repeat_html = TYPER_EXAMPLES / "composite/build/html/repeat.html"
subgroup_html = TYPER_EXAMPLES / "composite/build/html/subgroup.html"
files = [
index_html,
composite_html,
echo_html,
multiply_html,
repeat_html,
subgroup_html,
]
test_build(first=True)
times = [pth.stat().st_mtime for pth in files]
test_build()
times2 = [pth.stat().st_mtime for pth in files]
assert times == times2, "Rebuild was not cached!"
# test that
replace_in_file(
cli_py, "Lets do stuff with strings.", "XX Lets do stuff with strings. XX"
)
txts = test_build()
times3 = [pth.stat().st_mtime for pth in files]
for idx, (t3, t2) in enumerate(zip(times3, times2)):
assert t3 > t2, f"file {files[idx]} not regenerated."
assert "XX Lets do stuff with strings. XX" in txts[0]
replace_in_file(
group_py, "Subcommands are here.", "XX Subcommands are here. XX"
)
helps = test_build()
assert "XX Subcommands are here. XX" in helps[0]
assert "XX Subcommands are here. XX" in helps[1]
times4 = [pth.stat().st_mtime for pth in files]
for idx, (t4, t3) in enumerate(zip(times4, times3)):
if files[idx].name in ["echo.html", "multiply.html", "repeat.html"]:
continue
assert t4 > t3, f"file {files[idx]} not regenerated."
replace_in_file(
echo_py, "def echo(name: str):", "def echo(name: str, name2: str):"
)
helps = test_build()
assert "name2" in helps[3]
times5 = [pth.stat().st_mtime for pth in files]
for idx, (t5, t4) in enumerate(zip(times5, times4)):
if files[idx].name in ["composite.html", "multiply.html", "repeat.html"]:
continue
assert t5 > t4, f"file {files[idx]} not regenerated."
# check navbar
navitems = list(
bs(index_html.read_text()).find("div", class_="sphinxsidebar").find_all("a")
)
assert navitems[1].text == "composite"
assert navitems[2].text.strip() == "python -m cli.py repeat"
assert navitems[3].text == "cli subgroup"
assert navitems[4].text == "cli subgroup echo"
assert navitems[5].text == "cli subgroup multiply"
finally:
os.system(f"git checkout {cli_py}")
os.system(f"git checkout {group_py}")
os.system(f"git checkout {echo_py}")
def test_click_text_build_works():
bld_dir, text = build_example("validation", "text")
help_txt = get_click_ex_help("validation")
assert similarity(text, help_txt) > 0.95
assert text.count("Usage:") == 3, "Should have rendered the help 3 times as text"
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_click_latex_build_works():
"""
also tests the convert-png option and typer_svg2pdf and typer_convert_png callbacks.
"""
bld_dir, latex = build_example("validation", "latex")
help_txt = get_click_ex_help("validation")
assert check_callback("typer_svg2pdf")
assert check_callback("typer_convert_png")
# make sure the expected text rendered at least once
assert latex.count("Usage: validation [OPTIONS]") == 1
# get all pdf files from the build directory
pdf = bld_dir / "validation_2a8082c3.pdf"
assert (bld_dir / "validation_2a8082c3.svg").is_file()
assert len(list(bld_dir.glob("**/*.pdf"))) == 1, (
"Should have rendered the help 1 time as pdf"
)
assert pdf.name.split(".")[0] in latex
pdf_txt = pdf_text(pdf)[0]
assert similarity(pdf_txt, help_txt) > 0.95
assert len(list(bld_dir.glob("**/*.png"))) == 1, (
"Should have rendered the help 1 time as png"
)
html_png = bld_dir / "validation_4697b61f.png"
assert img_similarity(CLICK_EXAMPLES / "validation" / "html.png", html_png) < 9000
if bld_dir.exists():
shutil.rmtree(bld_dir.parent)
def test_enums():
from sphinxcontrib.typer import RenderTarget, RenderTheme
for target in RenderTarget:
assert target.value == str(target)
for theme in RenderTheme:
assert theme.value == str(theme)
|