[{"data":1,"prerenderedAt":2632},["ShallowReactive",2],{"page-\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fwriting-rotating-log-files-from-a-cli\u002F":3,"content-directory":2085},{"id":4,"title":5,"body":6,"date":2071,"description":2072,"difficulty":2073,"draft":2074,"extension":2075,"meta":2076,"navigation":128,"path":2077,"seo":2078,"stem":2079,"tags":2080,"updated":2071,"__hash__":2084},"content\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fwriting-rotating-log-files-from-a-cli\u002Findex.md","Writing Rotating Log Files from a Python CLI",{"type":7,"value":8,"toc":2052},"minimark",[9,33,38,60,64,68,83,87,744,1182,1187,1206,1218,1230,1241,1247,1268,1278,1282,1285,1292,1299,1303,1306,1355,1359,1374,1918,1921,1925,1937,1941,1945,1948,1952,1970,1974,1989,1993,2004,2008,2015,2019,2048],[10,11,12,13,17,18,22,23,26,27,32],"p",{},"A good CLI is quiet on the terminal: a line or two on success, a clear message on failure. But when something goes wrong — especially intermittently, or on a user's machine you cannot see — you want far more detail than the terminal showed: every request, every decision, timings, the full traceback. Asking the user to \"run it again with ",[14,15,16],"code",{},"-vvv","\" works only if the problem reproduces. The answer many mature tools use is a ",[19,20,21],"strong",{},"persistent debug log",": every run writes detailed logs to a file in the platform's log directory, rotated so it never grows without bound, while the console handler shows only what the user asked to see. When a command fails, the error message points at the file. This guide sets that up with the standard library's ",[14,24,25],{},"RotatingFileHandler",", integrates it with verbosity flags, handles unwritable locations gracefully, and tests rotation. It belongs to the ",[28,29,31],"a",{"href":30},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002F","structured logging for CLI apps topic",".",[34,35,37],"h2",{"id":36},"prerequisites","Prerequisites",[39,40,41,54],"ul",{},[42,43,44,45,48,49,53],"li",{},"Python 3.10+ and ",[14,46,47],{},"platformdirs"," for the log location (see ",[28,50,52],{"href":51},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs\u002F","storing app data with platformdirs",").",[42,55,56,57,32],{},"Logging configured in one place at startup, as described in ",[28,58,59],{"href":30},"the logging topic overview",[34,61,63],{"id":62},"two-destinations-two-levels","Two destinations, two levels",[65,66],"inline-diagram",{"name":67},"rot-flow",[10,69,70,71,74,75,78,79,82],{},"The trick is to set levels ",[19,72,73],{},"per handler",", not only on the logger. The root logger lets everything through (",[14,76,77],{},"DEBUG","); the console handler filters to what the user asked for with ",[14,80,81],{},"-v"," flags; the file handler keeps everything. Library code keeps logging normally — it never knows two destinations exist.",[34,84,86],{"id":85},"the-recipe","The recipe",[88,89,94],"pre",{"className":90,"code":91,"language":92,"meta":93,"style":93},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Flogsetup.py\nfrom __future__ import annotations\n\nimport logging\nimport logging.handlers\nimport sys\nfrom pathlib import Path\n\nfrom platformdirs import user_log_path\n\nLOG_FORMAT = \"%(asctime)s %(levelname)-7s %(name)s [%(process)d] %(message)s\"\n\n\ndef default_log_file() -> Path:\n    return user_log_path(\"mytool\", appauthor=False) \u002F \"mytool.log\"\n\n\ndef configure_logging(verbosity: int = 0, log_file: Path | None = None,\n                      max_bytes: int = 1_000_000, backups: int = 3) -> Path | None:\n    \"\"\"Console at the user's level on stderr; everything at DEBUG in a rotating file.\n\n    Returns the log file path, or None if file logging could not be set up.\n    \"\"\"\n    root = logging.getLogger()\n    root.setLevel(logging.DEBUG)\n    for h in list(root.handlers):\n        root.removeHandler(h)\n        h.close()\n\n    console = logging.StreamHandler(sys.stderr)\n    console.setLevel({0: logging.WARNING, 1: logging.INFO}.get(verbosity, logging.DEBUG))\n    console.setFormatter(logging.Formatter(\"%(levelname)s: %(message)s\"))\n    root.addHandler(console)\n\n    path = log_file or default_log_file()\n    try:\n        path.parent.mkdir(parents=True, exist_ok=True)\n        file_handler = logging.handlers.RotatingFileHandler(\n            path, maxBytes=max_bytes, backupCount=backups, encoding=\"utf-8\", delay=True)\n    except OSError as exc:                                  # read-only home, full disk...\n        logging.getLogger(__name__).warning(\"file logging disabled: %s\", exc)\n        return None\n    file_handler.setLevel(logging.DEBUG)\n    file_handler.setFormatter(logging.Formatter(LOG_FORMAT))\n    root.addHandler(file_handler)\n    for noisy in (\"httpx\", \"httpcore\", \"urllib3\"):\n        logging.getLogger(noisy).setLevel(logging.INFO)\n    return path\n","python","",[14,95,96,105,123,130,139,147,155,168,173,186,191,228,233,238,251,285,290,295,330,363,369,374,380,386,397,408,426,432,438,443,454,487,508,514,519,536,544,569,580,621,639,662,671,681,691,697,726,736],{"__ignoreMap":93},[97,98,101],"span",{"class":99,"line":100},"line",1,[97,102,104],{"class":103},"sJ8bj","# src\u002Fmytool\u002Flogsetup.py\n",[97,106,108,112,116,119],{"class":99,"line":107},2,[97,109,111],{"class":110},"szBVR","from",[97,113,115],{"class":114},"sj4cs"," __future__",[97,117,118],{"class":110}," import",[97,120,122],{"class":121},"sVt8B"," annotations\n",[97,124,126],{"class":99,"line":125},3,[97,127,129],{"emptyLinePlaceholder":128},true,"\n",[97,131,133,136],{"class":99,"line":132},4,[97,134,135],{"class":110},"import",[97,137,138],{"class":121}," logging\n",[97,140,142,144],{"class":99,"line":141},5,[97,143,135],{"class":110},[97,145,146],{"class":121}," logging.handlers\n",[97,148,150,152],{"class":99,"line":149},6,[97,151,135],{"class":110},[97,153,154],{"class":121}," sys\n",[97,156,158,160,163,165],{"class":99,"line":157},7,[97,159,111],{"class":110},[97,161,162],{"class":121}," pathlib ",[97,164,135],{"class":110},[97,166,167],{"class":121}," Path\n",[97,169,171],{"class":99,"line":170},8,[97,172,129],{"emptyLinePlaceholder":128},[97,174,176,178,181,183],{"class":99,"line":175},9,[97,177,111],{"class":110},[97,179,180],{"class":121}," platformdirs ",[97,182,135],{"class":110},[97,184,185],{"class":121}," user_log_path\n",[97,187,189],{"class":99,"line":188},10,[97,190,129],{"emptyLinePlaceholder":128},[97,192,194,197,200,204,207,210,213,216,219,222,225],{"class":99,"line":193},11,[97,195,196],{"class":114},"LOG_FORMAT",[97,198,199],{"class":110}," =",[97,201,203],{"class":202},"sZZnC"," \"",[97,205,206],{"class":114},"%(asctime)s",[97,208,209],{"class":114}," %(levelname)-7s",[97,211,212],{"class":114}," %(name)s",[97,214,215],{"class":202}," [",[97,217,218],{"class":114},"%(process)d",[97,220,221],{"class":202},"] ",[97,223,224],{"class":114},"%(message)s",[97,226,227],{"class":202},"\"\n",[97,229,231],{"class":99,"line":230},12,[97,232,129],{"emptyLinePlaceholder":128},[97,234,236],{"class":99,"line":235},13,[97,237,129],{"emptyLinePlaceholder":128},[97,239,241,244,248],{"class":99,"line":240},14,[97,242,243],{"class":110},"def",[97,245,247],{"class":246},"sScJk"," default_log_file",[97,249,250],{"class":121},"() -> Path:\n",[97,252,254,257,260,263,266,270,273,276,279,282],{"class":99,"line":253},15,[97,255,256],{"class":110},"    return",[97,258,259],{"class":121}," user_log_path(",[97,261,262],{"class":202},"\"mytool\"",[97,264,265],{"class":121},", ",[97,267,269],{"class":268},"s4XuR","appauthor",[97,271,272],{"class":110},"=",[97,274,275],{"class":114},"False",[97,277,278],{"class":121},") ",[97,280,281],{"class":110},"\u002F",[97,283,284],{"class":202}," \"mytool.log\"\n",[97,286,288],{"class":99,"line":287},16,[97,289,129],{"emptyLinePlaceholder":128},[97,291,293],{"class":99,"line":292},17,[97,294,129],{"emptyLinePlaceholder":128},[97,296,298,300,303,306,309,311,314,317,320,323,325,327],{"class":99,"line":297},18,[97,299,243],{"class":110},[97,301,302],{"class":246}," configure_logging",[97,304,305],{"class":121},"(verbosity: ",[97,307,308],{"class":114},"int",[97,310,199],{"class":110},[97,312,313],{"class":114}," 0",[97,315,316],{"class":121},", log_file: Path ",[97,318,319],{"class":110},"|",[97,321,322],{"class":114}," None",[97,324,199],{"class":110},[97,326,322],{"class":114},[97,328,329],{"class":121},",\n",[97,331,333,336,338,340,343,346,348,350,353,356,358,360],{"class":99,"line":332},19,[97,334,335],{"class":121},"                      max_bytes: ",[97,337,308],{"class":114},[97,339,199],{"class":110},[97,341,342],{"class":114}," 1_000_000",[97,344,345],{"class":121},", backups: ",[97,347,308],{"class":114},[97,349,199],{"class":110},[97,351,352],{"class":114}," 3",[97,354,355],{"class":121},") -> Path ",[97,357,319],{"class":110},[97,359,322],{"class":114},[97,361,362],{"class":121},":\n",[97,364,366],{"class":99,"line":365},20,[97,367,368],{"class":202},"    \"\"\"Console at the user's level on stderr; everything at DEBUG in a rotating file.\n",[97,370,372],{"class":99,"line":371},21,[97,373,129],{"emptyLinePlaceholder":128},[97,375,377],{"class":99,"line":376},22,[97,378,379],{"class":202},"    Returns the log file path, or None if file logging could not be set up.\n",[97,381,383],{"class":99,"line":382},23,[97,384,385],{"class":202},"    \"\"\"\n",[97,387,389,392,394],{"class":99,"line":388},24,[97,390,391],{"class":121},"    root ",[97,393,272],{"class":110},[97,395,396],{"class":121}," logging.getLogger()\n",[97,398,400,403,405],{"class":99,"line":399},25,[97,401,402],{"class":121},"    root.setLevel(logging.",[97,404,77],{"class":114},[97,406,407],{"class":121},")\n",[97,409,411,414,417,420,423],{"class":99,"line":410},26,[97,412,413],{"class":110},"    for",[97,415,416],{"class":121}," h ",[97,418,419],{"class":110},"in",[97,421,422],{"class":114}," list",[97,424,425],{"class":121},"(root.handlers):\n",[97,427,429],{"class":99,"line":428},27,[97,430,431],{"class":121},"        root.removeHandler(h)\n",[97,433,435],{"class":99,"line":434},28,[97,436,437],{"class":121},"        h.close()\n",[97,439,441],{"class":99,"line":440},29,[97,442,129],{"emptyLinePlaceholder":128},[97,444,446,449,451],{"class":99,"line":445},30,[97,447,448],{"class":121},"    console ",[97,450,272],{"class":110},[97,452,453],{"class":121}," logging.StreamHandler(sys.stderr)\n",[97,455,457,460,463,466,469,471,474,476,479,482,484],{"class":99,"line":456},31,[97,458,459],{"class":121},"    console.setLevel({",[97,461,462],{"class":114},"0",[97,464,465],{"class":121},": logging.",[97,467,468],{"class":114},"WARNING",[97,470,265],{"class":121},[97,472,473],{"class":114},"1",[97,475,465],{"class":121},[97,477,478],{"class":114},"INFO",[97,480,481],{"class":121},"}.get(verbosity, logging.",[97,483,77],{"class":114},[97,485,486],{"class":121},"))\n",[97,488,490,493,496,499,502,504,506],{"class":99,"line":489},32,[97,491,492],{"class":121},"    console.setFormatter(logging.Formatter(",[97,494,495],{"class":202},"\"",[97,497,498],{"class":114},"%(levelname)s",[97,500,501],{"class":202},": ",[97,503,224],{"class":114},[97,505,495],{"class":202},[97,507,486],{"class":121},[97,509,511],{"class":99,"line":510},33,[97,512,513],{"class":121},"    root.addHandler(console)\n",[97,515,517],{"class":99,"line":516},34,[97,518,129],{"emptyLinePlaceholder":128},[97,520,522,525,527,530,533],{"class":99,"line":521},35,[97,523,524],{"class":121},"    path ",[97,526,272],{"class":110},[97,528,529],{"class":121}," log_file ",[97,531,532],{"class":110},"or",[97,534,535],{"class":121}," default_log_file()\n",[97,537,539,542],{"class":99,"line":538},36,[97,540,541],{"class":110},"    try",[97,543,362],{"class":121},[97,545,547,550,553,555,558,560,563,565,567],{"class":99,"line":546},37,[97,548,549],{"class":121},"        path.parent.mkdir(",[97,551,552],{"class":268},"parents",[97,554,272],{"class":110},[97,556,557],{"class":114},"True",[97,559,265],{"class":121},[97,561,562],{"class":268},"exist_ok",[97,564,272],{"class":110},[97,566,557],{"class":114},[97,568,407],{"class":121},[97,570,572,575,577],{"class":99,"line":571},38,[97,573,574],{"class":121},"        file_handler ",[97,576,272],{"class":110},[97,578,579],{"class":121}," logging.handlers.RotatingFileHandler(\n",[97,581,583,586,589,591,594,597,599,602,605,607,610,612,615,617,619],{"class":99,"line":582},39,[97,584,585],{"class":121},"            path, ",[97,587,588],{"class":268},"maxBytes",[97,590,272],{"class":110},[97,592,593],{"class":121},"max_bytes, ",[97,595,596],{"class":268},"backupCount",[97,598,272],{"class":110},[97,600,601],{"class":121},"backups, ",[97,603,604],{"class":268},"encoding",[97,606,272],{"class":110},[97,608,609],{"class":202},"\"utf-8\"",[97,611,265],{"class":121},[97,613,614],{"class":268},"delay",[97,616,272],{"class":110},[97,618,557],{"class":114},[97,620,407],{"class":121},[97,622,624,627,630,633,636],{"class":99,"line":623},40,[97,625,626],{"class":110},"    except",[97,628,629],{"class":114}," OSError",[97,631,632],{"class":110}," as",[97,634,635],{"class":121}," exc:                                  ",[97,637,638],{"class":103},"# read-only home, full disk...\n",[97,640,642,645,648,651,654,657,659],{"class":99,"line":641},41,[97,643,644],{"class":121},"        logging.getLogger(",[97,646,647],{"class":114},"__name__",[97,649,650],{"class":121},").warning(",[97,652,653],{"class":202},"\"file logging disabled: ",[97,655,656],{"class":114},"%s",[97,658,495],{"class":202},[97,660,661],{"class":121},", exc)\n",[97,663,665,668],{"class":99,"line":664},42,[97,666,667],{"class":110},"        return",[97,669,670],{"class":114}," None\n",[97,672,674,677,679],{"class":99,"line":673},43,[97,675,676],{"class":121},"    file_handler.setLevel(logging.",[97,678,77],{"class":114},[97,680,407],{"class":121},[97,682,684,687,689],{"class":99,"line":683},44,[97,685,686],{"class":121},"    file_handler.setFormatter(logging.Formatter(",[97,688,196],{"class":114},[97,690,486],{"class":121},[97,692,694],{"class":99,"line":693},45,[97,695,696],{"class":121},"    root.addHandler(file_handler)\n",[97,698,700,702,705,707,710,713,715,718,720,723],{"class":99,"line":699},46,[97,701,413],{"class":110},[97,703,704],{"class":121}," noisy ",[97,706,419],{"class":110},[97,708,709],{"class":121}," (",[97,711,712],{"class":202},"\"httpx\"",[97,714,265],{"class":121},[97,716,717],{"class":202},"\"httpcore\"",[97,719,265],{"class":121},[97,721,722],{"class":202},"\"urllib3\"",[97,724,725],{"class":121},"):\n",[97,727,729,732,734],{"class":99,"line":728},47,[97,730,731],{"class":121},"        logging.getLogger(noisy).setLevel(logging.",[97,733,478],{"class":114},[97,735,407],{"class":121},[97,737,739,741],{"class":99,"line":738},48,[97,740,256],{"class":110},[97,742,743],{"class":121}," path\n",[88,745,747],{"className":90,"code":746,"language":92,"meta":93,"style":93},"# src\u002Fmytool\u002Fcli.py\nfrom __future__ import annotations\n\nimport logging\nfrom pathlib import Path\nfrom typing import Annotated\n\nimport typer\n\nfrom mytool.logsetup import configure_logging\n\napp = typer.Typer()\nlog = logging.getLogger(\"mytool.sync\")\n\n\n@app.callback()\ndef main(\n    ctx: typer.Context,\n    verbose: Annotated[int, typer.Option(\"--verbose\", \"-v\", count=True)] = 0,\n    log_file: Annotated[Path | None, typer.Option(envvar=\"MYTOOL_LOG_FILE\", help=\"Where to write the detailed log.\")] = None,\n) -> None:\n    \"\"\"Sync tool with a persistent debug log.\"\"\"\n    ctx.obj = configure_logging(verbose, log_file)\n\n\n@app.command()\ndef sync(ctx: typer.Context, fail: bool = False) -> None:\n    \"\"\"Sync items (use --fail to simulate an error).\"\"\"\n    log.debug(\"starting sync with 3 items\")\n    for i in range(3):\n        log.debug(\"item %d processed\", i)\n    if fail:\n        log.error(\"sync failed: remote closed the connection\")\n        if ctx.obj:\n            typer.echo(f\"details: {ctx.obj}\", err=True)\n        raise typer.Exit(1)\n    log.info(\"synced 3 items\")\n\n\nif __name__ == \"__main__\":\n    app()\n",[14,748,749,754,764,768,774,784,796,800,807,811,823,827,837,852,856,860,868,878,883,919,956,966,971,981,985,989,996,1020,1025,1035,1055,1072,1080,1090,1098,1131,1143,1153,1157,1161,1177],{"__ignoreMap":93},[97,750,751],{"class":99,"line":100},[97,752,753],{"class":103},"# src\u002Fmytool\u002Fcli.py\n",[97,755,756,758,760,762],{"class":99,"line":107},[97,757,111],{"class":110},[97,759,115],{"class":114},[97,761,118],{"class":110},[97,763,122],{"class":121},[97,765,766],{"class":99,"line":125},[97,767,129],{"emptyLinePlaceholder":128},[97,769,770,772],{"class":99,"line":132},[97,771,135],{"class":110},[97,773,138],{"class":121},[97,775,776,778,780,782],{"class":99,"line":141},[97,777,111],{"class":110},[97,779,162],{"class":121},[97,781,135],{"class":110},[97,783,167],{"class":121},[97,785,786,788,791,793],{"class":99,"line":149},[97,787,111],{"class":110},[97,789,790],{"class":121}," typing ",[97,792,135],{"class":110},[97,794,795],{"class":121}," Annotated\n",[97,797,798],{"class":99,"line":157},[97,799,129],{"emptyLinePlaceholder":128},[97,801,802,804],{"class":99,"line":170},[97,803,135],{"class":110},[97,805,806],{"class":121}," typer\n",[97,808,809],{"class":99,"line":175},[97,810,129],{"emptyLinePlaceholder":128},[97,812,813,815,818,820],{"class":99,"line":188},[97,814,111],{"class":110},[97,816,817],{"class":121}," mytool.logsetup ",[97,819,135],{"class":110},[97,821,822],{"class":121}," configure_logging\n",[97,824,825],{"class":99,"line":193},[97,826,129],{"emptyLinePlaceholder":128},[97,828,829,832,834],{"class":99,"line":230},[97,830,831],{"class":121},"app ",[97,833,272],{"class":110},[97,835,836],{"class":121}," typer.Typer()\n",[97,838,839,842,844,847,850],{"class":99,"line":235},[97,840,841],{"class":121},"log ",[97,843,272],{"class":110},[97,845,846],{"class":121}," logging.getLogger(",[97,848,849],{"class":202},"\"mytool.sync\"",[97,851,407],{"class":121},[97,853,854],{"class":99,"line":240},[97,855,129],{"emptyLinePlaceholder":128},[97,857,858],{"class":99,"line":253},[97,859,129],{"emptyLinePlaceholder":128},[97,861,862,865],{"class":99,"line":287},[97,863,864],{"class":246},"@app.callback",[97,866,867],{"class":121},"()\n",[97,869,870,872,875],{"class":99,"line":292},[97,871,243],{"class":110},[97,873,874],{"class":246}," main",[97,876,877],{"class":121},"(\n",[97,879,880],{"class":99,"line":297},[97,881,882],{"class":121},"    ctx: typer.Context,\n",[97,884,885,888,890,893,896,898,901,903,906,908,910,913,915,917],{"class":99,"line":332},[97,886,887],{"class":121},"    verbose: Annotated[",[97,889,308],{"class":114},[97,891,892],{"class":121},", typer.Option(",[97,894,895],{"class":202},"\"--verbose\"",[97,897,265],{"class":121},[97,899,900],{"class":202},"\"-v\"",[97,902,265],{"class":121},[97,904,905],{"class":268},"count",[97,907,272],{"class":110},[97,909,557],{"class":114},[97,911,912],{"class":121},")] ",[97,914,272],{"class":110},[97,916,313],{"class":114},[97,918,329],{"class":121},[97,920,921,924,926,928,930,933,935,938,940,943,945,948,950,952,954],{"class":99,"line":365},[97,922,923],{"class":121},"    log_file: Annotated[Path ",[97,925,319],{"class":110},[97,927,322],{"class":114},[97,929,892],{"class":121},[97,931,932],{"class":268},"envvar",[97,934,272],{"class":110},[97,936,937],{"class":202},"\"MYTOOL_LOG_FILE\"",[97,939,265],{"class":121},[97,941,942],{"class":268},"help",[97,944,272],{"class":110},[97,946,947],{"class":202},"\"Where to write the detailed log.\"",[97,949,912],{"class":121},[97,951,272],{"class":110},[97,953,322],{"class":114},[97,955,329],{"class":121},[97,957,958,961,964],{"class":99,"line":371},[97,959,960],{"class":121},") -> ",[97,962,963],{"class":114},"None",[97,965,362],{"class":121},[97,967,968],{"class":99,"line":376},[97,969,970],{"class":202},"    \"\"\"Sync tool with a persistent debug log.\"\"\"\n",[97,972,973,976,978],{"class":99,"line":382},[97,974,975],{"class":121},"    ctx.obj ",[97,977,272],{"class":110},[97,979,980],{"class":121}," configure_logging(verbose, log_file)\n",[97,982,983],{"class":99,"line":388},[97,984,129],{"emptyLinePlaceholder":128},[97,986,987],{"class":99,"line":399},[97,988,129],{"emptyLinePlaceholder":128},[97,990,991,994],{"class":99,"line":410},[97,992,993],{"class":246},"@app.command",[97,995,867],{"class":121},[97,997,998,1000,1003,1006,1009,1011,1014,1016,1018],{"class":99,"line":428},[97,999,243],{"class":110},[97,1001,1002],{"class":246}," sync",[97,1004,1005],{"class":121},"(ctx: typer.Context, fail: ",[97,1007,1008],{"class":114},"bool",[97,1010,199],{"class":110},[97,1012,1013],{"class":114}," False",[97,1015,960],{"class":121},[97,1017,963],{"class":114},[97,1019,362],{"class":121},[97,1021,1022],{"class":99,"line":434},[97,1023,1024],{"class":202},"    \"\"\"Sync items (use --fail to simulate an error).\"\"\"\n",[97,1026,1027,1030,1033],{"class":99,"line":440},[97,1028,1029],{"class":121},"    log.debug(",[97,1031,1032],{"class":202},"\"starting sync with 3 items\"",[97,1034,407],{"class":121},[97,1036,1037,1039,1042,1044,1047,1050,1053],{"class":99,"line":445},[97,1038,413],{"class":110},[97,1040,1041],{"class":121}," i ",[97,1043,419],{"class":110},[97,1045,1046],{"class":114}," range",[97,1048,1049],{"class":121},"(",[97,1051,1052],{"class":114},"3",[97,1054,725],{"class":121},[97,1056,1057,1060,1063,1066,1069],{"class":99,"line":456},[97,1058,1059],{"class":121},"        log.debug(",[97,1061,1062],{"class":202},"\"item ",[97,1064,1065],{"class":114},"%d",[97,1067,1068],{"class":202}," processed\"",[97,1070,1071],{"class":121},", i)\n",[97,1073,1074,1077],{"class":99,"line":489},[97,1075,1076],{"class":110},"    if",[97,1078,1079],{"class":121}," fail:\n",[97,1081,1082,1085,1088],{"class":99,"line":510},[97,1083,1084],{"class":121},"        log.error(",[97,1086,1087],{"class":202},"\"sync failed: remote closed the connection\"",[97,1089,407],{"class":121},[97,1091,1092,1095],{"class":99,"line":516},[97,1093,1094],{"class":110},"        if",[97,1096,1097],{"class":121}," ctx.obj:\n",[97,1099,1100,1103,1106,1109,1112,1115,1118,1120,1122,1125,1127,1129],{"class":99,"line":521},[97,1101,1102],{"class":121},"            typer.echo(",[97,1104,1105],{"class":110},"f",[97,1107,1108],{"class":202},"\"details: ",[97,1110,1111],{"class":114},"{",[97,1113,1114],{"class":121},"ctx.obj",[97,1116,1117],{"class":114},"}",[97,1119,495],{"class":202},[97,1121,265],{"class":121},[97,1123,1124],{"class":268},"err",[97,1126,272],{"class":110},[97,1128,557],{"class":114},[97,1130,407],{"class":121},[97,1132,1133,1136,1139,1141],{"class":99,"line":538},[97,1134,1135],{"class":110},"        raise",[97,1137,1138],{"class":121}," typer.Exit(",[97,1140,473],{"class":114},[97,1142,407],{"class":121},[97,1144,1145,1148,1151],{"class":99,"line":546},[97,1146,1147],{"class":121},"    log.info(",[97,1149,1150],{"class":202},"\"synced 3 items\"",[97,1152,407],{"class":121},[97,1154,1155],{"class":99,"line":571},[97,1156,129],{"emptyLinePlaceholder":128},[97,1158,1159],{"class":99,"line":582},[97,1160,129],{"emptyLinePlaceholder":128},[97,1162,1163,1166,1169,1172,1175],{"class":99,"line":623},[97,1164,1165],{"class":110},"if",[97,1167,1168],{"class":114}," __name__",[97,1170,1171],{"class":110}," ==",[97,1173,1174],{"class":202}," \"__main__\"",[97,1176,362],{"class":121},[97,1178,1179],{"class":99,"line":641},[97,1180,1181],{"class":121},"    app()\n",[1183,1184,1186],"h3",{"id":1185},"the-details","The details",[10,1188,1189,1194,1195,1198,1199,1202,1203,1205],{},[19,1190,1191],{},[14,1192,1193],{},"RotatingFileHandler(maxBytes=..., backupCount=...)"," renames ",[14,1196,1197],{},"mytool.log"," to ",[14,1200,1201],{},"mytool.log.1"," (and shifts older files up) when the file would exceed the size limit, keeping at most ",[14,1204,596],{}," old files. One megabyte and three backups caps disk use at about four megabytes — plenty for recent history, never a disk-filling surprise.",[10,1207,1208,1213,1214,1217],{},[19,1209,1210],{},[14,1211,1212],{},"delay=True"," opens the file only when the first record is written, so commands that log nothing (such as ",[14,1215,1216],{},"--help",") never create or touch the file.",[10,1219,1220,1225,1226,32],{},[19,1221,1222],{},[14,1223,1224],{},"encoding=\"utf-8\""," makes the log readable on every platform and immune to the Windows code-page problems described in ",[28,1227,1229],{"href":1228},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Ffixing-unicode-and-encoding-errors-on-windows\u002F","fixing Unicode and encoding errors on Windows",[10,1231,1232,1235,1236,1240],{},[19,1233,1234],{},"The file format carries timestamps and the process ID."," The console format is terse for humans; the file format includes when and which run, so interleaved runs can be told apart. For machine-parsed logs, use the JSON formatter from ",[28,1237,1239],{"href":1238},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis\u002F","structured JSON logging in Python CLIs"," on the file handler only.",[10,1242,1243,1246],{},[19,1244,1245],{},"Failure to set up file logging is not fatal."," A read-only home directory, a full disk or a locked-down container must not stop the tool; it logs one warning and continues with console logging only.",[10,1248,1249,1252,1253,1255,1256,1258,1259,1262,1263,1267],{},[19,1250,1251],{},"Noisy libraries are turned down."," At ",[14,1254,77],{},", HTTP libraries log every connection detail; capping them at ",[14,1257,478],{}," keeps the file useful. (Turn them up with a dedicated ",[14,1260,1261],{},"--debug-http"," flag when needed — with ",[28,1264,1266],{"href":1265},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fredacting-secrets-from-cli-output-and-logs\u002F","secret redaction"," in place.)",[10,1269,1270,1273,1274,1277],{},[19,1271,1272],{},"Configuration is idempotent."," Removing existing handlers first means calling ",[14,1275,1276],{},"configure_logging"," twice — in tests, or from a long-lived process — never duplicates output.",[34,1279,1281],{"id":1280},"choosing-a-rotation-strategy","Choosing a rotation strategy",[65,1283],{"name":1284},"rot-kinds",[10,1286,1287,1288,1291],{},"Size-based rotation suits most CLIs: it bounds disk use regardless of how often the tool runs. Time-based rotation (",[14,1289,1290],{},"TimedRotatingFileHandler",") suits long-running services, where \"yesterday's log\" is a meaningful unit. One file per run — named with a timestamp and pruned to the last N — suits batch jobs and CI, where each run's log may be uploaded as an artefact.",[10,1293,1294,1295,32],{},"One caveat applies to all of them: rotation is not coordinated across processes. Two invocations running at once can both decide to rotate, occasionally losing a few lines of the older file. For interactive CLIs that is acceptable; for a service that runs many concurrent workers, log to stderr and let the supervisor (journald, Docker) collect and rotate, as discussed in ",[28,1296,1298],{"href":1297},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Frunning-a-cli-on-a-schedule-with-cron-and-systemd\u002F","running a CLI on a schedule with cron and systemd",[34,1300,1302],{"id":1301},"ux-considerations","UX considerations",[65,1304],{"name":1305},"rot-terminal",[39,1307,1308,1314,1335,1341],{},[42,1309,1310,1313],{},[19,1311,1312],{},"Point to the log on failure."," \"details: ~\u002F.local\u002Fstate\u002Fmytool\u002Flog\u002Fmytool.log\" turns a one-line error into a complete story the user can attach to a bug report.",[42,1315,1316,1319,1320,1323,1324,1327,1328,1323,1331,1334],{},[19,1317,1318],{},"Make the location discoverable."," Include the log path in ",[14,1321,1322],{},"mytool paths"," or ",[14,1325,1326],{},"mytool doctor"," output, and allow ",[14,1329,1330],{},"--log-file",[14,1332,1333],{},"MYTOOL_LOG_FILE"," to override it.",[42,1336,1337,1340],{},[19,1338,1339],{},"Never write secrets to the file."," A persistent log lives longer and travels further than terminal output; attach the redaction filter to the file handler.",[42,1342,1343,1346,1347,1350,1351,1354],{},[19,1344,1345],{},"Offer an opt-out."," Some environments forbid writing logs to disk; ",[14,1348,1349],{},"MYTOOL_LOG_FILE="," set to an empty value, or ",[14,1352,1353],{},"--no-log-file",", should disable it.",[34,1356,1358],{"id":1357},"testing-the-behaviour","Testing the behaviour",[10,1360,1361,1362,1365,1366,1369,1370,1373],{},"Point the file handler at ",[14,1363,1364],{},"tmp_path",", run commands through ",[14,1367,1368],{},"CliRunner",", and call ",[14,1371,1372],{},"logging.shutdown()"," before reading the file so buffered data is flushed and the handle released:",[88,1375,1377],{"className":90,"code":1376,"language":92,"meta":93,"style":93},"# tests\u002Ftest_logging.py\nimport logging\n\nfrom typer.testing import CliRunner\n\nfrom mytool.cli import app\nfrom mytool.logsetup import configure_logging\n\nrunner = CliRunner()\n\n\ndef test_file_gets_debug_console_stays_quiet(tmp_path):\n    log_file = tmp_path \u002F \"logs\" \u002F \"mytool.log\"\n    result = runner.invoke(app, [\"sync\"], env={\"MYTOOL_LOG_FILE\": str(log_file)})\n    assert result.exit_code == 0\n    assert result.output == \"\"                             # nothing at WARNING or above\n    logging.shutdown()\n    text = log_file.read_text(encoding=\"utf-8\")\n    assert \"item 2 processed\" in text and \"DEBUG\" in text\n\n\ndef test_failure_points_at_the_log(tmp_path):\n    log_file = tmp_path \u002F \"mytool.log\"\n    result = runner.invoke(app, [\"sync\", \"--fail\"], env={\"MYTOOL_LOG_FILE\": str(log_file)})\n    assert result.exit_code == 1\n    assert \"sync failed\" in result.output and str(log_file) in result.output\n\n\ndef test_rotation_keeps_a_bounded_number_of_files(tmp_path):\n    path = tmp_path \u002F \"mytool.log\"\n    configure_logging(0, path, max_bytes=2_000, backups=2)\n    logger = logging.getLogger(\"rot\")\n    for i in range(500):\n        logger.debug(\"line %04d %s\", i, \"x\" * 40)\n    logging.shutdown()\n    assert sorted(p.name for p in tmp_path.iterdir()) == [\"mytool.log\", \"mytool.log.1\", \"mytool.log.2\"]\n\n\ndef test_unwritable_location_disables_file_logging(tmp_path):\n    blocker = tmp_path \u002F \"not-a-dir\"\n    blocker.write_text(\"\")\n    assert configure_logging(0, blocker \u002F \"mytool.log\") is None\n",[14,1378,1379,1384,1390,1394,1406,1410,1422,1432,1436,1446,1450,1454,1464,1484,1517,1531,1546,1551,1569,1593,1597,1601,1610,1622,1653,1664,1688,1692,1696,1705,1717,1747,1761,1778,1808,1812,1853,1857,1861,1870,1884,1894],{"__ignoreMap":93},[97,1380,1381],{"class":99,"line":100},[97,1382,1383],{"class":103},"# tests\u002Ftest_logging.py\n",[97,1385,1386,1388],{"class":99,"line":107},[97,1387,135],{"class":110},[97,1389,138],{"class":121},[97,1391,1392],{"class":99,"line":125},[97,1393,129],{"emptyLinePlaceholder":128},[97,1395,1396,1398,1401,1403],{"class":99,"line":132},[97,1397,111],{"class":110},[97,1399,1400],{"class":121}," typer.testing ",[97,1402,135],{"class":110},[97,1404,1405],{"class":121}," CliRunner\n",[97,1407,1408],{"class":99,"line":141},[97,1409,129],{"emptyLinePlaceholder":128},[97,1411,1412,1414,1417,1419],{"class":99,"line":149},[97,1413,111],{"class":110},[97,1415,1416],{"class":121}," mytool.cli ",[97,1418,135],{"class":110},[97,1420,1421],{"class":121}," app\n",[97,1423,1424,1426,1428,1430],{"class":99,"line":157},[97,1425,111],{"class":110},[97,1427,817],{"class":121},[97,1429,135],{"class":110},[97,1431,822],{"class":121},[97,1433,1434],{"class":99,"line":170},[97,1435,129],{"emptyLinePlaceholder":128},[97,1437,1438,1441,1443],{"class":99,"line":175},[97,1439,1440],{"class":121},"runner ",[97,1442,272],{"class":110},[97,1444,1445],{"class":121}," CliRunner()\n",[97,1447,1448],{"class":99,"line":188},[97,1449,129],{"emptyLinePlaceholder":128},[97,1451,1452],{"class":99,"line":193},[97,1453,129],{"emptyLinePlaceholder":128},[97,1455,1456,1458,1461],{"class":99,"line":230},[97,1457,243],{"class":110},[97,1459,1460],{"class":246}," test_file_gets_debug_console_stays_quiet",[97,1462,1463],{"class":121},"(tmp_path):\n",[97,1465,1466,1469,1471,1474,1476,1479,1482],{"class":99,"line":235},[97,1467,1468],{"class":121},"    log_file ",[97,1470,272],{"class":110},[97,1472,1473],{"class":121}," tmp_path ",[97,1475,281],{"class":110},[97,1477,1478],{"class":202}," \"logs\"",[97,1480,1481],{"class":110}," \u002F",[97,1483,284],{"class":202},[97,1485,1486,1489,1491,1494,1497,1500,1503,1505,1507,1509,1511,1514],{"class":99,"line":240},[97,1487,1488],{"class":121},"    result ",[97,1490,272],{"class":110},[97,1492,1493],{"class":121}," runner.invoke(app, [",[97,1495,1496],{"class":202},"\"sync\"",[97,1498,1499],{"class":121},"], ",[97,1501,1502],{"class":268},"env",[97,1504,272],{"class":110},[97,1506,1111],{"class":121},[97,1508,937],{"class":202},[97,1510,501],{"class":121},[97,1512,1513],{"class":114},"str",[97,1515,1516],{"class":121},"(log_file)})\n",[97,1518,1519,1522,1525,1528],{"class":99,"line":253},[97,1520,1521],{"class":110},"    assert",[97,1523,1524],{"class":121}," result.exit_code ",[97,1526,1527],{"class":110},"==",[97,1529,1530],{"class":114}," 0\n",[97,1532,1533,1535,1538,1540,1543],{"class":99,"line":287},[97,1534,1521],{"class":110},[97,1536,1537],{"class":121}," result.output ",[97,1539,1527],{"class":110},[97,1541,1542],{"class":202}," \"\"",[97,1544,1545],{"class":103},"                             # nothing at WARNING or above\n",[97,1547,1548],{"class":99,"line":292},[97,1549,1550],{"class":121},"    logging.shutdown()\n",[97,1552,1553,1556,1558,1561,1563,1565,1567],{"class":99,"line":297},[97,1554,1555],{"class":121},"    text ",[97,1557,272],{"class":110},[97,1559,1560],{"class":121}," log_file.read_text(",[97,1562,604],{"class":268},[97,1564,272],{"class":110},[97,1566,609],{"class":202},[97,1568,407],{"class":121},[97,1570,1571,1573,1576,1579,1582,1585,1588,1590],{"class":99,"line":332},[97,1572,1521],{"class":110},[97,1574,1575],{"class":202}," \"item 2 processed\"",[97,1577,1578],{"class":110}," in",[97,1580,1581],{"class":121}," text ",[97,1583,1584],{"class":110},"and",[97,1586,1587],{"class":202}," \"DEBUG\"",[97,1589,1578],{"class":110},[97,1591,1592],{"class":121}," text\n",[97,1594,1595],{"class":99,"line":365},[97,1596,129],{"emptyLinePlaceholder":128},[97,1598,1599],{"class":99,"line":371},[97,1600,129],{"emptyLinePlaceholder":128},[97,1602,1603,1605,1608],{"class":99,"line":376},[97,1604,243],{"class":110},[97,1606,1607],{"class":246}," test_failure_points_at_the_log",[97,1609,1463],{"class":121},[97,1611,1612,1614,1616,1618,1620],{"class":99,"line":382},[97,1613,1468],{"class":121},[97,1615,272],{"class":110},[97,1617,1473],{"class":121},[97,1619,281],{"class":110},[97,1621,284],{"class":202},[97,1623,1624,1626,1628,1630,1632,1634,1637,1639,1641,1643,1645,1647,1649,1651],{"class":99,"line":388},[97,1625,1488],{"class":121},[97,1627,272],{"class":110},[97,1629,1493],{"class":121},[97,1631,1496],{"class":202},[97,1633,265],{"class":121},[97,1635,1636],{"class":202},"\"--fail\"",[97,1638,1499],{"class":121},[97,1640,1502],{"class":268},[97,1642,272],{"class":110},[97,1644,1111],{"class":121},[97,1646,937],{"class":202},[97,1648,501],{"class":121},[97,1650,1513],{"class":114},[97,1652,1516],{"class":121},[97,1654,1655,1657,1659,1661],{"class":99,"line":399},[97,1656,1521],{"class":110},[97,1658,1524],{"class":121},[97,1660,1527],{"class":110},[97,1662,1663],{"class":114}," 1\n",[97,1665,1666,1668,1671,1673,1675,1677,1680,1683,1685],{"class":99,"line":410},[97,1667,1521],{"class":110},[97,1669,1670],{"class":202}," \"sync failed\"",[97,1672,1578],{"class":110},[97,1674,1537],{"class":121},[97,1676,1584],{"class":110},[97,1678,1679],{"class":114}," str",[97,1681,1682],{"class":121},"(log_file) ",[97,1684,419],{"class":110},[97,1686,1687],{"class":121}," result.output\n",[97,1689,1690],{"class":99,"line":428},[97,1691,129],{"emptyLinePlaceholder":128},[97,1693,1694],{"class":99,"line":434},[97,1695,129],{"emptyLinePlaceholder":128},[97,1697,1698,1700,1703],{"class":99,"line":440},[97,1699,243],{"class":110},[97,1701,1702],{"class":246}," test_rotation_keeps_a_bounded_number_of_files",[97,1704,1463],{"class":121},[97,1706,1707,1709,1711,1713,1715],{"class":99,"line":445},[97,1708,524],{"class":121},[97,1710,272],{"class":110},[97,1712,1473],{"class":121},[97,1714,281],{"class":110},[97,1716,284],{"class":202},[97,1718,1719,1722,1724,1727,1730,1732,1735,1737,1740,1742,1745],{"class":99,"line":456},[97,1720,1721],{"class":121},"    configure_logging(",[97,1723,462],{"class":114},[97,1725,1726],{"class":121},", path, ",[97,1728,1729],{"class":268},"max_bytes",[97,1731,272],{"class":110},[97,1733,1734],{"class":114},"2_000",[97,1736,265],{"class":121},[97,1738,1739],{"class":268},"backups",[97,1741,272],{"class":110},[97,1743,1744],{"class":114},"2",[97,1746,407],{"class":121},[97,1748,1749,1752,1754,1756,1759],{"class":99,"line":489},[97,1750,1751],{"class":121},"    logger ",[97,1753,272],{"class":110},[97,1755,846],{"class":121},[97,1757,1758],{"class":202},"\"rot\"",[97,1760,407],{"class":121},[97,1762,1763,1765,1767,1769,1771,1773,1776],{"class":99,"line":510},[97,1764,413],{"class":110},[97,1766,1041],{"class":121},[97,1768,419],{"class":110},[97,1770,1046],{"class":114},[97,1772,1049],{"class":121},[97,1774,1775],{"class":114},"500",[97,1777,725],{"class":121},[97,1779,1780,1783,1786,1789,1792,1794,1797,1800,1803,1806],{"class":99,"line":516},[97,1781,1782],{"class":121},"        logger.debug(",[97,1784,1785],{"class":202},"\"line ",[97,1787,1788],{"class":114},"%04d",[97,1790,1791],{"class":114}," %s",[97,1793,495],{"class":202},[97,1795,1796],{"class":121},", i, ",[97,1798,1799],{"class":202},"\"x\"",[97,1801,1802],{"class":110}," *",[97,1804,1805],{"class":114}," 40",[97,1807,407],{"class":121},[97,1809,1810],{"class":99,"line":521},[97,1811,1550],{"class":121},[97,1813,1814,1816,1819,1822,1825,1828,1830,1833,1835,1837,1840,1842,1845,1847,1850],{"class":99,"line":538},[97,1815,1521],{"class":110},[97,1817,1818],{"class":114}," sorted",[97,1820,1821],{"class":121},"(p.name ",[97,1823,1824],{"class":110},"for",[97,1826,1827],{"class":121}," p ",[97,1829,419],{"class":110},[97,1831,1832],{"class":121}," tmp_path.iterdir()) ",[97,1834,1527],{"class":110},[97,1836,215],{"class":121},[97,1838,1839],{"class":202},"\"mytool.log\"",[97,1841,265],{"class":121},[97,1843,1844],{"class":202},"\"mytool.log.1\"",[97,1846,265],{"class":121},[97,1848,1849],{"class":202},"\"mytool.log.2\"",[97,1851,1852],{"class":121},"]\n",[97,1854,1855],{"class":99,"line":546},[97,1856,129],{"emptyLinePlaceholder":128},[97,1858,1859],{"class":99,"line":571},[97,1860,129],{"emptyLinePlaceholder":128},[97,1862,1863,1865,1868],{"class":99,"line":582},[97,1864,243],{"class":110},[97,1866,1867],{"class":246}," test_unwritable_location_disables_file_logging",[97,1869,1463],{"class":121},[97,1871,1872,1875,1877,1879,1881],{"class":99,"line":623},[97,1873,1874],{"class":121},"    blocker ",[97,1876,272],{"class":110},[97,1878,1473],{"class":121},[97,1880,281],{"class":110},[97,1882,1883],{"class":202}," \"not-a-dir\"\n",[97,1885,1886,1889,1892],{"class":99,"line":641},[97,1887,1888],{"class":121},"    blocker.write_text(",[97,1890,1891],{"class":202},"\"\"",[97,1893,407],{"class":121},[97,1895,1896,1898,1901,1903,1906,1908,1911,1913,1916],{"class":99,"line":664},[97,1897,1521],{"class":110},[97,1899,1900],{"class":121}," configure_logging(",[97,1902,462],{"class":114},[97,1904,1905],{"class":121},", blocker ",[97,1907,281],{"class":110},[97,1909,1910],{"class":202}," \"mytool.log\"",[97,1912,278],{"class":121},[97,1914,1915],{"class":110},"is",[97,1917,670],{"class":114},[10,1919,1920],{},"The rotation test writes enough records to force several rotations and asserts that exactly the configured number of backups exists — the property that keeps disks from filling. The last test proves the tool keeps working when the log location is unusable.",[34,1922,1924],{"id":1923},"conclusion","Conclusion",[10,1926,1927,1928,1930,1931,1933,1934,1936],{},"A persistent, rotating debug log gives you the detail of ",[14,1929,16],{}," for every run without making the terminal noisy. Log everything at ",[14,1932,77],{}," to a ",[14,1935,25],{}," in the platform log directory, filter the console handler by verbosity, write UTF-8 with timestamps and process IDs, create the file lazily, keep going when the location is unwritable, and point users at the file when something fails. Bounded, discoverable and redacted, it turns hard-to-reproduce bug reports into diagnosable ones.",[34,1938,1940],{"id":1939},"frequently-asked-questions","Frequently asked questions",[1183,1942,1944],{"id":1943},"should-every-run-log-to-a-file-by-default","Should every run log to a file by default?",[10,1946,1947],{},"For interactive tools used by a team, yes — the cost is a few kilobytes per run and the benefit arrives exactly when something rare goes wrong. For tools run thousands of times a minute by automation, default to stderr only and make file logging opt-in.",[1183,1949,1951],{"id":1950},"where-do-logs-go-on-each-platform","Where do logs go on each platform?",[10,1953,1954,1957,1958,1961,1962,1965,1966,1969],{},[14,1955,1956],{},"platformdirs.user_log_path"," gives ",[14,1959,1960],{},"~\u002F.local\u002Fstate\u002Fmytool\u002Flog"," on Linux, ",[14,1963,1964],{},"~\u002FLibrary\u002FLogs\u002Fmytool"," on macOS and ",[14,1967,1968],{},"%LOCALAPPDATA%\\mytool\\Logs"," on Windows — the locations system tools and users expect.",[1183,1971,1973],{"id":1972},"how-do-i-include-the-full-traceback-in-the-file-but-not-on-screen","How do I include the full traceback in the file but not on screen?",[10,1975,1976,1977,1980,1981,1984,1985,32],{},"Log exceptions with ",[14,1978,1979],{},"log.exception(...)"," (or ",[14,1982,1983],{},"exc_info=True",") at the top-level handler: the file handler records the traceback, while the console formatter can show only the message. Friendly console errors are covered in ",[28,1986,1988],{"href":1987},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks\u002F","friendly error messages and tracebacks",[1183,1990,1992],{"id":1991},"how-do-i-tell-runs-apart-inside-one-log-file","How do I tell runs apart inside one log file?",[10,1994,1995,1996,1999,2000,32],{},"The process ID in the file format already separates concurrent runs; adding a short run ID to every record makes it trivial to extract one run with ",[14,1997,1998],{},"grep",", and lets error messages say \"run 7f3a9c failed\". The technique, including passing the same ID to APIs you call, is in ",[28,2001,2003],{"href":2002},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-trace-ids-and-context-to-cli-logs\u002F","adding trace IDs and context to CLI logs",[1183,2005,2007],{"id":2006},"can-i-use-loguru-instead","Can I use loguru instead?",[10,2009,2010,2011,2014],{},"loguru has built-in rotation and a pleasant API, and is a reasonable choice for applications. For a CLI whose libraries use standard ",[14,2012,2013],{},"logging",", sticking with the standard library avoids bridging two logging systems.",[34,2016,2018],{"id":2017},"related","Related",[39,2020,2021,2027,2033,2038,2043],{},[42,2022,2023,2024],{},"Up: ",[28,2025,2026],{"href":30},"Structured logging for CLI apps",[42,2028,2029],{},[28,2030,2032],{"href":2031},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags\u002F","Adding verbose and quiet logging flags",[42,2034,2035],{},[28,2036,2037],{"href":1238},"Structured JSON logging in Python CLIs",[42,2039,2040],{},[28,2041,2042],{"href":2002},"Adding trace IDs and context to CLI logs",[42,2044,2045],{},[28,2046,2047],{"href":51},"Storing app data with platformdirs",[2049,2050,2051],"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":93,"searchDepth":107,"depth":107,"links":2053},[2054,2055,2056,2059,2060,2061,2062,2063,2070],{"id":36,"depth":107,"text":37},{"id":62,"depth":107,"text":63},{"id":85,"depth":107,"text":86,"children":2057},[2058],{"id":1185,"depth":125,"text":1186},{"id":1280,"depth":107,"text":1281},{"id":1301,"depth":107,"text":1302},{"id":1357,"depth":107,"text":1358},{"id":1923,"depth":107,"text":1924},{"id":1939,"depth":107,"text":1940,"children":2064},[2065,2066,2067,2068,2069],{"id":1943,"depth":125,"text":1944},{"id":1950,"depth":125,"text":1951},{"id":1972,"depth":125,"text":1973},{"id":1991,"depth":125,"text":1992},{"id":2006,"depth":125,"text":2007},{"id":2017,"depth":107,"text":2018},"2026-09-18","Keep a detailed debug log on disk while the terminal stays quiet: RotatingFileHandler in the platform log directory, per-handler levels, failure hints and tests.","intermediate",false,"md",{},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fwriting-rotating-log-files-from-a-cli",{"title":5,"description":2072},"advanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fwriting-rotating-log-files-from-a-cli\u002Findex",[2013,2081,2082,2083],"log-files","rotation","debugging","AZuCMqC7-EXekKfp9YuSvds2zH03UxGB0P2SdZeU5MU",[2086,2089,2092,2095,2098,2101,2104,2107,2110,2113,2116,2119,2122,2125,2128,2131,2134,2137,2140,2143,2146,2149,2152,2155,2158,2161,2164,2167,2170,2173,2176,2179,2182,2185,2188,2191,2194,2197,2200,2203,2206,2209,2212,2215,2218,2221,2224,2227,2230,2231,2234,2237,2240,2243,2246,2249,2252,2255,2258,2261,2264,2267,2270,2273,2276,2279,2282,2285,2288,2291,2294,2297,2300,2303,2306,2309,2312,2315,2318,2321,2324,2327,2330,2333,2336,2339,2342,2345,2348,2351,2354,2357,2359,2362,2365,2368,2371,2374,2377,2380,2383,2386,2389,2392,2395,2398,2401,2404,2407,2410,2413,2416,2419,2422,2425,2428,2431,2434,2437,2440,2443,2446,2449,2452,2455,2458,2461,2464,2467,2470,2473,2476,2479,2482,2485,2488,2491,2494,2497,2500,2503,2506,2509,2512,2515,2518,2521,2524,2527,2530,2533,2536,2539,2542,2545,2548,2551,2554,2557,2560,2563,2566,2569,2572,2575,2578,2581,2584,2587,2590,2593,2596,2599,2602,2605,2608,2611,2614,2617,2620,2623,2626,2629],{"path":2087,"title":2088},"\u002Fabout","About Python CLI Toolcraft",{"path":2090,"title":2091},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":2093,"title":2094},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":2096,"title":2097},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":2099,"title":2100},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2102,"title":2103},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2105,"title":2106},"\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":2108,"title":2109},"\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":2111,"title":2112},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2114,"title":2115},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2117,"title":2118},"\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":2120,"title":2121},"\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":2123,"title":2124},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2126,"title":2127},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2129,"title":2130},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2132,"title":2133},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2135,"title":2136},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2138,"title":2139},"\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":2141,"title":2142},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2144,"title":2145},"\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":2147,"title":2148},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2150,"title":2151},"\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":2153,"title":2154},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2156,"title":2157},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2159,"title":2160},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2162,"title":2163},"\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":2165,"title":2166},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2168,"title":2169},"\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":2171,"title":2172},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2174,"title":2175},"\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":2177,"title":2178},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2180,"title":2181},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2183,"title":2184},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2186,"title":2187},"\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":2189,"title":2190},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2192,"title":2193},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2195,"title":2196},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2198,"title":2199},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2201,"title":2202},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2204,"title":2205},"\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":2207,"title":2208},"\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":2210,"title":2211},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2213,"title":2214},"\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":2216,"title":2217},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2219,"title":2220},"\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":2222,"title":2223},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2225,"title":2226},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2228,"title":2229},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2077,"title":5},{"path":2232,"title":2233},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2235,"title":2236},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2238,"title":2239},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2241,"title":2242},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2244,"title":2245},"\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":2247,"title":2248},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2250,"title":2251},"\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":2253,"title":2254},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2256,"title":2257},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2259,"title":2260},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2262,"title":2263},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2265,"title":2266},"\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":2268,"title":2269},"\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":2271,"title":2272},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2274,"title":2275},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2277,"title":2278},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2280,"title":2281},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2283,"title":2284},"\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":2286,"title":2287},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2289,"title":2290},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2292,"title":2293},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2295,"title":2296},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2298,"title":2299},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2301,"title":2302},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2304,"title":2305},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2307,"title":2308},"\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":2310,"title":2311},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2313,"title":2314},"\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":2316,"title":2317},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2319,"title":2320},"\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":2322,"title":2323},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2325,"title":2326},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2328,"title":2329},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2331,"title":2332},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2334,"title":2335},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2337,"title":2338},"\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":2340,"title":2341},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2343,"title":2344},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2346,"title":2347},"\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":2349,"title":2350},"\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":2352,"title":2353},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2355,"title":2356},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":281,"title":2358},"Python CLI Toolcraft",{"path":2360,"title":2361},"\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":2363,"title":2364},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2366,"title":2367},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2369,"title":2370},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2372,"title":2373},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2375,"title":2376},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2378,"title":2379},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2381,"title":2382},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2384,"title":2385},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2387,"title":2388},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2390,"title":2391},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2393,"title":2394},"\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":2396,"title":2397},"\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":2399,"title":2400},"\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":2402,"title":2403},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2405,"title":2406},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2408,"title":2409},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2411,"title":2412},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2414,"title":2415},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2417,"title":2418},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2420,"title":2421},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2423,"title":2424},"\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":2426,"title":2427},"\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":2429,"title":2430},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2432,"title":2433},"\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":2435,"title":2436},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2438,"title":2439},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2441,"title":2442},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2444,"title":2445},"\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":2447,"title":2448},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2450,"title":2451},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2453,"title":2454},"\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":2456,"title":2457},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2459,"title":2460},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2462,"title":2463},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2465,"title":2466},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2468,"title":2469},"\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":2471,"title":2472},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2474,"title":2475},"\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":2477,"title":2478},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2480,"title":2481},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2483,"title":2484},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2486,"title":2487},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2489,"title":2490},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2492,"title":2493},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2495,"title":2496},"\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":2498,"title":2499},"\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":2501,"title":2502},"\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":2504,"title":2505},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2507,"title":2508},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2510,"title":2511},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2513,"title":2514},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2516,"title":2517},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2519,"title":2520},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2522,"title":2523},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2525,"title":2526},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2528,"title":2529},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2531,"title":2532},"\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":2534,"title":2535},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2537,"title":2538},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2540,"title":2541},"\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":2543,"title":2544},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2546,"title":2547},"\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":2549,"title":2550},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2552,"title":2553},"\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":2555,"title":2556},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2558,"title":2559},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2561,"title":2562},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2564,"title":2565},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2567,"title":2568},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2570,"title":2571},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2573,"title":2574},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2576,"title":2577},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2579,"title":2580},"\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":2582,"title":2583},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2585,"title":2586},"\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":2588,"title":2589},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2591,"title":2592},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2594,"title":2595},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2597,"title":2598},"\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":2600,"title":2601},"\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":2603,"title":2604},"\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":2606,"title":2607},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2609,"title":2610},"\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":2612,"title":2613},"\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":2615,"title":2616},"\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":2618,"title":2619},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2621,"title":2622},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2624,"title":2625},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2627,"title":2628},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2630,"title":2631},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1789736905047]