[{"data":1,"prerenderedAt":2240},["ShallowReactive",2],{"page-\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Ffixing-unicode-and-encoding-errors-on-windows\u002F":3,"content-directory":1692},{"id":4,"title":5,"body":6,"date":1678,"description":1679,"difficulty":1680,"draft":1681,"extension":1682,"meta":1683,"navigation":182,"path":1684,"seo":1685,"stem":1686,"tags":1687,"updated":1678,"__hash__":1691},"content\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Ffixing-unicode-and-encoding-errors-on-windows\u002Findex.md","Fixing Unicode and Encoding Errors on Windows in Python CLIs",{"type":7,"value":8,"toc":1657},"minimark",[9,36,41,51,55,67,71,131,134,138,141,651,720,723,759,762,767,784,857,888,892,895,990,1000,1004,1015,1019,1022,1065,1069,1075,1525,1544,1548,1560,1564,1571,1574,1578,1581,1585,1604,1611,1617,1621,1653],[10,11,12,13,17,18,21,22,25,26,29,30,35],"p",{},"A Windows user reports that ",[14,15,16],"code",{},"mytool status > status.txt"," crashes with ",[14,19,20],{},"UnicodeEncodeError: 'charmap' codec can't encode character '\\u2713'",". You cannot reproduce it: on your Mac the command works, and on the user's machine it works too — until they redirect the output. Another user's config file with a German comment is read as ",[14,23,24],{},"Größe",". A third sees ",[14,27,28],{},"?"," in place of every accented letter in the output of a program your tool runs. These are the three faces of the same problem: text crossing a boundary where Python has to choose an encoding, and choosing one — on Windows — that cannot represent the text. This guide explains exactly when Windows Python uses a legacy code page, and fixes each boundary: standard streams, files, subprocess output and symbols the user's console cannot display. It belongs to the ",[31,32,34],"a",{"href":33},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002F","cross-platform terminal compatibility topic",".",[37,38,40],"h2",{"id":39},"prerequisites","Prerequisites",[42,43,44,48],"ul",{},[45,46,47],"li",{},"A Python CLI that runs on Windows, or that you want to run there.",[45,49,50],{},"A Windows machine or a Windows CI runner for final verification — the behaviour cannot be reproduced exactly elsewhere, although the tests below simulate it faithfully.",[37,52,54],{"id":53},"where-the-errors-come-from","Where the errors come from",[10,56,57,58,62,63,66],{},"Python strings are Unicode. Whenever text leaves the process — to a console, a file, a pipe — it must be ",[59,60,61],"strong",{},"encoded"," into bytes, and whenever it enters — from a file, a pipe, another program — it must be ",[59,64,65],{},"decoded",". Each boundary has its own encoding:",[68,69],"inline-diagram",{"name":70},"enc-where",[42,72,73,87,101,113],{},[45,74,75,78,79,82,83,86],{},[59,76,77],{},"The interactive Windows console"," is not the problem. Since Python 3.6, writing to a real console uses the Unicode console API, so ",[14,80,81],{},"print(\"✓\")"," in Windows Terminal or ",[14,84,85],{},"cmd.exe"," works.",[45,88,89,92,93,96,97,100],{},[59,90,91],{},"Redirected standard streams"," are the problem. When stdout is a file or pipe, Python encodes with the locale's ANSI code page — ",[14,94,95],{},"cp1252"," in Western Europe and the Americas, others elsewhere — which covers a couple of hundred characters. Anything outside it raises ",[14,98,99],{},"UnicodeEncodeError"," by default.",[45,102,103,112],{},[59,104,105,108,109],{},[14,106,107],{},"open()"," without ",[14,110,111],{},"encoding="," uses the same locale encoding on Windows, so files written on one machine are misread on another, and files with characters outside the code page cannot be written at all.",[45,114,115,118,119,122,123,126,127,130],{},[59,116,117],{},"Subprocess output"," arrives as bytes in whatever encoding the other program chose — often the OEM code page (",[14,120,121],{},"cp437",", ",[14,124,125],{},"cp850",") for older console tools — and ",[14,128,129],{},"text=True"," decodes it with the locale encoding, which may differ again.",[10,132,133],{},"The redirect case is why these bugs escape testing: the author tries the command interactively, it works, and only scripts and CI — which always redirect — hit the crash.",[37,135,137],{"id":136},"the-recipe","The recipe",[10,139,140],{},"Put the encoding decisions in one small module and call it at the very start of the entry point:",[142,143,148],"pre",{"className":144,"code":145,"language":146,"meta":147,"style":147},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fencoding.py\nfrom __future__ import annotations\n\nimport sys\nfrom typing import TextIO\n\nSYMBOLS = {\"✓\": \"[ok]\", \"✗\": \"[x]\", \"→\": \"->\", \"…\": \"...\", \"•\": \"*\"}\n\n\ndef ensure_utf8_streams() -> None:\n    \"\"\"Make stdout\u002Fstderr UTF-8 with replacement, whatever the platform decided.\"\"\"\n    for name in (\"stdout\", \"stderr\"):\n        stream = getattr(sys, name)\n        encoding = (getattr(stream, \"encoding\", None) or \"\").lower().replace(\"-\", \"\")\n        if encoding != \"utf8\" and hasattr(stream, \"reconfigure\"):\n            stream.reconfigure(encoding=\"utf-8\", errors=\"replace\")\n\n\ndef can_encode(text: str, stream: TextIO | None = None) -> bool:\n    encoding = getattr(stream or sys.stdout, \"encoding\", None) or \"ascii\"\n    try:\n        text.encode(encoding)\n    except (UnicodeEncodeError, LookupError):\n        return False\n    return True\n\n\ndef symbol(char: str, stream: TextIO | None = None) -> str:\n    \"\"\"Return char if the stream can show it, else an ASCII stand-in.\"\"\"\n    return char if can_encode(char, stream) else SYMBOLS.get(char, \"?\")\n","python","",[14,149,150,159,177,184,193,206,211,276,281,286,305,311,337,352,398,426,453,458,463,498,529,537,543,560,569,578,583,588,617,623],{"__ignoreMap":147},[151,152,155],"span",{"class":153,"line":154},"line",1,[151,156,158],{"class":157},"sJ8bj","# src\u002Fmytool\u002Fencoding.py\n",[151,160,162,166,170,173],{"class":153,"line":161},2,[151,163,165],{"class":164},"szBVR","from",[151,167,169],{"class":168},"sj4cs"," __future__",[151,171,172],{"class":164}," import",[151,174,176],{"class":175},"sVt8B"," annotations\n",[151,178,180],{"class":153,"line":179},3,[151,181,183],{"emptyLinePlaceholder":182},true,"\n",[151,185,187,190],{"class":153,"line":186},4,[151,188,189],{"class":164},"import",[151,191,192],{"class":175}," sys\n",[151,194,196,198,201,203],{"class":153,"line":195},5,[151,197,165],{"class":164},[151,199,200],{"class":175}," typing ",[151,202,189],{"class":164},[151,204,205],{"class":175}," TextIO\n",[151,207,209],{"class":153,"line":208},6,[151,210,183],{"emptyLinePlaceholder":182},[151,212,214,217,220,223,227,230,233,235,238,240,243,245,248,250,253,255,258,260,263,265,268,270,273],{"class":153,"line":213},7,[151,215,216],{"class":168},"SYMBOLS",[151,218,219],{"class":164}," =",[151,221,222],{"class":175}," {",[151,224,226],{"class":225},"sZZnC","\"✓\"",[151,228,229],{"class":175},": ",[151,231,232],{"class":225},"\"[ok]\"",[151,234,122],{"class":175},[151,236,237],{"class":225},"\"✗\"",[151,239,229],{"class":175},[151,241,242],{"class":225},"\"[x]\"",[151,244,122],{"class":175},[151,246,247],{"class":225},"\"→\"",[151,249,229],{"class":175},[151,251,252],{"class":225},"\"->\"",[151,254,122],{"class":175},[151,256,257],{"class":225},"\"…\"",[151,259,229],{"class":175},[151,261,262],{"class":225},"\"...\"",[151,264,122],{"class":175},[151,266,267],{"class":225},"\"•\"",[151,269,229],{"class":175},[151,271,272],{"class":225},"\"*\"",[151,274,275],{"class":175},"}\n",[151,277,279],{"class":153,"line":278},8,[151,280,183],{"emptyLinePlaceholder":182},[151,282,284],{"class":153,"line":283},9,[151,285,183],{"emptyLinePlaceholder":182},[151,287,289,292,296,299,302],{"class":153,"line":288},10,[151,290,291],{"class":164},"def",[151,293,295],{"class":294},"sScJk"," ensure_utf8_streams",[151,297,298],{"class":175},"() -> ",[151,300,301],{"class":168},"None",[151,303,304],{"class":175},":\n",[151,306,308],{"class":153,"line":307},11,[151,309,310],{"class":225},"    \"\"\"Make stdout\u002Fstderr UTF-8 with replacement, whatever the platform decided.\"\"\"\n",[151,312,314,317,320,323,326,329,331,334],{"class":153,"line":313},12,[151,315,316],{"class":164},"    for",[151,318,319],{"class":175}," name ",[151,321,322],{"class":164},"in",[151,324,325],{"class":175}," (",[151,327,328],{"class":225},"\"stdout\"",[151,330,122],{"class":175},[151,332,333],{"class":225},"\"stderr\"",[151,335,336],{"class":175},"):\n",[151,338,340,343,346,349],{"class":153,"line":339},13,[151,341,342],{"class":175},"        stream ",[151,344,345],{"class":164},"=",[151,347,348],{"class":168}," getattr",[151,350,351],{"class":175},"(sys, name)\n",[151,353,355,358,360,362,365,368,371,373,375,378,381,384,387,390,392,395],{"class":153,"line":354},14,[151,356,357],{"class":175},"        encoding ",[151,359,345],{"class":164},[151,361,325],{"class":175},[151,363,364],{"class":168},"getattr",[151,366,367],{"class":175},"(stream, ",[151,369,370],{"class":225},"\"encoding\"",[151,372,122],{"class":175},[151,374,301],{"class":168},[151,376,377],{"class":175},") ",[151,379,380],{"class":164},"or",[151,382,383],{"class":225}," \"\"",[151,385,386],{"class":175},").lower().replace(",[151,388,389],{"class":225},"\"-\"",[151,391,122],{"class":175},[151,393,394],{"class":225},"\"\"",[151,396,397],{"class":175},")\n",[151,399,401,404,407,410,413,416,419,421,424],{"class":153,"line":400},15,[151,402,403],{"class":164},"        if",[151,405,406],{"class":175}," encoding ",[151,408,409],{"class":164},"!=",[151,411,412],{"class":225}," \"utf8\"",[151,414,415],{"class":164}," and",[151,417,418],{"class":168}," hasattr",[151,420,367],{"class":175},[151,422,423],{"class":225},"\"reconfigure\"",[151,425,336],{"class":175},[151,427,429,432,436,438,441,443,446,448,451],{"class":153,"line":428},16,[151,430,431],{"class":175},"            stream.reconfigure(",[151,433,435],{"class":434},"s4XuR","encoding",[151,437,345],{"class":164},[151,439,440],{"class":225},"\"utf-8\"",[151,442,122],{"class":175},[151,444,445],{"class":434},"errors",[151,447,345],{"class":164},[151,449,450],{"class":225},"\"replace\"",[151,452,397],{"class":175},[151,454,456],{"class":153,"line":455},17,[151,457,183],{"emptyLinePlaceholder":182},[151,459,461],{"class":153,"line":460},18,[151,462,183],{"emptyLinePlaceholder":182},[151,464,466,468,471,474,477,480,483,486,488,490,493,496],{"class":153,"line":465},19,[151,467,291],{"class":164},[151,469,470],{"class":294}," can_encode",[151,472,473],{"class":175},"(text: ",[151,475,476],{"class":168},"str",[151,478,479],{"class":175},", stream: TextIO ",[151,481,482],{"class":164},"|",[151,484,485],{"class":168}," None",[151,487,219],{"class":164},[151,489,485],{"class":168},[151,491,492],{"class":175},") -> ",[151,494,495],{"class":168},"bool",[151,497,304],{"class":175},[151,499,501,504,506,508,511,513,516,518,520,522,524,526],{"class":153,"line":500},20,[151,502,503],{"class":175},"    encoding ",[151,505,345],{"class":164},[151,507,348],{"class":168},[151,509,510],{"class":175},"(stream ",[151,512,380],{"class":164},[151,514,515],{"class":175}," sys.stdout, ",[151,517,370],{"class":225},[151,519,122],{"class":175},[151,521,301],{"class":168},[151,523,377],{"class":175},[151,525,380],{"class":164},[151,527,528],{"class":225}," \"ascii\"\n",[151,530,532,535],{"class":153,"line":531},21,[151,533,534],{"class":164},"    try",[151,536,304],{"class":175},[151,538,540],{"class":153,"line":539},22,[151,541,542],{"class":175},"        text.encode(encoding)\n",[151,544,546,549,551,553,555,558],{"class":153,"line":545},23,[151,547,548],{"class":164},"    except",[151,550,325],{"class":175},[151,552,99],{"class":168},[151,554,122],{"class":175},[151,556,557],{"class":168},"LookupError",[151,559,336],{"class":175},[151,561,563,566],{"class":153,"line":562},24,[151,564,565],{"class":164},"        return",[151,567,568],{"class":168}," False\n",[151,570,572,575],{"class":153,"line":571},25,[151,573,574],{"class":164},"    return",[151,576,577],{"class":168}," True\n",[151,579,581],{"class":153,"line":580},26,[151,582,183],{"emptyLinePlaceholder":182},[151,584,586],{"class":153,"line":585},27,[151,587,183],{"emptyLinePlaceholder":182},[151,589,591,593,596,599,601,603,605,607,609,611,613,615],{"class":153,"line":590},28,[151,592,291],{"class":164},[151,594,595],{"class":294}," symbol",[151,597,598],{"class":175},"(char: ",[151,600,476],{"class":168},[151,602,479],{"class":175},[151,604,482],{"class":164},[151,606,485],{"class":168},[151,608,219],{"class":164},[151,610,485],{"class":168},[151,612,492],{"class":175},[151,614,476],{"class":168},[151,616,304],{"class":175},[151,618,620],{"class":153,"line":619},29,[151,621,622],{"class":225},"    \"\"\"Return char if the stream can show it, else an ASCII stand-in.\"\"\"\n",[151,624,626,628,631,634,637,640,643,646,649],{"class":153,"line":625},30,[151,627,574],{"class":164},[151,629,630],{"class":175}," char ",[151,632,633],{"class":164},"if",[151,635,636],{"class":175}," can_encode(char, stream) ",[151,638,639],{"class":164},"else",[151,641,642],{"class":168}," SYMBOLS",[151,644,645],{"class":175},".get(char, ",[151,647,648],{"class":225},"\"?\"",[151,650,397],{"class":175},[142,652,654],{"className":144,"code":653,"language":146,"meta":147,"style":147},"# src\u002Fmytool\u002F__main__.py (and the console-script entry function)\nfrom mytool.encoding import ensure_utf8_streams\n\n\ndef main() -> None:\n    ensure_utf8_streams()          # before anything is printed\n    from mytool.cli import app\n    app()\n",[14,655,656,661,673,677,681,694,702,715],{"__ignoreMap":147},[151,657,658],{"class":153,"line":154},[151,659,660],{"class":157},"# src\u002Fmytool\u002F__main__.py (and the console-script entry function)\n",[151,662,663,665,668,670],{"class":153,"line":161},[151,664,165],{"class":164},[151,666,667],{"class":175}," mytool.encoding ",[151,669,189],{"class":164},[151,671,672],{"class":175}," ensure_utf8_streams\n",[151,674,675],{"class":153,"line":179},[151,676,183],{"emptyLinePlaceholder":182},[151,678,679],{"class":153,"line":186},[151,680,183],{"emptyLinePlaceholder":182},[151,682,683,685,688,690,692],{"class":153,"line":195},[151,684,291],{"class":164},[151,686,687],{"class":294}," main",[151,689,298],{"class":175},[151,691,301],{"class":168},[151,693,304],{"class":175},[151,695,696,699],{"class":153,"line":208},[151,697,698],{"class":175},"    ensure_utf8_streams()          ",[151,700,701],{"class":157},"# before anything is printed\n",[151,703,704,707,710,712],{"class":153,"line":213},[151,705,706],{"class":164},"    from",[151,708,709],{"class":175}," mytool.cli ",[151,711,189],{"class":164},[151,713,714],{"class":175}," app\n",[151,716,717],{"class":153,"line":278},[151,718,719],{"class":175},"    app()\n",[10,721,722],{},"What each piece does:",[42,724,725,747],{},[45,726,727,732,733,736,737,740,741,743,744,746],{},[59,728,729],{},[14,730,731],{},"ensure_utf8_streams()"," reconfigures stdout and stderr to UTF-8 with ",[14,734,735],{},"errors=\"replace\"",". ",[14,738,739],{},"reconfigure"," (Python 3.7+) changes the encoding of an existing text stream in place, before anything has been written. UTF-8 can represent every character, so encoding never fails; ",[14,742,735],{}," guarantees that even a lone surrogate or other malformed string becomes ",[14,745,28],{}," rather than a traceback. Consumers reading redirected output — other programs, editors — overwhelmingly expect UTF-8 today.",[45,748,749,754,755,758],{},[59,750,751],{},[14,752,753],{},"symbol()"," is for decorative characters. When output goes somewhere that genuinely cannot display ",[14,756,757],{},"✓"," — a legacy console font, a stream you chose not to reconfigure — the ASCII stand-in keeps the meaning. Use it for status marks, arrows and bullets, never for user data, which must be passed through faithfully.",[68,760],{"name":761},"enc-fixes",[763,764,766],"h3",{"id":765},"files-always-say-which-encoding","Files: always say which encoding",[10,768,769,770,122,772,775,776,779,780,783],{},"Every ",[14,771,107],{},[14,773,774],{},"Path.read_text()"," and ",[14,777,778],{},"Path.write_text()"," in your tool should pass ",[14,781,782],{},"encoding=\"utf-8\"",":",[142,785,787],{"className":144,"code":786,"language":146,"meta":147,"style":147},"from pathlib import Path\n\nconfig = Path(\"mytool.toml\").read_text(encoding=\"utf-8\")\nPath(\"report.csv\").write_text(csv_text, encoding=\"utf-8\", newline=\"\")\n",[14,788,789,801,805,829],{"__ignoreMap":147},[151,790,791,793,796,798],{"class":153,"line":154},[151,792,165],{"class":164},[151,794,795],{"class":175}," pathlib ",[151,797,189],{"class":164},[151,799,800],{"class":175}," Path\n",[151,802,803],{"class":153,"line":161},[151,804,183],{"emptyLinePlaceholder":182},[151,806,807,810,812,815,818,821,823,825,827],{"class":153,"line":179},[151,808,809],{"class":175},"config ",[151,811,345],{"class":164},[151,813,814],{"class":175}," Path(",[151,816,817],{"class":225},"\"mytool.toml\"",[151,819,820],{"class":175},").read_text(",[151,822,435],{"class":434},[151,824,345],{"class":164},[151,826,440],{"class":225},[151,828,397],{"class":175},[151,830,831,834,837,840,842,844,846,848,851,853,855],{"class":153,"line":186},[151,832,833],{"class":175},"Path(",[151,835,836],{"class":225},"\"report.csv\"",[151,838,839],{"class":175},").write_text(csv_text, ",[151,841,435],{"class":434},[151,843,345],{"class":164},[151,845,440],{"class":225},[151,847,122],{"class":175},[151,849,850],{"class":434},"newline",[151,852,345],{"class":164},[151,854,394],{"class":225},[151,856,397],{"class":175},[10,858,859,860,863,864,867,868,871,872,876,877,880,881,883,884,35],{},"For files users edit in Windows tools, accept a byte-order mark by reading with ",[14,861,862],{},"encoding=\"utf-8-sig\"",", which handles files with or without one. For TOML specifically, ",[14,865,866],{},"tomllib"," requires binary mode (",[14,869,870],{},"open(path, \"rb\")",") and handles UTF-8 itself, which removes the question entirely — see ",[31,873,875],{"href":874},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib\u002F","reading TOML config with tomllib",". Ruff's ",[14,878,879],{},"PLW1514"," rule flags any text-mode ",[14,882,107],{}," without an encoding, which is the easiest way to find them all; see ",[31,885,887],{"href":886},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project\u002F","configuring Ruff for a CLI project",[763,889,891],{"id":890},"output-from-other-programs","Output from other programs",[10,893,894],{},"When your CLI runs other tools, decode their output deliberately:",[142,896,898],{"className":144,"code":897,"language":146,"meta":147,"style":147},"import subprocess\n\nproc = subprocess.run([\"git\", \"log\", \"-1\", \"--format=%an\"], capture_output=True, check=True)\nauthor = proc.stdout.decode(\"utf-8\", errors=\"replace\").strip()\n",[14,899,900,907,911,967],{"__ignoreMap":147},[151,901,902,904],{"class":153,"line":154},[151,903,189],{"class":164},[151,905,906],{"class":175}," subprocess\n",[151,908,909],{"class":153,"line":161},[151,910,183],{"emptyLinePlaceholder":182},[151,912,913,916,918,921,924,926,929,931,934,936,939,942,945,948,951,953,956,958,961,963,965],{"class":153,"line":179},[151,914,915],{"class":175},"proc ",[151,917,345],{"class":164},[151,919,920],{"class":175}," subprocess.run([",[151,922,923],{"class":225},"\"git\"",[151,925,122],{"class":175},[151,927,928],{"class":225},"\"log\"",[151,930,122],{"class":175},[151,932,933],{"class":225},"\"-1\"",[151,935,122],{"class":175},[151,937,938],{"class":225},"\"--format=",[151,940,941],{"class":168},"%a",[151,943,944],{"class":225},"n\"",[151,946,947],{"class":175},"], ",[151,949,950],{"class":434},"capture_output",[151,952,345],{"class":164},[151,954,955],{"class":168},"True",[151,957,122],{"class":175},[151,959,960],{"class":434},"check",[151,962,345],{"class":164},[151,964,955],{"class":168},[151,966,397],{"class":175},[151,968,969,972,974,977,979,981,983,985,987],{"class":153,"line":186},[151,970,971],{"class":175},"author ",[151,973,345],{"class":164},[151,975,976],{"class":175}," proc.stdout.decode(",[151,978,440],{"class":225},[151,980,122],{"class":175},[151,982,445],{"class":434},[151,984,345],{"class":164},[151,986,450],{"class":225},[151,988,989],{"class":175},").strip()\n",[10,991,992,993,995,996,35],{},"Modern tools (git, Go and Rust programs, Python with UTF-8 mode) usually emit UTF-8; older Windows console programs may emit the OEM code page. Decoding as UTF-8 with ",[14,994,735],{}," never crashes and is right for the modern majority; if you wrap a specific legacy tool, decode with its known encoding instead. The subprocess side of this is covered in ",[31,997,999],{"href":998},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess\u002F","calling external commands safely with subprocess",[763,1001,1003],{"id":1002},"pythons-utf-8-mode","Python's UTF-8 mode",[10,1005,1006,1007,1010,1011,1014],{},"Setting ",[14,1008,1009],{},"PYTHONUTF8=1"," (or running ",[14,1012,1013],{},"python -X utf8",") makes the whole interpreter default to UTF-8 for files and streams on every platform. It is an excellent setting for users and CI, and Python 3.15 is planned to make it the default. But a CLI cannot rely on it: users run whatever Python they have, and launchers generated by pip, pipx and uv do not set it. Explicit encodings in your own code work regardless.",[37,1016,1018],{"id":1017},"ux-considerations","UX considerations",[68,1020],{"name":1021},"enc-terminal",[42,1023,1024,1030,1036,1051],{},[45,1025,1026,1029],{},[59,1027,1028],{},"Never crash on output."," A tool that fails because it could not print a check mark has its priorities backwards. Replacement characters are an acceptable worst case; tracebacks are not.",[45,1031,1032,1035],{},[59,1033,1034],{},"Keep user data intact."," Symbols may fall back to ASCII; names, paths and messages from users must round-trip exactly, which UTF-8 guarantees.",[45,1037,1038,1041,1042,122,1044,122,1047,1050],{},[59,1039,1040],{},"Do not depend on emoji."," Even in UTF-8, older console fonts render many emoji as boxes. Plain symbols (",[14,1043,757],{},[14,1045,1046],{},"✗",[14,1048,1049],{},"→",") have much better font coverage, and a word next to each keeps meaning clear.",[45,1052,1053,1056,1057,1059,1060,1064],{},[59,1054,1055],{},"Document the escape hatch."," Mention ",[14,1058,1009],{}," in troubleshooting docs for users hitting encoding issues in ",[1061,1062,1063],"em",{},"other"," Python tools too.",[37,1066,1068],{"id":1067},"testing-the-behaviour","Testing the behaviour",[10,1070,1071,1072,1074],{},"You can reproduce the Windows redirect behaviour on any platform by wrapping a bytes buffer in a ",[14,1073,95],{}," text stream — exactly what Windows Python does for a redirected stdout:",[142,1076,1078],{"className":144,"code":1077,"language":146,"meta":147,"style":147},"# tests\u002Ftest_encoding.py\nimport io\nimport sys\n\nimport pytest\n\nfrom mytool import encoding\n\n\ndef cp1252_stream() -> io.TextIOWrapper:\n    \"\"\"What Windows gives a redirected stdout on a Western-European locale.\"\"\"\n    return io.TextIOWrapper(io.BytesIO(), encoding=\"cp1252\", errors=\"strict\")\n\n\ndef test_the_original_failure_is_real():\n    stream = cp1252_stream()\n    with pytest.raises(UnicodeEncodeError):\n        print(\"✓ deployed\", file=stream, flush=True)\n\n\ndef test_reconfigure_fixes_it(monkeypatch):\n    stream = cp1252_stream()\n    monkeypatch.setattr(sys, \"stdout\", stream)\n    encoding.ensure_utf8_streams()\n    print(\"✓ déployé → prod\", flush=True)\n    assert stream.buffer.getvalue().decode(\"utf-8\") == \"✓ déployé → prod\\n\"\n\n\ndef test_symbol_falls_back_on_narrow_streams():\n    assert encoding.symbol(\"✓\", cp1252_stream()) == \"[ok]\"\n    assert encoding.symbol(\"é\", cp1252_stream()) == \"é\"            # cp1252 has é\n    utf8 = io.TextIOWrapper(io.BytesIO(), encoding=\"utf-8\")\n    assert encoding.symbol(\"✓\", utf8) == \"✓\"\n\n\ndef test_reading_bytes_from_another_program():\n    raw = \"Größe: 5 MB\\n\".encode(\"utf-8\")\n    assert raw.decode(\"utf-8\", errors=\"replace\") == \"Größe: 5 MB\\n\"\n    assert \"�\" in b\"\\xff broken\".decode(\"utf-8\", errors=\"replace\")\n",[14,1079,1080,1085,1092,1098,1102,1109,1113,1125,1129,1133,1143,1148,1173,1177,1181,1191,1201,1213,1243,1247,1251,1261,1269,1279,1284,1304,1328,1332,1336,1345,1362,1382,1400,1417,1422,1427,1437,1460,1488],{"__ignoreMap":147},[151,1081,1082],{"class":153,"line":154},[151,1083,1084],{"class":157},"# tests\u002Ftest_encoding.py\n",[151,1086,1087,1089],{"class":153,"line":161},[151,1088,189],{"class":164},[151,1090,1091],{"class":175}," io\n",[151,1093,1094,1096],{"class":153,"line":179},[151,1095,189],{"class":164},[151,1097,192],{"class":175},[151,1099,1100],{"class":153,"line":186},[151,1101,183],{"emptyLinePlaceholder":182},[151,1103,1104,1106],{"class":153,"line":195},[151,1105,189],{"class":164},[151,1107,1108],{"class":175}," pytest\n",[151,1110,1111],{"class":153,"line":208},[151,1112,183],{"emptyLinePlaceholder":182},[151,1114,1115,1117,1120,1122],{"class":153,"line":213},[151,1116,165],{"class":164},[151,1118,1119],{"class":175}," mytool ",[151,1121,189],{"class":164},[151,1123,1124],{"class":175}," encoding\n",[151,1126,1127],{"class":153,"line":278},[151,1128,183],{"emptyLinePlaceholder":182},[151,1130,1131],{"class":153,"line":283},[151,1132,183],{"emptyLinePlaceholder":182},[151,1134,1135,1137,1140],{"class":153,"line":288},[151,1136,291],{"class":164},[151,1138,1139],{"class":294}," cp1252_stream",[151,1141,1142],{"class":175},"() -> io.TextIOWrapper:\n",[151,1144,1145],{"class":153,"line":307},[151,1146,1147],{"class":225},"    \"\"\"What Windows gives a redirected stdout on a Western-European locale.\"\"\"\n",[151,1149,1150,1152,1155,1157,1159,1162,1164,1166,1168,1171],{"class":153,"line":313},[151,1151,574],{"class":164},[151,1153,1154],{"class":175}," io.TextIOWrapper(io.BytesIO(), ",[151,1156,435],{"class":434},[151,1158,345],{"class":164},[151,1160,1161],{"class":225},"\"cp1252\"",[151,1163,122],{"class":175},[151,1165,445],{"class":434},[151,1167,345],{"class":164},[151,1169,1170],{"class":225},"\"strict\"",[151,1172,397],{"class":175},[151,1174,1175],{"class":153,"line":339},[151,1176,183],{"emptyLinePlaceholder":182},[151,1178,1179],{"class":153,"line":354},[151,1180,183],{"emptyLinePlaceholder":182},[151,1182,1183,1185,1188],{"class":153,"line":400},[151,1184,291],{"class":164},[151,1186,1187],{"class":294}," test_the_original_failure_is_real",[151,1189,1190],{"class":175},"():\n",[151,1192,1193,1196,1198],{"class":153,"line":428},[151,1194,1195],{"class":175},"    stream ",[151,1197,345],{"class":164},[151,1199,1200],{"class":175}," cp1252_stream()\n",[151,1202,1203,1206,1209,1211],{"class":153,"line":455},[151,1204,1205],{"class":164},"    with",[151,1207,1208],{"class":175}," pytest.raises(",[151,1210,99],{"class":168},[151,1212,336],{"class":175},[151,1214,1215,1218,1221,1224,1226,1229,1231,1234,1237,1239,1241],{"class":153,"line":460},[151,1216,1217],{"class":168},"        print",[151,1219,1220],{"class":175},"(",[151,1222,1223],{"class":225},"\"✓ deployed\"",[151,1225,122],{"class":175},[151,1227,1228],{"class":434},"file",[151,1230,345],{"class":164},[151,1232,1233],{"class":175},"stream, ",[151,1235,1236],{"class":434},"flush",[151,1238,345],{"class":164},[151,1240,955],{"class":168},[151,1242,397],{"class":175},[151,1244,1245],{"class":153,"line":465},[151,1246,183],{"emptyLinePlaceholder":182},[151,1248,1249],{"class":153,"line":500},[151,1250,183],{"emptyLinePlaceholder":182},[151,1252,1253,1255,1258],{"class":153,"line":531},[151,1254,291],{"class":164},[151,1256,1257],{"class":294}," test_reconfigure_fixes_it",[151,1259,1260],{"class":175},"(monkeypatch):\n",[151,1262,1263,1265,1267],{"class":153,"line":539},[151,1264,1195],{"class":175},[151,1266,345],{"class":164},[151,1268,1200],{"class":175},[151,1270,1271,1274,1276],{"class":153,"line":545},[151,1272,1273],{"class":175},"    monkeypatch.setattr(sys, ",[151,1275,328],{"class":225},[151,1277,1278],{"class":175},", stream)\n",[151,1280,1281],{"class":153,"line":562},[151,1282,1283],{"class":175},"    encoding.ensure_utf8_streams()\n",[151,1285,1286,1289,1291,1294,1296,1298,1300,1302],{"class":153,"line":571},[151,1287,1288],{"class":168},"    print",[151,1290,1220],{"class":175},[151,1292,1293],{"class":225},"\"✓ déployé → prod\"",[151,1295,122],{"class":175},[151,1297,1236],{"class":434},[151,1299,345],{"class":164},[151,1301,955],{"class":168},[151,1303,397],{"class":175},[151,1305,1306,1309,1312,1314,1316,1319,1322,1325],{"class":153,"line":580},[151,1307,1308],{"class":164},"    assert",[151,1310,1311],{"class":175}," stream.buffer.getvalue().decode(",[151,1313,440],{"class":225},[151,1315,377],{"class":175},[151,1317,1318],{"class":164},"==",[151,1320,1321],{"class":225}," \"✓ déployé → prod",[151,1323,1324],{"class":168},"\\n",[151,1326,1327],{"class":225},"\"\n",[151,1329,1330],{"class":153,"line":585},[151,1331,183],{"emptyLinePlaceholder":182},[151,1333,1334],{"class":153,"line":590},[151,1335,183],{"emptyLinePlaceholder":182},[151,1337,1338,1340,1343],{"class":153,"line":619},[151,1339,291],{"class":164},[151,1341,1342],{"class":294}," test_symbol_falls_back_on_narrow_streams",[151,1344,1190],{"class":175},[151,1346,1347,1349,1352,1354,1357,1359],{"class":153,"line":625},[151,1348,1308],{"class":164},[151,1350,1351],{"class":175}," encoding.symbol(",[151,1353,226],{"class":225},[151,1355,1356],{"class":175},", cp1252_stream()) ",[151,1358,1318],{"class":164},[151,1360,1361],{"class":225}," \"[ok]\"\n",[151,1363,1365,1367,1369,1372,1374,1376,1379],{"class":153,"line":1364},31,[151,1366,1308],{"class":164},[151,1368,1351],{"class":175},[151,1370,1371],{"class":225},"\"é\"",[151,1373,1356],{"class":175},[151,1375,1318],{"class":164},[151,1377,1378],{"class":225}," \"é\"",[151,1380,1381],{"class":157},"            # cp1252 has é\n",[151,1383,1385,1388,1390,1392,1394,1396,1398],{"class":153,"line":1384},32,[151,1386,1387],{"class":175},"    utf8 ",[151,1389,345],{"class":164},[151,1391,1154],{"class":175},[151,1393,435],{"class":434},[151,1395,345],{"class":164},[151,1397,440],{"class":225},[151,1399,397],{"class":175},[151,1401,1403,1405,1407,1409,1412,1414],{"class":153,"line":1402},33,[151,1404,1308],{"class":164},[151,1406,1351],{"class":175},[151,1408,226],{"class":225},[151,1410,1411],{"class":175},", utf8) ",[151,1413,1318],{"class":164},[151,1415,1416],{"class":225}," \"✓\"\n",[151,1418,1420],{"class":153,"line":1419},34,[151,1421,183],{"emptyLinePlaceholder":182},[151,1423,1425],{"class":153,"line":1424},35,[151,1426,183],{"emptyLinePlaceholder":182},[151,1428,1430,1432,1435],{"class":153,"line":1429},36,[151,1431,291],{"class":164},[151,1433,1434],{"class":294}," test_reading_bytes_from_another_program",[151,1436,1190],{"class":175},[151,1438,1440,1443,1445,1448,1450,1453,1456,1458],{"class":153,"line":1439},37,[151,1441,1442],{"class":175},"    raw ",[151,1444,345],{"class":164},[151,1446,1447],{"class":225}," \"Größe: 5 MB",[151,1449,1324],{"class":168},[151,1451,1452],{"class":225},"\"",[151,1454,1455],{"class":175},".encode(",[151,1457,440],{"class":225},[151,1459,397],{"class":175},[151,1461,1463,1465,1468,1470,1472,1474,1476,1478,1480,1482,1484,1486],{"class":153,"line":1462},38,[151,1464,1308],{"class":164},[151,1466,1467],{"class":175}," raw.decode(",[151,1469,440],{"class":225},[151,1471,122],{"class":175},[151,1473,445],{"class":434},[151,1475,345],{"class":164},[151,1477,450],{"class":225},[151,1479,377],{"class":175},[151,1481,1318],{"class":164},[151,1483,1447],{"class":225},[151,1485,1324],{"class":168},[151,1487,1327],{"class":225},[151,1489,1491,1493,1496,1499,1502,1504,1507,1510,1513,1515,1517,1519,1521,1523],{"class":153,"line":1490},39,[151,1492,1308],{"class":164},[151,1494,1495],{"class":225}," \"�\"",[151,1497,1498],{"class":164}," in",[151,1500,1501],{"class":164}," b",[151,1503,1452],{"class":225},[151,1505,1506],{"class":168},"\\xff",[151,1508,1509],{"class":225}," broken\"",[151,1511,1512],{"class":175},".decode(",[151,1514,440],{"class":225},[151,1516,122],{"class":175},[151,1518,445],{"class":434},[151,1520,345],{"class":164},[151,1522,450],{"class":225},[151,1524,397],{"class":175},[10,1526,1527,1528,1531,1532,1535,1536,1539,1540,35],{},"The first test is worth keeping even though it tests Python rather than your code: it documents ",[1061,1529,1530],{},"why"," the fix exists, and it fails loudly if a future Python changes the behaviour. For end-to-end confidence, add a Windows CI job that runs a command with output redirected (",[14,1533,1534],{},"mytool status > out.txt",") and with ",[14,1537,1538],{},"PYTHONUTF8"," unset, as described in ",[31,1541,1543],{"href":1542},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Ftesting-a-cli-across-python-versions-with-github-actions\u002F","testing a CLI across Python versions with GitHub Actions",[37,1545,1547],{"id":1546},"conclusion","Conclusion",[10,1549,1550,1551,1553,1554,1556,1557,1559],{},"Encoding errors in Python CLIs on Windows come from a small number of boundaries: redirected standard streams, files opened without an encoding, and output from other programs. Reconfigure stdout and stderr to UTF-8 with ",[14,1552,735],{}," at the start of the entry point, pass ",[14,1555,782],{}," to every file operation, decode subprocess output explicitly, and give decorative symbols ASCII fallbacks. Then simulate a ",[14,1558,95],{}," stream in tests and run one redirected command on a Windows runner, and the \"works on my machine\" class of Unicode bugs is closed.",[37,1561,1563],{"id":1562},"frequently-asked-questions","Frequently asked questions",[763,1565,1567,1568,28],{"id":1566},"should-i-change-the-console-code-page-with-chcp-65001","Should I change the console code page with ",[14,1569,1570],{},"chcp 65001",[10,1572,1573],{},"Not from your tool. Changing the console code page affects the user's whole session and other programs in it, and it is unnecessary for Python's own console output. Reconfiguring your own streams fixes your output without side effects.",[763,1575,1577],{"id":1576},"does-rich-handle-this-for-me","Does Rich handle this for me?",[10,1579,1580],{},"Rich writes to the console through Windows APIs and handles legacy consoles carefully, so interactive output is usually fine. When output is redirected, Rich writes to the stream Python gave it — which is why reconfiguring the streams first still matters.",[763,1582,1584],{"id":1583},"what-about-reading-from-stdin","What about reading from stdin?",[10,1586,1587,1588,1591,1592,1595,1596,1599,1600,35],{},"The same rules apply in reverse. Reconfigure ",[14,1589,1590],{},"sys.stdin"," with ",[14,1593,1594],{},"encoding=\"utf-8\", errors=\"replace\""," if your tool reads piped text, or read ",[14,1597,1598],{},"sys.stdin.buffer"," and decode explicitly when you need to handle binary input. See ",[31,1601,1603],{"href":1602},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis\u002F","reading piped input in Python CLIs",[763,1605,1607,1608,1610],{"id":1606},"is-errorsreplace-hiding-bugs","Is ",[14,1609,735],{}," hiding bugs?",[10,1612,1613,1614,1616],{},"For output streams it trades an impossible-to-display character for ",[14,1615,28],{},", which is the right trade in a CLI. For parsing input that must be exact — configuration, data files — use strict decoding and report a clear error naming the file and position instead.",[37,1618,1620],{"id":1619},"related","Related",[42,1622,1623,1629,1635,1641,1647],{},[45,1624,1625,1626],{},"Up: ",[31,1627,1628],{"href":33},"Cross-platform terminal compatibility",[45,1630,1631],{},[31,1632,1634],{"href":1633},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Frespecting-no-color-and-force-color\u002F","Respecting NO_COLOR and FORCE_COLOR",[45,1636,1637],{},[31,1638,1640],{"href":1639},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells\u002F","Detecting CI environments and non-interactive shells",[45,1642,1643],{},[31,1644,1646],{"href":1645},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib\u002F","Cross-platform paths with pathlib",[45,1648,1649],{},[31,1650,1652],{"href":1651},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe\u002F","Handling broken pipe and SIGPIPE",[1654,1655,1656],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":147,"searchDepth":161,"depth":161,"links":1658},[1659,1660,1661,1666,1667,1668,1669,1677],{"id":39,"depth":161,"text":40},{"id":53,"depth":161,"text":54},{"id":136,"depth":161,"text":137,"children":1662},[1663,1664,1665],{"id":765,"depth":179,"text":766},{"id":890,"depth":179,"text":891},{"id":1002,"depth":179,"text":1003},{"id":1017,"depth":161,"text":1018},{"id":1067,"depth":161,"text":1068},{"id":1546,"depth":161,"text":1547},{"id":1562,"depth":161,"text":1563,"children":1670},[1671,1673,1674,1675],{"id":1566,"depth":179,"text":1672},"Should I change the console code page with chcp 65001?",{"id":1576,"depth":179,"text":1577},{"id":1583,"depth":179,"text":1584},{"id":1606,"depth":179,"text":1676},"Is errors=\"replace\" hiding bugs?",{"id":1619,"depth":161,"text":1620},"2026-09-18","Stop UnicodeEncodeError and mojibake in Python CLIs on Windows: why redirected output uses cp1252, reconfiguring streams, files, subprocess output and ASCII fallbacks.","intermediate",false,"md",{},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Ffixing-unicode-and-encoding-errors-on-windows",{"title":5,"description":1679},"advanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Ffixing-unicode-and-encoding-errors-on-windows\u002Findex",[1688,1689,435,1690],"windows","unicode","terminal","whMgGS3CFp5WXWPSw4R72e4ymWpY9Y8DAI9zI-ZmjEY",[1693,1696,1699,1702,1705,1708,1711,1714,1717,1720,1723,1726,1729,1732,1735,1738,1741,1744,1745,1748,1751,1754,1757,1760,1763,1766,1769,1772,1775,1778,1781,1784,1787,1790,1793,1796,1799,1802,1805,1808,1811,1814,1817,1820,1823,1826,1829,1832,1835,1838,1841,1844,1847,1850,1853,1856,1859,1862,1865,1868,1871,1874,1877,1880,1883,1886,1889,1892,1895,1898,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,2201,2204,2207,2210,2213,2216,2219,2222,2225,2228,2231,2234,2237],{"path":1694,"title":1695},"\u002Fabout","About Python CLI Toolcraft",{"path":1697,"title":1698},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1700,"title":1701},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1703,"title":1704},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1706,"title":1707},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1709,"title":1710},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1712,"title":1713},"\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":1715,"title":1716},"\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":1718,"title":1719},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1721,"title":1722},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1724,"title":1725},"\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":1727,"title":1728},"\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":1730,"title":1731},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":1733,"title":1734},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":1736,"title":1737},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":1739,"title":1740},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":1742,"title":1743},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":1684,"title":5},{"path":1746,"title":1747},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":1749,"title":1750},"\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":1752,"title":1753},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":1755,"title":1756},"\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":1758,"title":1759},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":1761,"title":1762},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":1764,"title":1765},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":1767,"title":1768},"\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":1770,"title":1771},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":1773,"title":1774},"\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":1776,"title":1777},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":1779,"title":1780},"\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":1782,"title":1783},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":1785,"title":1786},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":1788,"title":1789},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":1791,"title":1792},"\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":1794,"title":1795},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":1797,"title":1798},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":1800,"title":1801},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":1803,"title":1804},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":1806,"title":1807},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":1809,"title":1810},"\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":1812,"title":1813},"\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":1815,"title":1816},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":1818,"title":1819},"\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":1821,"title":1822},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":1824,"title":1825},"\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":1827,"title":1828},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":1830,"title":1831},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":1833,"title":1834},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":1836,"title":1837},"\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":1839,"title":1840},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":1842,"title":1843},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":1845,"title":1846},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":1848,"title":1849},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":1851,"title":1852},"\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":1854,"title":1855},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":1857,"title":1858},"\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":1860,"title":1861},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":1863,"title":1864},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":1866,"title":1867},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":1869,"title":1870},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":1872,"title":1873},"\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":1875,"title":1876},"\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":1878,"title":1879},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":1881,"title":1882},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":1884,"title":1885},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":1887,"title":1888},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":1890,"title":1891},"\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":1893,"title":1894},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":1896,"title":1897},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":1899,"title":1900},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":1902,"title":1903},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":1905,"title":1906},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":1908,"title":1909},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":1911,"title":1912},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":1914,"title":1915},"\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":1917,"title":1918},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":1920,"title":1921},"\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":1923,"title":1924},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":1926,"title":1927},"\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":1929,"title":1930},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":1932,"title":1933},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":1935,"title":1936},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":1938,"title":1939},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":1941,"title":1942},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":1944,"title":1945},"\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":1947,"title":1948},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":1950,"title":1951},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":1953,"title":1954},"\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":1956,"title":1957},"\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":1959,"title":1960},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":1962,"title":1963},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":1965,"title":1966},"\u002F","Python CLI Toolcraft",{"path":1968,"title":1969},"\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":1971,"title":1972},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":1974,"title":1975},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":1977,"title":1978},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":1980,"title":1981},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":1983,"title":1984},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":1986,"title":1987},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":1989,"title":1990},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":1992,"title":1993},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":1995,"title":1996},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":1998,"title":1999},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2001,"title":2002},"\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":2004,"title":2005},"\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":2007,"title":2008},"\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":2010,"title":2011},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2013,"title":2014},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2016,"title":2017},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2019,"title":2020},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2022,"title":2023},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2025,"title":2026},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2028,"title":2029},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2031,"title":2032},"\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":2034,"title":2035},"\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":2037,"title":2038},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2040,"title":2041},"\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":2043,"title":2044},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2046,"title":2047},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2049,"title":2050},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2052,"title":2053},"\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":2055,"title":2056},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2058,"title":2059},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2061,"title":2062},"\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":2064,"title":2065},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2067,"title":2068},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2070,"title":2071},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2073,"title":2074},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2076,"title":2077},"\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":2079,"title":2080},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2082,"title":2083},"\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":2085,"title":2086},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2088,"title":2089},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2091,"title":2092},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2094,"title":2095},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2097,"title":2098},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2100,"title":2101},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2103,"title":2104},"\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":2106,"title":2107},"\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":2109,"title":2110},"\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":2112,"title":2113},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2115,"title":2116},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2118,"title":2119},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2121,"title":2122},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2124,"title":2125},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2127,"title":2128},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2130,"title":2131},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2133,"title":2134},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2136,"title":2137},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2139,"title":2140},"\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":2142,"title":2143},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2145,"title":2146},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2148,"title":2149},"\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":2151,"title":2152},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2154,"title":2155},"\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":2157,"title":2158},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2160,"title":2161},"\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":2163,"title":2164},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2166,"title":2167},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2169,"title":2170},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2172,"title":2173},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2175,"title":2176},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2178,"title":2179},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2181,"title":2182},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2184,"title":2185},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2187,"title":2188},"\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":2190,"title":2191},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2193,"title":2194},"\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":2196,"title":2197},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2199,"title":2200},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2202,"title":2203},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2205,"title":2206},"\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":2208,"title":2209},"\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":2211,"title":2212},"\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":2214,"title":2215},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2217,"title":2218},"\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":2220,"title":2221},"\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":2223,"title":2224},"\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":2226,"title":2227},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2229,"title":2230},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2232,"title":2233},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2235,"title":2236},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2238,"title":2239},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1789736905044]