[{"data":1,"prerenderedAt":3029},["ShallowReactive",2],{"page-\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy\u002F":3,"content-directory":2184},{"id":4,"title":5,"body":6,"date":2170,"description":2171,"difficulty":2172,"draft":2173,"extension":2174,"meta":2175,"navigation":152,"path":2176,"seo":2177,"stem":2178,"tags":2179,"updated":2170,"__hash__":2183},"content\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy\u002Findex.md","Hook-Based Plugins for Python CLIs with pluggy",{"type":7,"value":8,"toc":2150},"minimark",[9,33,38,60,64,88,92,107,111,370,392,395,399,538,696,707,710,1036,1040,1158,1198,1205,1209,1212,1238,1243,1262,1411,1418,1422,1467,1471,1477,2048,2055,2059,2065,2069,2073,2080,2084,2087,2091,2102,2106,2112,2116,2146],[10,11,12,13,17,18,22,23,26,27,32],"p",{},"Adding whole commands through entry points covers one kind of extensibility. Often what plugins need is finer-grained: contribute extra validation checks to ",[14,15,16],"code",{},"mytool lint",", add an output format to every listing command, transform a config after it is loaded, react when a deployment finishes. That is a ",[19,20,21],"strong",{},"hook"," system — the host defines named extension points with fixed signatures, plugins implement whichever they care about, and the host calls every implementation at the right moment. You could build it by hand; ",[19,24,25],{},"pluggy"," is the small, battle-tested library that pytest, tox, datasette and many others use for exactly this. This guide builds a hook-based plugin system for a CLI with pluggy: specifying hooks, implementing them, loading plugins from entry points, controlling result collection and ordering, and testing. It belongs to the ",[28,29,31],"a",{"href":30},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002F","plugin architectures for extensible CLIs topic",".",[34,35,37],"h2",{"id":36},"prerequisites","Prerequisites",[39,40,41,52],"ul",{},[42,43,44,45,47,48,51],"li",{},"Python 3.10+, ",[14,46,25],{}," 1.5+ (",[14,49,50],{},"uv add pluggy","), and Typer or Click.",[42,53,54,55,59],{},"Familiarity with entry points, as in ",[28,56,58],{"href":57},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points\u002F","discovering plugins with entry points"," — pluggy uses them to find plugins.",[34,61,63],{"id":62},"how-pluggy-works","How pluggy works",[10,65,66,67,70,71,74,75,70,78,81,82,87],{},"pluggy has three moving parts. ",[19,68,69],{},"Hook specifications"," (",[14,72,73],{},"@hookspec",") declare the extension points and their arguments, written by the host. ",[19,76,77],{},"Hook implementations",[14,79,80],{},"@hookimpl",") are functions in plugins with names matching a spec. A ",[19,83,84],{},[14,85,86],{},"PluginManager"," registers plugins, validates their implementations against the specs, and calls them.",[89,90],"inline-diagram",{"name":91},"plg-sequence",[10,93,94,95,98,99,102,103,106],{},"When the host calls ",[14,96,97],{},"pm.hook.mytool_checks(config=cfg)",", pluggy calls every registered implementation of ",[14,100,101],{},"mytool_checks"," — the most recently registered first — and returns their results as a list. Implementations may accept ",[19,104,105],{},"any subset"," of the spec's arguments by name, which is what lets you add arguments to a hook later without breaking existing plugins.",[34,108,110],{"id":109},"the-recipe-specifying-hooks","The recipe: specifying hooks",[112,113,118],"pre",{"className":114,"code":115,"language":116,"meta":117,"style":117},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fhookspecs.py\nfrom __future__ import annotations\n\nfrom typing import Any\n\nimport pluggy\n\nhookspec = pluggy.HookspecMarker(\"mytool\")\nhookimpl = pluggy.HookimplMarker(\"mytool\")\n\n\n@hookspec\ndef mytool_checks(config: dict[str, Any]) -> list[tuple[str, str]]:\n    \"\"\"Return (check_name, problem) tuples for a loaded config. Return [] when all is well.\"\"\"\n\n\n@hookspec\ndef mytool_output_formats() -> dict[str, Any]:\n    \"\"\"Return {format_name: render(rows) -> str} for extra --format choices.\"\"\"\n\n\n@hookspec(firstresult=True)\ndef mytool_resolve_target(url: str) -> str | None:\n    \"\"\"Turn a custom URL scheme into a deploy target; return None if not yours.\"\"\"\n","python","",[14,119,120,129,147,154,168,173,181,186,205,220,225,230,237,265,271,276,281,286,302,308,313,318,337,364],{"__ignoreMap":117},[121,122,125],"span",{"class":123,"line":124},"line",1,[121,126,128],{"class":127},"sJ8bj","# src\u002Fmytool\u002Fhookspecs.py\n",[121,130,132,136,140,143],{"class":123,"line":131},2,[121,133,135],{"class":134},"szBVR","from",[121,137,139],{"class":138},"sj4cs"," __future__",[121,141,142],{"class":134}," import",[121,144,146],{"class":145},"sVt8B"," annotations\n",[121,148,150],{"class":123,"line":149},3,[121,151,153],{"emptyLinePlaceholder":152},true,"\n",[121,155,157,159,162,165],{"class":123,"line":156},4,[121,158,135],{"class":134},[121,160,161],{"class":145}," typing ",[121,163,164],{"class":134},"import",[121,166,167],{"class":145}," Any\n",[121,169,171],{"class":123,"line":170},5,[121,172,153],{"emptyLinePlaceholder":152},[121,174,176,178],{"class":123,"line":175},6,[121,177,164],{"class":134},[121,179,180],{"class":145}," pluggy\n",[121,182,184],{"class":123,"line":183},7,[121,185,153],{"emptyLinePlaceholder":152},[121,187,189,192,195,198,202],{"class":123,"line":188},8,[121,190,191],{"class":145},"hookspec ",[121,193,194],{"class":134},"=",[121,196,197],{"class":145}," pluggy.HookspecMarker(",[121,199,201],{"class":200},"sZZnC","\"mytool\"",[121,203,204],{"class":145},")\n",[121,206,208,211,213,216,218],{"class":123,"line":207},9,[121,209,210],{"class":145},"hookimpl ",[121,212,194],{"class":134},[121,214,215],{"class":145}," pluggy.HookimplMarker(",[121,217,201],{"class":200},[121,219,204],{"class":145},[121,221,223],{"class":123,"line":222},10,[121,224,153],{"emptyLinePlaceholder":152},[121,226,228],{"class":123,"line":227},11,[121,229,153],{"emptyLinePlaceholder":152},[121,231,233],{"class":123,"line":232},12,[121,234,236],{"class":235},"sScJk","@hookspec\n",[121,238,240,243,246,249,252,255,257,260,262],{"class":123,"line":239},13,[121,241,242],{"class":134},"def",[121,244,245],{"class":235}," mytool_checks",[121,247,248],{"class":145},"(config: dict[",[121,250,251],{"class":138},"str",[121,253,254],{"class":145},", Any]) -> list[tuple[",[121,256,251],{"class":138},[121,258,259],{"class":145},", ",[121,261,251],{"class":138},[121,263,264],{"class":145},"]]:\n",[121,266,268],{"class":123,"line":267},14,[121,269,270],{"class":200},"    \"\"\"Return (check_name, problem) tuples for a loaded config. Return [] when all is well.\"\"\"\n",[121,272,274],{"class":123,"line":273},15,[121,275,153],{"emptyLinePlaceholder":152},[121,277,279],{"class":123,"line":278},16,[121,280,153],{"emptyLinePlaceholder":152},[121,282,284],{"class":123,"line":283},17,[121,285,236],{"class":235},[121,287,289,291,294,297,299],{"class":123,"line":288},18,[121,290,242],{"class":134},[121,292,293],{"class":235}," mytool_output_formats",[121,295,296],{"class":145},"() -> dict[",[121,298,251],{"class":138},[121,300,301],{"class":145},", Any]:\n",[121,303,305],{"class":123,"line":304},19,[121,306,307],{"class":200},"    \"\"\"Return {format_name: render(rows) -> str} for extra --format choices.\"\"\"\n",[121,309,311],{"class":123,"line":310},20,[121,312,153],{"emptyLinePlaceholder":152},[121,314,316],{"class":123,"line":315},21,[121,317,153],{"emptyLinePlaceholder":152},[121,319,321,323,326,330,332,335],{"class":123,"line":320},22,[121,322,73],{"class":235},[121,324,325],{"class":145},"(",[121,327,329],{"class":328},"s4XuR","firstresult",[121,331,194],{"class":134},[121,333,334],{"class":138},"True",[121,336,204],{"class":145},[121,338,340,342,345,348,350,353,355,358,361],{"class":123,"line":339},23,[121,341,242],{"class":134},[121,343,344],{"class":235}," mytool_resolve_target",[121,346,347],{"class":145},"(url: ",[121,349,251],{"class":138},[121,351,352],{"class":145},") -> ",[121,354,251],{"class":138},[121,356,357],{"class":134}," |",[121,359,360],{"class":138}," None",[121,362,363],{"class":145},":\n",[121,365,367],{"class":123,"line":366},24,[121,368,369],{"class":200},"    \"\"\"Turn a custom URL scheme into a deploy target; return None if not yours.\"\"\"\n",[10,371,372,375,376,379,380,383,384,387,388,32],{},[14,373,374],{},"HookspecMarker(\"mytool\")"," and ",[14,377,378],{},"HookimplMarker(\"mytool\")"," share a project name, which is how pluggy links specs to implementations. The host exports ",[14,381,382],{},"hookimpl"," so plugins import it from one stable place — ideally a small public module such as ",[14,385,386],{},"mytool.plugin_api",", as discussed in ",[28,389,391],{"href":390},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api\u002F","versioning a plugin API",[89,393],{"name":394},"plg-spec-impl",[34,396,398],{"id":397},"the-recipe-the-plugin-manager-and-built-ins","The recipe: the plugin manager and built-ins",[112,400,402],{"className":114,"code":401,"language":116,"meta":117,"style":117},"# src\u002Fmytool\u002Fpm.py\nfrom __future__ import annotations\n\nimport functools\n\nimport pluggy\n\nfrom mytool import builtin_checks, hookspecs\n\n\n@functools.cache\ndef get_plugin_manager() -> pluggy.PluginManager:\n    pm = pluggy.PluginManager(\"mytool\")\n    pm.add_hookspecs(hookspecs)\n    pm.register(builtin_checks, name=\"builtin\")          # built-ins use the same mechanism\n    pm.load_setuptools_entrypoints(\"mytool\")             # third-party plugins\n    return pm\n",[14,403,404,409,419,423,430,434,440,444,456,460,464,469,479,493,498,517,530],{"__ignoreMap":117},[121,405,406],{"class":123,"line":124},[121,407,408],{"class":127},"# src\u002Fmytool\u002Fpm.py\n",[121,410,411,413,415,417],{"class":123,"line":131},[121,412,135],{"class":134},[121,414,139],{"class":138},[121,416,142],{"class":134},[121,418,146],{"class":145},[121,420,421],{"class":123,"line":149},[121,422,153],{"emptyLinePlaceholder":152},[121,424,425,427],{"class":123,"line":156},[121,426,164],{"class":134},[121,428,429],{"class":145}," functools\n",[121,431,432],{"class":123,"line":170},[121,433,153],{"emptyLinePlaceholder":152},[121,435,436,438],{"class":123,"line":175},[121,437,164],{"class":134},[121,439,180],{"class":145},[121,441,442],{"class":123,"line":183},[121,443,153],{"emptyLinePlaceholder":152},[121,445,446,448,451,453],{"class":123,"line":188},[121,447,135],{"class":134},[121,449,450],{"class":145}," mytool ",[121,452,164],{"class":134},[121,454,455],{"class":145}," builtin_checks, hookspecs\n",[121,457,458],{"class":123,"line":207},[121,459,153],{"emptyLinePlaceholder":152},[121,461,462],{"class":123,"line":222},[121,463,153],{"emptyLinePlaceholder":152},[121,465,466],{"class":123,"line":227},[121,467,468],{"class":235},"@functools.cache\n",[121,470,471,473,476],{"class":123,"line":232},[121,472,242],{"class":134},[121,474,475],{"class":235}," get_plugin_manager",[121,477,478],{"class":145},"() -> pluggy.PluginManager:\n",[121,480,481,484,486,489,491],{"class":123,"line":239},[121,482,483],{"class":145},"    pm ",[121,485,194],{"class":134},[121,487,488],{"class":145}," pluggy.PluginManager(",[121,490,201],{"class":200},[121,492,204],{"class":145},[121,494,495],{"class":123,"line":267},[121,496,497],{"class":145},"    pm.add_hookspecs(hookspecs)\n",[121,499,500,503,506,508,511,514],{"class":123,"line":273},[121,501,502],{"class":145},"    pm.register(builtin_checks, ",[121,504,505],{"class":328},"name",[121,507,194],{"class":134},[121,509,510],{"class":200},"\"builtin\"",[121,512,513],{"class":145},")          ",[121,515,516],{"class":127},"# built-ins use the same mechanism\n",[121,518,519,522,524,527],{"class":123,"line":278},[121,520,521],{"class":145},"    pm.load_setuptools_entrypoints(",[121,523,201],{"class":200},[121,525,526],{"class":145},")             ",[121,528,529],{"class":127},"# third-party plugins\n",[121,531,532,535],{"class":123,"line":283},[121,533,534],{"class":134},"    return",[121,536,537],{"class":145}," pm\n",[112,539,541],{"className":114,"code":540,"language":116,"meta":117,"style":117},"# src\u002Fmytool\u002Fbuiltin_checks.py\nfrom typing import Any\n\nfrom mytool.hookspecs import hookimpl\n\n\n@hookimpl\ndef mytool_checks(config: dict[str, Any]) -> list[tuple[str, str]]:\n    problems = []\n    if \"name\" not in config:\n        problems.append((\"required-name\", \"config has no 'name'\"))\n    if config.get(\"replicas\", 1) \u003C 1:\n        problems.append((\"replicas\", \"replicas must be at least 1\"))\n    return problems\n",[14,542,543,548,558,562,574,578,582,587,607,617,634,650,676,689],{"__ignoreMap":117},[121,544,545],{"class":123,"line":124},[121,546,547],{"class":127},"# src\u002Fmytool\u002Fbuiltin_checks.py\n",[121,549,550,552,554,556],{"class":123,"line":131},[121,551,135],{"class":134},[121,553,161],{"class":145},[121,555,164],{"class":134},[121,557,167],{"class":145},[121,559,560],{"class":123,"line":149},[121,561,153],{"emptyLinePlaceholder":152},[121,563,564,566,569,571],{"class":123,"line":156},[121,565,135],{"class":134},[121,567,568],{"class":145}," mytool.hookspecs ",[121,570,164],{"class":134},[121,572,573],{"class":145}," hookimpl\n",[121,575,576],{"class":123,"line":170},[121,577,153],{"emptyLinePlaceholder":152},[121,579,580],{"class":123,"line":175},[121,581,153],{"emptyLinePlaceholder":152},[121,583,584],{"class":123,"line":183},[121,585,586],{"class":235},"@hookimpl\n",[121,588,589,591,593,595,597,599,601,603,605],{"class":123,"line":188},[121,590,242],{"class":134},[121,592,245],{"class":235},[121,594,248],{"class":145},[121,596,251],{"class":138},[121,598,254],{"class":145},[121,600,251],{"class":138},[121,602,259],{"class":145},[121,604,251],{"class":138},[121,606,264],{"class":145},[121,608,609,612,614],{"class":123,"line":207},[121,610,611],{"class":145},"    problems ",[121,613,194],{"class":134},[121,615,616],{"class":145}," []\n",[121,618,619,622,625,628,631],{"class":123,"line":222},[121,620,621],{"class":134},"    if",[121,623,624],{"class":200}," \"name\"",[121,626,627],{"class":134}," not",[121,629,630],{"class":134}," in",[121,632,633],{"class":145}," config:\n",[121,635,636,639,642,644,647],{"class":123,"line":227},[121,637,638],{"class":145},"        problems.append((",[121,640,641],{"class":200},"\"required-name\"",[121,643,259],{"class":145},[121,645,646],{"class":200},"\"config has no 'name'\"",[121,648,649],{"class":145},"))\n",[121,651,652,654,657,660,662,665,668,671,674],{"class":123,"line":232},[121,653,621],{"class":134},[121,655,656],{"class":145}," config.get(",[121,658,659],{"class":200},"\"replicas\"",[121,661,259],{"class":145},[121,663,664],{"class":138},"1",[121,666,667],{"class":145},") ",[121,669,670],{"class":134},"\u003C",[121,672,673],{"class":138}," 1",[121,675,363],{"class":145},[121,677,678,680,682,684,687],{"class":123,"line":239},[121,679,638],{"class":145},[121,681,659],{"class":200},[121,683,259],{"class":145},[121,685,686],{"class":200},"\"replicas must be at least 1\"",[121,688,649],{"class":145},[121,690,691,693],{"class":123,"line":267},[121,692,534],{"class":134},[121,694,695],{"class":145}," problems\n",[10,697,698,699,702,703,706],{},"Registering the built-in checks as a plugin is a deliberate design choice: it proves the hook interface is sufficient for real work, and it means built-ins and third-party checks behave identically. ",[14,700,701],{},"load_setuptools_entrypoints(\"mytool\")"," loads every package that declares an entry point in the ",[14,704,705],{},"mytool"," group — each entry point's target module is registered as a plugin.",[10,708,709],{},"The command layer calls the hooks and combines the results:",[112,711,713],{"className":114,"code":712,"language":116,"meta":117,"style":117},"# src\u002Fmytool\u002Fcli.py\nimport json\nfrom pathlib import Path\n\nimport typer\n\nfrom mytool.pm import get_plugin_manager\n\napp = typer.Typer()\n\n\n@app.callback()\ndef main() -> None:\n    \"\"\"Config tools.\"\"\"\n\n\n@app.command()\ndef check(config_file: Path) -> None:\n    \"\"\"Run every registered check against CONFIG_FILE.\"\"\"\n    config = json.loads(config_file.read_text(encoding=\"utf-8\"))\n    results = get_plugin_manager().hook.mytool_checks(config=config)\n    problems = [p for plugin_result in results for p in plugin_result]\n    for name, message in sorted(problems):\n        typer.echo(f\"{config_file}: [{name}] {message}\")\n    raise typer.Exit(1 if problems else 0)\n\n\nif __name__ == \"__main__\":\n    app()\n",[14,714,715,720,727,739,743,750,754,766,770,780,784,788,796,811,816,820,824,831,845,850,870,888,919,935,978,1003,1008,1013,1030],{"__ignoreMap":117},[121,716,717],{"class":123,"line":124},[121,718,719],{"class":127},"# src\u002Fmytool\u002Fcli.py\n",[121,721,722,724],{"class":123,"line":131},[121,723,164],{"class":134},[121,725,726],{"class":145}," json\n",[121,728,729,731,734,736],{"class":123,"line":149},[121,730,135],{"class":134},[121,732,733],{"class":145}," pathlib ",[121,735,164],{"class":134},[121,737,738],{"class":145}," Path\n",[121,740,741],{"class":123,"line":156},[121,742,153],{"emptyLinePlaceholder":152},[121,744,745,747],{"class":123,"line":170},[121,746,164],{"class":134},[121,748,749],{"class":145}," typer\n",[121,751,752],{"class":123,"line":175},[121,753,153],{"emptyLinePlaceholder":152},[121,755,756,758,761,763],{"class":123,"line":183},[121,757,135],{"class":134},[121,759,760],{"class":145}," mytool.pm ",[121,762,164],{"class":134},[121,764,765],{"class":145}," get_plugin_manager\n",[121,767,768],{"class":123,"line":188},[121,769,153],{"emptyLinePlaceholder":152},[121,771,772,775,777],{"class":123,"line":207},[121,773,774],{"class":145},"app ",[121,776,194],{"class":134},[121,778,779],{"class":145}," typer.Typer()\n",[121,781,782],{"class":123,"line":222},[121,783,153],{"emptyLinePlaceholder":152},[121,785,786],{"class":123,"line":227},[121,787,153],{"emptyLinePlaceholder":152},[121,789,790,793],{"class":123,"line":232},[121,791,792],{"class":235},"@app.callback",[121,794,795],{"class":145},"()\n",[121,797,798,800,803,806,809],{"class":123,"line":239},[121,799,242],{"class":134},[121,801,802],{"class":235}," main",[121,804,805],{"class":145},"() -> ",[121,807,808],{"class":138},"None",[121,810,363],{"class":145},[121,812,813],{"class":123,"line":267},[121,814,815],{"class":200},"    \"\"\"Config tools.\"\"\"\n",[121,817,818],{"class":123,"line":273},[121,819,153],{"emptyLinePlaceholder":152},[121,821,822],{"class":123,"line":278},[121,823,153],{"emptyLinePlaceholder":152},[121,825,826,829],{"class":123,"line":283},[121,827,828],{"class":235},"@app.command",[121,830,795],{"class":145},[121,832,833,835,838,841,843],{"class":123,"line":288},[121,834,242],{"class":134},[121,836,837],{"class":235}," check",[121,839,840],{"class":145},"(config_file: Path) -> ",[121,842,808],{"class":138},[121,844,363],{"class":145},[121,846,847],{"class":123,"line":304},[121,848,849],{"class":200},"    \"\"\"Run every registered check against CONFIG_FILE.\"\"\"\n",[121,851,852,855,857,860,863,865,868],{"class":123,"line":310},[121,853,854],{"class":145},"    config ",[121,856,194],{"class":134},[121,858,859],{"class":145}," json.loads(config_file.read_text(",[121,861,862],{"class":328},"encoding",[121,864,194],{"class":134},[121,866,867],{"class":200},"\"utf-8\"",[121,869,649],{"class":145},[121,871,872,875,877,880,883,885],{"class":123,"line":315},[121,873,874],{"class":145},"    results ",[121,876,194],{"class":134},[121,878,879],{"class":145}," get_plugin_manager().hook.mytool_checks(",[121,881,882],{"class":328},"config",[121,884,194],{"class":134},[121,886,887],{"class":145},"config)\n",[121,889,890,892,894,897,900,903,906,909,911,914,916],{"class":123,"line":320},[121,891,611],{"class":145},[121,893,194],{"class":134},[121,895,896],{"class":145}," [p ",[121,898,899],{"class":134},"for",[121,901,902],{"class":145}," plugin_result ",[121,904,905],{"class":134},"in",[121,907,908],{"class":145}," results ",[121,910,899],{"class":134},[121,912,913],{"class":145}," p ",[121,915,905],{"class":134},[121,917,918],{"class":145}," plugin_result]\n",[121,920,921,924,927,929,932],{"class":123,"line":339},[121,922,923],{"class":134},"    for",[121,925,926],{"class":145}," name, message ",[121,928,905],{"class":134},[121,930,931],{"class":138}," sorted",[121,933,934],{"class":145},"(problems):\n",[121,936,937,940,943,946,949,952,955,958,960,962,964,967,969,972,974,976],{"class":123,"line":366},[121,938,939],{"class":145},"        typer.echo(",[121,941,942],{"class":134},"f",[121,944,945],{"class":200},"\"",[121,947,948],{"class":138},"{",[121,950,951],{"class":145},"config_file",[121,953,954],{"class":138},"}",[121,956,957],{"class":200},": [",[121,959,948],{"class":138},[121,961,505],{"class":145},[121,963,954],{"class":138},[121,965,966],{"class":200},"] ",[121,968,948],{"class":138},[121,970,971],{"class":145},"message",[121,973,954],{"class":138},[121,975,945],{"class":200},[121,977,204],{"class":145},[121,979,981,984,987,989,992,995,998,1001],{"class":123,"line":980},25,[121,982,983],{"class":134},"    raise",[121,985,986],{"class":145}," typer.Exit(",[121,988,664],{"class":138},[121,990,991],{"class":134}," if",[121,993,994],{"class":145}," problems ",[121,996,997],{"class":134},"else",[121,999,1000],{"class":138}," 0",[121,1002,204],{"class":145},[121,1004,1006],{"class":123,"line":1005},26,[121,1007,153],{"emptyLinePlaceholder":152},[121,1009,1011],{"class":123,"line":1010},27,[121,1012,153],{"emptyLinePlaceholder":152},[121,1014,1016,1019,1022,1025,1028],{"class":123,"line":1015},28,[121,1017,1018],{"class":134},"if",[121,1020,1021],{"class":138}," __name__",[121,1023,1024],{"class":134}," ==",[121,1026,1027],{"class":200}," \"__main__\"",[121,1029,363],{"class":145},[121,1031,1033],{"class":123,"line":1032},29,[121,1034,1035],{"class":145},"    app()\n",[34,1037,1039],{"id":1038},"the-recipe-a-third-party-plugin","The recipe: a third-party plugin",[112,1041,1043],{"className":114,"code":1042,"language":116,"meta":117,"style":117},"# mytool_security\u002Fchecks.py  (a separate package)\nfrom typing import Any\n\nfrom mytool.hookspecs import hookimpl\n\n\n@hookimpl\ndef mytool_checks(config: dict[str, Any]) -> list[tuple[str, str]]:\n    if str(config.get(\"image\", \"\")).endswith(\":latest\"):\n        return [(\"pinned-image\", \"use a pinned image tag, not :latest\")]\n    return []\n",[14,1044,1045,1050,1060,1064,1074,1078,1082,1086,1106,1133,1152],{"__ignoreMap":117},[121,1046,1047],{"class":123,"line":124},[121,1048,1049],{"class":127},"# mytool_security\u002Fchecks.py  (a separate package)\n",[121,1051,1052,1054,1056,1058],{"class":123,"line":131},[121,1053,135],{"class":134},[121,1055,161],{"class":145},[121,1057,164],{"class":134},[121,1059,167],{"class":145},[121,1061,1062],{"class":123,"line":149},[121,1063,153],{"emptyLinePlaceholder":152},[121,1065,1066,1068,1070,1072],{"class":123,"line":156},[121,1067,135],{"class":134},[121,1069,568],{"class":145},[121,1071,164],{"class":134},[121,1073,573],{"class":145},[121,1075,1076],{"class":123,"line":170},[121,1077,153],{"emptyLinePlaceholder":152},[121,1079,1080],{"class":123,"line":175},[121,1081,153],{"emptyLinePlaceholder":152},[121,1083,1084],{"class":123,"line":183},[121,1085,586],{"class":235},[121,1087,1088,1090,1092,1094,1096,1098,1100,1102,1104],{"class":123,"line":188},[121,1089,242],{"class":134},[121,1091,245],{"class":235},[121,1093,248],{"class":145},[121,1095,251],{"class":138},[121,1097,254],{"class":145},[121,1099,251],{"class":138},[121,1101,259],{"class":145},[121,1103,251],{"class":138},[121,1105,264],{"class":145},[121,1107,1108,1110,1113,1116,1119,1121,1124,1127,1130],{"class":123,"line":207},[121,1109,621],{"class":134},[121,1111,1112],{"class":138}," str",[121,1114,1115],{"class":145},"(config.get(",[121,1117,1118],{"class":200},"\"image\"",[121,1120,259],{"class":145},[121,1122,1123],{"class":200},"\"\"",[121,1125,1126],{"class":145},")).endswith(",[121,1128,1129],{"class":200},"\":latest\"",[121,1131,1132],{"class":145},"):\n",[121,1134,1135,1138,1141,1144,1146,1149],{"class":123,"line":222},[121,1136,1137],{"class":134},"        return",[121,1139,1140],{"class":145}," [(",[121,1142,1143],{"class":200},"\"pinned-image\"",[121,1145,259],{"class":145},[121,1147,1148],{"class":200},"\"use a pinned image tag, not :latest\"",[121,1150,1151],{"class":145},")]\n",[121,1153,1154,1156],{"class":123,"line":227},[121,1155,534],{"class":134},[121,1157,616],{"class":145},[112,1159,1163],{"className":1160,"code":1161,"language":1162,"meta":117,"style":117},"language-toml shiki shiki-themes github-light github-dark","# mytool-security\u002Fpyproject.toml\n[project.entry-points.mytool]\nsecurity = \"mytool_security.checks\"\n","toml",[14,1164,1165,1170,1190],{"__ignoreMap":117},[121,1166,1167],{"class":123,"line":124},[121,1168,1169],{"class":127},"# mytool-security\u002Fpyproject.toml\n",[121,1171,1172,1175,1178,1180,1183,1185,1187],{"class":123,"line":131},[121,1173,1174],{"class":145},"[",[121,1176,1177],{"class":235},"project",[121,1179,32],{"class":145},[121,1181,1182],{"class":235},"entry-points",[121,1184,32],{"class":145},[121,1186,705],{"class":235},[121,1188,1189],{"class":145},"]\n",[121,1191,1192,1195],{"class":123,"line":149},[121,1193,1194],{"class":145},"security = ",[121,1196,1197],{"class":200},"\"mytool_security.checks\"\n",[10,1199,1200,1201,1204],{},"Once installed into the same environment, ",[14,1202,1203],{},"mytool check deploy.json"," runs both the built-in checks and the security checks, with no change to the host.",[34,1206,1208],{"id":1207},"collecting-all-results-or-the-first","Collecting all results or the first",[89,1210],{"name":1211},"plg-result-decision",[10,1213,1214,1215,1218,1219,1222,1223,1225,1226,1229,1230,1233,1234,1237],{},"Most CLI hooks are ",[19,1216,1217],{},"contribution hooks",": each plugin adds checks, output formats or commands, and the host wants every result — pluggy's default. Some hooks are ",[19,1220,1221],{},"resolution hooks",": \"who can handle this URL scheme?\", where the first plugin to return a non-",[14,1224,808],{}," answer wins. Declare those with ",[14,1227,1228],{},"firstresult=True"," on the spec, and pluggy stops calling implementations as soon as one returns something. Ordering can be nudged with ",[14,1231,1232],{},"@hookimpl(tryfirst=True)"," or ",[14,1235,1236],{},"trylast=True"," — useful for a built-in fallback that should only answer when no plugin does.",[1239,1240,1242],"h3",{"id":1241},"wrappers-for-cross-cutting-behaviour","Wrappers for cross-cutting behaviour",[10,1244,1245,1246,1250,1251,1254,1255,1258,1259,1261],{},"Some plugins do not contribute results; they want to run code ",[1247,1248,1249],"em",{},"around"," the other implementations — timing every check, catching and reporting their exceptions, or adjusting the combined result. pluggy supports this with wrapper implementations. A function marked ",[14,1252,1253],{},"@hookimpl(wrapper=True)"," is a generator: code before its ",[14,1256,1257],{},"yield"," runs before the other implementations, the ",[14,1260,1257],{}," returns their combined result, and whatever the wrapper returns becomes the hook's result.",[112,1263,1265],{"className":114,"code":1264,"language":116,"meta":117,"style":117},"import time\n\nfrom mytool.hookspecs import hookimpl\n\n\n@hookimpl(wrapper=True)\ndef mytool_checks(config):\n    start = time.perf_counter()\n    results = yield                      # every other implementation runs here\n    elapsed = time.perf_counter() - start\n    if elapsed > 1.0:\n        results.append([(\"slow-checks\", f\"checks took {elapsed:.1f}s\")])\n    return results\n",[14,1266,1267,1274,1278,1288,1292,1296,1311,1320,1330,1342,1358,1373,1404],{"__ignoreMap":117},[121,1268,1269,1271],{"class":123,"line":124},[121,1270,164],{"class":134},[121,1272,1273],{"class":145}," time\n",[121,1275,1276],{"class":123,"line":131},[121,1277,153],{"emptyLinePlaceholder":152},[121,1279,1280,1282,1284,1286],{"class":123,"line":149},[121,1281,135],{"class":134},[121,1283,568],{"class":145},[121,1285,164],{"class":134},[121,1287,573],{"class":145},[121,1289,1290],{"class":123,"line":156},[121,1291,153],{"emptyLinePlaceholder":152},[121,1293,1294],{"class":123,"line":170},[121,1295,153],{"emptyLinePlaceholder":152},[121,1297,1298,1300,1302,1305,1307,1309],{"class":123,"line":175},[121,1299,80],{"class":235},[121,1301,325],{"class":145},[121,1303,1304],{"class":328},"wrapper",[121,1306,194],{"class":134},[121,1308,334],{"class":138},[121,1310,204],{"class":145},[121,1312,1313,1315,1317],{"class":123,"line":183},[121,1314,242],{"class":134},[121,1316,245],{"class":235},[121,1318,1319],{"class":145},"(config):\n",[121,1321,1322,1325,1327],{"class":123,"line":188},[121,1323,1324],{"class":145},"    start ",[121,1326,194],{"class":134},[121,1328,1329],{"class":145}," time.perf_counter()\n",[121,1331,1332,1334,1336,1339],{"class":123,"line":207},[121,1333,874],{"class":145},[121,1335,194],{"class":134},[121,1337,1338],{"class":134}," yield",[121,1340,1341],{"class":127},"                      # every other implementation runs here\n",[121,1343,1344,1347,1349,1352,1355],{"class":123,"line":222},[121,1345,1346],{"class":145},"    elapsed ",[121,1348,194],{"class":134},[121,1350,1351],{"class":145}," time.perf_counter() ",[121,1353,1354],{"class":134},"-",[121,1356,1357],{"class":145}," start\n",[121,1359,1360,1362,1365,1368,1371],{"class":123,"line":227},[121,1361,621],{"class":134},[121,1363,1364],{"class":145}," elapsed ",[121,1366,1367],{"class":134},">",[121,1369,1370],{"class":138}," 1.0",[121,1372,363],{"class":145},[121,1374,1375,1378,1381,1383,1385,1388,1390,1393,1396,1398,1401],{"class":123,"line":232},[121,1376,1377],{"class":145},"        results.append([(",[121,1379,1380],{"class":200},"\"slow-checks\"",[121,1382,259],{"class":145},[121,1384,942],{"class":134},[121,1386,1387],{"class":200},"\"checks took ",[121,1389,948],{"class":138},[121,1391,1392],{"class":145},"elapsed",[121,1394,1395],{"class":134},":.1f",[121,1397,954],{"class":138},[121,1399,1400],{"class":200},"s\"",[121,1402,1403],{"class":145},")])\n",[121,1405,1406,1408],{"class":123,"line":239},[121,1407,534],{"class":134},[121,1409,1410],{"class":145}," results\n",[10,1412,1413,1414,1417],{},"A host can ship such wrappers itself — for example, one that converts exceptions from individual plugins into reported problems instead of crashing the command — and a ",[14,1415,1416],{},"--profile-plugins"," flag can register a timing wrapper only when asked.",[34,1419,1421],{"id":1420},"ux-considerations","UX considerations",[39,1423,1424,1434,1440,1454],{},[42,1425,1426,1429,1430,1433],{},[19,1427,1428],{},"Attribute results to plugins."," When a plugin's check fails, users need to know which plugin raised it. Prefix check names with the plugin name, or use ",[14,1431,1432],{},"pm.hook.mytool_checks.get_hookimpls()"," to call implementations one by one and label their results.",[42,1435,1436,1439],{},[19,1437,1438],{},"Contain plugin errors."," An exception in one implementation propagates out of the hook call by default. For contribution hooks, wrap the call so a crashing plugin is reported and skipped, not fatal — the same principle as isolating broken plugins at load time.",[42,1441,1442,1445,1446,1449,1450,1453],{},[19,1443,1444],{},"List what is active."," A ",[14,1447,1448],{},"plugins list"," command using ",[14,1451,1452],{},"pm.list_name_plugin()"," shows every registered plugin, which is the first thing to check when a check unexpectedly runs or does not.",[42,1455,1456,1459,1460,1462,1463,1466],{},[19,1457,1458],{},"Keep hook names prefixed."," ",[14,1461,101],{},", not ",[14,1464,1465],{},"checks",": pluggy hooks share one namespace per project, and prefixes make plugin code self-explanatory.",[34,1468,1470],{"id":1469},"testing-the-behaviour","Testing the behaviour",[10,1472,1473,1474,1476],{},"pluggy makes testing easy because plugins are just objects: register a class or module with implementations directly on a fresh ",[14,1475,86],{},", without entry points:",[112,1478,1480],{"className":114,"code":1479,"language":116,"meta":117,"style":117},"# tests\u002Ftest_hooks.py\nimport pluggy\n\nfrom mytool import builtin_checks, hookspecs\nfrom mytool.hookspecs import hookimpl\n\n\ndef fresh_pm(*plugins) -> pluggy.PluginManager:\n    pm = pluggy.PluginManager(\"mytool\")\n    pm.add_hookspecs(hookspecs)\n    for p in plugins:\n        pm.register(p)\n    return pm\n\n\nclass LatestTagCheck:\n    @hookimpl\n    def mytool_checks(self, config):\n        return [(\"pinned-image\", \"no :latest\")] if config.get(\"image\", \"\").endswith(\":latest\") else []\n\n\ndef test_results_are_collected_from_all_plugins():\n    pm = fresh_pm(builtin_checks, LatestTagCheck())\n    results = pm.hook.mytool_checks(config={\"image\": \"web:latest\"})\n    flat = sorted(p for r in results for p in r)\n    assert flat == [(\"pinned-image\", \"no :latest\"), (\"required-name\", \"config has no 'name'\")]\n\n\ndef test_first_result_wins():\n    class Git:\n        @hookimpl\n        def mytool_resolve_target(self, url):\n            return f\"git:{url[6:]}\" if url.startswith(\"git:\u002F\u002F\") else None\n\n    class Fallback:\n        @hookimpl(trylast=True)\n        def mytool_resolve_target(self, url):\n            return f\"path:{url}\"\n\n    pm = fresh_pm(Git(), Fallback())\n    assert pm.hook.mytool_resolve_target(url=\"git:\u002F\u002Frepo\") == \"git:repo\"\n    assert pm.hook.mytool_resolve_target(url=\".\u002Fdist\") == \"path:.\u002Fdist\"\n\n\ndef test_bad_implementation_signature_is_rejected():\n    class Wrong:\n        @hookimpl\n        def mytool_checks(self, config, unknown_arg):\n            return []\n\n    import pytest\n    with pytest.raises(pluggy.PluginValidationError):\n        fresh_pm(Wrong())\n",[14,1481,1482,1487,1493,1497,1507,1517,1521,1525,1540,1552,1556,1567,1572,1578,1582,1586,1596,1601,1611,1648,1652,1656,1666,1675,1701,1731,1761,1765,1769,1778,1789,1795,1806,1848,1853,1863,1880,1889,1909,1914,1924,1946,1967,1972,1977,1987,1997,2002,2012,2019,2024,2033,2042],{"__ignoreMap":117},[121,1483,1484],{"class":123,"line":124},[121,1485,1486],{"class":127},"# tests\u002Ftest_hooks.py\n",[121,1488,1489,1491],{"class":123,"line":131},[121,1490,164],{"class":134},[121,1492,180],{"class":145},[121,1494,1495],{"class":123,"line":149},[121,1496,153],{"emptyLinePlaceholder":152},[121,1498,1499,1501,1503,1505],{"class":123,"line":156},[121,1500,135],{"class":134},[121,1502,450],{"class":145},[121,1504,164],{"class":134},[121,1506,455],{"class":145},[121,1508,1509,1511,1513,1515],{"class":123,"line":170},[121,1510,135],{"class":134},[121,1512,568],{"class":145},[121,1514,164],{"class":134},[121,1516,573],{"class":145},[121,1518,1519],{"class":123,"line":175},[121,1520,153],{"emptyLinePlaceholder":152},[121,1522,1523],{"class":123,"line":183},[121,1524,153],{"emptyLinePlaceholder":152},[121,1526,1527,1529,1532,1534,1537],{"class":123,"line":188},[121,1528,242],{"class":134},[121,1530,1531],{"class":235}," fresh_pm",[121,1533,325],{"class":145},[121,1535,1536],{"class":134},"*",[121,1538,1539],{"class":145},"plugins) -> pluggy.PluginManager:\n",[121,1541,1542,1544,1546,1548,1550],{"class":123,"line":207},[121,1543,483],{"class":145},[121,1545,194],{"class":134},[121,1547,488],{"class":145},[121,1549,201],{"class":200},[121,1551,204],{"class":145},[121,1553,1554],{"class":123,"line":222},[121,1555,497],{"class":145},[121,1557,1558,1560,1562,1564],{"class":123,"line":227},[121,1559,923],{"class":134},[121,1561,913],{"class":145},[121,1563,905],{"class":134},[121,1565,1566],{"class":145}," plugins:\n",[121,1568,1569],{"class":123,"line":232},[121,1570,1571],{"class":145},"        pm.register(p)\n",[121,1573,1574,1576],{"class":123,"line":239},[121,1575,534],{"class":134},[121,1577,537],{"class":145},[121,1579,1580],{"class":123,"line":267},[121,1581,153],{"emptyLinePlaceholder":152},[121,1583,1584],{"class":123,"line":273},[121,1585,153],{"emptyLinePlaceholder":152},[121,1587,1588,1591,1594],{"class":123,"line":278},[121,1589,1590],{"class":134},"class",[121,1592,1593],{"class":235}," LatestTagCheck",[121,1595,363],{"class":145},[121,1597,1598],{"class":123,"line":283},[121,1599,1600],{"class":235},"    @hookimpl\n",[121,1602,1603,1606,1608],{"class":123,"line":288},[121,1604,1605],{"class":134},"    def",[121,1607,245],{"class":235},[121,1609,1610],{"class":145},"(self, config):\n",[121,1612,1613,1615,1617,1619,1621,1624,1627,1629,1631,1633,1635,1637,1640,1642,1644,1646],{"class":123,"line":304},[121,1614,1137],{"class":134},[121,1616,1140],{"class":145},[121,1618,1143],{"class":200},[121,1620,259],{"class":145},[121,1622,1623],{"class":200},"\"no :latest\"",[121,1625,1626],{"class":145},")] ",[121,1628,1018],{"class":134},[121,1630,656],{"class":145},[121,1632,1118],{"class":200},[121,1634,259],{"class":145},[121,1636,1123],{"class":200},[121,1638,1639],{"class":145},").endswith(",[121,1641,1129],{"class":200},[121,1643,667],{"class":145},[121,1645,997],{"class":134},[121,1647,616],{"class":145},[121,1649,1650],{"class":123,"line":310},[121,1651,153],{"emptyLinePlaceholder":152},[121,1653,1654],{"class":123,"line":315},[121,1655,153],{"emptyLinePlaceholder":152},[121,1657,1658,1660,1663],{"class":123,"line":320},[121,1659,242],{"class":134},[121,1661,1662],{"class":235}," test_results_are_collected_from_all_plugins",[121,1664,1665],{"class":145},"():\n",[121,1667,1668,1670,1672],{"class":123,"line":339},[121,1669,483],{"class":145},[121,1671,194],{"class":134},[121,1673,1674],{"class":145}," fresh_pm(builtin_checks, LatestTagCheck())\n",[121,1676,1677,1679,1681,1684,1686,1688,1690,1692,1695,1698],{"class":123,"line":366},[121,1678,874],{"class":145},[121,1680,194],{"class":134},[121,1682,1683],{"class":145}," pm.hook.mytool_checks(",[121,1685,882],{"class":328},[121,1687,194],{"class":134},[121,1689,948],{"class":145},[121,1691,1118],{"class":200},[121,1693,1694],{"class":145},": ",[121,1696,1697],{"class":200},"\"web:latest\"",[121,1699,1700],{"class":145},"})\n",[121,1702,1703,1706,1708,1710,1713,1715,1718,1720,1722,1724,1726,1728],{"class":123,"line":980},[121,1704,1705],{"class":145},"    flat ",[121,1707,194],{"class":134},[121,1709,931],{"class":138},[121,1711,1712],{"class":145},"(p ",[121,1714,899],{"class":134},[121,1716,1717],{"class":145}," r ",[121,1719,905],{"class":134},[121,1721,908],{"class":145},[121,1723,899],{"class":134},[121,1725,913],{"class":145},[121,1727,905],{"class":134},[121,1729,1730],{"class":145}," r)\n",[121,1732,1733,1736,1739,1742,1744,1746,1748,1750,1753,1755,1757,1759],{"class":123,"line":1005},[121,1734,1735],{"class":134},"    assert",[121,1737,1738],{"class":145}," flat ",[121,1740,1741],{"class":134},"==",[121,1743,1140],{"class":145},[121,1745,1143],{"class":200},[121,1747,259],{"class":145},[121,1749,1623],{"class":200},[121,1751,1752],{"class":145},"), (",[121,1754,641],{"class":200},[121,1756,259],{"class":145},[121,1758,646],{"class":200},[121,1760,1151],{"class":145},[121,1762,1763],{"class":123,"line":1010},[121,1764,153],{"emptyLinePlaceholder":152},[121,1766,1767],{"class":123,"line":1015},[121,1768,153],{"emptyLinePlaceholder":152},[121,1770,1771,1773,1776],{"class":123,"line":1032},[121,1772,242],{"class":134},[121,1774,1775],{"class":235}," test_first_result_wins",[121,1777,1665],{"class":145},[121,1779,1781,1784,1787],{"class":123,"line":1780},30,[121,1782,1783],{"class":134},"    class",[121,1785,1786],{"class":235}," Git",[121,1788,363],{"class":145},[121,1790,1792],{"class":123,"line":1791},31,[121,1793,1794],{"class":235},"        @hookimpl\n",[121,1796,1798,1801,1803],{"class":123,"line":1797},32,[121,1799,1800],{"class":134},"        def",[121,1802,344],{"class":235},[121,1804,1805],{"class":145},"(self, url):\n",[121,1807,1809,1812,1815,1818,1820,1823,1826,1829,1831,1833,1835,1838,1841,1843,1845],{"class":123,"line":1808},33,[121,1810,1811],{"class":134},"            return",[121,1813,1814],{"class":134}," f",[121,1816,1817],{"class":200},"\"git:",[121,1819,948],{"class":138},[121,1821,1822],{"class":145},"url[",[121,1824,1825],{"class":138},"6",[121,1827,1828],{"class":145},":]",[121,1830,954],{"class":138},[121,1832,945],{"class":200},[121,1834,991],{"class":134},[121,1836,1837],{"class":145}," url.startswith(",[121,1839,1840],{"class":200},"\"git:\u002F\u002F\"",[121,1842,667],{"class":145},[121,1844,997],{"class":134},[121,1846,1847],{"class":138}," None\n",[121,1849,1851],{"class":123,"line":1850},34,[121,1852,153],{"emptyLinePlaceholder":152},[121,1854,1856,1858,1861],{"class":123,"line":1855},35,[121,1857,1783],{"class":134},[121,1859,1860],{"class":235}," Fallback",[121,1862,363],{"class":145},[121,1864,1866,1869,1871,1874,1876,1878],{"class":123,"line":1865},36,[121,1867,1868],{"class":235},"        @hookimpl",[121,1870,325],{"class":145},[121,1872,1873],{"class":328},"trylast",[121,1875,194],{"class":134},[121,1877,334],{"class":138},[121,1879,204],{"class":145},[121,1881,1883,1885,1887],{"class":123,"line":1882},37,[121,1884,1800],{"class":134},[121,1886,344],{"class":235},[121,1888,1805],{"class":145},[121,1890,1892,1894,1896,1899,1901,1904,1906],{"class":123,"line":1891},38,[121,1893,1811],{"class":134},[121,1895,1814],{"class":134},[121,1897,1898],{"class":200},"\"path:",[121,1900,948],{"class":138},[121,1902,1903],{"class":145},"url",[121,1905,954],{"class":138},[121,1907,1908],{"class":200},"\"\n",[121,1910,1912],{"class":123,"line":1911},39,[121,1913,153],{"emptyLinePlaceholder":152},[121,1915,1917,1919,1921],{"class":123,"line":1916},40,[121,1918,483],{"class":145},[121,1920,194],{"class":134},[121,1922,1923],{"class":145}," fresh_pm(Git(), Fallback())\n",[121,1925,1927,1929,1932,1934,1936,1939,1941,1943],{"class":123,"line":1926},41,[121,1928,1735],{"class":134},[121,1930,1931],{"class":145}," pm.hook.mytool_resolve_target(",[121,1933,1903],{"class":328},[121,1935,194],{"class":134},[121,1937,1938],{"class":200},"\"git:\u002F\u002Frepo\"",[121,1940,667],{"class":145},[121,1942,1741],{"class":134},[121,1944,1945],{"class":200}," \"git:repo\"\n",[121,1947,1949,1951,1953,1955,1957,1960,1962,1964],{"class":123,"line":1948},42,[121,1950,1735],{"class":134},[121,1952,1931],{"class":145},[121,1954,1903],{"class":328},[121,1956,194],{"class":134},[121,1958,1959],{"class":200},"\".\u002Fdist\"",[121,1961,667],{"class":145},[121,1963,1741],{"class":134},[121,1965,1966],{"class":200}," \"path:.\u002Fdist\"\n",[121,1968,1970],{"class":123,"line":1969},43,[121,1971,153],{"emptyLinePlaceholder":152},[121,1973,1975],{"class":123,"line":1974},44,[121,1976,153],{"emptyLinePlaceholder":152},[121,1978,1980,1982,1985],{"class":123,"line":1979},45,[121,1981,242],{"class":134},[121,1983,1984],{"class":235}," test_bad_implementation_signature_is_rejected",[121,1986,1665],{"class":145},[121,1988,1990,1992,1995],{"class":123,"line":1989},46,[121,1991,1783],{"class":134},[121,1993,1994],{"class":235}," Wrong",[121,1996,363],{"class":145},[121,1998,2000],{"class":123,"line":1999},47,[121,2001,1794],{"class":235},[121,2003,2005,2007,2009],{"class":123,"line":2004},48,[121,2006,1800],{"class":134},[121,2008,245],{"class":235},[121,2010,2011],{"class":145},"(self, config, unknown_arg):\n",[121,2013,2015,2017],{"class":123,"line":2014},49,[121,2016,1811],{"class":134},[121,2018,616],{"class":145},[121,2020,2022],{"class":123,"line":2021},50,[121,2023,153],{"emptyLinePlaceholder":152},[121,2025,2027,2030],{"class":123,"line":2026},51,[121,2028,2029],{"class":134},"    import",[121,2031,2032],{"class":145}," pytest\n",[121,2034,2036,2039],{"class":123,"line":2035},52,[121,2037,2038],{"class":134},"    with",[121,2040,2041],{"class":145}," pytest.raises(pluggy.PluginValidationError):\n",[121,2043,2045],{"class":123,"line":2044},53,[121,2046,2047],{"class":145},"        fresh_pm(Wrong())\n",[10,2049,2050,2051,2054],{},"The last test demonstrates one of pluggy's most valuable properties: a plugin whose implementation asks for an argument the spec does not provide is rejected ",[19,2052,2053],{},"at registration time"," with a clear error, rather than failing mysteriously when the hook is called.",[34,2056,2058],{"id":2057},"conclusion","Conclusion",[10,2060,2061,2062,2064],{},"When plugins need to extend behaviour inside commands rather than add whole commands, a hook system is the right shape, and pluggy provides it in a few dozen lines: specs declare extension points, implementations contribute behaviour, a plugin manager validates and calls them, and entry points load third-party plugins. Register built-ins through the same mechanism, choose between collecting all results and ",[14,2063,329],{},", attribute and contain plugin failures, and test by registering plain objects on a fresh manager. It is the architecture pytest's enormous plugin ecosystem runs on, and it scales down to a single CLI just as well.",[34,2066,2068],{"id":2067},"frequently-asked-questions","Frequently asked questions",[1239,2070,2072],{"id":2071},"entry-point-commands-or-pluggy-hooks","Entry-point commands or pluggy hooks?",[10,2074,2075,2076,2079],{},"Use entry points for plugins that add whole command groups, and pluggy hooks for plugins that extend behaviour within existing commands. Many CLIs use both: pluggy's ",[14,2077,2078],{},"load_setuptools_entrypoints"," can even provide the command-contributing hook itself.",[1239,2081,2083],{"id":2082},"can-hooks-be-async","Can hooks be async?",[10,2085,2086],{},"pluggy calls implementations synchronously. For async plugins, have hooks return coroutines or awaitables and let the host gather them — or keep hooks synchronous and do async work inside the host.",[1239,2088,2090],{"id":2089},"how-do-i-let-plugins-add-options-to-existing-commands","How do I let plugins add options to existing commands?",[10,2092,2093,2094,2097,2098,2101],{},"Define a hook such as ",[14,2095,2096],{},"mytool_add_options(command_name)"," that returns Click options, and apply them when building the command. It works, but it makes ",[14,2099,2100],{},"--help"," depend on installed plugins; document it clearly.",[1239,2103,2105],{"id":2104},"does-pluggy-add-startup-cost","Does pluggy add startup cost?",[10,2107,2108,2109,2111],{},"pluggy itself is small. The cost is loading plugins, which imports them. Create the plugin manager lazily — only in commands that call hooks — to keep ",[14,2110,2100],{}," fast.",[34,2113,2115],{"id":2114},"related","Related",[39,2117,2118,2124,2129,2134,2140],{},[42,2119,2120,2121],{},"Up: ",[28,2122,2123],{"href":30},"Plugin architectures for extensible CLIs",[42,2125,2126],{},[28,2127,2128],{"href":57},"Discovering plugins with entry points",[42,2130,2131],{},[28,2132,2133],{"href":390},"Versioning a plugin API",[42,2135,2136],{},[28,2137,2139],{"href":2138},"\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",[42,2141,2142],{},[28,2143,2145],{"href":2144},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands\u002F","Dependency injection patterns for CLI commands",[2147,2148,2149],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":117,"searchDepth":131,"depth":131,"links":2151},[2152,2153,2154,2155,2156,2157,2160,2161,2162,2163,2169],{"id":36,"depth":131,"text":37},{"id":62,"depth":131,"text":63},{"id":109,"depth":131,"text":110},{"id":397,"depth":131,"text":398},{"id":1038,"depth":131,"text":1039},{"id":1207,"depth":131,"text":1208,"children":2158},[2159],{"id":1241,"depth":149,"text":1242},{"id":1420,"depth":131,"text":1421},{"id":1469,"depth":131,"text":1470},{"id":2057,"depth":131,"text":2058},{"id":2067,"depth":131,"text":2068,"children":2164},[2165,2166,2167,2168],{"id":2071,"depth":149,"text":2072},{"id":2082,"depth":149,"text":2083},{"id":2089,"depth":149,"text":2090},{"id":2104,"depth":149,"text":2105},{"id":2114,"depth":131,"text":2115},"2026-09-18","Build a hook-based plugin system for a Python CLI with pluggy, the library behind pytest: hook specs, implementations, entry-point loading, ordering and tests.","advanced",false,"md",{},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy",{"title":5,"description":2171},"modern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy\u002Findex",[2180,25,2181,2182],"plugins","architecture","extensibility","AY4Sn_R02Z1D56V2f01YySvGWfZePul7b6Ra-NFvdwU",[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,2539,2542,2545,2548,2551,2554,2557,2560,2563,2566,2569,2572,2575,2578,2581,2584,2587,2590,2593,2596,2599,2602,2605,2608,2611,2614,2617,2620,2623,2626,2629,2632,2635,2638,2641,2644,2647,2650,2653,2656,2659,2662,2665,2668,2671,2674,2677,2680,2683,2686,2689,2692,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,2864,2867,2870,2873,2876,2879,2882,2885,2888,2891,2894,2897,2900,2903,2906,2909,2912,2915,2918,2921,2924,2927,2930,2933,2936,2939,2942,2945,2948,2951,2954,2957,2960,2963,2966,2969,2972,2975,2978,2981,2984,2987,2990,2993,2996,2999,3002,3005,3008,3011,3014,3017,3020,3023,3026],{"path":2186,"title":2187},"\u002Fabout","About Python CLI Toolcraft",{"path":2189,"title":2190},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":2192,"title":2193},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":2195,"title":2196},"\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":2198,"title":2199},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":2201,"title":2202},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2204,"title":2205},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":2207,"title":2208},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2210,"title":2211},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":2213,"title":2214},"\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":2216,"title":2217},"\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":2219,"title":2220},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2222,"title":2223},"\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":2225,"title":2226},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":2228,"title":2229},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2231,"title":2232},"\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":2234,"title":2235},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":2237,"title":2238},"\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":2240,"title":2241},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2243,"title":2244},"\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":2246,"title":2247},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2249,"title":2250},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2252,"title":2253},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2255,"title":2256},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2258,"title":2259},"\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":2261,"title":2262},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":2264,"title":2265},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2267,"title":2268},"\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":2270,"title":2271},"\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":2273,"title":2274},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2276,"title":2277},"\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":2279,"title":2280},"\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":2282,"title":2283},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2285,"title":2286},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2288,"title":2289},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2291,"title":2292},"\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":2294,"title":2295},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2297,"title":2298},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2300,"title":2301},"\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":2303,"title":2304},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2306,"title":2307},"\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":2309,"title":2310},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2312,"title":2313},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2315,"title":2316},"\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":2318,"title":2319},"\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":2321,"title":2322},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2324,"title":2325},"\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":2327,"title":2328},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2330,"title":2331},"\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":2333,"title":2334},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2336,"title":2337},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2339,"title":2340},"\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":2342,"title":2343},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2345,"title":2346},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2348,"title":2349},"\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":2351,"title":2352},"\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":2354,"title":2355},"\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":2357,"title":2358},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2360,"title":2361},"\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":2363,"title":2364},"\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":2366,"title":2367},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2369,"title":2370},"\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":2372,"title":2373},"\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":2375,"title":2376},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2378,"title":2379},"\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":2381,"title":2382},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2384,"title":2385},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2387,"title":2388},"\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":2390,"title":2391},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2393,"title":2394},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2396,"title":2397},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2399,"title":2400},"\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":2402,"title":2403},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2405,"title":2406},"\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":2408,"title":2409},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2411,"title":2412},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2414,"title":2415},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2417,"title":2418},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2420,"title":2421},"\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":2423,"title":2424},"\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":2426,"title":2427},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2429,"title":2430},"\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":2432,"title":2433},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2435,"title":2436},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2438,"title":2439},"\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":2441,"title":2442},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2444,"title":2445},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2447,"title":2448},"\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":2450,"title":2451},"\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":2453,"title":2454},"\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":2456,"title":2457},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2459,"title":2460},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2462,"title":2463},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2465,"title":2466},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2468,"title":2469},"\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":2471,"title":2472},"\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":2474,"title":2475},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2477,"title":2478},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2480,"title":2481},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2483,"title":2484},"\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":2486,"title":2487},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2489,"title":2490},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2492,"title":2493},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2495,"title":2496},"\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":2498,"title":2499},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2501,"title":2502},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2504,"title":2505},"\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":2507,"title":2508},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2510,"title":2511},"\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":2513,"title":2514},"\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":2516,"title":2517},"\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":2519,"title":2520},"\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":2522,"title":2523},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2525,"title":2526},"\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":2528,"title":2529},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2531,"title":2532},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2534,"title":2535},"\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":2537,"title":2538},"\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":2540,"title":2541},"\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":2543,"title":2544},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2546,"title":2547},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2549,"title":2550},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2552,"title":2553},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2555,"title":2556},"\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":2558,"title":2559},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2561,"title":2562},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2564,"title":2565},"\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":2567,"title":2568},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2570,"title":2571},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2573,"title":2574},"\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":2576,"title":2577},"\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":2579,"title":2580},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2582,"title":2583},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2585,"title":2586},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2588,"title":2589},"\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":2591,"title":2592},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2594,"title":2595},"\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":2597,"title":2598},"\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":2600,"title":2601},"\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":2603,"title":2604},"\u002F","Python CLI Toolcraft",{"path":2606,"title":2607},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2609,"title":2610},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2612,"title":2613},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2615,"title":2616},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2618,"title":2619},"\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":2621,"title":2622},"\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":2624,"title":2625},"\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":2627,"title":2628},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2630,"title":2631},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2633,"title":2634},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2636,"title":2637},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2639,"title":2640},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2642,"title":2643},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2645,"title":2646},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2648,"title":2649},"\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":2651,"title":2652},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2654,"title":2655},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2657,"title":2658},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2660,"title":2661},"\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":2663,"title":2664},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2666,"title":2667},"\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":2669,"title":2670},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2672,"title":2673},"\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":2675,"title":2676},"\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":2678,"title":2679},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2681,"title":2682},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2684,"title":2685},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2687,"title":2688},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2690,"title":2691},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2176,"title":5},{"path":2694,"title":2695},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2697,"title":2698},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2700,"title":2701},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2703,"title":2704},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2706,"title":2707},"\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":2709,"title":2710},"\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":2712,"title":2713},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2715,"title":2716},"\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":2718,"title":2719},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2721,"title":2722},"\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":2724,"title":2725},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2727,"title":2728},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2730,"title":2731},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2733,"title":2734},"\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":2736,"title":2737},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2739,"title":2740},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2742,"title":2743},"\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":2745,"title":2746},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2748,"title":2749},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2751,"title":2752},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2754,"title":2755},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2757,"title":2758},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2760,"title":2761},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2763,"title":2764},"\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":2766,"title":2767},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2769,"title":2770},"\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":2772,"title":2773},"\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":2775,"title":2776},"\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":2778,"title":2779},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2781,"title":2782},"\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":2784,"title":2785},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2787,"title":2788},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2790,"title":2791},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2793,"title":2794},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2796,"title":2797},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2799,"title":2800},"\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":2802,"title":2803},"\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":2805,"title":2806},"\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":2808,"title":2809},"\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":2811,"title":2812},"\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":2814,"title":2815},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2817,"title":2818},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2820,"title":2821},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2823,"title":2824},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2826,"title":2827},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2829,"title":2830},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2832,"title":2833},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2835,"title":2836},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2838,"title":2839},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2841,"title":2842},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2844,"title":2845},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2847,"title":2848},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2850,"title":2851},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2853,"title":2854},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2856,"title":2857},"\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":2859,"title":2860},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2862,"title":2863},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2865,"title":2866},"\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":2868,"title":2869},"\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":2871,"title":2872},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2874,"title":2875},"\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":2877,"title":2878},"\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":2880,"title":2881},"\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":2883,"title":2884},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2886,"title":2887},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2889,"title":2890},"\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":2892,"title":2893},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2895,"title":2896},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2898,"title":2899},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2901,"title":2902},"\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":2904,"title":2905},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2907,"title":2908},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2910,"title":2911},"\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":2913,"title":2914},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2916,"title":2917},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2919,"title":2920},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2922,"title":2923},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2925,"title":2926},"\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":2928,"title":2929},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2931,"title":2932},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2934,"title":2935},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2937,"title":2938},"\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":2940,"title":2941},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2943,"title":2944},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2946,"title":2947},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2949,"title":2950},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2952,"title":2953},"\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":2955,"title":2956},"\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":2958,"title":2959},"\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":2961,"title":2962},"\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":2964,"title":2965},"\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":2967,"title":2968},"\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":2970,"title":2971},"\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":2973,"title":2974},"\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":2976,"title":2977},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2979,"title":2980},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2982,"title":2983},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2985,"title":2986},"\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":2988,"title":2989},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2991,"title":2992},"\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":2994,"title":2995},"\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":2997,"title":2998},"\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":3000,"title":3001},"\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":3003,"title":3004},"\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":3006,"title":3007},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":3009,"title":3010},"\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":3012,"title":3013},"\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":3015,"title":3016},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":3018,"title":3019},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":3021,"title":3022},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":3024,"title":3025},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":3027,"title":3028},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967541360]