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