[{"data":1,"prerenderedAt":2667},["ShallowReactive",2],{"page-\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown\u002F":3,"content-directory":1823},{"id":4,"title":5,"body":6,"date":1808,"description":1809,"difficulty":1810,"draft":1811,"extension":1812,"meta":1813,"navigation":197,"path":1814,"seo":1815,"stem":1816,"tags":1817,"updated":1808,"__hash__":1822},"content\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown\u002Findex.md","Handling SIGTERM and Graceful Shutdown in CLIs",{"type":7,"value":8,"toc":1787},"minimark",[9,42,47,71,77,87,91,121,125,128,156,530,549,1024,1042,1047,1050,1053,1060,1064,1074,1077,1084,1088,1120,1139,1143,1193,1197,1203,1628,1639,1643,1652,1656,1664,1682,1686,1711,1715,1732,1736,1748,1752,1783],[10,11,12,13,17,18,21,22,24,25,28,29,31,32,35,36,41],"p",{},"Your CLI handles Ctrl+C beautifully — temp files removed, lock released, a one-line summary printed. Then someone runs it in a container, and ",[14,15,16],"code",{},"docker stop"," leaves a stale lock file and half-written output behind. Or a CI job hits its timeout, and the \"cleanup\" step finds your process's debris. The reason is that supervisors do not press Ctrl+C: they send ",[14,19,20],{},"SIGTERM",", and Python's default response to ",[14,23,20],{}," is to terminate at once, without raising an exception, without running ",[14,26,27],{},"finally"," blocks or context-manager exits, and without flushing buffered output. This guide shows how to give ",[14,30,20],{}," the same graceful treatment as ",[14,33,34],{},"SIGINT",", how to fit shutdown inside a supervisor's grace period, what changes when your CLI is PID 1 in a container, and how to test it. It belongs to the ",[37,38,40],"a",{"href":39},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002F","long-running and watch-mode topic",".",[43,44,46],"h2",{"id":45},"prerequisites","Prerequisites",[48,49,50,54,61],"ul",{},[51,52,53],"li",{},"Python 3.10+ on Linux or macOS (Windows notes at the end).",[51,55,56,57,41],{},"A CLI whose cleanup already works for Ctrl+C, as described in ",[37,58,60],{"href":59},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly\u002F","handling KeyboardInterrupt cleanly",[51,62,63,64,66,67,70],{},"Something that will stop it with ",[14,65,20],{},": systemd, Docker, Kubernetes, ",[14,68,69],{},"timeout(1)",", a CI runner or a process manager.",[43,72,74,75],{"id":73},"what-happens-on-docker-stop","What happens on ",[14,76,16],{},[10,78,79,80,82,83,86],{},"Every supervisor follows the same protocol: send ",[14,81,20],{},", wait a grace period, then send ",[14,84,85],{},"SIGKILL",", which cannot be caught.",[88,89],"inline-diagram",{"name":90},"lr-sigterm-sequence",[10,92,93,94,96,97,100,101,104,105,107,108,110,111,114,115,117,118,120],{},"The grace periods differ: ",[14,95,16],{}," waits 10 seconds, Kubernetes 30 (",[14,98,99],{},"terminationGracePeriodSeconds","), systemd 90 (",[14,102,103],{},"TimeoutStopSec","), and ",[14,106,69],{}," sends only ",[14,109,20],{}," unless you add ",[14,112,113],{},"--kill-after",". Your shutdown has to fit comfortably inside the shortest one your users will hit. Anything still running when ",[14,116,85],{}," arrives — including ",[14,119,27],{}," blocks — simply stops.",[43,122,124],{"id":123},"the-recipe-two-patterns","The recipe: two patterns",[10,126,127],{},"Which pattern to use depends on the shape of the command.",[10,129,130,134,135,138,139,141,142,145,146,148,149,151,152,155],{},[131,132,133],"strong",{},"One-shot commands"," — a build, an export, a migration — are written as ordinary sequential code with ",[14,136,137],{},"try","\u002F",[14,140,27],{}," and ",[14,143,144],{},"with"," blocks for cleanup. For them, the simplest correct approach is to make ",[14,147,20],{}," raise an exception, exactly as ",[14,150,34],{}," raises ",[14,153,154],{},"KeyboardInterrupt",", so the existing cleanup runs:",[157,158,163],"pre",{"className":159,"code":160,"language":161,"meta":162,"style":162},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fsignals.py\nfrom __future__ import annotations\n\nimport signal\nimport sys\nfrom collections.abc import Iterator\nfrom contextlib import contextmanager\n\n\nclass Terminated(BaseException):\n    \"\"\"Raised in the main thread when SIGTERM arrives.\"\"\"\n\n    def __init__(self, signum: int) -> None:\n        super().__init__(signum)\n        self.signum = signum\n        self.exit_code = 128 + signum\n\n\ndef _raise(signum: int, frame: object) -> None:\n    # Restore the default first: a second SIGTERM during slow cleanup kills us outright.\n    signal.signal(signum, signal.SIG_DFL)\n    raise Terminated(signum)\n\n\n@contextmanager\ndef terminate_as_exception() -> Iterator[None]:\n    previous = signal.signal(signal.SIGTERM, _raise)\n    if hasattr(signal, \"SIGHUP\"):\n        signal.signal(signal.SIGHUP, _raise)       # terminal closed\n    try:\n        yield\n    finally:\n        signal.signal(signal.SIGTERM, previous)\n","python","",[14,164,165,174,192,199,208,216,229,242,247,252,271,278,283,307,322,337,355,360,365,391,397,409,418,423,428,434,450,466,483,498,506,512,520],{"__ignoreMap":162},[166,167,170],"span",{"class":168,"line":169},"line",1,[166,171,173],{"class":172},"sJ8bj","# src\u002Fmytool\u002Fsignals.py\n",[166,175,177,181,185,188],{"class":168,"line":176},2,[166,178,180],{"class":179},"szBVR","from",[166,182,184],{"class":183},"sj4cs"," __future__",[166,186,187],{"class":179}," import",[166,189,191],{"class":190},"sVt8B"," annotations\n",[166,193,195],{"class":168,"line":194},3,[166,196,198],{"emptyLinePlaceholder":197},true,"\n",[166,200,202,205],{"class":168,"line":201},4,[166,203,204],{"class":179},"import",[166,206,207],{"class":190}," signal\n",[166,209,211,213],{"class":168,"line":210},5,[166,212,204],{"class":179},[166,214,215],{"class":190}," sys\n",[166,217,219,221,224,226],{"class":168,"line":218},6,[166,220,180],{"class":179},[166,222,223],{"class":190}," collections.abc ",[166,225,204],{"class":179},[166,227,228],{"class":190}," Iterator\n",[166,230,232,234,237,239],{"class":168,"line":231},7,[166,233,180],{"class":179},[166,235,236],{"class":190}," contextlib ",[166,238,204],{"class":179},[166,240,241],{"class":190}," contextmanager\n",[166,243,245],{"class":168,"line":244},8,[166,246,198],{"emptyLinePlaceholder":197},[166,248,250],{"class":168,"line":249},9,[166,251,198],{"emptyLinePlaceholder":197},[166,253,255,258,262,265,268],{"class":168,"line":254},10,[166,256,257],{"class":179},"class",[166,259,261],{"class":260},"sScJk"," Terminated",[166,263,264],{"class":190},"(",[166,266,267],{"class":183},"BaseException",[166,269,270],{"class":190},"):\n",[166,272,274],{"class":168,"line":273},11,[166,275,277],{"class":276},"sZZnC","    \"\"\"Raised in the main thread when SIGTERM arrives.\"\"\"\n",[166,279,281],{"class":168,"line":280},12,[166,282,198],{"emptyLinePlaceholder":197},[166,284,286,289,292,295,298,301,304],{"class":168,"line":285},13,[166,287,288],{"class":179},"    def",[166,290,291],{"class":183}," __init__",[166,293,294],{"class":190},"(self, signum: ",[166,296,297],{"class":183},"int",[166,299,300],{"class":190},") -> ",[166,302,303],{"class":183},"None",[166,305,306],{"class":190},":\n",[166,308,310,313,316,319],{"class":168,"line":309},14,[166,311,312],{"class":183},"        super",[166,314,315],{"class":190},"().",[166,317,318],{"class":183},"__init__",[166,320,321],{"class":190},"(signum)\n",[166,323,325,328,331,334],{"class":168,"line":324},15,[166,326,327],{"class":183},"        self",[166,329,330],{"class":190},".signum ",[166,332,333],{"class":179},"=",[166,335,336],{"class":190}," signum\n",[166,338,340,342,345,347,350,353],{"class":168,"line":339},16,[166,341,327],{"class":183},[166,343,344],{"class":190},".exit_code ",[166,346,333],{"class":179},[166,348,349],{"class":183}," 128",[166,351,352],{"class":179}," +",[166,354,336],{"class":190},[166,356,358],{"class":168,"line":357},17,[166,359,198],{"emptyLinePlaceholder":197},[166,361,363],{"class":168,"line":362},18,[166,364,198],{"emptyLinePlaceholder":197},[166,366,368,371,374,377,379,382,385,387,389],{"class":168,"line":367},19,[166,369,370],{"class":179},"def",[166,372,373],{"class":260}," _raise",[166,375,376],{"class":190},"(signum: ",[166,378,297],{"class":183},[166,380,381],{"class":190},", frame: ",[166,383,384],{"class":183},"object",[166,386,300],{"class":190},[166,388,303],{"class":183},[166,390,306],{"class":190},[166,392,394],{"class":168,"line":393},20,[166,395,396],{"class":172},"    # Restore the default first: a second SIGTERM during slow cleanup kills us outright.\n",[166,398,400,403,406],{"class":168,"line":399},21,[166,401,402],{"class":190},"    signal.signal(signum, signal.",[166,404,405],{"class":183},"SIG_DFL",[166,407,408],{"class":190},")\n",[166,410,412,415],{"class":168,"line":411},22,[166,413,414],{"class":179},"    raise",[166,416,417],{"class":190}," Terminated(signum)\n",[166,419,421],{"class":168,"line":420},23,[166,422,198],{"emptyLinePlaceholder":197},[166,424,426],{"class":168,"line":425},24,[166,427,198],{"emptyLinePlaceholder":197},[166,429,431],{"class":168,"line":430},25,[166,432,433],{"class":260},"@contextmanager\n",[166,435,437,439,442,445,447],{"class":168,"line":436},26,[166,438,370],{"class":179},[166,440,441],{"class":260}," terminate_as_exception",[166,443,444],{"class":190},"() -> Iterator[",[166,446,303],{"class":183},[166,448,449],{"class":190},"]:\n",[166,451,453,456,458,461,463],{"class":168,"line":452},27,[166,454,455],{"class":190},"    previous ",[166,457,333],{"class":179},[166,459,460],{"class":190}," signal.signal(signal.",[166,462,20],{"class":183},[166,464,465],{"class":190},", _raise)\n",[166,467,469,472,475,478,481],{"class":168,"line":468},28,[166,470,471],{"class":179},"    if",[166,473,474],{"class":183}," hasattr",[166,476,477],{"class":190},"(signal, ",[166,479,480],{"class":276},"\"SIGHUP\"",[166,482,270],{"class":190},[166,484,486,489,492,495],{"class":168,"line":485},29,[166,487,488],{"class":190},"        signal.signal(signal.",[166,490,491],{"class":183},"SIGHUP",[166,493,494],{"class":190},", _raise)       ",[166,496,497],{"class":172},"# terminal closed\n",[166,499,501,504],{"class":168,"line":500},30,[166,502,503],{"class":179},"    try",[166,505,306],{"class":190},[166,507,509],{"class":168,"line":508},31,[166,510,511],{"class":179},"        yield\n",[166,513,515,518],{"class":168,"line":514},32,[166,516,517],{"class":179},"    finally",[166,519,306],{"class":190},[166,521,523,525,527],{"class":168,"line":522},33,[166,524,488],{"class":190},[166,526,20],{"class":183},[166,528,529],{"class":190},", previous)\n",[10,531,532,535,536,538,539,541,542,545,546,548],{},[14,533,534],{},"Terminated"," derives from ",[14,537,267],{},", like ",[14,540,154],{},", so ordinary ",[14,543,544],{},"except Exception:"," blocks in your code and in libraries do not swallow it. Wire it in at the top of the command layer, where ",[14,547,154],{}," is already handled:",[157,550,552],{"className":159,"code":551,"language":161,"meta":162,"style":162},"# src\u002Fmytool\u002Fcli.py\nimport shutil\nimport tempfile\nimport time\nfrom pathlib import Path\n\nimport typer\n\nfrom mytool.signals import Terminated, terminate_as_exception\n\napp = typer.Typer()\n\n\n@app.callback()\ndef main() -> None:\n    \"\"\"Export tools.\"\"\"\n\n\n@app.command()\ndef export(out: Path, items: int = 50) -> None:\n    \"\"\"Export ITEMS records to OUT, cleaning up if stopped.\"\"\"\n    with terminate_as_exception():\n        work = Path(tempfile.mkdtemp(prefix=\"mytool-export-\"))\n        try:\n            for i in range(items):\n                (work \u002F f\"{i:04}.json\").write_text(\"{}\")\n                time.sleep(0.05)                     # stand-in for real work\n            shutil.copytree(work, out, dirs_exist_ok=True)\n            typer.echo(f\"exported {items} records to {out}\", err=True)\n        except KeyboardInterrupt:\n            typer.echo(\"interrupted; nothing written\", err=True)\n            raise typer.Exit(130)\n        except Terminated as exc:\n            typer.echo(f\"stopped by signal {exc.signum}; nothing written\", err=True)\n            raise typer.Exit(exc.exit_code)\n        finally:\n            shutil.rmtree(work, ignore_errors=True)\n\n\nif __name__ == \"__main__\":\n    app()\n",[14,553,554,559,566,573,580,592,596,603,607,619,623,633,637,641,649,663,668,672,676,683,707,712,720,742,749,766,806,820,835,877,887,904,917,930,960,968,976,991,996,1001,1018],{"__ignoreMap":162},[166,555,556],{"class":168,"line":169},[166,557,558],{"class":172},"# src\u002Fmytool\u002Fcli.py\n",[166,560,561,563],{"class":168,"line":176},[166,562,204],{"class":179},[166,564,565],{"class":190}," shutil\n",[166,567,568,570],{"class":168,"line":194},[166,569,204],{"class":179},[166,571,572],{"class":190}," tempfile\n",[166,574,575,577],{"class":168,"line":201},[166,576,204],{"class":179},[166,578,579],{"class":190}," time\n",[166,581,582,584,587,589],{"class":168,"line":210},[166,583,180],{"class":179},[166,585,586],{"class":190}," pathlib ",[166,588,204],{"class":179},[166,590,591],{"class":190}," Path\n",[166,593,594],{"class":168,"line":218},[166,595,198],{"emptyLinePlaceholder":197},[166,597,598,600],{"class":168,"line":231},[166,599,204],{"class":179},[166,601,602],{"class":190}," typer\n",[166,604,605],{"class":168,"line":244},[166,606,198],{"emptyLinePlaceholder":197},[166,608,609,611,614,616],{"class":168,"line":249},[166,610,180],{"class":179},[166,612,613],{"class":190}," mytool.signals ",[166,615,204],{"class":179},[166,617,618],{"class":190}," Terminated, terminate_as_exception\n",[166,620,621],{"class":168,"line":254},[166,622,198],{"emptyLinePlaceholder":197},[166,624,625,628,630],{"class":168,"line":273},[166,626,627],{"class":190},"app ",[166,629,333],{"class":179},[166,631,632],{"class":190}," typer.Typer()\n",[166,634,635],{"class":168,"line":280},[166,636,198],{"emptyLinePlaceholder":197},[166,638,639],{"class":168,"line":285},[166,640,198],{"emptyLinePlaceholder":197},[166,642,643,646],{"class":168,"line":309},[166,644,645],{"class":260},"@app.callback",[166,647,648],{"class":190},"()\n",[166,650,651,653,656,659,661],{"class":168,"line":324},[166,652,370],{"class":179},[166,654,655],{"class":260}," main",[166,657,658],{"class":190},"() -> ",[166,660,303],{"class":183},[166,662,306],{"class":190},[166,664,665],{"class":168,"line":339},[166,666,667],{"class":276},"    \"\"\"Export tools.\"\"\"\n",[166,669,670],{"class":168,"line":357},[166,671,198],{"emptyLinePlaceholder":197},[166,673,674],{"class":168,"line":362},[166,675,198],{"emptyLinePlaceholder":197},[166,677,678,681],{"class":168,"line":367},[166,679,680],{"class":260},"@app.command",[166,682,648],{"class":190},[166,684,685,687,690,693,695,698,701,703,705],{"class":168,"line":393},[166,686,370],{"class":179},[166,688,689],{"class":260}," export",[166,691,692],{"class":190},"(out: Path, items: ",[166,694,297],{"class":183},[166,696,697],{"class":179}," =",[166,699,700],{"class":183}," 50",[166,702,300],{"class":190},[166,704,303],{"class":183},[166,706,306],{"class":190},[166,708,709],{"class":168,"line":399},[166,710,711],{"class":276},"    \"\"\"Export ITEMS records to OUT, cleaning up if stopped.\"\"\"\n",[166,713,714,717],{"class":168,"line":411},[166,715,716],{"class":179},"    with",[166,718,719],{"class":190}," terminate_as_exception():\n",[166,721,722,725,727,730,734,736,739],{"class":168,"line":420},[166,723,724],{"class":190},"        work ",[166,726,333],{"class":179},[166,728,729],{"class":190}," Path(tempfile.mkdtemp(",[166,731,733],{"class":732},"s4XuR","prefix",[166,735,333],{"class":179},[166,737,738],{"class":276},"\"mytool-export-\"",[166,740,741],{"class":190},"))\n",[166,743,744,747],{"class":168,"line":425},[166,745,746],{"class":179},"        try",[166,748,306],{"class":190},[166,750,751,754,757,760,763],{"class":168,"line":430},[166,752,753],{"class":179},"            for",[166,755,756],{"class":190}," i ",[166,758,759],{"class":179},"in",[166,761,762],{"class":183}," range",[166,764,765],{"class":190},"(items):\n",[166,767,768,771,773,776,779,782,785,788,791,794,797,799,802,804],{"class":168,"line":436},[166,769,770],{"class":190},"                (work ",[166,772,138],{"class":179},[166,774,775],{"class":179}," f",[166,777,778],{"class":276},"\"",[166,780,781],{"class":183},"{",[166,783,784],{"class":190},"i",[166,786,787],{"class":179},":04",[166,789,790],{"class":183},"}",[166,792,793],{"class":276},".json\"",[166,795,796],{"class":190},").write_text(",[166,798,778],{"class":276},[166,800,801],{"class":183},"{}",[166,803,778],{"class":276},[166,805,408],{"class":190},[166,807,808,811,814,817],{"class":168,"line":452},[166,809,810],{"class":190},"                time.sleep(",[166,812,813],{"class":183},"0.05",[166,815,816],{"class":190},")                     ",[166,818,819],{"class":172},"# stand-in for real work\n",[166,821,822,825,828,830,833],{"class":168,"line":468},[166,823,824],{"class":190},"            shutil.copytree(work, out, ",[166,826,827],{"class":732},"dirs_exist_ok",[166,829,333],{"class":179},[166,831,832],{"class":183},"True",[166,834,408],{"class":190},[166,836,837,840,843,846,848,851,853,856,858,861,863,865,868,871,873,875],{"class":168,"line":485},[166,838,839],{"class":190},"            typer.echo(",[166,841,842],{"class":179},"f",[166,844,845],{"class":276},"\"exported ",[166,847,781],{"class":183},[166,849,850],{"class":190},"items",[166,852,790],{"class":183},[166,854,855],{"class":276}," records to ",[166,857,781],{"class":183},[166,859,860],{"class":190},"out",[166,862,790],{"class":183},[166,864,778],{"class":276},[166,866,867],{"class":190},", ",[166,869,870],{"class":732},"err",[166,872,333],{"class":179},[166,874,832],{"class":183},[166,876,408],{"class":190},[166,878,879,882,885],{"class":168,"line":500},[166,880,881],{"class":179},"        except",[166,883,884],{"class":183}," KeyboardInterrupt",[166,886,306],{"class":190},[166,888,889,891,894,896,898,900,902],{"class":168,"line":508},[166,890,839],{"class":190},[166,892,893],{"class":276},"\"interrupted; nothing written\"",[166,895,867],{"class":190},[166,897,870],{"class":732},[166,899,333],{"class":179},[166,901,832],{"class":183},[166,903,408],{"class":190},[166,905,906,909,912,915],{"class":168,"line":514},[166,907,908],{"class":179},"            raise",[166,910,911],{"class":190}," typer.Exit(",[166,913,914],{"class":183},"130",[166,916,408],{"class":190},[166,918,919,921,924,927],{"class":168,"line":522},[166,920,881],{"class":179},[166,922,923],{"class":190}," Terminated ",[166,925,926],{"class":179},"as",[166,928,929],{"class":190}," exc:\n",[166,931,933,935,937,940,942,945,947,950,952,954,956,958],{"class":168,"line":932},34,[166,934,839],{"class":190},[166,936,842],{"class":179},[166,938,939],{"class":276},"\"stopped by signal ",[166,941,781],{"class":183},[166,943,944],{"class":190},"exc.signum",[166,946,790],{"class":183},[166,948,949],{"class":276},"; nothing written\"",[166,951,867],{"class":190},[166,953,870],{"class":732},[166,955,333],{"class":179},[166,957,832],{"class":183},[166,959,408],{"class":190},[166,961,963,965],{"class":168,"line":962},35,[166,964,908],{"class":179},[166,966,967],{"class":190}," typer.Exit(exc.exit_code)\n",[166,969,971,974],{"class":168,"line":970},36,[166,972,973],{"class":179},"        finally",[166,975,306],{"class":190},[166,977,979,982,985,987,989],{"class":168,"line":978},37,[166,980,981],{"class":190},"            shutil.rmtree(work, ",[166,983,984],{"class":732},"ignore_errors",[166,986,333],{"class":179},[166,988,832],{"class":183},[166,990,408],{"class":190},[166,992,994],{"class":168,"line":993},38,[166,995,198],{"emptyLinePlaceholder":197},[166,997,999],{"class":168,"line":998},39,[166,1000,198],{"emptyLinePlaceholder":197},[166,1002,1004,1007,1010,1013,1016],{"class":168,"line":1003},40,[166,1005,1006],{"class":179},"if",[166,1008,1009],{"class":183}," __name__",[166,1011,1012],{"class":179}," ==",[166,1014,1015],{"class":276}," \"__main__\"",[166,1017,306],{"class":190},[166,1019,1021],{"class":168,"line":1020},41,[166,1022,1023],{"class":190},"    app()\n",[10,1025,1026,1029,1030,1033,1034,1037,1038,1041],{},[131,1027,1028],{},"Loop-shaped commands"," — watchers, workers, pollers — are better served by a stop ",[131,1031,1032],{},"event"," than an exception: the handler sets a flag, and the loop checks it between units of work, so a unit is never torn in half. That pattern, with an interruptible ",[14,1035,1036],{},"event.wait()",", is shown in full on ",[37,1039,1040],{"href":39},"the topic overview",". The exception approach interrupts whatever line is running; the event approach lets the current unit finish. Choose per command.",[1043,1044,1046],"h3",{"id":1045},"what-a-handler-may-and-may-not-do","What a handler may and may not do",[10,1048,1049],{},"Python runs signal handlers in the main thread, between bytecode instructions, at whatever point the main thread happened to be. That makes them precarious places for real work: a handler that takes a lock the interrupted code already holds deadlocks, and one that does network I\u002FO can blow the grace period by itself.",[88,1051],{"name":1052},"lr-handler-rules",[10,1054,1055,1056,1059],{},"Keep handlers to setting an event or raising an exception, and do the cleanup in ordinary code that the exception or flag leads to. Note also that handlers only ever run in the ",[131,1057,1058],{},"main thread",": if the main thread is blocked joining a worker thread with no timeout, the handler waits too. Join with a timeout in a loop, or wait on an event, so signals are noticed.",[43,1061,1063],{"id":1062},"exit-codes","Exit codes",[10,1065,1066,1067,1070,1071,1073],{},"A process killed by a signal has no exit code of its own; shells and supervisors report ",[14,1068,1069],{},"128 + signal number",". When you catch the signal and shut down cleanly, exit with the same value, so everything watching sees \"stopped by ",[14,1072,20],{},"\" rather than \"succeeded\" or \"crashed\".",[88,1075],{"name":1076},"lr-exit-codes-bars",[10,1078,1079,1080,1083],{},"systemd treats 143 after a stop request as a clean exit when the unit sets ",[14,1081,1082],{},"SuccessExitStatus=143","; Kubernetes records it as the container's exit code. Exiting 0 after being told to stop mid-task would falsely report that the work was completed.",[43,1085,1087],{"id":1086},"when-your-cli-is-pid-1","When your CLI is PID 1",[10,1089,1090,1091,1094,1095,1098,1099,1101,1102,1105,1106,1108,1109,1111,1112,1115,1116,1119],{},"In a container started with ",[14,1092,1093],{},"docker run image mytool worker"," (or an ",[14,1096,1097],{},"ENTRYPOINT"," in exec form), your Python process is PID 1. The Linux kernel does not apply default signal actions to PID 1: a ",[14,1100,20],{}," with no handler installed is simply ",[131,1103,1104],{},"ignored",". The container then sits there for the full grace period and is killed with ",[14,1107,85],{}," — every ",[14,1110,16],{}," takes ten seconds and no cleanup ever runs. Installing a handler, as above, fixes it. So does running with ",[14,1113,1114],{},"docker run --init"," or ",[14,1117,1118],{},"tini"," as the entrypoint, which also reaps zombie child processes — worth doing if your CLI starts subprocesses.",[10,1121,1122,1123,1126,1127,1130,1131,1134,1135,1138],{},"Also check the entrypoint uses ",[131,1124,1125],{},"exec form"," (",[14,1128,1129],{},"ENTRYPOINT [\"mytool\", \"worker\"]","). Shell form (",[14,1132,1133],{},"ENTRYPOINT mytool worker",") wraps your process in ",[14,1136,1137],{},"\u002Fbin\u002Fsh -c",", which receives the signal and does not forward it.",[43,1140,1142],{"id":1141},"ux-considerations","UX considerations",[48,1144,1145,1151,1161,1170,1183],{},[51,1146,1147,1150],{},[131,1148,1149],{},"Say why you stopped."," \"stopped by signal 15; nothing written\" in the log tells an operator the process did not crash.",[51,1152,1153,1156,1157,41],{},[131,1154,1155],{},"Keep partial results consistent."," Build into a temporary location and publish at the end, so a stop mid-way leaves the previous output intact rather than half of the new one. The pattern is in ",[37,1158,1160],{"href":1159},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories\u002F","safe temporary files and directories",[51,1162,1163,1166,1167,1169],{},[131,1164,1165],{},"Bound your cleanup."," If cleanup involves the network, put a timeout on it well under the shortest grace period. A courteous \"job aborted\" call to an API is not worth being ",[14,1168,85],{},"ed for.",[51,1171,1172,1175,1176,1178,1179,41],{},[131,1173,1174],{},"Stop child processes too."," A ",[14,1177,20],{}," to your CLI does not reach children in other process groups. Forward it, as described in ",[37,1180,1182],{"href":1181},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes\u002F","handling subprocess timeouts and exit codes",[51,1184,1185,1188,1189,1192],{},[131,1186,1187],{},"Flush logs."," Run with ",[14,1190,1191],{},"PYTHONUNBUFFERED=1"," under supervisors so the last lines before shutdown actually reach the journal.",[43,1194,1196],{"id":1195},"testing-the-behaviour","Testing the behaviour",[10,1198,1199,1200,1202],{},"Signal handling can only be tested convincingly with a real signal to a real process. Start the CLI as a subprocess, wait until it is working, send ",[14,1201,20],{},", and assert on the exit code, the message and the filesystem:",[157,1204,1206],{"className":159,"code":1205,"language":161,"meta":162,"style":162},"# tests\u002Ftest_sigterm.py\nimport signal\nimport subprocess\nimport sys\nimport time\n\nimport pytest\n\npytestmark = pytest.mark.skipif(sys.platform == \"win32\", reason=\"POSIX signals\")\n\n\ndef start_export(tmp_path):\n    out = tmp_path \u002F \"out\"\n    proc = subprocess.Popen(\n        [sys.executable, \"-m\", \"mytool.cli\", \"export\", str(out), \"--items\", \"200\"],\n        stderr=subprocess.PIPE, text=True, env={\"TMPDIR\": str(tmp_path), \"PATH\": \"\"},\n    )\n    time.sleep(1.0)                      # let it get into the work loop\n    return proc, out\n\n\ndef test_sigterm_cleans_up_and_exits_143(tmp_path):\n    proc, out = start_export(tmp_path)\n    proc.send_signal(signal.SIGTERM)\n    _, err = proc.communicate(timeout=5)\n    assert proc.returncode == 143\n    assert \"stopped by signal 15\" in err\n    assert not out.exists()                                     # nothing half-published\n    assert not list(tmp_path.glob(\"mytool-export-*\"))           # temp dir removed\n\n\ndef test_sigint_still_works(tmp_path):\n    proc, out = start_export(tmp_path)\n    proc.send_signal(signal.SIGINT)\n    proc.communicate(timeout=5)\n    assert proc.returncode == 130\n    assert not list(tmp_path.glob(\"mytool-export-*\"))\n",[14,1207,1208,1213,1219,1226,1232,1238,1242,1249,1253,1281,1285,1289,1299,1314,1324,1361,1414,1419,1433,1441,1445,1449,1458,1468,1477,1497,1510,1523,1536,1557,1561,1565,1574,1582,1590,1603,1614],{"__ignoreMap":162},[166,1209,1210],{"class":168,"line":169},[166,1211,1212],{"class":172},"# tests\u002Ftest_sigterm.py\n",[166,1214,1215,1217],{"class":168,"line":176},[166,1216,204],{"class":179},[166,1218,207],{"class":190},[166,1220,1221,1223],{"class":168,"line":194},[166,1222,204],{"class":179},[166,1224,1225],{"class":190}," subprocess\n",[166,1227,1228,1230],{"class":168,"line":201},[166,1229,204],{"class":179},[166,1231,215],{"class":190},[166,1233,1234,1236],{"class":168,"line":210},[166,1235,204],{"class":179},[166,1237,579],{"class":190},[166,1239,1240],{"class":168,"line":218},[166,1241,198],{"emptyLinePlaceholder":197},[166,1243,1244,1246],{"class":168,"line":231},[166,1245,204],{"class":179},[166,1247,1248],{"class":190}," pytest\n",[166,1250,1251],{"class":168,"line":244},[166,1252,198],{"emptyLinePlaceholder":197},[166,1254,1255,1258,1260,1263,1266,1269,1271,1274,1276,1279],{"class":168,"line":249},[166,1256,1257],{"class":190},"pytestmark ",[166,1259,333],{"class":179},[166,1261,1262],{"class":190}," pytest.mark.skipif(sys.platform ",[166,1264,1265],{"class":179},"==",[166,1267,1268],{"class":276}," \"win32\"",[166,1270,867],{"class":190},[166,1272,1273],{"class":732},"reason",[166,1275,333],{"class":179},[166,1277,1278],{"class":276},"\"POSIX signals\"",[166,1280,408],{"class":190},[166,1282,1283],{"class":168,"line":254},[166,1284,198],{"emptyLinePlaceholder":197},[166,1286,1287],{"class":168,"line":273},[166,1288,198],{"emptyLinePlaceholder":197},[166,1290,1291,1293,1296],{"class":168,"line":280},[166,1292,370],{"class":179},[166,1294,1295],{"class":260}," start_export",[166,1297,1298],{"class":190},"(tmp_path):\n",[166,1300,1301,1304,1306,1309,1311],{"class":168,"line":285},[166,1302,1303],{"class":190},"    out ",[166,1305,333],{"class":179},[166,1307,1308],{"class":190}," tmp_path ",[166,1310,138],{"class":179},[166,1312,1313],{"class":276}," \"out\"\n",[166,1315,1316,1319,1321],{"class":168,"line":309},[166,1317,1318],{"class":190},"    proc ",[166,1320,333],{"class":179},[166,1322,1323],{"class":190}," subprocess.Popen(\n",[166,1325,1326,1329,1332,1334,1337,1339,1342,1344,1347,1350,1353,1355,1358],{"class":168,"line":324},[166,1327,1328],{"class":190},"        [sys.executable, ",[166,1330,1331],{"class":276},"\"-m\"",[166,1333,867],{"class":190},[166,1335,1336],{"class":276},"\"mytool.cli\"",[166,1338,867],{"class":190},[166,1340,1341],{"class":276},"\"export\"",[166,1343,867],{"class":190},[166,1345,1346],{"class":183},"str",[166,1348,1349],{"class":190},"(out), ",[166,1351,1352],{"class":276},"\"--items\"",[166,1354,867],{"class":190},[166,1356,1357],{"class":276},"\"200\"",[166,1359,1360],{"class":190},"],\n",[166,1362,1363,1366,1368,1371,1374,1376,1379,1381,1383,1385,1388,1390,1392,1395,1398,1400,1403,1406,1408,1411],{"class":168,"line":339},[166,1364,1365],{"class":732},"        stderr",[166,1367,333],{"class":179},[166,1369,1370],{"class":190},"subprocess.",[166,1372,1373],{"class":183},"PIPE",[166,1375,867],{"class":190},[166,1377,1378],{"class":732},"text",[166,1380,333],{"class":179},[166,1382,832],{"class":183},[166,1384,867],{"class":190},[166,1386,1387],{"class":732},"env",[166,1389,333],{"class":179},[166,1391,781],{"class":190},[166,1393,1394],{"class":276},"\"TMPDIR\"",[166,1396,1397],{"class":190},": ",[166,1399,1346],{"class":183},[166,1401,1402],{"class":190},"(tmp_path), ",[166,1404,1405],{"class":276},"\"PATH\"",[166,1407,1397],{"class":190},[166,1409,1410],{"class":276},"\"\"",[166,1412,1413],{"class":190},"},\n",[166,1415,1416],{"class":168,"line":357},[166,1417,1418],{"class":190},"    )\n",[166,1420,1421,1424,1427,1430],{"class":168,"line":362},[166,1422,1423],{"class":190},"    time.sleep(",[166,1425,1426],{"class":183},"1.0",[166,1428,1429],{"class":190},")                      ",[166,1431,1432],{"class":172},"# let it get into the work loop\n",[166,1434,1435,1438],{"class":168,"line":367},[166,1436,1437],{"class":179},"    return",[166,1439,1440],{"class":190}," proc, out\n",[166,1442,1443],{"class":168,"line":393},[166,1444,198],{"emptyLinePlaceholder":197},[166,1446,1447],{"class":168,"line":399},[166,1448,198],{"emptyLinePlaceholder":197},[166,1450,1451,1453,1456],{"class":168,"line":411},[166,1452,370],{"class":179},[166,1454,1455],{"class":260}," test_sigterm_cleans_up_and_exits_143",[166,1457,1298],{"class":190},[166,1459,1460,1463,1465],{"class":168,"line":420},[166,1461,1462],{"class":190},"    proc, out ",[166,1464,333],{"class":179},[166,1466,1467],{"class":190}," start_export(tmp_path)\n",[166,1469,1470,1473,1475],{"class":168,"line":425},[166,1471,1472],{"class":190},"    proc.send_signal(signal.",[166,1474,20],{"class":183},[166,1476,408],{"class":190},[166,1478,1479,1482,1484,1487,1490,1492,1495],{"class":168,"line":430},[166,1480,1481],{"class":190},"    _, err ",[166,1483,333],{"class":179},[166,1485,1486],{"class":190}," proc.communicate(",[166,1488,1489],{"class":732},"timeout",[166,1491,333],{"class":179},[166,1493,1494],{"class":183},"5",[166,1496,408],{"class":190},[166,1498,1499,1502,1505,1507],{"class":168,"line":436},[166,1500,1501],{"class":179},"    assert",[166,1503,1504],{"class":190}," proc.returncode ",[166,1506,1265],{"class":179},[166,1508,1509],{"class":183}," 143\n",[166,1511,1512,1514,1517,1520],{"class":168,"line":452},[166,1513,1501],{"class":179},[166,1515,1516],{"class":276}," \"stopped by signal 15\"",[166,1518,1519],{"class":179}," in",[166,1521,1522],{"class":190}," err\n",[166,1524,1525,1527,1530,1533],{"class":168,"line":468},[166,1526,1501],{"class":179},[166,1528,1529],{"class":179}," not",[166,1531,1532],{"class":190}," out.exists()                                     ",[166,1534,1535],{"class":172},"# nothing half-published\n",[166,1537,1538,1540,1542,1545,1548,1551,1554],{"class":168,"line":485},[166,1539,1501],{"class":179},[166,1541,1529],{"class":179},[166,1543,1544],{"class":183}," list",[166,1546,1547],{"class":190},"(tmp_path.glob(",[166,1549,1550],{"class":276},"\"mytool-export-*\"",[166,1552,1553],{"class":190},"))           ",[166,1555,1556],{"class":172},"# temp dir removed\n",[166,1558,1559],{"class":168,"line":500},[166,1560,198],{"emptyLinePlaceholder":197},[166,1562,1563],{"class":168,"line":508},[166,1564,198],{"emptyLinePlaceholder":197},[166,1566,1567,1569,1572],{"class":168,"line":514},[166,1568,370],{"class":179},[166,1570,1571],{"class":260}," test_sigint_still_works",[166,1573,1298],{"class":190},[166,1575,1576,1578,1580],{"class":168,"line":522},[166,1577,1462],{"class":190},[166,1579,333],{"class":179},[166,1581,1467],{"class":190},[166,1583,1584,1586,1588],{"class":168,"line":932},[166,1585,1472],{"class":190},[166,1587,34],{"class":183},[166,1589,408],{"class":190},[166,1591,1592,1595,1597,1599,1601],{"class":168,"line":962},[166,1593,1594],{"class":190},"    proc.communicate(",[166,1596,1489],{"class":732},[166,1598,333],{"class":179},[166,1600,1494],{"class":183},[166,1602,408],{"class":190},[166,1604,1605,1607,1609,1611],{"class":168,"line":970},[166,1606,1501],{"class":179},[166,1608,1504],{"class":190},[166,1610,1265],{"class":179},[166,1612,1613],{"class":183}," 130\n",[166,1615,1616,1618,1620,1622,1624,1626],{"class":168,"line":978},[166,1617,1501],{"class":179},[166,1619,1529],{"class":179},[166,1621,1544],{"class":183},[166,1623,1547],{"class":190},[166,1625,1550],{"class":276},[166,1627,741],{"class":190},[10,1629,1630,1631,1634,1635,1638],{},"Pointing ",[14,1632,1633],{},"TMPDIR"," at ",[14,1636,1637],{},"tmp_path"," lets the test see exactly which temporary directories the command created and prove they were removed. The one-second sleep is crude but reliable; for faster tests, have the command print a \"started\" line and wait for it on the pipe.",[43,1640,1642],{"id":1641},"conclusion","Conclusion",[10,1644,1645,1647,1648,1651],{},[14,1646,20],{}," is how the world asks your CLI to stop, and by default Python does not listen. Convert it into an exception for sequential commands or a stop event for loops, keep handlers tiny, fit cleanup inside the shortest grace period your users face, exit with ",[14,1649,1650],{},"128 + signal",", and remember that as PID 1 in a container you get no default handling at all. One subprocess-based test per signal keeps it all honest.",[43,1653,1655],{"id":1654},"frequently-asked-questions","Frequently asked questions",[1043,1657,1659,1660,1663],{"id":1658},"can-i-just-use-atexit-for-cleanup","Can I just use ",[14,1661,1662],{},"atexit"," for cleanup?",[10,1665,1666,1668,1669,1672,1673,1675,1676,1678,1679,1681],{},[14,1667,1662],{}," handlers run on normal interpreter exit, including after ",[14,1670,1671],{},"sys.exit()"," and unhandled exceptions — but not when the process is killed by an unhandled signal. With a ",[14,1674,20],{}," handler that raises, ",[14,1677,1662],{}," handlers do run; without one, they do not. Context managers and ",[14,1680,27],{}," blocks near the work are easier to reason about.",[1043,1683,1685],{"id":1684},"what-about-windows","What about Windows?",[10,1687,1688,1689,1691,1692,1115,1695,1698,1699,141,1701,104,1704,1707,1708,1710],{},"Windows has no real ",[14,1690,20],{}," delivery between processes. Console programs receive ",[14,1693,1694],{},"CTRL_C_EVENT",[14,1696,1697],{},"CTRL_BREAK_EVENT"," (which Python maps to ",[14,1700,154],{},[14,1702,1703],{},"SIGBREAK",[14,1705,1706],{},"TerminateProcess"," — what most tools use to stop a process — cannot be caught. Handle ",[14,1709,1703],{}," where available and rely on the same exception-based cleanup.",[1043,1712,1714],{"id":1713},"does-asyncio-handle-sigterm-for-me","Does asyncio handle SIGTERM for me?",[10,1716,1717,1720,1721,1723,1724,1727,1728,41],{},[14,1718,1719],{},"asyncio.run"," handles ",[14,1722,34],{}," only. Add ",[14,1725,1726],{},"loop.add_signal_handler(signal.SIGTERM, task.cancel)"," for the main task on POSIX to get the same cancellation-based shutdown, as covered in ",[37,1729,1731],{"href":1730},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fcancelling-async-tasks-on-ctrl-c\u002F","cancelling async tasks on Ctrl+C",[1043,1733,1735],{"id":1734},"should-i-ignore-sighup","Should I ignore SIGHUP?",[10,1737,1738,1739,1741,1742,1744,1745,1747],{},"For interactive commands, treating ",[14,1740,491],{}," (terminal closed) like ",[14,1743,20],{}," is sensible — the user has gone. For daemons, ",[14,1746,491],{}," conventionally means \"reload configuration\". Pick one meaning per command and document it.",[43,1749,1751],{"id":1750},"related","Related",[48,1753,1754,1760,1766,1772,1777],{},[51,1755,1756,1757],{},"Up: ",[37,1758,1759],{"href":39},"Long-running and watch-mode CLIs",[51,1761,1762],{},[37,1763,1765],{"href":1764},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Frunning-a-cli-on-a-schedule-with-cron-and-systemd\u002F","Running a CLI on a schedule with cron and systemd",[51,1767,1768],{},[37,1769,1771],{"href":1770},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhealth-checks-and-heartbeats-for-long-running-clis\u002F","Health checks and heartbeats for long-running CLIs",[51,1773,1774],{},[37,1775,1776],{"href":59},"Handling KeyboardInterrupt cleanly",[51,1778,1779],{},[37,1780,1782],{"href":1781},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools\u002F","Choosing exit codes for CLI tools",[1784,1785,1786],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}",{"title":162,"searchDepth":176,"depth":176,"links":1788},[1789,1790,1792,1795,1796,1797,1798,1799,1800,1807],{"id":45,"depth":176,"text":46},{"id":73,"depth":176,"text":1791},"What happens on docker stop",{"id":123,"depth":176,"text":124,"children":1793},[1794],{"id":1045,"depth":194,"text":1046},{"id":1062,"depth":176,"text":1063},{"id":1086,"depth":176,"text":1087},{"id":1141,"depth":176,"text":1142},{"id":1195,"depth":176,"text":1196},{"id":1641,"depth":176,"text":1642},{"id":1654,"depth":176,"text":1655,"children":1801},[1802,1804,1805,1806],{"id":1658,"depth":194,"text":1803},"Can I just use atexit for cleanup?",{"id":1684,"depth":194,"text":1685},{"id":1713,"depth":194,"text":1714},{"id":1734,"depth":194,"text":1735},{"id":1750,"depth":176,"text":1751},"2026-09-18","Make a Python CLI shut down cleanly under systemd, Docker, Kubernetes and timeout: convert SIGTERM into cleanup, respect grace periods, exit 143, and test it.","advanced",false,"md",{},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown",{"title":5,"description":1809},"cli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown\u002Findex",[1818,1819,1820,1821],"signals","sigterm","shutdown","containers","-yvzvmUPHdc1MeU2_CdyxdmjxN3bYNHJHGJQ9kDCnqw",[1824,1827,1830,1833,1836,1839,1842,1845,1848,1851,1854,1857,1860,1863,1866,1869,1872,1875,1878,1881,1884,1887,1890,1893,1896,1899,1902,1905,1908,1911,1914,1917,1920,1923,1926,1929,1932,1935,1938,1941,1944,1947,1950,1953,1956,1959,1962,1965,1968,1971,1974,1977,1980,1983,1986,1989,1992,1995,1998,2001,2004,2007,2010,2013,2016,2019,2022,2025,2028,2031,2034,2037,2040,2043,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,2161,2164,2167,2170,2173,2176,2179,2182,2185,2188,2191,2194,2197,2200,2203,2206,2209,2212,2215,2218,2221,2224,2227,2230,2233,2236,2239,2241,2244,2247,2250,2253,2256,2259,2262,2265,2268,2271,2274,2277,2280,2283,2286,2289,2292,2295,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,2463,2466,2469,2472,2475,2478,2481,2484,2487,2490,2493,2496,2499,2502,2505,2508,2511,2514,2517,2520,2523,2526,2529,2532,2535,2538,2541,2544,2547,2550,2553,2556,2559,2562,2565,2568,2571,2574,2577,2580,2583,2586,2589,2592,2595,2598,2601,2604,2607,2610,2613,2616,2619,2622,2625,2628,2631,2634,2637,2640,2643,2646,2649,2652,2655,2658,2661,2664],{"path":1825,"title":1826},"\u002Fabout","About Python CLI Toolcraft",{"path":1828,"title":1829},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1831,"title":1832},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1834,"title":1835},"\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":1837,"title":1838},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1840,"title":1841},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1843,"title":1844},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":1846,"title":1847},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1849,"title":1850},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":1852,"title":1853},"\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":1855,"title":1856},"\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":1858,"title":1859},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1861,"title":1862},"\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":1864,"title":1865},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":1867,"title":1868},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1870,"title":1871},"\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":1873,"title":1874},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":1876,"title":1877},"\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":1879,"title":1880},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":1882,"title":1883},"\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":1885,"title":1886},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":1888,"title":1889},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":1891,"title":1892},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":1894,"title":1895},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":1897,"title":1898},"\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":1900,"title":1901},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":1903,"title":1904},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":1906,"title":1907},"\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":1909,"title":1910},"\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":1912,"title":1913},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":1915,"title":1916},"\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":1918,"title":1919},"\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":1921,"title":1922},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":1924,"title":1925},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":1927,"title":1928},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":1930,"title":1931},"\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":1933,"title":1934},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":1936,"title":1937},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":1939,"title":1940},"\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":1942,"title":1943},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":1945,"title":1946},"\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":1948,"title":1949},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":1951,"title":1952},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":1954,"title":1955},"\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":1957,"title":1958},"\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":1960,"title":1961},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":1963,"title":1964},"\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":1966,"title":1967},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":1969,"title":1970},"\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":1972,"title":1973},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":1975,"title":1976},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":1978,"title":1979},"\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":1981,"title":1982},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":1984,"title":1985},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":1987,"title":1988},"\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":1990,"title":1991},"\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":1993,"title":1994},"\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":1996,"title":1997},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":1999,"title":2000},"\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":2002,"title":2003},"\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":2005,"title":2006},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2008,"title":2009},"\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":2011,"title":2012},"\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":2014,"title":2015},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2017,"title":2018},"\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":2020,"title":2021},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2023,"title":2024},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2026,"title":2027},"\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":2029,"title":2030},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2032,"title":2033},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2035,"title":2036},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2038,"title":2039},"\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":2041,"title":2042},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2044,"title":2045},"\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":2047,"title":2048},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2050,"title":2051},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2053,"title":2054},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2056,"title":2057},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2059,"title":2060},"\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":2062,"title":2063},"\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":2065,"title":2066},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2068,"title":2069},"\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":2071,"title":2072},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2074,"title":2075},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2077,"title":2078},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fmocking-http-in-cli-tests-with-respx","Mocking HTTP in Python CLI Tests with respx",{"path":2080,"title":2081},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2083,"title":2084},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2086,"title":2087},"\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":2089,"title":2090},"\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":2092,"title":2093},"\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":2095,"title":2096},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2098,"title":2099},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2101,"title":2102},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2104,"title":2105},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2107,"title":2108},"\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":2110,"title":2111},"\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":2113,"title":2114},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2116,"title":2117},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2119,"title":2120},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2122,"title":2123},"\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":2125,"title":2126},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2128,"title":2129},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2131,"title":2132},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2134,"title":2135},"\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":2137,"title":2138},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2140,"title":2141},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2143,"title":2144},"\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":2146,"title":2147},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2149,"title":2150},"\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":2152,"title":2153},"\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":2155,"title":2156},"\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":2158,"title":2159},"\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":1814,"title":5},{"path":2162,"title":2163},"\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":2165,"title":2166},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2168,"title":2169},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2171,"title":2172},"\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":2174,"title":2175},"\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":2177,"title":2178},"\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":2180,"title":2181},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2183,"title":2184},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2186,"title":2187},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2189,"title":2190},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2192,"title":2193},"\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":2195,"title":2196},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2198,"title":2199},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2201,"title":2202},"\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":2204,"title":2205},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2207,"title":2208},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2210,"title":2211},"\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":2213,"title":2214},"\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":2216,"title":2217},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2219,"title":2220},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2222,"title":2223},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2225,"title":2226},"\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":2228,"title":2229},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2231,"title":2232},"\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":2234,"title":2235},"\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":2237,"title":2238},"\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":138,"title":2240},"Python CLI Toolcraft",{"path":2242,"title":2243},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2245,"title":2246},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2248,"title":2249},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2251,"title":2252},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2254,"title":2255},"\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":2257,"title":2258},"\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":2260,"title":2261},"\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":2263,"title":2264},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2266,"title":2267},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2269,"title":2270},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2272,"title":2273},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2275,"title":2276},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2278,"title":2279},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2281,"title":2282},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2284,"title":2285},"\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":2287,"title":2288},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2290,"title":2291},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2293,"title":2294},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2296,"title":2297},"\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":2299,"title":2300},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2302,"title":2303},"\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":2305,"title":2306},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2308,"title":2309},"\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":2311,"title":2312},"\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":2314,"title":2315},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2317,"title":2318},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2320,"title":2321},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2323,"title":2324},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2326,"title":2327},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2329,"title":2330},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2332,"title":2333},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2335,"title":2336},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2338,"title":2339},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2341,"title":2342},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2344,"title":2345},"\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":2347,"title":2348},"\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":2350,"title":2351},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2353,"title":2354},"\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":2356,"title":2357},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2359,"title":2360},"\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":2362,"title":2363},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2365,"title":2366},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2368,"title":2369},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2371,"title":2372},"\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":2374,"title":2375},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2377,"title":2378},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2380,"title":2381},"\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":2383,"title":2384},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2386,"title":2387},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2389,"title":2390},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2392,"title":2393},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2395,"title":2396},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2398,"title":2399},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2401,"title":2402},"\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":2404,"title":2405},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2407,"title":2408},"\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":2410,"title":2411},"\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":2413,"title":2414},"\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":2416,"title":2417},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2419,"title":2420},"\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":2422,"title":2423},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2425,"title":2426},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2428,"title":2429},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2431,"title":2432},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2434,"title":2435},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2437,"title":2438},"\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":2440,"title":2441},"\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":2443,"title":2444},"\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":2446,"title":2447},"\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":2449,"title":2450},"\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":2452,"title":2453},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2455,"title":2456},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2458,"title":2459},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2461,"title":2462},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2464,"title":2465},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2467,"title":2468},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2470,"title":2471},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2473,"title":2474},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2476,"title":2477},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2479,"title":2480},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2482,"title":2483},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2485,"title":2486},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2488,"title":2489},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2491,"title":2492},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2494,"title":2495},"\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":2497,"title":2498},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2500,"title":2501},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2503,"title":2504},"\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":2506,"title":2507},"\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":2509,"title":2510},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2512,"title":2513},"\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":2515,"title":2516},"\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":2518,"title":2519},"\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":2521,"title":2522},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2524,"title":2525},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2527,"title":2528},"\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":2530,"title":2531},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2533,"title":2534},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2536,"title":2537},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2539,"title":2540},"\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":2542,"title":2543},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2545,"title":2546},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2548,"title":2549},"\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":2551,"title":2552},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2554,"title":2555},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2557,"title":2558},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2560,"title":2561},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2563,"title":2564},"\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":2566,"title":2567},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2569,"title":2570},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2572,"title":2573},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2575,"title":2576},"\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":2578,"title":2579},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2581,"title":2582},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2584,"title":2585},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2587,"title":2588},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2590,"title":2591},"\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":2593,"title":2594},"\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":2596,"title":2597},"\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":2599,"title":2600},"\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":2602,"title":2603},"\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":2605,"title":2606},"\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":2608,"title":2609},"\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":2611,"title":2612},"\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":2614,"title":2615},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2617,"title":2618},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2620,"title":2621},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2623,"title":2624},"\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":2626,"title":2627},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2629,"title":2630},"\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":2632,"title":2633},"\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":2635,"title":2636},"\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":2638,"title":2639},"\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":2641,"title":2642},"\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":2644,"title":2645},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2647,"title":2648},"\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":2650,"title":2651},"\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":2653,"title":2654},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2656,"title":2657},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2659,"title":2660},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2662,"title":2663},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2665,"title":2666},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967539860]