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