[{"data":1,"prerenderedAt":2864},["ShallowReactive",2],{"page-\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli\u002F":3,"content-directory":2019},{"id":4,"title":5,"body":6,"date":2004,"description":2005,"difficulty":2006,"draft":2007,"extension":2008,"meta":2009,"navigation":150,"path":2010,"seo":2011,"stem":2012,"tags":2013,"updated":2004,"__hash__":2018},"content\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli\u002Findex.md","Testing Plugins Against the Host CLI",{"type":7,"value":8,"toc":1985},"minimark",[9,28,33,51,55,59,91,98,102,674,968,987,991,1267,1278,1281,1286,1293,1406,1412,1416,1428,1522,1525,1529,1532,1558,1561,1565,1568,1889,1893,1896,1900,1904,1914,1918,1929,1933,1940,1944,1947,1951,1981],[10,11,12,13,17,18,21,22,27],"p",{},"A plugin is code that only works inside someone else's program. Unit tests of its functions say little about whether it works when the host CLI discovers it, mounts its commands, passes it configuration and renders its output — and the host evolves on its own schedule, so a plugin that works today can break with the host's next minor release. Plugin testing therefore has two halves. The ",[14,15,16],"strong",{},"host"," should ship tools that make plugins easy to test: a way to build the CLI with a given plugin mounted, and a set of contract tests every plugin can run. The ",[14,19,20],{},"plugin"," should use them, verify its own packaging registers the entry point, and run its tests against every host version it claims to support. This guide builds both halves for a Typer-based host and plugin. It belongs to the ",[23,24,26],"a",{"href":25},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002F","plugin architectures topic",".",[29,30,32],"h2",{"id":31},"prerequisites","Prerequisites",[34,35,36,44],"ul",{},[37,38,39,40,27],"li",{},"A host CLI that mounts plugins from an entry-point group, as in ",[23,41,43],{"href":42},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points\u002F","discovering plugins with entry points",[37,45,46,47,27],{},"A plugin package written as in ",[23,48,50],{"href":49},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fwriting-a-plugin-for-an-existing-cli\u002F","writing a plugin for an existing CLI",[29,52,54],{"id":53},"what-to-test-and-where","What to test, and where",[56,57],"inline-diagram",{"name":58},"plugtest-layers",[60,61,62,68,79,85],"ol",{},[37,63,64,67],{},[14,65,66],{},"Plugin logic"," — ordinary unit tests in the plugin's repository, no host involved.",[37,69,70,73,74,78],{},[14,71,72],{},"The plugin inside the host"," — the host's real command tree with the plugin mounted, invoked through ",[75,76,77],"code",{},"CliRunner",". This catches option clashes, help rendering problems and assumptions about the context.",[37,80,81,84],{},[14,82,83],{},"Packaging"," — the installed plugin's entry point actually points at the right object, so discovery finds it.",[37,86,87,90],{},[14,88,89],{},"Compatibility"," — the same tests against the oldest and newest host versions the plugin supports.",[10,92,93,94,97],{},"The host makes layers 2 and 4 cheap by shipping a small ",[75,95,96],{},"testing"," module.",[29,99,101],{"id":100},"the-recipe-the-host-side","The recipe: the host side",[103,104,109],"pre",{"className":105,"code":106,"language":107,"meta":108,"style":108},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Ftesting.py\n\"\"\"Helpers for testing plugins against mytool. Part of the public plugin API.\"\"\"\nfrom __future__ import annotations\n\nfrom collections.abc import Mapping\n\nimport typer\nfrom typer.testing import CliRunner, Result\n\nfrom mytool.cli import build_app\n\n\ndef app_with_plugins(plugins: Mapping[str, typer.Typer], *, discover: bool = False) -> typer.Typer:\n    \"\"\"Build the real mytool command tree with the given plugin apps mounted.\"\"\"\n    return build_app(extra_plugins=dict(plugins), discover=discover)\n\n\ndef invoke(app: typer.Typer, *args: str, env: Mapping[str, str] | None = None) -> Result:\n    return CliRunner().invoke(app, list(args), env=dict(env or {}))\n\n\ndef check_plugin_contract(name: str, plugin_app: typer.Typer) -> list[str]:\n    \"\"\"Return a list of contract violations for a plugin app (empty means OK).\"\"\"\n    problems = []\n    app = app_with_plugins({name: plugin_app})\n    help_result = invoke(app, name, \"--help\")\n    if help_result.exit_code != 0:\n        problems.append(f\"'{name} --help' exited with {help_result.exit_code}\")\n    for info in plugin_app.registered_commands:\n        cmd = info.name or info.callback.__name__.replace(\"_\", \"-\")\n        if not (info.help or info.callback.__doc__):\n            problems.append(f\"command {cmd!r} has no help text\")\n        result = invoke(app, name, cmd, \"--help\")\n        if result.exit_code != 0:\n            problems.append(f\"'{name} {cmd} --help' exited with {result.exit_code}\")\n    return problems\n","python","",[75,110,111,120,127,145,152,166,171,179,192,197,210,215,220,257,263,293,298,303,347,377,382,387,408,414,425,436,453,471,507,522,554,576,602,617,631,666],{"__ignoreMap":108},[112,113,116],"span",{"class":114,"line":115},"line",1,[112,117,119],{"class":118},"sJ8bj","# src\u002Fmytool\u002Ftesting.py\n",[112,121,123],{"class":114,"line":122},2,[112,124,126],{"class":125},"sZZnC","\"\"\"Helpers for testing plugins against mytool. Part of the public plugin API.\"\"\"\n",[112,128,130,134,138,141],{"class":114,"line":129},3,[112,131,133],{"class":132},"szBVR","from",[112,135,137],{"class":136},"sj4cs"," __future__",[112,139,140],{"class":132}," import",[112,142,144],{"class":143},"sVt8B"," annotations\n",[112,146,148],{"class":114,"line":147},4,[112,149,151],{"emptyLinePlaceholder":150},true,"\n",[112,153,155,157,160,163],{"class":114,"line":154},5,[112,156,133],{"class":132},[112,158,159],{"class":143}," collections.abc ",[112,161,162],{"class":132},"import",[112,164,165],{"class":143}," Mapping\n",[112,167,169],{"class":114,"line":168},6,[112,170,151],{"emptyLinePlaceholder":150},[112,172,174,176],{"class":114,"line":173},7,[112,175,162],{"class":132},[112,177,178],{"class":143}," typer\n",[112,180,182,184,187,189],{"class":114,"line":181},8,[112,183,133],{"class":132},[112,185,186],{"class":143}," typer.testing ",[112,188,162],{"class":132},[112,190,191],{"class":143}," CliRunner, Result\n",[112,193,195],{"class":114,"line":194},9,[112,196,151],{"emptyLinePlaceholder":150},[112,198,200,202,205,207],{"class":114,"line":199},10,[112,201,133],{"class":132},[112,203,204],{"class":143}," mytool.cli ",[112,206,162],{"class":132},[112,208,209],{"class":143}," build_app\n",[112,211,213],{"class":114,"line":212},11,[112,214,151],{"emptyLinePlaceholder":150},[112,216,218],{"class":114,"line":217},12,[112,219,151],{"emptyLinePlaceholder":150},[112,221,223,226,230,233,236,239,242,245,248,251,254],{"class":114,"line":222},13,[112,224,225],{"class":132},"def",[112,227,229],{"class":228},"sScJk"," app_with_plugins",[112,231,232],{"class":143},"(plugins: Mapping[",[112,234,235],{"class":136},"str",[112,237,238],{"class":143},", typer.Typer], ",[112,240,241],{"class":132},"*",[112,243,244],{"class":143},", discover: ",[112,246,247],{"class":136},"bool",[112,249,250],{"class":132}," =",[112,252,253],{"class":136}," False",[112,255,256],{"class":143},") -> typer.Typer:\n",[112,258,260],{"class":114,"line":259},14,[112,261,262],{"class":125},"    \"\"\"Build the real mytool command tree with the given plugin apps mounted.\"\"\"\n",[112,264,266,269,272,276,279,282,285,288,290],{"class":114,"line":265},15,[112,267,268],{"class":132},"    return",[112,270,271],{"class":143}," build_app(",[112,273,275],{"class":274},"s4XuR","extra_plugins",[112,277,278],{"class":132},"=",[112,280,281],{"class":136},"dict",[112,283,284],{"class":143},"(plugins), ",[112,286,287],{"class":274},"discover",[112,289,278],{"class":132},[112,291,292],{"class":143},"discover)\n",[112,294,296],{"class":114,"line":295},16,[112,297,151],{"emptyLinePlaceholder":150},[112,299,301],{"class":114,"line":300},17,[112,302,151],{"emptyLinePlaceholder":150},[112,304,306,308,311,314,316,319,321,324,326,329,331,334,337,340,342,344],{"class":114,"line":305},18,[112,307,225],{"class":132},[112,309,310],{"class":228}," invoke",[112,312,313],{"class":143},"(app: typer.Typer, ",[112,315,241],{"class":132},[112,317,318],{"class":143},"args: ",[112,320,235],{"class":136},[112,322,323],{"class":143},", env: Mapping[",[112,325,235],{"class":136},[112,327,328],{"class":143},", ",[112,330,235],{"class":136},[112,332,333],{"class":143},"] ",[112,335,336],{"class":132},"|",[112,338,339],{"class":136}," None",[112,341,250],{"class":132},[112,343,339],{"class":136},[112,345,346],{"class":143},") -> Result:\n",[112,348,350,352,355,358,361,364,366,368,371,374],{"class":114,"line":349},19,[112,351,268],{"class":132},[112,353,354],{"class":143}," CliRunner().invoke(app, ",[112,356,357],{"class":136},"list",[112,359,360],{"class":143},"(args), ",[112,362,363],{"class":274},"env",[112,365,278],{"class":132},[112,367,281],{"class":136},[112,369,370],{"class":143},"(env ",[112,372,373],{"class":132},"or",[112,375,376],{"class":143}," {}))\n",[112,378,380],{"class":114,"line":379},20,[112,381,151],{"emptyLinePlaceholder":150},[112,383,385],{"class":114,"line":384},21,[112,386,151],{"emptyLinePlaceholder":150},[112,388,390,392,395,398,400,403,405],{"class":114,"line":389},22,[112,391,225],{"class":132},[112,393,394],{"class":228}," check_plugin_contract",[112,396,397],{"class":143},"(name: ",[112,399,235],{"class":136},[112,401,402],{"class":143},", plugin_app: typer.Typer) -> list[",[112,404,235],{"class":136},[112,406,407],{"class":143},"]:\n",[112,409,411],{"class":114,"line":410},23,[112,412,413],{"class":125},"    \"\"\"Return a list of contract violations for a plugin app (empty means OK).\"\"\"\n",[112,415,417,420,422],{"class":114,"line":416},24,[112,418,419],{"class":143},"    problems ",[112,421,278],{"class":132},[112,423,424],{"class":143}," []\n",[112,426,428,431,433],{"class":114,"line":427},25,[112,429,430],{"class":143},"    app ",[112,432,278],{"class":132},[112,434,435],{"class":143}," app_with_plugins({name: plugin_app})\n",[112,437,439,442,444,447,450],{"class":114,"line":438},26,[112,440,441],{"class":143},"    help_result ",[112,443,278],{"class":132},[112,445,446],{"class":143}," invoke(app, name, ",[112,448,449],{"class":125},"\"--help\"",[112,451,452],{"class":143},")\n",[112,454,456,459,462,465,468],{"class":114,"line":455},27,[112,457,458],{"class":132},"    if",[112,460,461],{"class":143}," help_result.exit_code ",[112,463,464],{"class":132},"!=",[112,466,467],{"class":136}," 0",[112,469,470],{"class":143},":\n",[112,472,474,477,480,483,486,489,492,495,497,500,502,505],{"class":114,"line":473},28,[112,475,476],{"class":143},"        problems.append(",[112,478,479],{"class":132},"f",[112,481,482],{"class":125},"\"'",[112,484,485],{"class":136},"{",[112,487,488],{"class":143},"name",[112,490,491],{"class":136},"}",[112,493,494],{"class":125}," --help' exited with ",[112,496,485],{"class":136},[112,498,499],{"class":143},"help_result.exit_code",[112,501,491],{"class":136},[112,503,504],{"class":125},"\"",[112,506,452],{"class":143},[112,508,510,513,516,519],{"class":114,"line":509},29,[112,511,512],{"class":132},"    for",[112,514,515],{"class":143}," info ",[112,517,518],{"class":132},"in",[112,520,521],{"class":143}," plugin_app.registered_commands:\n",[112,523,525,528,530,533,535,538,541,544,547,549,552],{"class":114,"line":524},30,[112,526,527],{"class":143},"        cmd ",[112,529,278],{"class":132},[112,531,532],{"class":143}," info.name ",[112,534,373],{"class":132},[112,536,537],{"class":143}," info.callback.",[112,539,540],{"class":136},"__name__",[112,542,543],{"class":143},".replace(",[112,545,546],{"class":125},"\"_\"",[112,548,328],{"class":143},[112,550,551],{"class":125},"\"-\"",[112,553,452],{"class":143},[112,555,557,560,563,566,568,570,573],{"class":114,"line":556},31,[112,558,559],{"class":132},"        if",[112,561,562],{"class":132}," not",[112,564,565],{"class":143}," (info.help ",[112,567,373],{"class":132},[112,569,537],{"class":143},[112,571,572],{"class":136},"__doc__",[112,574,575],{"class":143},"):\n",[112,577,579,582,584,587,589,592,595,597,600],{"class":114,"line":578},32,[112,580,581],{"class":143},"            problems.append(",[112,583,479],{"class":132},[112,585,586],{"class":125},"\"command ",[112,588,485],{"class":136},[112,590,591],{"class":143},"cmd",[112,593,594],{"class":132},"!r",[112,596,491],{"class":136},[112,598,599],{"class":125}," has no help text\"",[112,601,452],{"class":143},[112,603,605,608,610,613,615],{"class":114,"line":604},33,[112,606,607],{"class":143},"        result ",[112,609,278],{"class":132},[112,611,612],{"class":143}," invoke(app, name, cmd, ",[112,614,449],{"class":125},[112,616,452],{"class":143},[112,618,620,622,625,627,629],{"class":114,"line":619},34,[112,621,559],{"class":132},[112,623,624],{"class":143}," result.exit_code ",[112,626,464],{"class":132},[112,628,467],{"class":136},[112,630,470],{"class":143},[112,632,634,636,638,640,642,644,646,649,651,653,655,657,660,662,664],{"class":114,"line":633},35,[112,635,581],{"class":143},[112,637,479],{"class":132},[112,639,482],{"class":125},[112,641,485],{"class":136},[112,643,488],{"class":143},[112,645,491],{"class":136},[112,647,648],{"class":136}," {",[112,650,591],{"class":143},[112,652,491],{"class":136},[112,654,494],{"class":125},[112,656,485],{"class":136},[112,658,659],{"class":143},"result.exit_code",[112,661,491],{"class":136},[112,663,504],{"class":125},[112,665,452],{"class":143},[112,667,669,671],{"class":114,"line":668},36,[112,670,268],{"class":132},[112,672,673],{"class":143}," problems\n",[103,675,677],{"className":105,"code":676,"language":107,"meta":108,"style":108},"# src\u002Fmytool\u002Fcli.py (excerpt)\nfrom importlib.metadata import entry_points\n\nimport typer\n\nBUILTINS = {\"status\", \"plugins\"}\n\n\ndef build_app(extra_plugins: dict[str, typer.Typer] | None = None,\n              discover: bool = True) -> typer.Typer:\n    app = typer.Typer()\n\n    @app.callback()\n    def main() -> None:\n        \"\"\"mytool.\"\"\"\n\n    @app.command()\n    def status() -> None:\n        \"\"\"Show status.\"\"\"\n        typer.echo(\"ok\")\n\n    plugins = dict(extra_plugins or {})\n    if discover:\n        for ep in entry_points(group=\"mytool.commands\"):\n            plugins.setdefault(ep.name, ep.load())\n    for name, plugin_app in sorted(plugins.items()):\n        if name not in BUILTINS:\n            app.add_typer(plugin_app, name=name)\n    return app\n",[75,678,679,684,696,700,706,710,730,734,738,764,778,787,791,799,815,820,824,831,844,849,859,863,881,888,911,916,931,949,961],{"__ignoreMap":108},[112,680,681],{"class":114,"line":115},[112,682,683],{"class":118},"# src\u002Fmytool\u002Fcli.py (excerpt)\n",[112,685,686,688,691,693],{"class":114,"line":122},[112,687,133],{"class":132},[112,689,690],{"class":143}," importlib.metadata ",[112,692,162],{"class":132},[112,694,695],{"class":143}," entry_points\n",[112,697,698],{"class":114,"line":129},[112,699,151],{"emptyLinePlaceholder":150},[112,701,702,704],{"class":114,"line":147},[112,703,162],{"class":132},[112,705,178],{"class":143},[112,707,708],{"class":114,"line":154},[112,709,151],{"emptyLinePlaceholder":150},[112,711,712,715,717,719,722,724,727],{"class":114,"line":168},[112,713,714],{"class":136},"BUILTINS",[112,716,250],{"class":132},[112,718,648],{"class":143},[112,720,721],{"class":125},"\"status\"",[112,723,328],{"class":143},[112,725,726],{"class":125},"\"plugins\"",[112,728,729],{"class":143},"}\n",[112,731,732],{"class":114,"line":173},[112,733,151],{"emptyLinePlaceholder":150},[112,735,736],{"class":114,"line":181},[112,737,151],{"emptyLinePlaceholder":150},[112,739,740,742,745,748,750,753,755,757,759,761],{"class":114,"line":194},[112,741,225],{"class":132},[112,743,744],{"class":228}," build_app",[112,746,747],{"class":143},"(extra_plugins: dict[",[112,749,235],{"class":136},[112,751,752],{"class":143},", typer.Typer] ",[112,754,336],{"class":132},[112,756,339],{"class":136},[112,758,250],{"class":132},[112,760,339],{"class":136},[112,762,763],{"class":143},",\n",[112,765,766,769,771,773,776],{"class":114,"line":199},[112,767,768],{"class":143},"              discover: ",[112,770,247],{"class":136},[112,772,250],{"class":132},[112,774,775],{"class":136}," True",[112,777,256],{"class":143},[112,779,780,782,784],{"class":114,"line":212},[112,781,430],{"class":143},[112,783,278],{"class":132},[112,785,786],{"class":143}," typer.Typer()\n",[112,788,789],{"class":114,"line":217},[112,790,151],{"emptyLinePlaceholder":150},[112,792,793,796],{"class":114,"line":222},[112,794,795],{"class":228},"    @app.callback",[112,797,798],{"class":143},"()\n",[112,800,801,804,807,810,813],{"class":114,"line":259},[112,802,803],{"class":132},"    def",[112,805,806],{"class":228}," main",[112,808,809],{"class":143},"() -> ",[112,811,812],{"class":136},"None",[112,814,470],{"class":143},[112,816,817],{"class":114,"line":265},[112,818,819],{"class":125},"        \"\"\"mytool.\"\"\"\n",[112,821,822],{"class":114,"line":295},[112,823,151],{"emptyLinePlaceholder":150},[112,825,826,829],{"class":114,"line":300},[112,827,828],{"class":228},"    @app.command",[112,830,798],{"class":143},[112,832,833,835,838,840,842],{"class":114,"line":305},[112,834,803],{"class":132},[112,836,837],{"class":228}," status",[112,839,809],{"class":143},[112,841,812],{"class":136},[112,843,470],{"class":143},[112,845,846],{"class":114,"line":349},[112,847,848],{"class":125},"        \"\"\"Show status.\"\"\"\n",[112,850,851,854,857],{"class":114,"line":379},[112,852,853],{"class":143},"        typer.echo(",[112,855,856],{"class":125},"\"ok\"",[112,858,452],{"class":143},[112,860,861],{"class":114,"line":384},[112,862,151],{"emptyLinePlaceholder":150},[112,864,865,868,870,873,876,878],{"class":114,"line":389},[112,866,867],{"class":143},"    plugins ",[112,869,278],{"class":132},[112,871,872],{"class":136}," dict",[112,874,875],{"class":143},"(extra_plugins ",[112,877,373],{"class":132},[112,879,880],{"class":143}," {})\n",[112,882,883,885],{"class":114,"line":410},[112,884,458],{"class":132},[112,886,887],{"class":143}," discover:\n",[112,889,890,893,896,898,901,904,906,909],{"class":114,"line":416},[112,891,892],{"class":132},"        for",[112,894,895],{"class":143}," ep ",[112,897,518],{"class":132},[112,899,900],{"class":143}," entry_points(",[112,902,903],{"class":274},"group",[112,905,278],{"class":132},[112,907,908],{"class":125},"\"mytool.commands\"",[112,910,575],{"class":143},[112,912,913],{"class":114,"line":427},[112,914,915],{"class":143},"            plugins.setdefault(ep.name, ep.load())\n",[112,917,918,920,923,925,928],{"class":114,"line":438},[112,919,512],{"class":132},[112,921,922],{"class":143}," name, plugin_app ",[112,924,518],{"class":132},[112,926,927],{"class":136}," sorted",[112,929,930],{"class":143},"(plugins.items()):\n",[112,932,933,935,938,941,944,947],{"class":114,"line":455},[112,934,559],{"class":132},[112,936,937],{"class":143}," name ",[112,939,940],{"class":132},"not",[112,942,943],{"class":132}," in",[112,945,946],{"class":136}," BUILTINS",[112,948,470],{"class":143},[112,950,951,954,956,958],{"class":114,"line":473},[112,952,953],{"class":143},"            app.add_typer(plugin_app, ",[112,955,488],{"class":274},[112,957,278],{"class":132},[112,959,960],{"class":143},"name)\n",[112,962,963,965],{"class":114,"line":509},[112,964,268],{"class":132},[112,966,967],{"class":143}," app\n",[10,969,970,971,974,975,978,979,982,983,27],{},"The essential design decision is that the command tree is built by a ",[14,972,973],{},"function",", not at import time, so tests can build it with exactly the plugins they want — and with discovery switched off, so a developer's other installed plugins do not leak into the test. ",[75,976,977],{},"check_plugin_contract"," encodes the host's expectations once — every command has help, help renders without error — so every plugin checks the same rules. Treat ",[75,980,981],{},"mytool.testing"," as public API: document it, and keep it stable across minor versions like the rest of the plugin interface described in ",[23,984,986],{"href":985},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api\u002F","versioning a plugin API",[29,988,990],{"id":989},"the-recipe-the-plugin-side","The recipe: the plugin side",[103,992,994],{"className":105,"code":993,"language":107,"meta":108,"style":108},"# tests\u002Ftest_in_host.py (in the mytool-aws plugin repository)\nfrom importlib.metadata import entry_points\n\nfrom mytool.testing import app_with_plugins, check_plugin_contract, invoke\n\nfrom mytool_aws.cli import app as aws_app\n\n\ndef test_plugin_meets_the_host_contract():\n    assert check_plugin_contract(\"aws\", aws_app) == []\n\n\ndef test_command_runs_inside_the_host():\n    app = app_with_plugins({\"aws\": aws_app})\n    result = invoke(app, \"aws\", \"buckets\", \"--prefix\", \"logs-\",\n                    env={\"MYTOOL_AWS_FAKE\": \"1\"})\n    assert result.exit_code == 0\n    assert \"logs-2026\" in result.stdout\n\n\ndef test_entry_point_is_registered():\n    eps = {ep.name: ep for ep in entry_points(group=\"mytool.commands\")}\n    assert \"aws\" in eps, \"is the plugin installed (uv sync \u002F pip install -e .)?\"\n    assert eps[\"aws\"].load() is aws_app\n",[75,995,996,1001,1011,1015,1027,1031,1049,1053,1057,1067,1086,1090,1094,1103,1117,1146,1167,1178,1190,1194,1198,1207,1235,1250],{"__ignoreMap":108},[112,997,998],{"class":114,"line":115},[112,999,1000],{"class":118},"# tests\u002Ftest_in_host.py (in the mytool-aws plugin repository)\n",[112,1002,1003,1005,1007,1009],{"class":114,"line":122},[112,1004,133],{"class":132},[112,1006,690],{"class":143},[112,1008,162],{"class":132},[112,1010,695],{"class":143},[112,1012,1013],{"class":114,"line":129},[112,1014,151],{"emptyLinePlaceholder":150},[112,1016,1017,1019,1022,1024],{"class":114,"line":147},[112,1018,133],{"class":132},[112,1020,1021],{"class":143}," mytool.testing ",[112,1023,162],{"class":132},[112,1025,1026],{"class":143}," app_with_plugins, check_plugin_contract, invoke\n",[112,1028,1029],{"class":114,"line":154},[112,1030,151],{"emptyLinePlaceholder":150},[112,1032,1033,1035,1038,1040,1043,1046],{"class":114,"line":168},[112,1034,133],{"class":132},[112,1036,1037],{"class":143}," mytool_aws.cli ",[112,1039,162],{"class":132},[112,1041,1042],{"class":143}," app ",[112,1044,1045],{"class":132},"as",[112,1047,1048],{"class":143}," aws_app\n",[112,1050,1051],{"class":114,"line":173},[112,1052,151],{"emptyLinePlaceholder":150},[112,1054,1055],{"class":114,"line":181},[112,1056,151],{"emptyLinePlaceholder":150},[112,1058,1059,1061,1064],{"class":114,"line":194},[112,1060,225],{"class":132},[112,1062,1063],{"class":228}," test_plugin_meets_the_host_contract",[112,1065,1066],{"class":143},"():\n",[112,1068,1069,1072,1075,1078,1081,1084],{"class":114,"line":199},[112,1070,1071],{"class":132},"    assert",[112,1073,1074],{"class":143}," check_plugin_contract(",[112,1076,1077],{"class":125},"\"aws\"",[112,1079,1080],{"class":143},", aws_app) ",[112,1082,1083],{"class":132},"==",[112,1085,424],{"class":143},[112,1087,1088],{"class":114,"line":212},[112,1089,151],{"emptyLinePlaceholder":150},[112,1091,1092],{"class":114,"line":217},[112,1093,151],{"emptyLinePlaceholder":150},[112,1095,1096,1098,1101],{"class":114,"line":222},[112,1097,225],{"class":132},[112,1099,1100],{"class":228}," test_command_runs_inside_the_host",[112,1102,1066],{"class":143},[112,1104,1105,1107,1109,1112,1114],{"class":114,"line":259},[112,1106,430],{"class":143},[112,1108,278],{"class":132},[112,1110,1111],{"class":143}," app_with_plugins({",[112,1113,1077],{"class":125},[112,1115,1116],{"class":143},": aws_app})\n",[112,1118,1119,1122,1124,1127,1129,1131,1134,1136,1139,1141,1144],{"class":114,"line":265},[112,1120,1121],{"class":143},"    result ",[112,1123,278],{"class":132},[112,1125,1126],{"class":143}," invoke(app, ",[112,1128,1077],{"class":125},[112,1130,328],{"class":143},[112,1132,1133],{"class":125},"\"buckets\"",[112,1135,328],{"class":143},[112,1137,1138],{"class":125},"\"--prefix\"",[112,1140,328],{"class":143},[112,1142,1143],{"class":125},"\"logs-\"",[112,1145,763],{"class":143},[112,1147,1148,1151,1153,1155,1158,1161,1164],{"class":114,"line":295},[112,1149,1150],{"class":274},"                    env",[112,1152,278],{"class":132},[112,1154,485],{"class":143},[112,1156,1157],{"class":125},"\"MYTOOL_AWS_FAKE\"",[112,1159,1160],{"class":143},": ",[112,1162,1163],{"class":125},"\"1\"",[112,1165,1166],{"class":143},"})\n",[112,1168,1169,1171,1173,1175],{"class":114,"line":300},[112,1170,1071],{"class":132},[112,1172,624],{"class":143},[112,1174,1083],{"class":132},[112,1176,1177],{"class":136}," 0\n",[112,1179,1180,1182,1185,1187],{"class":114,"line":305},[112,1181,1071],{"class":132},[112,1183,1184],{"class":125}," \"logs-2026\"",[112,1186,943],{"class":132},[112,1188,1189],{"class":143}," result.stdout\n",[112,1191,1192],{"class":114,"line":349},[112,1193,151],{"emptyLinePlaceholder":150},[112,1195,1196],{"class":114,"line":379},[112,1197,151],{"emptyLinePlaceholder":150},[112,1199,1200,1202,1205],{"class":114,"line":384},[112,1201,225],{"class":132},[112,1203,1204],{"class":228}," test_entry_point_is_registered",[112,1206,1066],{"class":143},[112,1208,1209,1212,1214,1217,1220,1222,1224,1226,1228,1230,1232],{"class":114,"line":389},[112,1210,1211],{"class":143},"    eps ",[112,1213,278],{"class":132},[112,1215,1216],{"class":143}," {ep.name: ep ",[112,1218,1219],{"class":132},"for",[112,1221,895],{"class":143},[112,1223,518],{"class":132},[112,1225,900],{"class":143},[112,1227,903],{"class":274},[112,1229,278],{"class":132},[112,1231,908],{"class":125},[112,1233,1234],{"class":143},")}\n",[112,1236,1237,1239,1242,1244,1247],{"class":114,"line":410},[112,1238,1071],{"class":132},[112,1240,1241],{"class":125}," \"aws\"",[112,1243,943],{"class":132},[112,1245,1246],{"class":143}," eps, ",[112,1248,1249],{"class":125},"\"is the plugin installed (uv sync \u002F pip install -e .)?\"\n",[112,1251,1252,1254,1257,1259,1262,1265],{"class":114,"line":416},[112,1253,1071],{"class":132},[112,1255,1256],{"class":143}," eps[",[112,1258,1077],{"class":125},[112,1260,1261],{"class":143},"].load() ",[112,1263,1264],{"class":132},"is",[112,1266,1048],{"class":143},[10,1268,1269,1270,1273,1274,1277],{},"The last test is the packaging check. It fails if the ",[75,1271,1272],{},"[project.entry-points.\"mytool.commands\"]"," table in ",[75,1275,1276],{},"pyproject.toml"," has a typo, points at the wrong attribute, or uses the wrong group name — mistakes that pass every other test because those tests import the plugin directly.",[56,1279],{"name":1280},"plugtest-terminal",[1282,1283,1285],"h3",{"id":1284},"a-compatibility-matrix","A compatibility matrix",[10,1287,1288,1289,1292],{},"A plugin declares the host versions it supports in its dependencies (",[75,1290,1291],{},"mytool>=1.4,\u003C2","). CI should test the edges of that range, not just whatever version the lock file picked:",[103,1294,1298],{"className":1295,"code":1296,"language":1297,"meta":108,"style":108},"language-yaml shiki shiki-themes github-light github-dark","# .github\u002Fworkflows\u002Ftest.yml (in the plugin repository)\njobs:\n  test:\n    strategy:\n      matrix:\n        host: [\"mytool==1.4.*\", \"mytool\u003C2\"]\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions\u002Fcheckout@v4\n      - uses: astral-sh\u002Fsetup-uv@v6\n      - run: uv run --with \"${{ matrix.host }}\" pytest -q\n","yaml",[75,1299,1300,1305,1313,1320,1327,1334,1353,1363,1370,1383,1394],{"__ignoreMap":108},[112,1301,1302],{"class":114,"line":115},[112,1303,1304],{"class":118},"# .github\u002Fworkflows\u002Ftest.yml (in the plugin repository)\n",[112,1306,1307,1311],{"class":114,"line":122},[112,1308,1310],{"class":1309},"s9eBZ","jobs",[112,1312,470],{"class":143},[112,1314,1315,1318],{"class":114,"line":129},[112,1316,1317],{"class":1309},"  test",[112,1319,470],{"class":143},[112,1321,1322,1325],{"class":114,"line":147},[112,1323,1324],{"class":1309},"    strategy",[112,1326,470],{"class":143},[112,1328,1329,1332],{"class":114,"line":154},[112,1330,1331],{"class":1309},"      matrix",[112,1333,470],{"class":143},[112,1335,1336,1339,1342,1345,1347,1350],{"class":114,"line":168},[112,1337,1338],{"class":1309},"        host",[112,1340,1341],{"class":143},": [",[112,1343,1344],{"class":125},"\"mytool==1.4.*\"",[112,1346,328],{"class":143},[112,1348,1349],{"class":125},"\"mytool\u003C2\"",[112,1351,1352],{"class":143},"]\n",[112,1354,1355,1358,1360],{"class":114,"line":173},[112,1356,1357],{"class":1309},"    runs-on",[112,1359,1160],{"class":143},[112,1361,1362],{"class":125},"ubuntu-latest\n",[112,1364,1365,1368],{"class":114,"line":181},[112,1366,1367],{"class":1309},"    steps",[112,1369,470],{"class":143},[112,1371,1372,1375,1378,1380],{"class":114,"line":194},[112,1373,1374],{"class":143},"      - ",[112,1376,1377],{"class":1309},"uses",[112,1379,1160],{"class":143},[112,1381,1382],{"class":125},"actions\u002Fcheckout@v4\n",[112,1384,1385,1387,1389,1391],{"class":114,"line":199},[112,1386,1374],{"class":143},[112,1388,1377],{"class":1309},[112,1390,1160],{"class":143},[112,1392,1393],{"class":125},"astral-sh\u002Fsetup-uv@v6\n",[112,1395,1396,1398,1401,1403],{"class":114,"line":212},[112,1397,1374],{"class":143},[112,1399,1400],{"class":1309},"run",[112,1402,1160],{"class":143},[112,1404,1405],{"class":125},"uv run --with \"${{ matrix.host }}\" pytest -q\n",[10,1407,1408,1411],{},[75,1409,1410],{},"uv run --with"," adds the requested host version on top of the project environment for that run, so one job tests the oldest supported host and another the newest release. When the newest-host job fails, either the plugin needs a fix or the host broke its contract — both worth knowing before users find out. Hosts can return the favour: a scheduled job in the host repository that installs popular plugins and runs their contract checks catches accidental API breaks before a release.",[1282,1413,1415],{"id":1414},"testing-what-the-plugin-receives-from-the-host","Testing what the plugin receives from the host",[10,1417,1418,1419,1422,1423,1427],{},"Plugins rarely live on options alone: they read the host's configuration, use its HTTP client or credentials, and write output through its formatting helpers. Those touch points are the most fragile part of the contract, so the host's testing module should let plugin tests supply them explicitly instead of reaching for real files and environment variables. A typical pattern is a context object the host passes to plugins — on ",[75,1420,1421],{},"ctx.obj",", as in ",[23,1424,1426],{"href":1425},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects\u002F","sharing state with Click context objects"," — and a helper that builds one for tests:",[103,1429,1431],{"className":105,"code":1430,"language":107,"meta":108,"style":108},"# assumes a context-aware variant of the helpers above\nfrom mytool.testing import app_with_plugins, invoke, make_context\n\nctx = make_context(config={\"region\": \"eu-west-1\"}, output_format=\"json\")\nresult = invoke(app_with_plugins({\"aws\": aws_app}, context=ctx), \"aws\", \"buckets\")\n",[75,1432,1433,1438,1449,1453,1491],{"__ignoreMap":108},[112,1434,1435],{"class":114,"line":115},[112,1436,1437],{"class":118},"# assumes a context-aware variant of the helpers above\n",[112,1439,1440,1442,1444,1446],{"class":114,"line":122},[112,1441,133],{"class":132},[112,1443,1021],{"class":143},[112,1445,162],{"class":132},[112,1447,1448],{"class":143}," app_with_plugins, invoke, make_context\n",[112,1450,1451],{"class":114,"line":129},[112,1452,151],{"emptyLinePlaceholder":150},[112,1454,1455,1458,1460,1463,1466,1468,1470,1473,1475,1478,1481,1484,1486,1489],{"class":114,"line":147},[112,1456,1457],{"class":143},"ctx ",[112,1459,278],{"class":132},[112,1461,1462],{"class":143}," make_context(",[112,1464,1465],{"class":274},"config",[112,1467,278],{"class":132},[112,1469,485],{"class":143},[112,1471,1472],{"class":125},"\"region\"",[112,1474,1160],{"class":143},[112,1476,1477],{"class":125},"\"eu-west-1\"",[112,1479,1480],{"class":143},"}, ",[112,1482,1483],{"class":274},"output_format",[112,1485,278],{"class":132},[112,1487,1488],{"class":125},"\"json\"",[112,1490,452],{"class":143},[112,1492,1493,1496,1498,1501,1503,1506,1509,1511,1514,1516,1518,1520],{"class":114,"line":154},[112,1494,1495],{"class":143},"result ",[112,1497,278],{"class":132},[112,1499,1500],{"class":143}," invoke(app_with_plugins({",[112,1502,1077],{"class":125},[112,1504,1505],{"class":143},": aws_app}, ",[112,1507,1508],{"class":274},"context",[112,1510,278],{"class":132},[112,1512,1513],{"class":143},"ctx), ",[112,1515,1077],{"class":125},[112,1517,328],{"class":143},[112,1519,1133],{"class":125},[112,1521,452],{"class":143},[10,1523,1524],{},"The plugin then tests real interactions — \"when the host is in JSON mode, my command returns records rather than printing a table\" — without knowing how the host loads configuration internally. When the host changes that internal machinery, plugin tests keep passing because they only depend on the published context shape. Keep the context small and versioned; every field on it is something plugins will start to rely on.",[29,1526,1528],{"id":1527},"ux-considerations","UX considerations",[10,1530,1531],{},"The users of this tooling are plugin authors, often outside your team:",[34,1533,1534,1540,1546,1552],{},[37,1535,1536,1539],{},[14,1537,1538],{},"Document the testing module"," next to the plugin guide, with a copy-paste example like the plugin-side tests above.",[37,1541,1542,1545],{},[14,1543,1544],{},"Make contract failures specific."," \"command 'buckets' has no help text\" is actionable; \"contract failed\" is not.",[37,1547,1548,1551],{},[14,1549,1550],{},"Keep discovery out of tests by default."," A test that silently picks up every plugin installed on the developer's machine is flaky in the most confusing way.",[37,1553,1554,1557],{},[14,1555,1556],{},"Version the contract."," If the host adds a rule, announce it, and consider making it a warning for one minor release before it fails.",[56,1559],{"name":1560},"plugtest-matrix",[29,1562,1564],{"id":1563},"testing-the-behaviour","Testing the behaviour",[10,1566,1567],{},"The host should test its own testing helpers — they are API — including that the contract check actually catches violations:",[103,1569,1571],{"className":105,"code":1570,"language":107,"meta":108,"style":108},"# tests\u002Ftest_testing_helpers.py (in the host repository)\nimport typer\n\nfrom mytool.testing import app_with_plugins, check_plugin_contract, invoke\n\n\ndef make_plugin(with_docs: bool) -> typer.Typer:\n    plugin = typer.Typer()\n\n    @plugin.command()\n    def ping() -> None:\n        typer.echo(\"pong\")\n\n    if with_docs:\n        ping.__doc__ = \"Reply with pong.\"\n    return plugin\n\n\ndef test_mounted_plugin_runs():\n    result = invoke(app_with_plugins({\"net\": make_plugin(True)}), \"net\", \"ping\")\n    assert result.stdout == \"pong\\n\"\n\n\ndef test_contract_passes_for_documented_plugin():\n    assert check_plugin_contract(\"net\", make_plugin(True)) == []\n\n\ndef test_contract_flags_missing_help():\n    assert check_plugin_contract(\"net\", make_plugin(False)) == [\"command 'ping' has no help text\"]\n\n\ndef test_builtins_cannot_be_shadowed():\n    app = app_with_plugins({\"status\": make_plugin(True)})\n    assert invoke(app, \"status\").stdout == \"ok\\n\"\n",[75,1572,1573,1578,1584,1588,1598,1602,1606,1620,1629,1633,1640,1653,1662,1666,1673,1685,1692,1696,1700,1709,1738,1756,1760,1764,1773,1793,1797,1801,1810,1835,1839,1843,1852,1869],{"__ignoreMap":108},[112,1574,1575],{"class":114,"line":115},[112,1576,1577],{"class":118},"# tests\u002Ftest_testing_helpers.py (in the host repository)\n",[112,1579,1580,1582],{"class":114,"line":122},[112,1581,162],{"class":132},[112,1583,178],{"class":143},[112,1585,1586],{"class":114,"line":129},[112,1587,151],{"emptyLinePlaceholder":150},[112,1589,1590,1592,1594,1596],{"class":114,"line":147},[112,1591,133],{"class":132},[112,1593,1021],{"class":143},[112,1595,162],{"class":132},[112,1597,1026],{"class":143},[112,1599,1600],{"class":114,"line":154},[112,1601,151],{"emptyLinePlaceholder":150},[112,1603,1604],{"class":114,"line":168},[112,1605,151],{"emptyLinePlaceholder":150},[112,1607,1608,1610,1613,1616,1618],{"class":114,"line":173},[112,1609,225],{"class":132},[112,1611,1612],{"class":228}," make_plugin",[112,1614,1615],{"class":143},"(with_docs: ",[112,1617,247],{"class":136},[112,1619,256],{"class":143},[112,1621,1622,1625,1627],{"class":114,"line":181},[112,1623,1624],{"class":143},"    plugin ",[112,1626,278],{"class":132},[112,1628,786],{"class":143},[112,1630,1631],{"class":114,"line":194},[112,1632,151],{"emptyLinePlaceholder":150},[112,1634,1635,1638],{"class":114,"line":199},[112,1636,1637],{"class":228},"    @plugin.command",[112,1639,798],{"class":143},[112,1641,1642,1644,1647,1649,1651],{"class":114,"line":212},[112,1643,803],{"class":132},[112,1645,1646],{"class":228}," ping",[112,1648,809],{"class":143},[112,1650,812],{"class":136},[112,1652,470],{"class":143},[112,1654,1655,1657,1660],{"class":114,"line":217},[112,1656,853],{"class":143},[112,1658,1659],{"class":125},"\"pong\"",[112,1661,452],{"class":143},[112,1663,1664],{"class":114,"line":222},[112,1665,151],{"emptyLinePlaceholder":150},[112,1667,1668,1670],{"class":114,"line":259},[112,1669,458],{"class":132},[112,1671,1672],{"class":143}," with_docs:\n",[112,1674,1675,1678,1680,1682],{"class":114,"line":265},[112,1676,1677],{"class":143},"        ping.",[112,1679,572],{"class":136},[112,1681,250],{"class":132},[112,1683,1684],{"class":125}," \"Reply with pong.\"\n",[112,1686,1687,1689],{"class":114,"line":295},[112,1688,268],{"class":132},[112,1690,1691],{"class":143}," plugin\n",[112,1693,1694],{"class":114,"line":300},[112,1695,151],{"emptyLinePlaceholder":150},[112,1697,1698],{"class":114,"line":305},[112,1699,151],{"emptyLinePlaceholder":150},[112,1701,1702,1704,1707],{"class":114,"line":349},[112,1703,225],{"class":132},[112,1705,1706],{"class":228}," test_mounted_plugin_runs",[112,1708,1066],{"class":143},[112,1710,1711,1713,1715,1717,1720,1723,1726,1729,1731,1733,1736],{"class":114,"line":379},[112,1712,1121],{"class":143},[112,1714,278],{"class":132},[112,1716,1500],{"class":143},[112,1718,1719],{"class":125},"\"net\"",[112,1721,1722],{"class":143},": make_plugin(",[112,1724,1725],{"class":136},"True",[112,1727,1728],{"class":143},")}), ",[112,1730,1719],{"class":125},[112,1732,328],{"class":143},[112,1734,1735],{"class":125},"\"ping\"",[112,1737,452],{"class":143},[112,1739,1740,1742,1745,1747,1750,1753],{"class":114,"line":384},[112,1741,1071],{"class":132},[112,1743,1744],{"class":143}," result.stdout ",[112,1746,1083],{"class":132},[112,1748,1749],{"class":125}," \"pong",[112,1751,1752],{"class":136},"\\n",[112,1754,1755],{"class":125},"\"\n",[112,1757,1758],{"class":114,"line":389},[112,1759,151],{"emptyLinePlaceholder":150},[112,1761,1762],{"class":114,"line":410},[112,1763,151],{"emptyLinePlaceholder":150},[112,1765,1766,1768,1771],{"class":114,"line":416},[112,1767,225],{"class":132},[112,1769,1770],{"class":228}," test_contract_passes_for_documented_plugin",[112,1772,1066],{"class":143},[112,1774,1775,1777,1779,1781,1784,1786,1789,1791],{"class":114,"line":427},[112,1776,1071],{"class":132},[112,1778,1074],{"class":143},[112,1780,1719],{"class":125},[112,1782,1783],{"class":143},", make_plugin(",[112,1785,1725],{"class":136},[112,1787,1788],{"class":143},")) ",[112,1790,1083],{"class":132},[112,1792,424],{"class":143},[112,1794,1795],{"class":114,"line":438},[112,1796,151],{"emptyLinePlaceholder":150},[112,1798,1799],{"class":114,"line":455},[112,1800,151],{"emptyLinePlaceholder":150},[112,1802,1803,1805,1808],{"class":114,"line":473},[112,1804,225],{"class":132},[112,1806,1807],{"class":228}," test_contract_flags_missing_help",[112,1809,1066],{"class":143},[112,1811,1812,1814,1816,1818,1820,1823,1825,1827,1830,1833],{"class":114,"line":509},[112,1813,1071],{"class":132},[112,1815,1074],{"class":143},[112,1817,1719],{"class":125},[112,1819,1783],{"class":143},[112,1821,1822],{"class":136},"False",[112,1824,1788],{"class":143},[112,1826,1083],{"class":132},[112,1828,1829],{"class":143}," [",[112,1831,1832],{"class":125},"\"command 'ping' has no help text\"",[112,1834,1352],{"class":143},[112,1836,1837],{"class":114,"line":524},[112,1838,151],{"emptyLinePlaceholder":150},[112,1840,1841],{"class":114,"line":556},[112,1842,151],{"emptyLinePlaceholder":150},[112,1844,1845,1847,1850],{"class":114,"line":578},[112,1846,225],{"class":132},[112,1848,1849],{"class":228}," test_builtins_cannot_be_shadowed",[112,1851,1066],{"class":143},[112,1853,1854,1856,1858,1860,1862,1864,1866],{"class":114,"line":604},[112,1855,430],{"class":143},[112,1857,278],{"class":132},[112,1859,1111],{"class":143},[112,1861,721],{"class":125},[112,1863,1722],{"class":143},[112,1865,1725],{"class":136},[112,1867,1868],{"class":143},")})\n",[112,1870,1871,1873,1875,1877,1880,1882,1885,1887],{"class":114,"line":619},[112,1872,1071],{"class":132},[112,1874,1126],{"class":143},[112,1876,721],{"class":125},[112,1878,1879],{"class":143},").stdout ",[112,1881,1083],{"class":132},[112,1883,1884],{"class":125}," \"ok",[112,1886,1752],{"class":136},[112,1888,1755],{"class":125},[29,1890,1892],{"id":1891},"conclusion","Conclusion",[10,1894,1895],{},"Plugins are only as reliable as their integration with the host. Give plugin authors a host-provided testing module that builds the real command tree with chosen plugins mounted and checks a written contract; in each plugin, test inside that tree, verify the entry point resolves to the right object, and run the suite against the oldest and newest supported host versions. Hosts that also run popular plugins' checks before releasing catch their own breaking changes first.",[29,1897,1899],{"id":1898},"frequently-asked-questions","Frequently asked questions",[1282,1901,1903],{"id":1902},"should-the-hosts-testing-helpers-be-in-a-separate-package","Should the host's testing helpers be in a separate package?",[10,1905,1906,1907,1909,1910,1913],{},"They can live in the host package (",[75,1908,981],{},"), which keeps versions aligned automatically. Move them to ",[75,1911,1912],{},"mytool-testing"," only if they pull in test-only dependencies the host does not otherwise need.",[1282,1915,1917],{"id":1916},"can-the-contract-be-a-pytest-plugin","Can the contract be a pytest plugin?",[10,1919,1920,1921,1924,1925,1928],{},"Yes: register a ",[75,1922,1923],{},"pytest11"," entry point in the host that provides fixtures such as ",[75,1926,1927],{},"mytool_app",", and plugins get them automatically when the host is installed. It is more magic than an explicit import; for small ecosystems the explicit helper is easier to understand.",[1282,1930,1932],{"id":1931},"how-do-i-test-a-plugin-against-an-unreleased-host","How do I test a plugin against an unreleased host?",[10,1934,1935,1936,1939],{},"Point the matrix at the host's main branch: ",[75,1937,1938],{},"uv run --with \"mytool @ git+https:\u002F\u002Fgithub.com\u002Facme\u002Fmytool\"",". Run it on a schedule rather than on every pull request, since upstream main can break for unrelated reasons.",[1282,1941,1943],{"id":1942},"what-about-plugins-discovered-from-a-directory-instead-of-entry-points","What about plugins discovered from a directory instead of entry points?",[10,1945,1946],{},"The same layers apply; replace the entry-point check with a test that the plugin file is found and loaded by the host's discovery function from a temporary directory.",[29,1948,1950],{"id":1949},"related","Related",[34,1952,1953,1959,1964,1970,1975],{},[37,1954,1955,1956],{},"Up: ",[23,1957,1958],{"href":25},"Plugin architectures for extensible CLIs",[37,1960,1961],{},[23,1962,1963],{"href":49},"Writing a plugin for an existing CLI",[37,1965,1966],{},[23,1967,1969],{"href":1968},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures\u002F","Isolating plugin failures",[37,1971,1972],{},[23,1973,1974],{"href":985},"Versioning a plugin API",[37,1976,1977],{},[23,1978,1980],{"href":1979},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner\u002F","Testing Click commands with CliRunner",[1982,1983,1984],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}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 .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);}html pre.shiki code .s9eBZ, html code.shiki .s9eBZ{--shiki-default:#22863A;--shiki-dark:#85E89D}",{"title":108,"searchDepth":122,"depth":122,"links":1986},[1987,1988,1989,1990,1994,1995,1996,1997,2003],{"id":31,"depth":122,"text":32},{"id":53,"depth":122,"text":54},{"id":100,"depth":122,"text":101},{"id":989,"depth":122,"text":990,"children":1991},[1992,1993],{"id":1284,"depth":129,"text":1285},{"id":1414,"depth":129,"text":1415},{"id":1527,"depth":122,"text":1528},{"id":1563,"depth":122,"text":1564},{"id":1891,"depth":122,"text":1892},{"id":1898,"depth":122,"text":1899,"children":1998},[1999,2000,2001,2002],{"id":1902,"depth":129,"text":1903},{"id":1916,"depth":129,"text":1917},{"id":1931,"depth":129,"text":1932},{"id":1942,"depth":129,"text":1943},{"id":1949,"depth":122,"text":1950},"2026-10-02","Test a CLI plugin the way users run it: a host-provided testing helper, entry-point registration checks, contract tests and a CI matrix across supported host versions.","intermediate",false,"md",{},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli",{"title":5,"description":2005},"modern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli\u002Findex",[2014,96,2015,2016,2017],"plugins","pytest","compatibility","ci","l85zk73sGgEa1UKPIz0WuElsrMGHMTKa0OBqIf8EhRs",[2020,2023,2026,2029,2032,2035,2038,2041,2044,2047,2050,2053,2056,2059,2062,2065,2068,2071,2074,2077,2080,2083,2086,2089,2092,2095,2098,2101,2104,2107,2110,2113,2116,2119,2122,2125,2128,2131,2134,2137,2140,2143,2146,2149,2152,2155,2158,2161,2164,2167,2170,2173,2176,2179,2182,2185,2188,2191,2194,2197,2200,2203,2206,2209,2212,2215,2218,2221,2224,2227,2230,2233,2236,2239,2242,2245,2248,2251,2254,2257,2260,2263,2266,2269,2272,2275,2278,2281,2284,2287,2290,2293,2296,2299,2302,2305,2308,2311,2314,2317,2320,2323,2326,2329,2332,2335,2338,2341,2344,2347,2350,2353,2356,2359,2362,2365,2368,2371,2374,2377,2380,2383,2386,2389,2392,2395,2398,2401,2404,2407,2410,2413,2416,2419,2422,2425,2428,2431,2434,2437,2440,2443,2446,2449,2452,2455,2458,2461,2464,2467,2470,2473,2476,2479,2482,2485,2488,2491,2494,2497,2500,2503,2506,2509,2512,2515,2518,2521,2524,2527,2530,2533,2536,2537,2540,2543,2546,2549,2552,2555,2558,2561,2564,2567,2570,2573,2576,2579,2582,2585,2588,2591,2594,2597,2600,2603,2606,2609,2612,2615,2618,2621,2624,2627,2630,2633,2636,2639,2642,2645,2648,2651,2654,2657,2660,2663,2666,2669,2672,2675,2678,2681,2684,2687,2690,2693,2696,2699,2702,2705,2708,2711,2714,2717,2720,2723,2726,2729,2732,2735,2738,2741,2744,2747,2750,2753,2756,2759,2762,2765,2768,2771,2774,2777,2780,2783,2786,2789,2792,2795,2798,2801,2804,2807,2810,2813,2816,2819,2822,2825,2828,2831,2834,2837,2840,2843,2846,2849,2852,2855,2858,2861],{"path":2021,"title":2022},"\u002Fabout","About Python CLI Toolcraft",{"path":2024,"title":2025},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":2027,"title":2028},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":2030,"title":2031},"\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":2033,"title":2034},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":2036,"title":2037},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2039,"title":2040},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":2042,"title":2043},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2045,"title":2046},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":2048,"title":2049},"\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":2051,"title":2052},"\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":2054,"title":2055},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2057,"title":2058},"\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":2060,"title":2061},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":2063,"title":2064},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2066,"title":2067},"\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":2069,"title":2070},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":2072,"title":2073},"\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":2075,"title":2076},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2078,"title":2079},"\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":2081,"title":2082},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2084,"title":2085},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2087,"title":2088},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2090,"title":2091},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2093,"title":2094},"\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":2096,"title":2097},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":2099,"title":2100},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2102,"title":2103},"\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":2105,"title":2106},"\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":2108,"title":2109},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2111,"title":2112},"\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":2114,"title":2115},"\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":2117,"title":2118},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2120,"title":2121},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2123,"title":2124},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2126,"title":2127},"\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":2129,"title":2130},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2132,"title":2133},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2135,"title":2136},"\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":2138,"title":2139},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2141,"title":2142},"\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":2144,"title":2145},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2147,"title":2148},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2150,"title":2151},"\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":2153,"title":2154},"\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":2156,"title":2157},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2159,"title":2160},"\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":2162,"title":2163},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2165,"title":2166},"\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":2168,"title":2169},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2171,"title":2172},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2174,"title":2175},"\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":2177,"title":2178},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2180,"title":2181},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2183,"title":2184},"\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":2186,"title":2187},"\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":2189,"title":2190},"\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":2192,"title":2193},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2195,"title":2196},"\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":2198,"title":2199},"\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":2201,"title":2202},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2204,"title":2205},"\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":2207,"title":2208},"\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":2210,"title":2211},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2213,"title":2214},"\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":2216,"title":2217},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2219,"title":2220},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2222,"title":2223},"\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":2225,"title":2226},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2228,"title":2229},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2231,"title":2232},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2234,"title":2235},"\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":2237,"title":2238},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2240,"title":2241},"\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":2243,"title":2244},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2246,"title":2247},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2249,"title":2250},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2252,"title":2253},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2255,"title":2256},"\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":2258,"title":2259},"\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":2261,"title":2262},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2264,"title":2265},"\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":2267,"title":2268},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2270,"title":2271},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2273,"title":2274},"\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":2276,"title":2277},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2279,"title":2280},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2282,"title":2283},"\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":2285,"title":2286},"\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":2288,"title":2289},"\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":2291,"title":2292},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2294,"title":2295},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2297,"title":2298},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2300,"title":2301},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2303,"title":2304},"\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":2306,"title":2307},"\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":2309,"title":2310},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2312,"title":2313},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2315,"title":2316},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2318,"title":2319},"\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":2321,"title":2322},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2324,"title":2325},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2327,"title":2328},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2330,"title":2331},"\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":2333,"title":2334},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2336,"title":2337},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2339,"title":2340},"\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":2342,"title":2343},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2345,"title":2346},"\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":2348,"title":2349},"\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":2351,"title":2352},"\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":2354,"title":2355},"\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":2357,"title":2358},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2360,"title":2361},"\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":2363,"title":2364},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2366,"title":2367},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2369,"title":2370},"\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":2372,"title":2373},"\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":2375,"title":2376},"\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":2378,"title":2379},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2381,"title":2382},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2384,"title":2385},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2387,"title":2388},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2390,"title":2391},"\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":2393,"title":2394},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2396,"title":2397},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2399,"title":2400},"\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":2402,"title":2403},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2405,"title":2406},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2408,"title":2409},"\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":2411,"title":2412},"\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":2414,"title":2415},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2417,"title":2418},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2420,"title":2421},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2423,"title":2424},"\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":2426,"title":2427},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2429,"title":2430},"\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":2432,"title":2433},"\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":2435,"title":2436},"\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":2438,"title":2439},"\u002F","Python CLI Toolcraft",{"path":2441,"title":2442},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2444,"title":2445},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2447,"title":2448},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2450,"title":2451},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2453,"title":2454},"\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":2456,"title":2457},"\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":2459,"title":2460},"\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":2462,"title":2463},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2465,"title":2466},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2468,"title":2469},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2471,"title":2472},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2474,"title":2475},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2477,"title":2478},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2480,"title":2481},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2483,"title":2484},"\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":2486,"title":2487},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2489,"title":2490},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2492,"title":2493},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2495,"title":2496},"\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":2498,"title":2499},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2501,"title":2502},"\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":2504,"title":2505},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2507,"title":2508},"\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":2510,"title":2511},"\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":2513,"title":2514},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2516,"title":2517},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2519,"title":2520},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2522,"title":2523},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2525,"title":2526},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2528,"title":2529},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2531,"title":2532},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2534,"title":2535},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2010,"title":5},{"path":2538,"title":2539},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2541,"title":2542},"\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":2544,"title":2545},"\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":2547,"title":2548},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2550,"title":2551},"\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":2553,"title":2554},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2556,"title":2557},"\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":2559,"title":2560},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2562,"title":2563},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2565,"title":2566},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2568,"title":2569},"\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":2571,"title":2572},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2574,"title":2575},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2577,"title":2578},"\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":2580,"title":2581},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2583,"title":2584},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2586,"title":2587},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2589,"title":2590},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2592,"title":2593},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2595,"title":2596},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2598,"title":2599},"\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":2601,"title":2602},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2604,"title":2605},"\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":2607,"title":2608},"\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":2610,"title":2611},"\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":2613,"title":2614},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2616,"title":2617},"\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":2619,"title":2620},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2622,"title":2623},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2625,"title":2626},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2628,"title":2629},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2631,"title":2632},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2634,"title":2635},"\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":2637,"title":2638},"\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":2640,"title":2641},"\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":2643,"title":2644},"\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":2646,"title":2647},"\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":2649,"title":2650},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2652,"title":2653},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2655,"title":2656},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2658,"title":2659},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2661,"title":2662},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2664,"title":2665},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2667,"title":2668},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2670,"title":2671},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2673,"title":2674},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2676,"title":2677},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2679,"title":2680},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2682,"title":2683},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2685,"title":2686},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2688,"title":2689},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2691,"title":2692},"\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":2694,"title":2695},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2697,"title":2698},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2700,"title":2701},"\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":2703,"title":2704},"\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":2706,"title":2707},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2709,"title":2710},"\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":2712,"title":2713},"\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":2715,"title":2716},"\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":2718,"title":2719},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2721,"title":2722},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2724,"title":2725},"\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":2727,"title":2728},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2730,"title":2731},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2733,"title":2734},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2736,"title":2737},"\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":2739,"title":2740},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2742,"title":2743},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2745,"title":2746},"\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":2748,"title":2749},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2751,"title":2752},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2754,"title":2755},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2757,"title":2758},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2760,"title":2761},"\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":2763,"title":2764},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2766,"title":2767},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2769,"title":2770},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2772,"title":2773},"\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":2775,"title":2776},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2778,"title":2779},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2781,"title":2782},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2784,"title":2785},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2787,"title":2788},"\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":2790,"title":2791},"\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":2793,"title":2794},"\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":2796,"title":2797},"\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":2799,"title":2800},"\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":2802,"title":2803},"\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":2805,"title":2806},"\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":2808,"title":2809},"\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":2811,"title":2812},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2814,"title":2815},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2817,"title":2818},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2820,"title":2821},"\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":2823,"title":2824},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2826,"title":2827},"\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":2829,"title":2830},"\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":2832,"title":2833},"\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":2835,"title":2836},"\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":2838,"title":2839},"\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":2841,"title":2842},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2844,"title":2845},"\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":2847,"title":2848},"\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":2850,"title":2851},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2853,"title":2854},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2856,"title":2857},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2859,"title":2860},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2862,"title":2863},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967541370]