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