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