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