[{"data":1,"prerenderedAt":2739},["ShallowReactive",2],{"page-\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis\u002F":3,"content-directory":1894},{"id":4,"title":5,"body":6,"date":1878,"description":1879,"difficulty":1880,"draft":1881,"extension":1882,"meta":1883,"navigation":148,"path":1884,"seo":1885,"stem":1886,"tags":1887,"updated":1878,"__hash__":1893},"content\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis\u002Findex.md","Testing Shell Completion in Python CLIs",{"type":7,"value":8,"toc":1858},"minimark",[9,24,29,43,47,51,62,65,69,72,96,100,107,475,479,511,1033,1052,1055,1058,1063,1095,1327,1330,1334,1345,1690,1701,1705,1746,1750,1765,1769,1773,1788,1792,1795,1799,1806,1810,1813,1817,1820,1824,1854],[10,11,12,13,17,18,23],"p",{},"Shell completion is the feature most likely to be broken without anyone noticing. It is invisible in ",[14,15,16],"code",{},"--help",", nobody presses Tab in CI, and a refactor that renames an option, moves a command into a group or changes a callback's signature leaves completion silently returning nothing. Users notice weeks later, assume completion \"just doesn't work\" for your tool, and stop trying. Completion is also easy to test once you know how it works: the shell runs your program with a few environment variables set, and your program prints the candidates and exits. This guide tests completion at three levels — the callback, the completion protocol, and a real bash session — shows the differences between Typer's and Click's protocols that trip up most tests, and explains which level is worth running where. It belongs to the ",[19,20,22],"a",{"href":21},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002F","shell completion for Python CLIs topic",".",[25,26,28],"h2",{"id":27},"prerequisites","Prerequisites",[30,31,32,40],"ul",{},[33,34,35,36,23],"li",{},"A Typer or Click CLI with completion enabled, as in ",[19,37,39],{"href":38},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fenabling-tab-completion-in-click-and-typer\u002F","enabling tab completion in Click and Typer",[33,41,42],{},"pytest; bash for the optional end-to-end level.",[25,44,46],{"id":45},"how-completion-works","How completion works",[48,49],"inline-diagram",{"name":50},"ct-protocol",[10,52,53,54,57,58,61],{},"When you press Tab, the shell calls a small function that was installed by the completion script. That function runs your CLI with an environment variable named after the program — ",[14,55,56],{},"_MYTOOL_COMPLETE"," for ",[14,59,60],{},"mytool"," — plus variables describing the words typed so far. Your CLI notices the variable, parses the words, works out whether the cursor is on a command, an option or an option's value, calls the matching completion callback, prints one candidate per line and exits without running any command. The shell function turns those lines into the completion menu.",[10,63,64],{},"A test can play the part of the shell function: set the same variables, run the CLI, read the lines.",[25,66,68],{"id":67},"three-levels-of-test","Three levels of test",[48,70],{"name":71},"ct-layers",[10,73,74,78,79,83,84,87,88,91,92,95],{},[75,76,77],"strong",{},"Callbacks"," are plain functions, so test them directly for their filtering and caching logic, as in ",[19,80,82],{"href":81},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fdynamic-completion-values-from-apis-and-files\u002F","dynamic completion values from APIs and files",". ",[75,85,86],{},"The protocol"," level runs the whole CLI through the framework's completion code, which catches wiring mistakes — a callback attached to the wrong option, a renamed command, a signature the framework no longer calls correctly. ",[75,89,90],{},"The real shell"," level sources the generated script into bash and checks ",[14,93,94],{},"COMPREPLY",", which catches problems in the script itself and in how the program is installed.",[25,97,99],{"id":98},"the-app-under-test","The app under test",[10,101,102,103,106],{},"A small Typer app with two commands and a dynamic value for ",[14,104,105],{},"--env",":",[108,109,114],"pre",{"className":110,"code":111,"language":112,"meta":113,"style":113},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fcli.py\nfrom __future__ import annotations\n\nimport typer\n\napp = typer.Typer()\n\nENVIRONMENTS = {\"prod-eu\": \"Production, Frankfurt\", \"prod-us\": \"Production, Virginia\",\n                \"staging\": \"Staging\"}\n\n\ndef complete_env(incomplete: str) -> list[tuple[str, str]]:\n    return [(name, help) for name, help in ENVIRONMENTS.items() if name.startswith(incomplete)]\n\n\n@app.callback()\ndef main() -> None:\n    \"\"\"Deploy things.\"\"\"\n\n\n@app.command()\ndef deploy(env: str = typer.Option(..., \"--env\", autocompletion=complete_env),\n           force: bool = typer.Option(False, \"--force\")) -> None:\n    \"\"\"Deploy to ENV.\"\"\"\n\n\n@app.command()\ndef status() -> None:\n    \"\"\"Show status.\"\"\"\n","python","",[14,115,116,125,143,150,159,164,176,181,217,231,236,241,269,307,312,317,326,343,349,354,359,367,404,432,438,443,448,455,469],{"__ignoreMap":113},[117,118,121],"span",{"class":119,"line":120},"line",1,[117,122,124],{"class":123},"sJ8bj","# src\u002Fmytool\u002Fcli.py\n",[117,126,128,132,136,139],{"class":119,"line":127},2,[117,129,131],{"class":130},"szBVR","from",[117,133,135],{"class":134},"sj4cs"," __future__",[117,137,138],{"class":130}," import",[117,140,142],{"class":141},"sVt8B"," annotations\n",[117,144,146],{"class":119,"line":145},3,[117,147,149],{"emptyLinePlaceholder":148},true,"\n",[117,151,153,156],{"class":119,"line":152},4,[117,154,155],{"class":130},"import",[117,157,158],{"class":141}," typer\n",[117,160,162],{"class":119,"line":161},5,[117,163,149],{"emptyLinePlaceholder":148},[117,165,167,170,173],{"class":119,"line":166},6,[117,168,169],{"class":141},"app ",[117,171,172],{"class":130},"=",[117,174,175],{"class":141}," typer.Typer()\n",[117,177,179],{"class":119,"line":178},7,[117,180,149],{"emptyLinePlaceholder":148},[117,182,184,187,190,193,197,200,203,206,209,211,214],{"class":119,"line":183},8,[117,185,186],{"class":134},"ENVIRONMENTS",[117,188,189],{"class":130}," =",[117,191,192],{"class":141}," {",[117,194,196],{"class":195},"sZZnC","\"prod-eu\"",[117,198,199],{"class":141},": ",[117,201,202],{"class":195},"\"Production, Frankfurt\"",[117,204,205],{"class":141},", ",[117,207,208],{"class":195},"\"prod-us\"",[117,210,199],{"class":141},[117,212,213],{"class":195},"\"Production, Virginia\"",[117,215,216],{"class":141},",\n",[117,218,220,223,225,228],{"class":119,"line":219},9,[117,221,222],{"class":195},"                \"staging\"",[117,224,199],{"class":141},[117,226,227],{"class":195},"\"Staging\"",[117,229,230],{"class":141},"}\n",[117,232,234],{"class":119,"line":233},10,[117,235,149],{"emptyLinePlaceholder":148},[117,237,239],{"class":119,"line":238},11,[117,240,149],{"emptyLinePlaceholder":148},[117,242,244,247,251,254,257,260,262,264,266],{"class":119,"line":243},12,[117,245,246],{"class":130},"def",[117,248,250],{"class":249},"sScJk"," complete_env",[117,252,253],{"class":141},"(incomplete: ",[117,255,256],{"class":134},"str",[117,258,259],{"class":141},") -> list[tuple[",[117,261,256],{"class":134},[117,263,205],{"class":141},[117,265,256],{"class":134},[117,267,268],{"class":141},"]]:\n",[117,270,272,275,278,281,284,287,290,292,295,298,301,304],{"class":119,"line":271},13,[117,273,274],{"class":130},"    return",[117,276,277],{"class":141}," [(name, ",[117,279,280],{"class":134},"help",[117,282,283],{"class":141},") ",[117,285,286],{"class":130},"for",[117,288,289],{"class":141}," name, ",[117,291,280],{"class":134},[117,293,294],{"class":130}," in",[117,296,297],{"class":134}," ENVIRONMENTS",[117,299,300],{"class":141},".items() ",[117,302,303],{"class":130},"if",[117,305,306],{"class":141}," name.startswith(incomplete)]\n",[117,308,310],{"class":119,"line":309},14,[117,311,149],{"emptyLinePlaceholder":148},[117,313,315],{"class":119,"line":314},15,[117,316,149],{"emptyLinePlaceholder":148},[117,318,320,323],{"class":119,"line":319},16,[117,321,322],{"class":249},"@app.callback",[117,324,325],{"class":141},"()\n",[117,327,329,331,334,337,340],{"class":119,"line":328},17,[117,330,246],{"class":130},[117,332,333],{"class":249}," main",[117,335,336],{"class":141},"() -> ",[117,338,339],{"class":134},"None",[117,341,342],{"class":141},":\n",[117,344,346],{"class":119,"line":345},18,[117,347,348],{"class":195},"    \"\"\"Deploy things.\"\"\"\n",[117,350,352],{"class":119,"line":351},19,[117,353,149],{"emptyLinePlaceholder":148},[117,355,357],{"class":119,"line":356},20,[117,358,149],{"emptyLinePlaceholder":148},[117,360,362,365],{"class":119,"line":361},21,[117,363,364],{"class":249},"@app.command",[117,366,325],{"class":141},[117,368,370,372,375,378,380,382,385,388,390,393,395,399,401],{"class":119,"line":369},22,[117,371,246],{"class":130},[117,373,374],{"class":249}," deploy",[117,376,377],{"class":141},"(env: ",[117,379,256],{"class":134},[117,381,189],{"class":130},[117,383,384],{"class":141}," typer.Option(",[117,386,387],{"class":134},"...",[117,389,205],{"class":141},[117,391,392],{"class":195},"\"--env\"",[117,394,205],{"class":141},[117,396,398],{"class":397},"s4XuR","autocompletion",[117,400,172],{"class":130},[117,402,403],{"class":141},"complete_env),\n",[117,405,407,410,413,415,417,420,422,425,428,430],{"class":119,"line":406},23,[117,408,409],{"class":141},"           force: ",[117,411,412],{"class":134},"bool",[117,414,189],{"class":130},[117,416,384],{"class":141},[117,418,419],{"class":134},"False",[117,421,205],{"class":141},[117,423,424],{"class":195},"\"--force\"",[117,426,427],{"class":141},")) -> ",[117,429,339],{"class":134},[117,431,342],{"class":141},[117,433,435],{"class":119,"line":434},24,[117,436,437],{"class":195},"    \"\"\"Deploy to ENV.\"\"\"\n",[117,439,441],{"class":119,"line":440},25,[117,442,149],{"emptyLinePlaceholder":148},[117,444,446],{"class":119,"line":445},26,[117,447,149],{"emptyLinePlaceholder":148},[117,449,451,453],{"class":119,"line":450},27,[117,452,364],{"class":249},[117,454,325],{"class":141},[117,456,458,460,463,465,467],{"class":119,"line":457},28,[117,459,246],{"class":130},[117,461,462],{"class":249}," status",[117,464,336],{"class":141},[117,466,339],{"class":134},[117,468,342],{"class":141},[117,470,472],{"class":119,"line":471},29,[117,473,474],{"class":195},"    \"\"\"Show status.\"\"\"\n",[25,476,478],{"id":477},"the-recipe-testing-the-protocol","The recipe: testing the protocol",[10,480,481,482,205,485,488,489,492,493,495,496,499,500,503,504,507,508,106],{},"Typer's protocol uses ",[14,483,484],{},"complete_bash",[14,486,487],{},"complete_zsh"," and ",[14,490,491],{},"complete_fish"," as values of ",[14,494,56],{},". Bash passes the words in ",[14,497,498],{},"COMP_WORDS"," and the cursor position in ",[14,501,502],{},"COMP_CWORD","; zsh and fish use ",[14,505,506],{},"_TYPER_COMPLETE_ARGS",". A helper sets all of them and runs the app through ",[14,509,510],{},"CliRunner",[108,512,514],{"className":110,"code":513,"language":112,"meta":113,"style":113},"# tests\u002Ftest_completion_typer.py\nfrom typer.testing import CliRunner\n\nfrom mytool.cli import app\n\nrunner = CliRunner()\n\n\ndef complete(line: str, shell: str = \"bash\") -> list[str]:\n    \"\"\"Ask the app for completions the way the shell script does, and return the lines.\"\"\"\n    words = line.split(\" \")\n    env = {\"_MYTOOL_COMPLETE\": f\"complete_{shell}\",\n           \"COMP_WORDS\": line, \"COMP_CWORD\": str(len(words) - 1),   # bash\n           \"_TYPER_COMPLETE_ARGS\": line}                               # zsh, fish\n    if shell == \"fish\":\n        env[\"_TYPER_COMPLETE_FISH_ACTION\"] = \"get-args\"\n    result = runner.invoke(app, [], env=env, prog_name=\"mytool\")\n    assert result.exit_code == 0, result.output\n    return [line for line in result.output.splitlines() if line]   # bash ends with a blank line\n\n\ndef test_subcommands():\n    assert complete(\"mytool \") == [\"deploy\", \"status\"]\n\n\ndef test_options_of_a_command():\n    assert {\"--env\", \"--force\"} \u003C= set(complete(\"mytool deploy --\"))\n\n\ndef test_dynamic_values_are_filtered_by_prefix():\n    assert complete(\"mytool deploy --env prod-\") == [\"prod-eu\", \"prod-us\"]\n\n\ndef test_fish_gets_descriptions():\n    assert complete(\"mytool deploy --env st\", shell=\"fish\") == [\"staging\\tStaging\"]\n\n\ndef test_no_match_means_no_candidates():\n    assert complete(\"mytool deploy --env zz\") == []\n",[14,515,516,521,533,537,549,553,563,567,571,601,606,622,656,692,703,719,735,763,779,805,809,813,823,851,855,859,868,898,902,906,916,940,945,950,960,996,1001,1006,1016],{"__ignoreMap":113},[117,517,518],{"class":119,"line":120},[117,519,520],{"class":123},"# tests\u002Ftest_completion_typer.py\n",[117,522,523,525,528,530],{"class":119,"line":127},[117,524,131],{"class":130},[117,526,527],{"class":141}," typer.testing ",[117,529,155],{"class":130},[117,531,532],{"class":141}," CliRunner\n",[117,534,535],{"class":119,"line":145},[117,536,149],{"emptyLinePlaceholder":148},[117,538,539,541,544,546],{"class":119,"line":152},[117,540,131],{"class":130},[117,542,543],{"class":141}," mytool.cli ",[117,545,155],{"class":130},[117,547,548],{"class":141}," app\n",[117,550,551],{"class":119,"line":161},[117,552,149],{"emptyLinePlaceholder":148},[117,554,555,558,560],{"class":119,"line":166},[117,556,557],{"class":141},"runner ",[117,559,172],{"class":130},[117,561,562],{"class":141}," CliRunner()\n",[117,564,565],{"class":119,"line":178},[117,566,149],{"emptyLinePlaceholder":148},[117,568,569],{"class":119,"line":183},[117,570,149],{"emptyLinePlaceholder":148},[117,572,573,575,578,581,583,586,588,590,593,596,598],{"class":119,"line":219},[117,574,246],{"class":130},[117,576,577],{"class":249}," complete",[117,579,580],{"class":141},"(line: ",[117,582,256],{"class":134},[117,584,585],{"class":141},", shell: ",[117,587,256],{"class":134},[117,589,189],{"class":130},[117,591,592],{"class":195}," \"bash\"",[117,594,595],{"class":141},") -> list[",[117,597,256],{"class":134},[117,599,600],{"class":141},"]:\n",[117,602,603],{"class":119,"line":233},[117,604,605],{"class":195},"    \"\"\"Ask the app for completions the way the shell script does, and return the lines.\"\"\"\n",[117,607,608,611,613,616,619],{"class":119,"line":238},[117,609,610],{"class":141},"    words ",[117,612,172],{"class":130},[117,614,615],{"class":141}," line.split(",[117,617,618],{"class":195},"\" \"",[117,620,621],{"class":141},")\n",[117,623,624,627,629,631,634,636,639,642,645,648,651,654],{"class":119,"line":243},[117,625,626],{"class":141},"    env ",[117,628,172],{"class":130},[117,630,192],{"class":141},[117,632,633],{"class":195},"\"_MYTOOL_COMPLETE\"",[117,635,199],{"class":141},[117,637,638],{"class":130},"f",[117,640,641],{"class":195},"\"complete_",[117,643,644],{"class":134},"{",[117,646,647],{"class":141},"shell",[117,649,650],{"class":134},"}",[117,652,653],{"class":195},"\"",[117,655,216],{"class":141},[117,657,658,661,664,667,669,671,674,677,680,683,686,689],{"class":119,"line":271},[117,659,660],{"class":195},"           \"COMP_WORDS\"",[117,662,663],{"class":141},": line, ",[117,665,666],{"class":195},"\"COMP_CWORD\"",[117,668,199],{"class":141},[117,670,256],{"class":134},[117,672,673],{"class":141},"(",[117,675,676],{"class":134},"len",[117,678,679],{"class":141},"(words) ",[117,681,682],{"class":130},"-",[117,684,685],{"class":134}," 1",[117,687,688],{"class":141},"),   ",[117,690,691],{"class":123},"# bash\n",[117,693,694,697,700],{"class":119,"line":309},[117,695,696],{"class":195},"           \"_TYPER_COMPLETE_ARGS\"",[117,698,699],{"class":141},": line}                               ",[117,701,702],{"class":123},"# zsh, fish\n",[117,704,705,708,711,714,717],{"class":119,"line":314},[117,706,707],{"class":130},"    if",[117,709,710],{"class":141}," shell ",[117,712,713],{"class":130},"==",[117,715,716],{"class":195}," \"fish\"",[117,718,342],{"class":141},[117,720,721,724,727,730,732],{"class":119,"line":319},[117,722,723],{"class":141},"        env[",[117,725,726],{"class":195},"\"_TYPER_COMPLETE_FISH_ACTION\"",[117,728,729],{"class":141},"] ",[117,731,172],{"class":130},[117,733,734],{"class":195}," \"get-args\"\n",[117,736,737,740,742,745,748,750,753,756,758,761],{"class":119,"line":328},[117,738,739],{"class":141},"    result ",[117,741,172],{"class":130},[117,743,744],{"class":141}," runner.invoke(app, [], ",[117,746,747],{"class":397},"env",[117,749,172],{"class":130},[117,751,752],{"class":141},"env, ",[117,754,755],{"class":397},"prog_name",[117,757,172],{"class":130},[117,759,760],{"class":195},"\"mytool\"",[117,762,621],{"class":141},[117,764,765,768,771,773,776],{"class":119,"line":345},[117,766,767],{"class":130},"    assert",[117,769,770],{"class":141}," result.exit_code ",[117,772,713],{"class":130},[117,774,775],{"class":134}," 0",[117,777,778],{"class":141},", result.output\n",[117,780,781,783,786,788,791,794,797,799,802],{"class":119,"line":351},[117,782,274],{"class":130},[117,784,785],{"class":141}," [line ",[117,787,286],{"class":130},[117,789,790],{"class":141}," line ",[117,792,793],{"class":130},"in",[117,795,796],{"class":141}," result.output.splitlines() ",[117,798,303],{"class":130},[117,800,801],{"class":141}," line]   ",[117,803,804],{"class":123},"# bash ends with a blank line\n",[117,806,807],{"class":119,"line":356},[117,808,149],{"emptyLinePlaceholder":148},[117,810,811],{"class":119,"line":361},[117,812,149],{"emptyLinePlaceholder":148},[117,814,815,817,820],{"class":119,"line":369},[117,816,246],{"class":130},[117,818,819],{"class":249}," test_subcommands",[117,821,822],{"class":141},"():\n",[117,824,825,827,830,833,835,837,840,843,845,848],{"class":119,"line":406},[117,826,767],{"class":130},[117,828,829],{"class":141}," complete(",[117,831,832],{"class":195},"\"mytool \"",[117,834,283],{"class":141},[117,836,713],{"class":130},[117,838,839],{"class":141}," [",[117,841,842],{"class":195},"\"deploy\"",[117,844,205],{"class":141},[117,846,847],{"class":195},"\"status\"",[117,849,850],{"class":141},"]\n",[117,852,853],{"class":119,"line":434},[117,854,149],{"emptyLinePlaceholder":148},[117,856,857],{"class":119,"line":440},[117,858,149],{"emptyLinePlaceholder":148},[117,860,861,863,866],{"class":119,"line":445},[117,862,246],{"class":130},[117,864,865],{"class":249}," test_options_of_a_command",[117,867,822],{"class":141},[117,869,870,872,874,876,878,880,883,886,889,892,895],{"class":119,"line":450},[117,871,767],{"class":130},[117,873,192],{"class":141},[117,875,392],{"class":195},[117,877,205],{"class":141},[117,879,424],{"class":195},[117,881,882],{"class":141},"} ",[117,884,885],{"class":130},"\u003C=",[117,887,888],{"class":134}," set",[117,890,891],{"class":141},"(complete(",[117,893,894],{"class":195},"\"mytool deploy --\"",[117,896,897],{"class":141},"))\n",[117,899,900],{"class":119,"line":457},[117,901,149],{"emptyLinePlaceholder":148},[117,903,904],{"class":119,"line":471},[117,905,149],{"emptyLinePlaceholder":148},[117,907,909,911,914],{"class":119,"line":908},30,[117,910,246],{"class":130},[117,912,913],{"class":249}," test_dynamic_values_are_filtered_by_prefix",[117,915,822],{"class":141},[117,917,919,921,923,926,928,930,932,934,936,938],{"class":119,"line":918},31,[117,920,767],{"class":130},[117,922,829],{"class":141},[117,924,925],{"class":195},"\"mytool deploy --env prod-\"",[117,927,283],{"class":141},[117,929,713],{"class":130},[117,931,839],{"class":141},[117,933,196],{"class":195},[117,935,205],{"class":141},[117,937,208],{"class":195},[117,939,850],{"class":141},[117,941,943],{"class":119,"line":942},32,[117,944,149],{"emptyLinePlaceholder":148},[117,946,948],{"class":119,"line":947},33,[117,949,149],{"emptyLinePlaceholder":148},[117,951,953,955,958],{"class":119,"line":952},34,[117,954,246],{"class":130},[117,956,957],{"class":249}," test_fish_gets_descriptions",[117,959,822],{"class":141},[117,961,963,965,967,970,972,974,976,979,981,983,985,988,991,994],{"class":119,"line":962},35,[117,964,767],{"class":130},[117,966,829],{"class":141},[117,968,969],{"class":195},"\"mytool deploy --env st\"",[117,971,205],{"class":141},[117,973,647],{"class":397},[117,975,172],{"class":130},[117,977,978],{"class":195},"\"fish\"",[117,980,283],{"class":141},[117,982,713],{"class":130},[117,984,839],{"class":141},[117,986,987],{"class":195},"\"staging",[117,989,990],{"class":134},"\\t",[117,992,993],{"class":195},"Staging\"",[117,995,850],{"class":141},[117,997,999],{"class":119,"line":998},36,[117,1000,149],{"emptyLinePlaceholder":148},[117,1002,1004],{"class":119,"line":1003},37,[117,1005,149],{"emptyLinePlaceholder":148},[117,1007,1009,1011,1014],{"class":119,"line":1008},38,[117,1010,246],{"class":130},[117,1012,1013],{"class":249}," test_no_match_means_no_candidates",[117,1015,822],{"class":141},[117,1017,1019,1021,1023,1026,1028,1030],{"class":119,"line":1018},39,[117,1020,767],{"class":130},[117,1022,829],{"class":141},[117,1024,1025],{"class":195},"\"mytool deploy --env zz\"",[117,1027,283],{"class":141},[117,1029,713],{"class":130},[117,1031,1032],{"class":141}," []\n",[10,1034,1035,1036,1041,1042,1045,1046,1048,1049,1051],{},"Two details make or break these tests. ",[75,1037,1038],{},[14,1039,1040],{},"prog_name=\"mytool\""," matters because the environment variable's name is derived from the program name; without it, the runner's program name is something else, the variable is ignored, and the CLI runs normally instead of completing. ",[75,1043,1044],{},"A trailing space"," in ",[14,1047,832],{}," means \"complete a new word\"; without it, the cursor is still on ",[14,1050,60],{}," itself.",[10,1053,1054],{},"The same checks by hand, which is also the quickest way to debug a failing test:",[48,1056],{"name":1057},"ct-terminal",[1059,1060,1062],"h3",{"id":1061},"plain-click-has-a-public-api-for-this","Plain Click has a public API for this",[10,1064,1065,1066,205,1069,205,1072,1075,1076,1079,1080,1083,1084,1086,1087,1090,1091,1094],{},"Click's protocol uses different values (",[14,1067,1068],{},"bash_complete",[14,1070,1071],{},"zsh_complete",[14,1073,1074],{},"fish_complete","), and it also exposes the machinery directly. ",[14,1077,1078],{},"ShellComplete.get_completions"," returns completion items with their help text, without environment variables or output parsing. Here ",[14,1081,1082],{},"mytool.clickcli"," is the same app written with Click, its ",[14,1085,105],{}," option declared with ",[14,1088,1089],{},"shell_complete=complete_env"," and the callback returning ",[14,1092,1093],{},"CompletionItem(name, help=help)"," objects:",[108,1096,1098],{"className":110,"code":1097,"language":112,"meta":113,"style":113},"# tests\u002Ftest_completion_click.py\nfrom click.shell_completion import ShellComplete\n\nfrom mytool.clickcli import cli\n\n\ndef completions(args: list[str], incomplete: str) -> list[tuple[str, str | None]]:\n    comp = ShellComplete(cli, {}, \"mytool\", \"_MYTOOL_COMPLETE\")\n    return [(item.value, item.help) for item in comp.get_completions(args, incomplete)]\n\n\ndef test_values_with_help():\n    assert completions([\"deploy\", \"--env\"], \"prod-\") == [\n        (\"prod-eu\", \"Production, Frankfurt\"), (\"prod-us\", \"Production, Virginia\")]\n\n\ndef test_commands():\n    assert [v for v, _ in completions([], \"\")] == [\"deploy\", \"status\"]\n",[14,1099,1100,1105,1117,1121,1133,1137,1141,1174,1192,1209,1213,1217,1226,1252,1275,1279,1283,1292],{"__ignoreMap":113},[117,1101,1102],{"class":119,"line":120},[117,1103,1104],{"class":123},"# tests\u002Ftest_completion_click.py\n",[117,1106,1107,1109,1112,1114],{"class":119,"line":127},[117,1108,131],{"class":130},[117,1110,1111],{"class":141}," click.shell_completion ",[117,1113,155],{"class":130},[117,1115,1116],{"class":141}," ShellComplete\n",[117,1118,1119],{"class":119,"line":145},[117,1120,149],{"emptyLinePlaceholder":148},[117,1122,1123,1125,1128,1130],{"class":119,"line":152},[117,1124,131],{"class":130},[117,1126,1127],{"class":141}," mytool.clickcli ",[117,1129,155],{"class":130},[117,1131,1132],{"class":141}," cli\n",[117,1134,1135],{"class":119,"line":161},[117,1136,149],{"emptyLinePlaceholder":148},[117,1138,1139],{"class":119,"line":166},[117,1140,149],{"emptyLinePlaceholder":148},[117,1142,1143,1145,1148,1151,1153,1156,1158,1160,1162,1164,1166,1169,1172],{"class":119,"line":178},[117,1144,246],{"class":130},[117,1146,1147],{"class":249}," completions",[117,1149,1150],{"class":141},"(args: list[",[117,1152,256],{"class":134},[117,1154,1155],{"class":141},"], incomplete: ",[117,1157,256],{"class":134},[117,1159,259],{"class":141},[117,1161,256],{"class":134},[117,1163,205],{"class":141},[117,1165,256],{"class":134},[117,1167,1168],{"class":130}," |",[117,1170,1171],{"class":134}," None",[117,1173,268],{"class":141},[117,1175,1176,1179,1181,1184,1186,1188,1190],{"class":119,"line":183},[117,1177,1178],{"class":141},"    comp ",[117,1180,172],{"class":130},[117,1182,1183],{"class":141}," ShellComplete(cli, {}, ",[117,1185,760],{"class":195},[117,1187,205],{"class":141},[117,1189,633],{"class":195},[117,1191,621],{"class":141},[117,1193,1194,1196,1199,1201,1204,1206],{"class":119,"line":219},[117,1195,274],{"class":130},[117,1197,1198],{"class":141}," [(item.value, item.help) ",[117,1200,286],{"class":130},[117,1202,1203],{"class":141}," item ",[117,1205,793],{"class":130},[117,1207,1208],{"class":141}," comp.get_completions(args, incomplete)]\n",[117,1210,1211],{"class":119,"line":233},[117,1212,149],{"emptyLinePlaceholder":148},[117,1214,1215],{"class":119,"line":238},[117,1216,149],{"emptyLinePlaceholder":148},[117,1218,1219,1221,1224],{"class":119,"line":243},[117,1220,246],{"class":130},[117,1222,1223],{"class":249}," test_values_with_help",[117,1225,822],{"class":141},[117,1227,1228,1230,1233,1235,1237,1239,1242,1245,1247,1249],{"class":119,"line":271},[117,1229,767],{"class":130},[117,1231,1232],{"class":141}," completions([",[117,1234,842],{"class":195},[117,1236,205],{"class":141},[117,1238,392],{"class":195},[117,1240,1241],{"class":141},"], ",[117,1243,1244],{"class":195},"\"prod-\"",[117,1246,283],{"class":141},[117,1248,713],{"class":130},[117,1250,1251],{"class":141}," [\n",[117,1253,1254,1257,1259,1261,1263,1266,1268,1270,1272],{"class":119,"line":309},[117,1255,1256],{"class":141},"        (",[117,1258,196],{"class":195},[117,1260,205],{"class":141},[117,1262,202],{"class":195},[117,1264,1265],{"class":141},"), (",[117,1267,208],{"class":195},[117,1269,205],{"class":141},[117,1271,213],{"class":195},[117,1273,1274],{"class":141},")]\n",[117,1276,1277],{"class":119,"line":314},[117,1278,149],{"emptyLinePlaceholder":148},[117,1280,1281],{"class":119,"line":319},[117,1282,149],{"emptyLinePlaceholder":148},[117,1284,1285,1287,1290],{"class":119,"line":328},[117,1286,246],{"class":130},[117,1288,1289],{"class":249}," test_commands",[117,1291,822],{"class":141},[117,1293,1294,1296,1299,1301,1304,1306,1309,1312,1315,1317,1319,1321,1323,1325],{"class":119,"line":345},[117,1295,767],{"class":130},[117,1297,1298],{"class":141}," [v ",[117,1300,286],{"class":130},[117,1302,1303],{"class":141}," v, _ ",[117,1305,793],{"class":130},[117,1307,1308],{"class":141}," completions([], ",[117,1310,1311],{"class":195},"\"\"",[117,1313,1314],{"class":141},")] ",[117,1316,713],{"class":130},[117,1318,839],{"class":141},[117,1320,842],{"class":195},[117,1322,205],{"class":141},[117,1324,847],{"class":195},[117,1326,850],{"class":141},[10,1328,1329],{},"Do not use this API with a Typer app: recent Typer releases build their command objects from their own bundled copy of Click, so standalone Click's completion classes are not the ones Typer runs. The environment-variable protocol above works for both, as long as the values match the framework.",[25,1331,1333],{"id":1332},"the-real-shell-once","The real shell, once",[10,1335,1336,1337,1340,1341,1344],{},"The protocol tests prove your Python side. What they cannot prove is that the script ",[14,1338,1339],{},"mytool --show-completion bash"," generates, sourced into a real shell, calls the installed program correctly. One end-to-end test covers that; it needs the CLI installed on ",[14,1342,1343],{},"PATH",", so skip it where it is not:",[108,1346,1348],{"className":110,"code":1347,"language":112,"meta":113,"style":113},"# tests\u002Ftest_completion_bash.py\nimport shutil\nimport subprocess\n\nimport pytest\n\npytestmark = pytest.mark.skipif(not shutil.which(\"mytool\") or not shutil.which(\"bash\"),\n                                reason=\"needs the installed CLI and bash\")\n\nSCRIPT = \"\"\"\nsource \u003C(mytool --show-completion bash)\nCOMP_WORDS=({words})\nCOMP_CWORD={cword}\n_mytool_completion mytool\nprintf '%s\\\\n' \"${{COMPREPLY[@]}}\"\n\"\"\"\n\n\ndef bash_complete(*words: str) -> list[str]:\n    script = SCRIPT.format(words=\" \".join(words), cword=len(words) - 1)\n    out = subprocess.run([\"bash\", \"-c\", script], capture_output=True, text=True, check=True).stdout\n    return [line for line in out.splitlines() if line]\n\n\ndef test_real_bash_completes_values():\n    assert bash_complete(\"mytool\", \"deploy\", \"--env\", \"prod-\") == [\"prod-eu\", \"prod-us\"]\n",[14,1349,1350,1355,1362,1369,1373,1380,1384,1418,1430,1434,1444,1449,1459,1467,1472,1495,1500,1504,1508,1531,1569,1618,1638,1642,1646,1655],{"__ignoreMap":113},[117,1351,1352],{"class":119,"line":120},[117,1353,1354],{"class":123},"# tests\u002Ftest_completion_bash.py\n",[117,1356,1357,1359],{"class":119,"line":127},[117,1358,155],{"class":130},[117,1360,1361],{"class":141}," shutil\n",[117,1363,1364,1366],{"class":119,"line":145},[117,1365,155],{"class":130},[117,1367,1368],{"class":141}," subprocess\n",[117,1370,1371],{"class":119,"line":152},[117,1372,149],{"emptyLinePlaceholder":148},[117,1374,1375,1377],{"class":119,"line":161},[117,1376,155],{"class":130},[117,1378,1379],{"class":141}," pytest\n",[117,1381,1382],{"class":119,"line":166},[117,1383,149],{"emptyLinePlaceholder":148},[117,1385,1386,1389,1391,1394,1397,1400,1402,1404,1407,1410,1412,1415],{"class":119,"line":178},[117,1387,1388],{"class":141},"pytestmark ",[117,1390,172],{"class":130},[117,1392,1393],{"class":141}," pytest.mark.skipif(",[117,1395,1396],{"class":130},"not",[117,1398,1399],{"class":141}," shutil.which(",[117,1401,760],{"class":195},[117,1403,283],{"class":141},[117,1405,1406],{"class":130},"or",[117,1408,1409],{"class":130}," not",[117,1411,1399],{"class":141},[117,1413,1414],{"class":195},"\"bash\"",[117,1416,1417],{"class":141},"),\n",[117,1419,1420,1423,1425,1428],{"class":119,"line":183},[117,1421,1422],{"class":397},"                                reason",[117,1424,172],{"class":130},[117,1426,1427],{"class":195},"\"needs the installed CLI and bash\"",[117,1429,621],{"class":141},[117,1431,1432],{"class":119,"line":219},[117,1433,149],{"emptyLinePlaceholder":148},[117,1435,1436,1439,1441],{"class":119,"line":233},[117,1437,1438],{"class":134},"SCRIPT",[117,1440,189],{"class":130},[117,1442,1443],{"class":195}," \"\"\"\n",[117,1445,1446],{"class":119,"line":238},[117,1447,1448],{"class":195},"source \u003C(mytool --show-completion bash)\n",[117,1450,1451,1454,1457],{"class":119,"line":243},[117,1452,1453],{"class":195},"COMP_WORDS=(",[117,1455,1456],{"class":134},"{words}",[117,1458,621],{"class":195},[117,1460,1461,1464],{"class":119,"line":271},[117,1462,1463],{"class":195},"COMP_CWORD=",[117,1465,1466],{"class":134},"{cword}\n",[117,1468,1469],{"class":119,"line":309},[117,1470,1471],{"class":195},"_mytool_completion mytool\n",[117,1473,1474,1477,1480,1483,1486,1489,1492],{"class":119,"line":314},[117,1475,1476],{"class":195},"printf '",[117,1478,1479],{"class":134},"%s\\\\",[117,1481,1482],{"class":195},"n' \"$",[117,1484,1485],{"class":134},"{{",[117,1487,1488],{"class":195},"COMPREPLY[@]",[117,1490,1491],{"class":134},"}}",[117,1493,1494],{"class":195},"\"\n",[117,1496,1497],{"class":119,"line":319},[117,1498,1499],{"class":195},"\"\"\"\n",[117,1501,1502],{"class":119,"line":328},[117,1503,149],{"emptyLinePlaceholder":148},[117,1505,1506],{"class":119,"line":345},[117,1507,149],{"emptyLinePlaceholder":148},[117,1509,1510,1512,1515,1517,1520,1523,1525,1527,1529],{"class":119,"line":351},[117,1511,246],{"class":130},[117,1513,1514],{"class":249}," bash_complete",[117,1516,673],{"class":141},[117,1518,1519],{"class":130},"*",[117,1521,1522],{"class":141},"words: ",[117,1524,256],{"class":134},[117,1526,595],{"class":141},[117,1528,256],{"class":134},[117,1530,600],{"class":141},[117,1532,1533,1536,1538,1541,1544,1547,1549,1551,1554,1557,1559,1561,1563,1565,1567],{"class":119,"line":356},[117,1534,1535],{"class":141},"    script ",[117,1537,172],{"class":130},[117,1539,1540],{"class":134}," SCRIPT",[117,1542,1543],{"class":141},".format(",[117,1545,1546],{"class":397},"words",[117,1548,172],{"class":130},[117,1550,618],{"class":195},[117,1552,1553],{"class":141},".join(words), ",[117,1555,1556],{"class":397},"cword",[117,1558,172],{"class":130},[117,1560,676],{"class":134},[117,1562,679],{"class":141},[117,1564,682],{"class":130},[117,1566,685],{"class":134},[117,1568,621],{"class":141},[117,1570,1571,1574,1576,1579,1581,1583,1586,1589,1592,1594,1597,1599,1602,1604,1606,1608,1611,1613,1615],{"class":119,"line":361},[117,1572,1573],{"class":141},"    out ",[117,1575,172],{"class":130},[117,1577,1578],{"class":141}," subprocess.run([",[117,1580,1414],{"class":195},[117,1582,205],{"class":141},[117,1584,1585],{"class":195},"\"-c\"",[117,1587,1588],{"class":141},", script], ",[117,1590,1591],{"class":397},"capture_output",[117,1593,172],{"class":130},[117,1595,1596],{"class":134},"True",[117,1598,205],{"class":141},[117,1600,1601],{"class":397},"text",[117,1603,172],{"class":130},[117,1605,1596],{"class":134},[117,1607,205],{"class":141},[117,1609,1610],{"class":397},"check",[117,1612,172],{"class":130},[117,1614,1596],{"class":134},[117,1616,1617],{"class":141},").stdout\n",[117,1619,1620,1622,1624,1626,1628,1630,1633,1635],{"class":119,"line":369},[117,1621,274],{"class":130},[117,1623,785],{"class":141},[117,1625,286],{"class":130},[117,1627,790],{"class":141},[117,1629,793],{"class":130},[117,1631,1632],{"class":141}," out.splitlines() ",[117,1634,303],{"class":130},[117,1636,1637],{"class":141}," line]\n",[117,1639,1640],{"class":119,"line":406},[117,1641,149],{"emptyLinePlaceholder":148},[117,1643,1644],{"class":119,"line":434},[117,1645,149],{"emptyLinePlaceholder":148},[117,1647,1648,1650,1653],{"class":119,"line":440},[117,1649,246],{"class":130},[117,1651,1652],{"class":249}," test_real_bash_completes_values",[117,1654,822],{"class":141},[117,1656,1657,1659,1662,1664,1666,1668,1670,1672,1674,1676,1678,1680,1682,1684,1686,1688],{"class":119,"line":445},[117,1658,767],{"class":130},[117,1660,1661],{"class":141}," bash_complete(",[117,1663,760],{"class":195},[117,1665,205],{"class":141},[117,1667,842],{"class":195},[117,1669,205],{"class":141},[117,1671,392],{"class":195},[117,1673,205],{"class":141},[117,1675,1244],{"class":195},[117,1677,283],{"class":141},[117,1679,713],{"class":130},[117,1681,839],{"class":141},[117,1683,196],{"class":195},[117,1685,205],{"class":141},[117,1687,208],{"class":195},[117,1689,850],{"class":141},[10,1691,1692,1693,1696,1697,23],{},"The function name ",[14,1694,1695],{},"_mytool_completion"," comes from the generated script; if you change the program name, the test fails loudly rather than silently. Run it in the job that installs the built wheel, as in ",[19,1698,1700],{"href":1699},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fend-to-end-testing-an-installed-cli\u002F","end-to-end testing an installed CLI",[25,1702,1704],{"id":1703},"ux-considerations","UX considerations",[30,1706,1707,1725,1731,1737],{},[33,1708,1709,1712,1713,1716,1717,1720,1721,23],{},[75,1710,1711],{},"Completion must be fast."," A test that times the protocol call (",[14,1714,1715],{},"time.perf_counter()"," around ",[14,1718,1719],{},"complete(...)",") and fails above, say, 300 ms catches the import that made Tab feel sluggish; see ",[19,1722,1724],{"href":1723},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002F","CLI startup performance and lazy loading",[33,1726,1727,1730],{},[75,1728,1729],{},"Completion must be quiet."," Anything a callback prints — a warning, a log line on stderr — can end up in the user's prompt. The protocol tests check stdout exactly; add an assertion that stderr is empty if your callbacks do I\u002FO.",[33,1732,1733,1736],{},[75,1734,1735],{},"Failing sources return nothing."," A callback that raises breaks the whole completion; test that an unreachable API gives an empty list, not an exception.",[33,1738,1739,1742,1743,1745],{},[75,1740,1741],{},"Hidden commands stay hidden."," If you hide aliases from ",[14,1744,16],{},", assert they are absent from command completion too.",[25,1747,1749],{"id":1748},"conclusion","Conclusion",[10,1751,1752,1753,1755,1756,1758,1759,1761,1762,1764],{},"Completion breaks silently, so it needs tests more than most features — and it is easy to test, because the protocol is just environment variables in and lines out. Test callbacks as plain functions, test the protocol through ",[14,1754,510],{}," with ",[14,1757,755],{}," set and the framework's own values (",[14,1760,484],{}," for Typer, ",[14,1763,1068],{}," for Click), and run one real-bash test against the installed CLI in CI. Together they keep Tab working through every refactor.",[25,1766,1768],{"id":1767},"frequently-asked-questions","Frequently asked questions",[1059,1770,1772],{"id":1771},"why-does-my-completion-test-print-the-normal-help-or-run-the-command","Why does my completion test print the normal help or run the command?",[10,1774,1775,1776,1778,1779,1782,1783,1785,1786,23],{},"The completion variable was not recognised. Either its name does not match the program name (pass ",[14,1777,755],{}," to ",[14,1780,1781],{},"invoke",", or name the variable after the runner's program name), or its value belongs to the other framework — Typer expects ",[14,1784,484],{},", Click expects ",[14,1787,1068],{},[1059,1789,1791],{"id":1790},"how-do-i-test-zsh-completion-output","How do I test zsh completion output?",[10,1793,1794],{},"Zsh output from Typer is a snippet of zsh code rather than one value per line. Assert that it contains the expected values and descriptions, or test with bash and fish, whose output is simpler, and rely on the shared Python logic for zsh.",[1059,1796,1798],{"id":1797},"should-completion-tests-call-the-network","Should completion tests call the network?",[10,1800,1801,1802,23],{},"No. Inject or monkeypatch the data source so tests are fast and deterministic; test the network-facing fetch separately, with a fake transport as described in ",[19,1803,1805],{"href":1804},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002F","calling HTTP APIs from Python CLIs",[1059,1807,1809],{"id":1808},"do-i-need-to-test-every-shell","Do I need to test every shell?",[10,1811,1812],{},"Test the protocol for the shells you document, since each has its own output format, and one real-shell test for the most common one. The completion logic itself is shared, so one set of callback tests covers all shells.",[1059,1814,1816],{"id":1815},"where-do-completion-tests-belong-in-the-test-suite","Where do completion tests belong in the test suite?",[10,1818,1819],{},"Alongside the other CLI tests, in the fast unit run. They take milliseconds each, so there is no reason to separate them; only the real-shell test belongs in the slower job that installs the package.",[25,1821,1823],{"id":1822},"related","Related",[30,1825,1826,1832,1837,1842,1848],{},[33,1827,1828,1829],{},"Up: ",[19,1830,1831],{"href":21},"Shell completion for Python CLIs",[33,1833,1834],{},[19,1835,1836],{"href":38},"Enabling tab completion in Click and Typer",[33,1838,1839],{},[19,1840,1841],{"href":81},"Dynamic completion values from APIs and files",[33,1843,1844],{},[19,1845,1847],{"href":1846},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Finstalling-shell-completion-for-bash-zsh-fish\u002F","Installing shell completion for bash, zsh and fish",[33,1849,1850],{},[19,1851,1853],{"href":1852},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002F","Testing Python CLI applications",[1855,1856,1857],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":113,"searchDepth":127,"depth":127,"links":1859},[1860,1861,1862,1863,1864,1867,1868,1869,1870,1877],{"id":27,"depth":127,"text":28},{"id":45,"depth":127,"text":46},{"id":67,"depth":127,"text":68},{"id":98,"depth":127,"text":99},{"id":477,"depth":127,"text":478,"children":1865},[1866],{"id":1061,"depth":145,"text":1062},{"id":1332,"depth":127,"text":1333},{"id":1703,"depth":127,"text":1704},{"id":1748,"depth":127,"text":1749},{"id":1767,"depth":127,"text":1768,"children":1871},[1872,1873,1874,1875,1876],{"id":1771,"depth":145,"text":1772},{"id":1790,"depth":145,"text":1791},{"id":1797,"depth":145,"text":1798},{"id":1808,"depth":145,"text":1809},{"id":1815,"depth":145,"text":1816},{"id":1822,"depth":127,"text":1823},"2026-09-18","Test Typer and Click shell completion at three levels: completion callbacks, the completion protocol through CliRunner, and a real bash session in CI.","intermediate",false,"md",{},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis",{"title":5,"description":1879},"advanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis\u002Findex",[1888,1889,1890,1891,1892],"shell-completion","testing","typer","click","pytest","zPKfJq_A6fXKiSxQecl6qwEzUjax_5pSlNqQvcRaNrk",[1895,1898,1901,1904,1907,1910,1913,1916,1919,1922,1925,1928,1931,1934,1937,1940,1943,1946,1949,1952,1955,1958,1961,1964,1967,1970,1973,1976,1979,1982,1985,1988,1991,1994,1997,2000,2003,2006,2009,2012,2015,2018,2021,2024,2027,2030,2033,2036,2039,2042,2045,2048,2051,2054,2057,2060,2063,2066,2069,2072,2075,2078,2081,2084,2087,2090,2093,2094,2097,2100,2103,2106,2109,2112,2115,2118,2121,2124,2127,2130,2133,2136,2139,2142,2145,2148,2151,2154,2157,2160,2163,2166,2169,2172,2175,2178,2181,2184,2187,2190,2193,2196,2199,2202,2205,2208,2211,2214,2217,2220,2223,2226,2229,2232,2235,2238,2241,2244,2247,2250,2253,2256,2259,2262,2265,2268,2271,2274,2277,2280,2283,2286,2289,2292,2295,2298,2301,2304,2307,2310,2313,2316,2319,2322,2325,2328,2331,2334,2337,2340,2343,2346,2349,2352,2355,2358,2361,2364,2367,2370,2373,2376,2379,2382,2385,2388,2391,2394,2397,2400,2403,2406,2409,2412,2415,2418,2421,2424,2427,2430,2433,2436,2439,2442,2445,2448,2451,2454,2457,2460,2463,2466,2469,2472,2475,2478,2481,2484,2487,2490,2493,2496,2499,2502,2505,2508,2511,2514,2517,2520,2523,2526,2529,2532,2535,2538,2541,2544,2547,2550,2553,2556,2559,2562,2565,2568,2571,2574,2577,2580,2583,2586,2589,2592,2595,2598,2601,2604,2607,2610,2613,2616,2619,2622,2625,2628,2631,2634,2637,2640,2643,2646,2649,2652,2655,2658,2661,2664,2667,2670,2673,2676,2679,2682,2685,2688,2691,2694,2697,2700,2703,2706,2709,2712,2715,2718,2721,2724,2727,2730,2733,2736],{"path":1896,"title":1897},"\u002Fabout","About Python CLI Toolcraft",{"path":1899,"title":1900},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1902,"title":1903},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1905,"title":1906},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dates-and-durations-in-cli-arguments","Validating Dates and Durations in Python CLI Arguments",{"path":1908,"title":1909},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1911,"title":1912},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1914,"title":1915},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":1917,"title":1918},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1920,"title":1921},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":1923,"title":1924},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbuilding-your-first-textual-app","Building Your First Textual App for a Python CLI",{"path":1926,"title":1927},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fchoosing-between-a-cli-a-prompt-flow-and-a-tui","Choosing Between a CLI, a Prompt Flow and a TUI",{"path":1929,"title":1930},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1932,"title":1933},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Frunning-background-work-in-textual-with-workers","Running Background Work in Textual with Workers",{"path":1935,"title":1936},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":1938,"title":1939},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1941,"title":1942},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fadding-examples-and-epilogs-to-help-output","Adding Examples and Epilogs to Help Output",{"path":1944,"title":1945},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":1947,"title":1948},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fgenerating-man-pages-and-docs-from-a-cli","Generating Man Pages and Docs from a CLI",{"path":1950,"title":1951},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":1953,"title":1954},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Frich-formatted-help-with-rich-click","Rich-Formatted Help for Click CLIs with rich-click",{"path":1956,"title":1957},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":1959,"title":1960},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":1962,"title":1963},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":1965,"title":1966},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":1968,"title":1969},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Ffixing-unicode-and-encoding-errors-on-windows","Fixing Unicode and Encoding Errors on Windows in Python CLIs",{"path":1971,"title":1972},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":1974,"title":1975},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":1977,"title":1978},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Frespecting-no-color-and-force-color","Respecting NO_COLOR and FORCE_COLOR in Python CLIs",{"path":1980,"title":1981},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fsupporting-dumb-terminals-and-screen-readers","Supporting Dumb Terminals and Screen Readers in a Python CLI",{"path":1983,"title":1984},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":1986,"title":1987},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdesigning-an-exception-hierarchy-for-a-cli","Designing an Exception Hierarchy for a Python CLI",{"path":1989,"title":1990},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdid-you-mean-suggestions-for-mistyped-input","Did You Mean…? Suggestions for Mistyped CLI Input",{"path":1992,"title":1993},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":1995,"title":1996},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":1998,"title":1999},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2001,"title":2002},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Freporting-machine-readable-errors-in-json-mode","Reporting Machine-Readable Errors in JSON Mode",{"path":2004,"title":2005},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2007,"title":2008},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2010,"title":2011},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fdiscovering-project-config-files-by-walking-up-directories","Discovering Project Config Files by Walking Up Directories",{"path":2013,"title":2014},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2016,"title":2017},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Floading-yaml-configs-safely-in-cli-apps","Loading YAML configs safely in CLI apps",{"path":2019,"title":2020},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2022,"title":2023},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2025,"title":2026},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fvalidating-config-files-with-json-schema","Validating Config Files with JSON Schema in a Python CLI",{"path":2028,"title":2029},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fwriting-a-config-init-and-edit-command","Writing a Config Init and Edit Command for a Python CLI",{"path":2031,"title":2032},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2034,"title":2035},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fadding-progress-bars-and-spinners-to-python-clis","Progress Bars and Spinners for Python CLIs",{"path":2037,"title":2038},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2040,"title":2041},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-tree-views-with-rich","Building Tree Views with Rich in a Python CLI",{"path":2043,"title":2044},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2046,"title":2047},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2049,"title":2050},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-markdown-and-syntax-highlighting-with-rich","Rendering Markdown and Syntax Highlighting with Rich",{"path":2052,"title":2053},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2055,"title":2056},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2058,"title":2059},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fadding-a-format-flag-for-table-json-and-csv","Adding a Format Flag for Table, JSON and CSV Output",{"path":2061,"title":2062},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fcustom-output-templates-with-a-format-string","Custom Output Templates with a Format String in Python CLIs",{"path":2064,"title":2065},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fexporting-cli-results-to-files","Exporting CLI Results to Files from a Python CLI",{"path":2067,"title":2068},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2070,"title":2071},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fselecting-fields-and-columns-from-cli-output","Selecting Fields and Columns from Python CLI Output",{"path":2073,"title":2074},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fwriting-csv-and-tsv-output-correctly","Writing CSV and TSV Output Correctly from a Python CLI",{"path":2076,"title":2077},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2079,"title":2080},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fdynamic-completion-values-from-apis-and-files","Dynamic Completion Values from APIs and Files",{"path":2082,"title":2083},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fenabling-tab-completion-in-click-and-typer","Enabling Tab Completion in Click and Typer",{"path":2085,"title":2086},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2088,"title":2089},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Finstalling-shell-completion-for-bash-zsh-fish","Installing Shell Completion for bash, zsh, fish",{"path":2091,"title":2092},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":1884,"title":5},{"path":2095,"title":2096},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-trace-ids-and-context-to-cli-logs","Adding Trace IDs and Context to Python CLI Logs",{"path":2098,"title":2099},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2101,"title":2102},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2104,"title":2105},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2107,"title":2108},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fseparating-logs-from-program-output","Separating Logs from Program Output in a Python CLI",{"path":2110,"title":2111},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2113,"title":2114},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fwriting-rotating-log-files-from-a-cli","Writing Rotating Log Files from a Python CLI",{"path":2116,"title":2117},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2119,"title":2120},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2122,"title":2123},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2125,"title":2126},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2128,"title":2129},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fnull-delimited-input-and-xargs-compatibility","Null-Delimited Input and xargs Compatibility in Python CLIs",{"path":2131,"title":2132},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fprocessing-large-files-and-ndjson-streams","Processing Large Files and NDJSON Streams in Python CLIs",{"path":2134,"title":2135},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2137,"title":2138},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fbuilding-an-api-client-cli-with-httpx","Building an API Client CLI with httpx",{"path":2140,"title":2141},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2143,"title":2144},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2146,"title":2147},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fmocking-http-in-cli-tests-with-respx","Mocking HTTP in Python CLI Tests with respx",{"path":2149,"title":2150},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2152,"title":2153},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2155,"title":2156},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fretries-and-backoff-for-cli-http-calls","Retries and Backoff for CLI HTTP Calls",{"path":2158,"title":2159},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fuploading-files-with-multipart-and-progress","Uploading Files with Multipart and Progress in a Python CLI",{"path":2161,"title":2162},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fcancelling-async-tasks-on-ctrl-c","Cancelling Async Tasks on Ctrl+C in Python CLIs",{"path":2164,"title":2165},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2167,"title":2168},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2170,"title":2171},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2173,"title":2174},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2176,"title":2177},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frunning-async-code-in-typer-and-click","Running Async Code in Typer and Click",{"path":2179,"title":2180},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fshowing-progress-for-concurrent-tasks","Showing Progress for Concurrent Tasks in a Python CLI",{"path":2182,"title":2183},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2185,"title":2186},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2188,"title":2189},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2191,"title":2192},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fhandling-file-permissions-and-umask-in-clis","Handling File Permissions and umask in Python CLIs",{"path":2194,"title":2195},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2197,"title":2198},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2200,"title":2201},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2203,"title":2204},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwalking-directory-trees-with-ignore-rules","Walking Directory Trees with Ignore Rules in a Python CLI",{"path":2206,"title":2207},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2209,"title":2210},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2212,"title":2213},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fcaching-http-responses-on-disk-in-a-cli","Caching HTTP Responses on Disk in a Python CLI",{"path":2215,"title":2216},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2218,"title":2219},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fmigrating-a-cli-sqlite-schema","Migrating a CLI’s SQLite Schema Between Releases",{"path":2221,"title":2222},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Frecording-and-querying-cli-run-history","Recording and Querying CLI Run History in SQLite",{"path":2224,"title":2225},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fstoring-cli-state-in-sqlite","Storing CLI State in SQLite with a Small Repository Class",{"path":2227,"title":2228},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fbuilding-a-watch-mode-with-watchfiles","Building a Watch Mode with watchfiles in Python",{"path":2230,"title":2231},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2233,"title":2234},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhealth-checks-and-heartbeats-for-long-running-clis","Health Checks and Heartbeats for Long-Running CLIs",{"path":2236,"title":2237},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2239,"title":2240},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2242,"title":2243},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Frunning-a-cli-as-a-systemd-service","Running a Python CLI as a systemd Service",{"path":2245,"title":2246},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Frunning-a-cli-on-a-schedule-with-cron-and-systemd","Running a Python CLI on a Schedule with cron and systemd",{"path":2248,"title":2249},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fsending-cli-logs-to-journald-and-syslog","Sending Python CLI Logs to journald and syslog",{"path":2251,"title":2252},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2254,"title":2255},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2257,"title":2258},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2260,"title":2261},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2263,"title":2264},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Flaunching-the-users-editor-from-a-cli","Launching the User’s Editor from a Python CLI",{"path":2266,"title":2267},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2269,"title":2270},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2272,"title":2273},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fwrapping-git-and-other-tools-from-a-python-cli","Wrapping git and Other Tools from a Python CLI",{"path":2275,"title":2276},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2278,"title":2279},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2281,"title":2282},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Freading-secrets-from-env-and-files","Reading Secrets from Env Vars and Files in CLIs",{"path":2284,"title":2285},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fredacting-secrets-from-cli-output-and-logs","Redacting Secrets from CLI Output and Logs",{"path":2287,"title":2288},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2290,"title":2291},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2293,"title":2294},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2296,"title":2297},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fchecking-pypi-for-a-newer-version","Checking PyPI for a Newer Version of Your Python CLI",{"path":2299,"title":2300},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2302,"title":2303},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fopt-in-usage-telemetry-for-python-clis","Opt-In Usage Telemetry for Python CLIs Done Responsibly",{"path":2305,"title":2306},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fself-upgrading-a-cli-installed-with-pipx-or-uv","Self-Upgrading a Python CLI Installed with pipx or uv",{"path":2308,"title":2309},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fshowing-non-blocking-update-notices","Showing Non-Blocking Update Notices in a Python CLI",{"path":2311,"title":2312},"\u002F","Python CLI Toolcraft",{"path":2314,"title":2315},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2317,"title":2318},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2320,"title":2321},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2323,"title":2324},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2326,"title":2327},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fusage-string-driven-clis-with-docopt-ng","Usage-String Driven Python CLIs with docopt-ng",{"path":2329,"title":2330},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Favoiding-import-time-side-effects","Avoiding Import-Time Side Effects in a Python CLI",{"path":2332,"title":2333},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fcaching-expensive-work-between-cli-runs","Caching Expensive Work Between Python CLI Runs",{"path":2335,"title":2336},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2338,"title":2339},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2341,"title":2342},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2344,"title":2345},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2347,"title":2348},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2350,"title":2351},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2353,"title":2354},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2356,"title":2357},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargument-groups-and-help-formatting-in-argparse","Argument Groups and Help Formatting in argparse",{"path":2359,"title":2360},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2362,"title":2363},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2365,"title":2366},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2368,"title":2369},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Freading-arguments-from-files-with-fromfile-prefix-chars","Reading Arguments from Files with argparse’s fromfile_prefix_chars",{"path":2371,"title":2372},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2374,"title":2375},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fadding-dry-run-and-confirmation-to-destructive-commands","Adding Dry-Run and Confirmation to Destructive Commands",{"path":2377,"title":2378},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2380,"title":2381},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Ffollowing-posix-and-gnu-argument-conventions","Following POSIX and GNU Argument Conventions in Python",{"path":2383,"title":2384},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fglobal-options-vs-per-command-options","Global Options vs Per-Command Options in Python CLIs",{"path":2386,"title":2387},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2389,"title":2390},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2392,"title":2393},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2395,"title":2396},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2398,"title":2399},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2401,"title":2402},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2404,"title":2405},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2407,"title":2408},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2410,"title":2411},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2413,"title":2414},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2416,"title":2417},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fwriting-a-plugin-for-an-existing-cli","Writing a Plugin for an Existing CLI",{"path":2419,"title":2420},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fbest-practices-for-python-cli-entry-points","Best practices for Python CLI entry points",{"path":2422,"title":2423},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2425,"title":2426},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fhow-to-structure-a-large-python-cli-project","Structuring a Large Python CLI Project",{"path":2428,"title":2429},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2431,"title":2432},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Foffering-a-python-api-alongside-your-cli","Offering a Python API Alongside Your CLI",{"path":2434,"title":2435},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2437,"title":2438},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2440,"title":2441},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2443,"title":2444},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fend-to-end-testing-an-installed-cli","End-to-End Testing an Installed Python CLI",{"path":2446,"title":2447},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2449,"title":2450},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2452,"title":2453},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmocking-filesystem-and-network-in-cli-tests","Mocking the Filesystem and Network in CLI Tests",{"path":2455,"title":2456},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2458,"title":2459},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2461,"title":2462},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2464,"title":2465},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2467,"title":2468},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2470,"title":2471},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2473,"title":2474},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-a-cli-with-subcommands-in-click","Building a CLI with subcommands in Click",{"path":2476,"title":2477},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2479,"title":2480},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fchoices-and-enums-in-typer-and-click","Choices and Enums in Typer and Click Options",{"path":2482,"title":2483},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fclick-option-callbacks-and-eager-options","Click Option Callbacks and Eager Options Explained",{"path":2485,"title":2486},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fconverting-a-click-app-to-typer","Converting a Click App to Typer",{"path":2488,"title":2489},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2491,"title":2492},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Frich-markup-and-help-panels-in-typer","Rich Markup and Help Panels in Typer",{"path":2494,"title":2495},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2497,"title":2498},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2500,"title":2501},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2503,"title":2504},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2506,"title":2507},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2509,"title":2510},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fpublishing-a-cli-docker-image-from-ci","Publishing a Python CLI as a Docker Image from CI",{"path":2512,"title":2513},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fpublishing-to-pypi-with-trusted-publishing","Publishing a CLI to PyPI with Trusted Publishing",{"path":2515,"title":2516},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Frunning-cli-tests-on-windows-and-macos-runners","Running Python CLI Tests on Windows and macOS Runners",{"path":2518,"title":2519},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fsmoke-testing-the-built-wheel-in-ci","Smoke-Testing the Built Wheel of a Python CLI in CI",{"path":2521,"title":2522},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Ftesting-a-cli-across-python-versions-with-github-actions","Testing a CLI Across Python Versions in GitHub Actions",{"path":2524,"title":2525},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2527,"title":2528},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2530,"title":2531},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2533,"title":2534},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2536,"title":2537},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2539,"title":2540},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2542,"title":2543},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2545,"title":2546},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2548,"title":2549},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2551,"title":2552},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2554,"title":2555},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2557,"title":2558},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2560,"title":2561},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2563,"title":2564},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2566,"title":2567},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fshipping-a-cli-as-a-zipapp-with-shiv","Shipping a CLI as a Zipapp with shiv",{"path":2569,"title":2570},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2572,"title":2573},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2575,"title":2576},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fenforcing-import-boundaries-in-a-cli-codebase","Enforcing Import Boundaries in a Python CLI Codebase",{"path":2578,"title":2579},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Ffinding-unused-code-and-dependencies-with-vulture-and-deptry","Finding Unused Code and Dependencies with vulture and deptry",{"path":2581,"title":2582},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2584,"title":2585},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-pyright-in-strict-mode-on-a-cli","Running Pyright in Strict Mode on a Python CLI",{"path":2587,"title":2588},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-ruff-and-mypy-in-ci-with-annotations","Running Ruff and mypy in CI with Inline Annotations",{"path":2590,"title":2591},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Ftype-checking-click-and-typer-code-with-mypy","Type-Checking Click and Typer Code with mypy",{"path":2593,"title":2594},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2596,"title":2597},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2599,"title":2600},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fderiving-versions-from-git-tags-with-hatch-vcs","Deriving CLI Versions from Git Tags with hatch-vcs",{"path":2602,"title":2603},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2605,"title":2606},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2608,"title":2609},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2611,"title":2612},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fshipping-pre-releases-and-release-candidates","Shipping Pre-Releases and Release Candidates of a Python CLI",{"path":2614,"title":2615},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2617,"title":2618},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2620,"title":2621},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fchoosing-a-build-backend-for-a-python-cli","Choosing a Build Backend for a Python CLI",{"path":2623,"title":2624},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2626,"title":2627},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2629,"title":2630},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2632,"title":2633},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2635,"title":2636},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fwriting-pyproject-toml-metadata-for-a-cli","Writing pyproject.toml Metadata for a Python CLI",{"path":2638,"title":2639},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2641,"title":2642},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2644,"title":2645},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2647,"title":2648},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmigrating-a-cli-from-poetry-to-uv","Migrating a Python CLI from Poetry to uv",{"path":2650,"title":2651},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2653,"title":2654},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2656,"title":2657},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2659,"title":2660},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2662,"title":2663},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fkeeping-hook-versions-current-with-autoupdate","Keeping pre-commit Hook Versions Current with autoupdate",{"path":2665,"title":2666},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Frunning-pre-commit-in-ci","Running pre-commit in CI for a Python CLI Repository",{"path":2668,"title":2669},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fsetting-up-pre-commit-for-python-cli-repos","Setting up pre-commit for Python CLI repos",{"path":2671,"title":2672},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fshipping-your-cli-as-a-pre-commit-hook","Shipping Your Python CLI as a pre-commit Hook",{"path":2674,"title":2675},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fspeeding-up-slow-pre-commit-hooks","Speeding Up Slow pre-commit Hooks in a CLI Repository",{"path":2677,"title":2678},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fwriting-local-pre-commit-hooks-in-python","Writing Local pre-commit Hooks in Python",{"path":2680,"title":2681},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fauditing-dependencies-with-pip-audit","Auditing a Python CLI’s Dependencies with pip-audit",{"path":2683,"title":2684},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fgenerating-an-sbom-for-a-python-cli","Generating an SBOM for a Python CLI Release",{"path":2686,"title":2687},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2689,"title":2690},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2692,"title":2693},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2695,"title":2696},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fbuilding-and-publishing-a-cli-with-uv","Building and Publishing a Python CLI with uv",{"path":2698,"title":2699},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2701,"title":2702},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Flocking-and-syncing-cli-dependencies-with-uv","Locking and Syncing a Python CLI’s Dependencies with uv",{"path":2704,"title":2705},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Frunning-one-off-cli-scripts-with-uv-run","Running One-Off CLI Scripts with uv run and PEP 723",{"path":2707,"title":2708},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fusing-private-package-indexes-with-uv","Using Private Package Indexes with uv for Internal CLIs",{"path":2710,"title":2711},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-init-vs-poetry-init-for-cli-tools","uv init vs poetry init for CLI tools",{"path":2713,"title":2714},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-tool-install-vs-pipx-for-clis","uv tool install vs pipx for CLIs",{"path":2716,"title":2717},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2719,"title":2720},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fdebugging-wrong-python-and-wrong-venv-problems","Debugging Wrong-Python and Wrong-Venv Problems in CLIs",{"path":2722,"title":2723},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fexternally-managed-environments-and-pep-668","PEP 668 and Python CLIs: the externally-managed-environment Error",{"path":2725,"title":2726},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2728,"title":2729},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2731,"title":2732},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2734,"title":2735},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2737,"title":2738},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967537216]