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