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