[{"data":1,"prerenderedAt":2895},["ShallowReactive",2],{"page-\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwalking-directory-trees-with-ignore-rules\u002F":3,"content-directory":2051},{"id":4,"title":5,"body":6,"date":2036,"description":2037,"difficulty":2038,"draft":2039,"extension":2040,"meta":2041,"navigation":142,"path":2042,"seo":2043,"stem":2044,"tags":2045,"updated":2036,"__hash__":2050},"content\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwalking-directory-trees-with-ignore-rules\u002Findex.md","Walking Directory Trees with Ignore Rules in a Python CLI",{"type":7,"value":8,"toc":2014},"minimark",[9,48,53,74,78,82,97,101,616,619,672,708,711,716,1021,1032,1036,1051,1239,1253,1256,1260,1300,1304,1360,1364,1371,1889,1892,1896,1908,1912,1922,1932,1940,1953,1957,1964,1968,1975,1979,2010],[10,11,12,13,17,18,21,22,25,26,29,30,33,34,37,38,41,42,47],"p",{},"Linters, formatters, sync tools, code generators, search tools — a large share of CLIs start by walking a directory tree. And every one of them meets the same expectations from users: do not descend into ",[14,15,16],"code",{},".git",", ",[14,19,20],{},".venv"," or ",[14,23,24],{},"node_modules","; respect ",[14,27,28],{},".gitignore","; let me add my own exclusions; and do it fast even in a repository with two hundred thousand files. ",[14,31,32],{},"Path.rglob(\"*\")"," gets none of that right: it visits everything, including the virtual environment with its tens of thousands of files, and filtering afterwards wastes all that work. This guide builds a walker that prunes ignored directories before entering them, understands gitignore syntax — including negation — through the ",[14,35,36],{},"pathspec"," library, supports a tool-specific ignore file and command-line excludes, and offers ",[14,39,40],{},"git ls-files"," as an exact alternative inside repositories. It belongs to the ",[43,44,46],"a",{"href":45},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002F","filesystem topic",".",[49,50,52],"h2",{"id":51},"prerequisites","Prerequisites",[54,55,56,67],"ul",{},[57,58,59,60,62,63,66],"li",{},"Python 3.10+ and ",[14,61,36],{}," (",[14,64,65],{},"uv add pathspec","), the gitignore-matching library used by Black and many other tools.",[57,68,69,70,47],{},"Familiarity with ",[43,71,73],{"href":72},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib\u002F","cross-platform paths with pathlib",[49,75,77],{"id":76},"prune-do-not-filter","Prune, do not filter",[79,80],"inline-diagram",{"name":81},"treewalk-prune",[10,83,84,85,89,90,92,93,96],{},"The single most important performance decision is ",[86,87,88],"em",{},"when"," ignore rules apply. Filtering after a full traversal still reads every directory under ",[14,91,24],{},". ",[14,94,95],{},"os.walk"," lets you edit the list of subdirectories in place before it descends, so an ignored directory is never opened at all — in a typical JavaScript-adjacent Python repository, that is the difference between a walk that takes seconds and one that takes milliseconds.",[49,98,100],{"id":99},"the-recipe","The recipe",[102,103,108],"pre",{"className":104,"code":105,"language":106,"meta":107,"style":107},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fwalk.py\nfrom __future__ import annotations\n\nimport os\nfrom collections.abc import Iterator, Sequence\nfrom pathlib import Path\n\nimport pathspec\n\nALWAYS_SKIP = [\".git\u002F\", \"__pycache__\u002F\", \".venv\u002F\", \"node_modules\u002F\"]\n\n\ndef load_spec(root: Path, extra: Sequence[str] = (),\n              ignore_files: Sequence[str] = (\".gitignore\", \".mytoolignore\")) -> pathspec.GitIgnoreSpec:\n    \"\"\"Combine built-in skips, ignore files at the root, and --exclude patterns.\"\"\"\n    lines = list(ALWAYS_SKIP)\n    for name in ignore_files:\n        f = root \u002F name\n        if f.is_file():\n            lines += f.read_text(encoding=\"utf-8\").splitlines()\n    lines += list(extra)                       # command-line excludes come last and win\n    return pathspec.GitIgnoreSpec.from_lines(lines)\n\n\ndef walk_files(root: Path, spec: pathspec.GitIgnoreSpec, *,\n               follow_symlinks: bool = False) -> Iterator[Path]:\n    root = root.resolve()\n    for dirpath, dirnames, filenames in os.walk(root, followlinks=follow_symlinks):\n        rel_dir = Path(dirpath).relative_to(root)\n        # Prune in place: os.walk never descends into directories removed here.\n        dirnames[:] = sorted(d for d in dirnames\n                             if not spec.match_file(f\"{(rel_dir \u002F d).as_posix()}\u002F\"))\n        for name in sorted(filenames):\n            rel = (rel_dir \u002F name).as_posix()\n            if not spec.match_file(rel):\n                yield root \u002F rel\n","python","",[14,109,110,119,137,144,153,166,179,184,192,197,231,236,241,266,291,297,316,331,348,357,381,396,405,410,415,432,449,460,481,492,498,523,561,576,592,603],{"__ignoreMap":107},[111,112,115],"span",{"class":113,"line":114},"line",1,[111,116,118],{"class":117},"sJ8bj","# src\u002Fmytool\u002Fwalk.py\n",[111,120,122,126,130,133],{"class":113,"line":121},2,[111,123,125],{"class":124},"szBVR","from",[111,127,129],{"class":128},"sj4cs"," __future__",[111,131,132],{"class":124}," import",[111,134,136],{"class":135},"sVt8B"," annotations\n",[111,138,140],{"class":113,"line":139},3,[111,141,143],{"emptyLinePlaceholder":142},true,"\n",[111,145,147,150],{"class":113,"line":146},4,[111,148,149],{"class":124},"import",[111,151,152],{"class":135}," os\n",[111,154,156,158,161,163],{"class":113,"line":155},5,[111,157,125],{"class":124},[111,159,160],{"class":135}," collections.abc ",[111,162,149],{"class":124},[111,164,165],{"class":135}," Iterator, Sequence\n",[111,167,169,171,174,176],{"class":113,"line":168},6,[111,170,125],{"class":124},[111,172,173],{"class":135}," pathlib ",[111,175,149],{"class":124},[111,177,178],{"class":135}," Path\n",[111,180,182],{"class":113,"line":181},7,[111,183,143],{"emptyLinePlaceholder":142},[111,185,187,189],{"class":113,"line":186},8,[111,188,149],{"class":124},[111,190,191],{"class":135}," pathspec\n",[111,193,195],{"class":113,"line":194},9,[111,196,143],{"emptyLinePlaceholder":142},[111,198,200,203,206,209,213,215,218,220,223,225,228],{"class":113,"line":199},10,[111,201,202],{"class":128},"ALWAYS_SKIP",[111,204,205],{"class":124}," =",[111,207,208],{"class":135}," [",[111,210,212],{"class":211},"sZZnC","\".git\u002F\"",[111,214,17],{"class":135},[111,216,217],{"class":211},"\"__pycache__\u002F\"",[111,219,17],{"class":135},[111,221,222],{"class":211},"\".venv\u002F\"",[111,224,17],{"class":135},[111,226,227],{"class":211},"\"node_modules\u002F\"",[111,229,230],{"class":135},"]\n",[111,232,234],{"class":113,"line":233},11,[111,235,143],{"emptyLinePlaceholder":142},[111,237,239],{"class":113,"line":238},12,[111,240,143],{"emptyLinePlaceholder":142},[111,242,244,247,251,254,257,260,263],{"class":113,"line":243},13,[111,245,246],{"class":124},"def",[111,248,250],{"class":249},"sScJk"," load_spec",[111,252,253],{"class":135},"(root: Path, extra: Sequence[",[111,255,256],{"class":128},"str",[111,258,259],{"class":135},"] ",[111,261,262],{"class":124},"=",[111,264,265],{"class":135}," (),\n",[111,267,269,272,274,276,278,280,283,285,288],{"class":113,"line":268},14,[111,270,271],{"class":135},"              ignore_files: Sequence[",[111,273,256],{"class":128},[111,275,259],{"class":135},[111,277,262],{"class":124},[111,279,62],{"class":135},[111,281,282],{"class":211},"\".gitignore\"",[111,284,17],{"class":135},[111,286,287],{"class":211},"\".mytoolignore\"",[111,289,290],{"class":135},")) -> pathspec.GitIgnoreSpec:\n",[111,292,294],{"class":113,"line":293},15,[111,295,296],{"class":211},"    \"\"\"Combine built-in skips, ignore files at the root, and --exclude patterns.\"\"\"\n",[111,298,300,303,305,308,311,313],{"class":113,"line":299},16,[111,301,302],{"class":135},"    lines ",[111,304,262],{"class":124},[111,306,307],{"class":128}," list",[111,309,310],{"class":135},"(",[111,312,202],{"class":128},[111,314,315],{"class":135},")\n",[111,317,319,322,325,328],{"class":113,"line":318},17,[111,320,321],{"class":124},"    for",[111,323,324],{"class":135}," name ",[111,326,327],{"class":124},"in",[111,329,330],{"class":135}," ignore_files:\n",[111,332,334,337,339,342,345],{"class":113,"line":333},18,[111,335,336],{"class":135},"        f ",[111,338,262],{"class":124},[111,340,341],{"class":135}," root ",[111,343,344],{"class":124},"\u002F",[111,346,347],{"class":135}," name\n",[111,349,351,354],{"class":113,"line":350},19,[111,352,353],{"class":124},"        if",[111,355,356],{"class":135}," f.is_file():\n",[111,358,360,363,366,369,373,375,378],{"class":113,"line":359},20,[111,361,362],{"class":135},"            lines ",[111,364,365],{"class":124},"+=",[111,367,368],{"class":135}," f.read_text(",[111,370,372],{"class":371},"s4XuR","encoding",[111,374,262],{"class":124},[111,376,377],{"class":211},"\"utf-8\"",[111,379,380],{"class":135},").splitlines()\n",[111,382,384,386,388,390,393],{"class":113,"line":383},21,[111,385,302],{"class":135},[111,387,365],{"class":124},[111,389,307],{"class":128},[111,391,392],{"class":135},"(extra)                       ",[111,394,395],{"class":117},"# command-line excludes come last and win\n",[111,397,399,402],{"class":113,"line":398},22,[111,400,401],{"class":124},"    return",[111,403,404],{"class":135}," pathspec.GitIgnoreSpec.from_lines(lines)\n",[111,406,408],{"class":113,"line":407},23,[111,409,143],{"emptyLinePlaceholder":142},[111,411,413],{"class":113,"line":412},24,[111,414,143],{"emptyLinePlaceholder":142},[111,416,418,420,423,426,429],{"class":113,"line":417},25,[111,419,246],{"class":124},[111,421,422],{"class":249}," walk_files",[111,424,425],{"class":135},"(root: Path, spec: pathspec.GitIgnoreSpec, ",[111,427,428],{"class":124},"*",[111,430,431],{"class":135},",\n",[111,433,435,438,441,443,446],{"class":113,"line":434},26,[111,436,437],{"class":135},"               follow_symlinks: ",[111,439,440],{"class":128},"bool",[111,442,205],{"class":124},[111,444,445],{"class":128}," False",[111,447,448],{"class":135},") -> Iterator[Path]:\n",[111,450,452,455,457],{"class":113,"line":451},27,[111,453,454],{"class":135},"    root ",[111,456,262],{"class":124},[111,458,459],{"class":135}," root.resolve()\n",[111,461,463,465,468,470,473,476,478],{"class":113,"line":462},28,[111,464,321],{"class":124},[111,466,467],{"class":135}," dirpath, dirnames, filenames ",[111,469,327],{"class":124},[111,471,472],{"class":135}," os.walk(root, ",[111,474,475],{"class":371},"followlinks",[111,477,262],{"class":124},[111,479,480],{"class":135},"follow_symlinks):\n",[111,482,484,487,489],{"class":113,"line":483},29,[111,485,486],{"class":135},"        rel_dir ",[111,488,262],{"class":124},[111,490,491],{"class":135}," Path(dirpath).relative_to(root)\n",[111,493,495],{"class":113,"line":494},30,[111,496,497],{"class":117},"        # Prune in place: os.walk never descends into directories removed here.\n",[111,499,501,504,506,509,512,515,518,520],{"class":113,"line":500},31,[111,502,503],{"class":135},"        dirnames[:] ",[111,505,262],{"class":124},[111,507,508],{"class":128}," sorted",[111,510,511],{"class":135},"(d ",[111,513,514],{"class":124},"for",[111,516,517],{"class":135}," d ",[111,519,327],{"class":124},[111,521,522],{"class":135}," dirnames\n",[111,524,526,529,532,535,538,541,544,547,549,552,555,558],{"class":113,"line":525},32,[111,527,528],{"class":124},"                             if",[111,530,531],{"class":124}," not",[111,533,534],{"class":135}," spec.match_file(",[111,536,537],{"class":124},"f",[111,539,540],{"class":211},"\"",[111,542,543],{"class":128},"{",[111,545,546],{"class":135},"(rel_dir ",[111,548,344],{"class":124},[111,550,551],{"class":135}," d).as_posix()",[111,553,554],{"class":128},"}",[111,556,557],{"class":211},"\u002F\"",[111,559,560],{"class":135},"))\n",[111,562,564,567,569,571,573],{"class":113,"line":563},33,[111,565,566],{"class":124},"        for",[111,568,324],{"class":135},[111,570,327],{"class":124},[111,572,508],{"class":128},[111,574,575],{"class":135},"(filenames):\n",[111,577,579,582,584,587,589],{"class":113,"line":578},34,[111,580,581],{"class":135},"            rel ",[111,583,262],{"class":124},[111,585,586],{"class":135}," (rel_dir ",[111,588,344],{"class":124},[111,590,591],{"class":135}," name).as_posix()\n",[111,593,595,598,600],{"class":113,"line":594},35,[111,596,597],{"class":124},"            if",[111,599,531],{"class":124},[111,601,602],{"class":135}," spec.match_file(rel):\n",[111,604,606,609,611,613],{"class":113,"line":605},36,[111,607,608],{"class":124},"                yield",[111,610,341],{"class":135},[111,612,344],{"class":124},[111,614,615],{"class":135}," rel\n",[10,617,618],{},"A few details are easy to get wrong:",[54,620,621,638,648,666],{},[57,622,623,627,628,631,632,634,635,637],{},[624,625,626],"strong",{},"Directories are matched with a trailing slash."," A gitignore pattern such as ",[14,629,630],{},"build\u002F"," matches only directories; ",[14,633,36],{}," knows a path is a directory by the slash, so the pruning check appends one. Without it, ",[14,636,630],{}," would never match and the walker would descend into every build directory.",[57,639,640,643,644,647],{},[624,641,642],{},"Paths are relative and POSIX-style."," Gitignore patterns are written with forward slashes relative to the root, so matching uses ",[14,645,646],{},"as_posix()"," relative paths on every platform, including Windows.",[57,649,650,653,654,657,658,661,662,665],{},[624,651,652],{},"Order matters for negation."," Gitignore semantics are \"last matching pattern wins\", so ",[14,655,656],{},"!logs\u002Fkeep.log"," re-includes a file excluded by ",[14,659,660],{},"logs\u002F*.log"," above it. Putting command-line ",[14,663,664],{},"--exclude"," patterns last lets them override the ignore files.",[57,667,668,671],{},[624,669,670],{},"Sorting makes output deterministic,"," which keeps tests and diffs stable regardless of filesystem order.",[10,673,674,675,677,678,17,680,17,683,685,686,688,689,17,691,17,694,685,697,700,701,17,703,21,706,47],{},"Given a tree with a ",[14,676,28],{}," of ",[14,679,630],{},[14,681,682],{},"*.pyc",[14,684,660],{}," and ",[14,687,656],{},", the walker yields exactly ",[14,690,28],{},[14,692,693],{},"README.md",[14,695,696],{},"logs\u002Fkeep.log",[14,698,699],{},"src\u002Fpkg\u002Fa.py"," — never entering ",[14,702,16],{},[14,704,705],{},"build",[14,707,24],{},[79,709],{"name":710},"treewalk-terminal",[712,713,715],"h3",{"id":714},"wiring-it-into-a-command","Wiring it into a command",[102,717,719],{"className":104,"code":718,"language":106,"meta":107,"style":107},"# src\u002Fmytool\u002Fcli.py\nfrom pathlib import Path\nfrom typing import Annotated\n\nimport typer\n\nfrom mytool.walk import load_spec, walk_files\n\napp = typer.Typer()\n\n\n@app.callback()\ndef main() -> None:\n    \"\"\"File tool.\"\"\"\n\n\n@app.command()\ndef files(\n    root: Annotated[Path, typer.Argument(exists=True, file_okay=False)] = Path(\".\"),\n    exclude: Annotated[list[str], typer.Option(\"--exclude\", \"-x\", help=\"Gitignore-style pattern; repeatable.\")] = [],\n    no_ignore: Annotated[bool, typer.Option(\"--no-ignore\", help=\"Ignore .gitignore and .mytoolignore.\")] = False,\n) -> None:\n    \"\"\"List the files mytool would process.\"\"\"\n    spec = load_spec(root, exclude, ignore_files=() if no_ignore else (\".gitignore\", \".mytoolignore\"))\n    for path in walk_files(root, spec):\n        typer.echo(path.relative_to(root.resolve()).as_posix())\n",[14,720,721,726,736,748,752,759,763,775,779,789,793,797,805,821,826,830,834,841,851,888,923,953,962,967,1004,1016],{"__ignoreMap":107},[111,722,723],{"class":113,"line":114},[111,724,725],{"class":117},"# src\u002Fmytool\u002Fcli.py\n",[111,727,728,730,732,734],{"class":113,"line":121},[111,729,125],{"class":124},[111,731,173],{"class":135},[111,733,149],{"class":124},[111,735,178],{"class":135},[111,737,738,740,743,745],{"class":113,"line":139},[111,739,125],{"class":124},[111,741,742],{"class":135}," typing ",[111,744,149],{"class":124},[111,746,747],{"class":135}," Annotated\n",[111,749,750],{"class":113,"line":146},[111,751,143],{"emptyLinePlaceholder":142},[111,753,754,756],{"class":113,"line":155},[111,755,149],{"class":124},[111,757,758],{"class":135}," typer\n",[111,760,761],{"class":113,"line":168},[111,762,143],{"emptyLinePlaceholder":142},[111,764,765,767,770,772],{"class":113,"line":181},[111,766,125],{"class":124},[111,768,769],{"class":135}," mytool.walk ",[111,771,149],{"class":124},[111,773,774],{"class":135}," load_spec, walk_files\n",[111,776,777],{"class":113,"line":186},[111,778,143],{"emptyLinePlaceholder":142},[111,780,781,784,786],{"class":113,"line":194},[111,782,783],{"class":135},"app ",[111,785,262],{"class":124},[111,787,788],{"class":135}," typer.Typer()\n",[111,790,791],{"class":113,"line":199},[111,792,143],{"emptyLinePlaceholder":142},[111,794,795],{"class":113,"line":233},[111,796,143],{"emptyLinePlaceholder":142},[111,798,799,802],{"class":113,"line":238},[111,800,801],{"class":249},"@app.callback",[111,803,804],{"class":135},"()\n",[111,806,807,809,812,815,818],{"class":113,"line":243},[111,808,246],{"class":124},[111,810,811],{"class":249}," main",[111,813,814],{"class":135},"() -> ",[111,816,817],{"class":128},"None",[111,819,820],{"class":135},":\n",[111,822,823],{"class":113,"line":268},[111,824,825],{"class":211},"    \"\"\"File tool.\"\"\"\n",[111,827,828],{"class":113,"line":293},[111,829,143],{"emptyLinePlaceholder":142},[111,831,832],{"class":113,"line":299},[111,833,143],{"emptyLinePlaceholder":142},[111,835,836,839],{"class":113,"line":318},[111,837,838],{"class":249},"@app.command",[111,840,804],{"class":135},[111,842,843,845,848],{"class":113,"line":333},[111,844,246],{"class":124},[111,846,847],{"class":249}," files",[111,849,850],{"class":135},"(\n",[111,852,853,856,859,861,864,866,869,871,874,877,879,882,885],{"class":113,"line":350},[111,854,855],{"class":135},"    root: Annotated[Path, typer.Argument(",[111,857,858],{"class":371},"exists",[111,860,262],{"class":124},[111,862,863],{"class":128},"True",[111,865,17],{"class":135},[111,867,868],{"class":371},"file_okay",[111,870,262],{"class":124},[111,872,873],{"class":128},"False",[111,875,876],{"class":135},")] ",[111,878,262],{"class":124},[111,880,881],{"class":135}," Path(",[111,883,884],{"class":211},"\".\"",[111,886,887],{"class":135},"),\n",[111,889,890,893,895,898,901,903,906,908,911,913,916,918,920],{"class":113,"line":359},[111,891,892],{"class":135},"    exclude: Annotated[list[",[111,894,256],{"class":128},[111,896,897],{"class":135},"], typer.Option(",[111,899,900],{"class":211},"\"--exclude\"",[111,902,17],{"class":135},[111,904,905],{"class":211},"\"-x\"",[111,907,17],{"class":135},[111,909,910],{"class":371},"help",[111,912,262],{"class":124},[111,914,915],{"class":211},"\"Gitignore-style pattern; repeatable.\"",[111,917,876],{"class":135},[111,919,262],{"class":124},[111,921,922],{"class":135}," [],\n",[111,924,925,928,930,933,936,938,940,942,945,947,949,951],{"class":113,"line":383},[111,926,927],{"class":135},"    no_ignore: Annotated[",[111,929,440],{"class":128},[111,931,932],{"class":135},", typer.Option(",[111,934,935],{"class":211},"\"--no-ignore\"",[111,937,17],{"class":135},[111,939,910],{"class":371},[111,941,262],{"class":124},[111,943,944],{"class":211},"\"Ignore .gitignore and .mytoolignore.\"",[111,946,876],{"class":135},[111,948,262],{"class":124},[111,950,445],{"class":128},[111,952,431],{"class":135},[111,954,955,958,960],{"class":113,"line":398},[111,956,957],{"class":135},") -> ",[111,959,817],{"class":128},[111,961,820],{"class":135},[111,963,964],{"class":113,"line":407},[111,965,966],{"class":211},"    \"\"\"List the files mytool would process.\"\"\"\n",[111,968,969,972,974,977,980,982,985,988,991,994,996,998,1000,1002],{"class":113,"line":412},[111,970,971],{"class":135},"    spec ",[111,973,262],{"class":124},[111,975,976],{"class":135}," load_spec(root, exclude, ",[111,978,979],{"class":371},"ignore_files",[111,981,262],{"class":124},[111,983,984],{"class":135},"() ",[111,986,987],{"class":124},"if",[111,989,990],{"class":135}," no_ignore ",[111,992,993],{"class":124},"else",[111,995,62],{"class":135},[111,997,282],{"class":211},[111,999,17],{"class":135},[111,1001,287],{"class":211},[111,1003,560],{"class":135},[111,1005,1006,1008,1011,1013],{"class":113,"line":417},[111,1007,321],{"class":124},[111,1009,1010],{"class":135}," path ",[111,1012,327],{"class":124},[111,1014,1015],{"class":135}," walk_files(root, spec):\n",[111,1017,1018],{"class":113,"line":434},[111,1019,1020],{"class":135},"        typer.echo(path.relative_to(root.resolve()).as_posix())\n",[10,1022,1023,1024,1027,1028,1031],{},"A ",[14,1025,1026],{},"files"," (or ",[14,1029,1030],{},"--list-files",") command that shows exactly what the tool will process is the best debugging aid you can give users of an ignore-aware CLI; Ruff, Black and many others offer one.",[49,1033,1035],{"id":1034},"inside-a-git-repository-ask-git","Inside a git repository: ask git",[10,1037,1038,1040,1041,1043,1044,1046,1047,1050],{},[14,1039,36],{}," reads the root ",[14,1042,28],{},", but git's real rules are richer: nested ",[14,1045,28],{}," files in subdirectories, ",[14,1048,1049],{},".git\u002Finfo\u002Fexclude",", the user's global excludes file, and files that are tracked despite matching an ignore pattern. When the root is a git repository and you want git's exact view, ask git:",[102,1052,1054],{"className":104,"code":1053,"language":106,"meta":107,"style":107},"import subprocess\nfrom pathlib import Path\n\n\ndef git_files(root: Path) -> list[Path] | None:\n    \"\"\"Tracked plus untracked-but-not-ignored files, or None if not a git repo.\"\"\"\n    result = subprocess.run(\n        [\"git\", \"ls-files\", \"--cached\", \"--others\", \"--exclude-standard\", \"-z\"],\n        cwd=root, capture_output=True,\n    )\n    if result.returncode != 0:\n        return None\n    return [root \u002F p for p in result.stdout.decode(\"utf-8\").split(\"\\0\") if p]\n",[14,1055,1056,1063,1073,1077,1081,1099,1104,1114,1150,1169,1174,1190,1198],{"__ignoreMap":107},[111,1057,1058,1060],{"class":113,"line":114},[111,1059,149],{"class":124},[111,1061,1062],{"class":135}," subprocess\n",[111,1064,1065,1067,1069,1071],{"class":113,"line":121},[111,1066,125],{"class":124},[111,1068,173],{"class":135},[111,1070,149],{"class":124},[111,1072,178],{"class":135},[111,1074,1075],{"class":113,"line":139},[111,1076,143],{"emptyLinePlaceholder":142},[111,1078,1079],{"class":113,"line":146},[111,1080,143],{"emptyLinePlaceholder":142},[111,1082,1083,1085,1088,1091,1094,1097],{"class":113,"line":155},[111,1084,246],{"class":124},[111,1086,1087],{"class":249}," git_files",[111,1089,1090],{"class":135},"(root: Path) -> list[Path] ",[111,1092,1093],{"class":124},"|",[111,1095,1096],{"class":128}," None",[111,1098,820],{"class":135},[111,1100,1101],{"class":113,"line":168},[111,1102,1103],{"class":211},"    \"\"\"Tracked plus untracked-but-not-ignored files, or None if not a git repo.\"\"\"\n",[111,1105,1106,1109,1111],{"class":113,"line":181},[111,1107,1108],{"class":135},"    result ",[111,1110,262],{"class":124},[111,1112,1113],{"class":135}," subprocess.run(\n",[111,1115,1116,1119,1122,1124,1127,1129,1132,1134,1137,1139,1142,1144,1147],{"class":113,"line":186},[111,1117,1118],{"class":135},"        [",[111,1120,1121],{"class":211},"\"git\"",[111,1123,17],{"class":135},[111,1125,1126],{"class":211},"\"ls-files\"",[111,1128,17],{"class":135},[111,1130,1131],{"class":211},"\"--cached\"",[111,1133,17],{"class":135},[111,1135,1136],{"class":211},"\"--others\"",[111,1138,17],{"class":135},[111,1140,1141],{"class":211},"\"--exclude-standard\"",[111,1143,17],{"class":135},[111,1145,1146],{"class":211},"\"-z\"",[111,1148,1149],{"class":135},"],\n",[111,1151,1152,1155,1157,1160,1163,1165,1167],{"class":113,"line":194},[111,1153,1154],{"class":371},"        cwd",[111,1156,262],{"class":124},[111,1158,1159],{"class":135},"root, ",[111,1161,1162],{"class":371},"capture_output",[111,1164,262],{"class":124},[111,1166,863],{"class":128},[111,1168,431],{"class":135},[111,1170,1171],{"class":113,"line":199},[111,1172,1173],{"class":135},"    )\n",[111,1175,1176,1179,1182,1185,1188],{"class":113,"line":233},[111,1177,1178],{"class":124},"    if",[111,1180,1181],{"class":135}," result.returncode ",[111,1183,1184],{"class":124},"!=",[111,1186,1187],{"class":128}," 0",[111,1189,820],{"class":135},[111,1191,1192,1195],{"class":113,"line":238},[111,1193,1194],{"class":124},"        return",[111,1196,1197],{"class":128}," None\n",[111,1199,1200,1202,1205,1207,1210,1212,1214,1216,1219,1221,1224,1226,1229,1231,1234,1236],{"class":113,"line":243},[111,1201,401],{"class":124},[111,1203,1204],{"class":135}," [root ",[111,1206,344],{"class":124},[111,1208,1209],{"class":135}," p ",[111,1211,514],{"class":124},[111,1213,1209],{"class":135},[111,1215,327],{"class":124},[111,1217,1218],{"class":135}," result.stdout.decode(",[111,1220,377],{"class":211},[111,1222,1223],{"class":135},").split(",[111,1225,540],{"class":211},[111,1227,1228],{"class":128},"\\0",[111,1230,540],{"class":211},[111,1232,1233],{"class":135},") ",[111,1235,987],{"class":124},[111,1237,1238],{"class":135}," p]\n",[10,1240,1241,1244,1245,1247,1248,1252],{},[14,1242,1243],{},"-z"," separates names with NUL bytes so file names containing newlines or unusual characters survive intact. Fall back to the ",[14,1246,36],{}," walker when git is missing or the directory is not a repository, and apply your tool-specific ignore file on top in both cases. The safe-subprocess practices from ",[43,1249,1251],{"href":1250},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess\u002F","calling external commands safely with subprocess"," apply.",[79,1254],{"name":1255},"treewalk-sources",[712,1257,1259],{"id":1258},"choosing-the-root","Choosing the root",[10,1261,1262,1263,1266,1267,1270,1271,1273,1274,1276,1277,1280,1281,1283,1284,1288,1289,685,1292,1295,1296,1299],{},"Ignore files are interpreted relative to the directory that contains them, so the walker needs to know where the project ",[86,1264,1265],{},"root"," is — not just where the user happens to be. Running ",[14,1268,1269],{},"mytool files src\u002F"," from the repository root should still apply the root ",[14,1272,28],{},", with patterns matched against paths like ",[14,1275,699],{},", not ",[14,1278,1279],{},"pkg\u002Fa.py",". The usual solution is to find the root first by walking up from the target to the nearest directory containing ",[14,1282,16],{}," or the tool's config file, as described in ",[43,1285,1287],{"href":1286},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fdiscovering-project-config-files-by-walking-up-directories\u002F","discovering project config files by walking up directories",", load the spec there, and then walk only the requested subtree while computing relative paths from the root. Getting this right is what makes ",[14,1290,1291],{},"mytool check src\u002F",[14,1293,1294],{},"mytool check ."," agree about which files under ",[14,1297,1298],{},"src\u002F"," are ignored — a mismatch users notice immediately and find very confusing.",[49,1301,1303],{"id":1302},"ux-considerations","UX considerations",[54,1305,1306,1319,1328,1341,1347],{},[57,1307,1308,1311,1312,1314,1315,1318],{},[624,1309,1310],{},"Give users a way to see the decision."," A ",[14,1313,1026],{}," command or ",[14,1316,1317],{},"--verbose"," output listing skipped directories ends most \"why was my file ignored?\" questions.",[57,1320,1321,1327],{},[624,1322,1323,1324],{},"Offer ",[14,1325,1326],{},"--no-ignore"," for the occasional need to process everything, as ripgrep does.",[57,1329,1330,62,1333,1336,1337,1340],{},[624,1331,1332],{},"Use a tool-specific ignore file",[14,1334,1335],{},".mytoolignore",") for exclusions that are about ",[86,1338,1339],{},"your"," tool and not about git — generated fixtures, vendored code you do not want linted.",[57,1342,1343,1346],{},[624,1344,1345],{},"Do not follow symlinks by default."," Following them can escape the root or loop forever; make it an explicit option.",[57,1348,1349,1352,1353,1355,1356,1359],{},[624,1350,1351],{},"Report unreadable directories, do not crash."," ",[14,1354,95],{}," takes an ",[14,1357,1358],{},"onerror"," callback; log a warning and continue rather than aborting a walk over a permission error.",[49,1361,1363],{"id":1362},"testing-the-behaviour","Testing the behaviour",[10,1365,1366,1367,1370],{},"Build small trees in ",[14,1368,1369],{},"tmp_path"," and assert on the exact list of files — including that ignored directories were never entered:",[102,1372,1374],{"className":104,"code":1373,"language":106,"meta":107,"style":107},"# tests\u002Ftest_walk.py\nimport os\nfrom pathlib import Path\n\nfrom mytool.walk import load_spec, walk_files\n\n\ndef make_tree(root: Path) -> None:\n    for rel in [\"src\u002Fpkg\u002Fa.py\", \"src\u002Fpkg\u002Fb.pyc\", \"build\u002Fout.o\", \".git\u002FHEAD\",\n                \"logs\u002Fapp.log\", \"logs\u002Fkeep.log\", \"node_modules\u002Fx\u002Fi.js\", \"README.md\"]:\n        path = root \u002F rel\n        path.parent.mkdir(parents=True, exist_ok=True)\n        path.write_text(\"\")\n    (root \u002F \".gitignore\").write_text(\"build\u002F\\n*.pyc\\nlogs\u002F*.log\\n!logs\u002Fkeep.log\\n\")\n\n\ndef listed(root: Path, *extra: str) -> list[str]:\n    spec = load_spec(root, extra)\n    return [p.relative_to(root.resolve()).as_posix() for p in walk_files(root, spec)]\n\n\ndef test_gitignore_rules_and_negation(tmp_path):\n    make_tree(tmp_path)\n    assert listed(tmp_path) == [\".gitignore\", \"README.md\", \"logs\u002Fkeep.log\", \"src\u002Fpkg\u002Fa.py\"]\n\n\ndef test_command_line_excludes_apply_last(tmp_path):\n    make_tree(tmp_path)\n    assert listed(tmp_path, \"src\u002F\") == [\".gitignore\", \"README.md\", \"logs\u002Fkeep.log\"]\n\n\ndef test_ignored_directories_are_never_entered(tmp_path, monkeypatch):\n    make_tree(tmp_path)\n    visited = []\n    real_walk = os.walk\n\n    def spy(top, *args, **kwargs):\n        for entry in real_walk(top, *args, **kwargs):\n            visited.append(Path(entry[0]).name)\n            yield entry\n\n    monkeypatch.setattr(\"mytool.walk.os.walk\", spy)\n    listed(tmp_path)\n    assert \"node_modules\" not in visited and \"build\" not in visited\n",[14,1375,1376,1381,1387,1397,1401,1411,1415,1419,1433,1464,1487,1500,1523,1533,1568,1572,1576,1600,1609,1625,1629,1633,1643,1648,1677,1681,1685,1694,1698,1726,1730,1734,1744,1748,1758,1768,1772,1795,1816,1828,1837,1842,1854,1860],{"__ignoreMap":107},[111,1377,1378],{"class":113,"line":114},[111,1379,1380],{"class":117},"# tests\u002Ftest_walk.py\n",[111,1382,1383,1385],{"class":113,"line":121},[111,1384,149],{"class":124},[111,1386,152],{"class":135},[111,1388,1389,1391,1393,1395],{"class":113,"line":139},[111,1390,125],{"class":124},[111,1392,173],{"class":135},[111,1394,149],{"class":124},[111,1396,178],{"class":135},[111,1398,1399],{"class":113,"line":146},[111,1400,143],{"emptyLinePlaceholder":142},[111,1402,1403,1405,1407,1409],{"class":113,"line":155},[111,1404,125],{"class":124},[111,1406,769],{"class":135},[111,1408,149],{"class":124},[111,1410,774],{"class":135},[111,1412,1413],{"class":113,"line":168},[111,1414,143],{"emptyLinePlaceholder":142},[111,1416,1417],{"class":113,"line":181},[111,1418,143],{"emptyLinePlaceholder":142},[111,1420,1421,1423,1426,1429,1431],{"class":113,"line":186},[111,1422,246],{"class":124},[111,1424,1425],{"class":249}," make_tree",[111,1427,1428],{"class":135},"(root: Path) -> ",[111,1430,817],{"class":128},[111,1432,820],{"class":135},[111,1434,1435,1437,1440,1442,1444,1447,1449,1452,1454,1457,1459,1462],{"class":113,"line":194},[111,1436,321],{"class":124},[111,1438,1439],{"class":135}," rel ",[111,1441,327],{"class":124},[111,1443,208],{"class":135},[111,1445,1446],{"class":211},"\"src\u002Fpkg\u002Fa.py\"",[111,1448,17],{"class":135},[111,1450,1451],{"class":211},"\"src\u002Fpkg\u002Fb.pyc\"",[111,1453,17],{"class":135},[111,1455,1456],{"class":211},"\"build\u002Fout.o\"",[111,1458,17],{"class":135},[111,1460,1461],{"class":211},"\".git\u002FHEAD\"",[111,1463,431],{"class":135},[111,1465,1466,1469,1471,1474,1476,1479,1481,1484],{"class":113,"line":199},[111,1467,1468],{"class":211},"                \"logs\u002Fapp.log\"",[111,1470,17],{"class":135},[111,1472,1473],{"class":211},"\"logs\u002Fkeep.log\"",[111,1475,17],{"class":135},[111,1477,1478],{"class":211},"\"node_modules\u002Fx\u002Fi.js\"",[111,1480,17],{"class":135},[111,1482,1483],{"class":211},"\"README.md\"",[111,1485,1486],{"class":135},"]:\n",[111,1488,1489,1492,1494,1496,1498],{"class":113,"line":233},[111,1490,1491],{"class":135},"        path ",[111,1493,262],{"class":124},[111,1495,341],{"class":135},[111,1497,344],{"class":124},[111,1499,615],{"class":135},[111,1501,1502,1505,1508,1510,1512,1514,1517,1519,1521],{"class":113,"line":238},[111,1503,1504],{"class":135},"        path.parent.mkdir(",[111,1506,1507],{"class":371},"parents",[111,1509,262],{"class":124},[111,1511,863],{"class":128},[111,1513,17],{"class":135},[111,1515,1516],{"class":371},"exist_ok",[111,1518,262],{"class":124},[111,1520,863],{"class":128},[111,1522,315],{"class":135},[111,1524,1525,1528,1531],{"class":113,"line":243},[111,1526,1527],{"class":135},"        path.write_text(",[111,1529,1530],{"class":211},"\"\"",[111,1532,315],{"class":135},[111,1534,1535,1538,1540,1543,1546,1549,1552,1554,1556,1558,1560,1562,1564,1566],{"class":113,"line":268},[111,1536,1537],{"class":135},"    (root ",[111,1539,344],{"class":124},[111,1541,1542],{"class":211}," \".gitignore\"",[111,1544,1545],{"class":135},").write_text(",[111,1547,1548],{"class":211},"\"build\u002F",[111,1550,1551],{"class":128},"\\n",[111,1553,682],{"class":211},[111,1555,1551],{"class":128},[111,1557,660],{"class":211},[111,1559,1551],{"class":128},[111,1561,656],{"class":211},[111,1563,1551],{"class":128},[111,1565,540],{"class":211},[111,1567,315],{"class":135},[111,1569,1570],{"class":113,"line":293},[111,1571,143],{"emptyLinePlaceholder":142},[111,1573,1574],{"class":113,"line":299},[111,1575,143],{"emptyLinePlaceholder":142},[111,1577,1578,1580,1583,1586,1588,1591,1593,1596,1598],{"class":113,"line":318},[111,1579,246],{"class":124},[111,1581,1582],{"class":249}," listed",[111,1584,1585],{"class":135},"(root: Path, ",[111,1587,428],{"class":124},[111,1589,1590],{"class":135},"extra: ",[111,1592,256],{"class":128},[111,1594,1595],{"class":135},") -> list[",[111,1597,256],{"class":128},[111,1599,1486],{"class":135},[111,1601,1602,1604,1606],{"class":113,"line":333},[111,1603,971],{"class":135},[111,1605,262],{"class":124},[111,1607,1608],{"class":135}," load_spec(root, extra)\n",[111,1610,1611,1613,1616,1618,1620,1622],{"class":113,"line":350},[111,1612,401],{"class":124},[111,1614,1615],{"class":135}," [p.relative_to(root.resolve()).as_posix() ",[111,1617,514],{"class":124},[111,1619,1209],{"class":135},[111,1621,327],{"class":124},[111,1623,1624],{"class":135}," walk_files(root, spec)]\n",[111,1626,1627],{"class":113,"line":359},[111,1628,143],{"emptyLinePlaceholder":142},[111,1630,1631],{"class":113,"line":383},[111,1632,143],{"emptyLinePlaceholder":142},[111,1634,1635,1637,1640],{"class":113,"line":398},[111,1636,246],{"class":124},[111,1638,1639],{"class":249}," test_gitignore_rules_and_negation",[111,1641,1642],{"class":135},"(tmp_path):\n",[111,1644,1645],{"class":113,"line":407},[111,1646,1647],{"class":135},"    make_tree(tmp_path)\n",[111,1649,1650,1653,1656,1659,1661,1663,1665,1667,1669,1671,1673,1675],{"class":113,"line":412},[111,1651,1652],{"class":124},"    assert",[111,1654,1655],{"class":135}," listed(tmp_path) ",[111,1657,1658],{"class":124},"==",[111,1660,208],{"class":135},[111,1662,282],{"class":211},[111,1664,17],{"class":135},[111,1666,1483],{"class":211},[111,1668,17],{"class":135},[111,1670,1473],{"class":211},[111,1672,17],{"class":135},[111,1674,1446],{"class":211},[111,1676,230],{"class":135},[111,1678,1679],{"class":113,"line":417},[111,1680,143],{"emptyLinePlaceholder":142},[111,1682,1683],{"class":113,"line":434},[111,1684,143],{"emptyLinePlaceholder":142},[111,1686,1687,1689,1692],{"class":113,"line":451},[111,1688,246],{"class":124},[111,1690,1691],{"class":249}," test_command_line_excludes_apply_last",[111,1693,1642],{"class":135},[111,1695,1696],{"class":113,"line":462},[111,1697,1647],{"class":135},[111,1699,1700,1702,1705,1708,1710,1712,1714,1716,1718,1720,1722,1724],{"class":113,"line":483},[111,1701,1652],{"class":124},[111,1703,1704],{"class":135}," listed(tmp_path, ",[111,1706,1707],{"class":211},"\"src\u002F\"",[111,1709,1233],{"class":135},[111,1711,1658],{"class":124},[111,1713,208],{"class":135},[111,1715,282],{"class":211},[111,1717,17],{"class":135},[111,1719,1483],{"class":211},[111,1721,17],{"class":135},[111,1723,1473],{"class":211},[111,1725,230],{"class":135},[111,1727,1728],{"class":113,"line":494},[111,1729,143],{"emptyLinePlaceholder":142},[111,1731,1732],{"class":113,"line":500},[111,1733,143],{"emptyLinePlaceholder":142},[111,1735,1736,1738,1741],{"class":113,"line":525},[111,1737,246],{"class":124},[111,1739,1740],{"class":249}," test_ignored_directories_are_never_entered",[111,1742,1743],{"class":135},"(tmp_path, monkeypatch):\n",[111,1745,1746],{"class":113,"line":563},[111,1747,1647],{"class":135},[111,1749,1750,1753,1755],{"class":113,"line":578},[111,1751,1752],{"class":135},"    visited ",[111,1754,262],{"class":124},[111,1756,1757],{"class":135}," []\n",[111,1759,1760,1763,1765],{"class":113,"line":594},[111,1761,1762],{"class":135},"    real_walk ",[111,1764,262],{"class":124},[111,1766,1767],{"class":135}," os.walk\n",[111,1769,1770],{"class":113,"line":605},[111,1771,143],{"emptyLinePlaceholder":142},[111,1773,1775,1778,1781,1784,1786,1789,1792],{"class":113,"line":1774},37,[111,1776,1777],{"class":124},"    def",[111,1779,1780],{"class":249}," spy",[111,1782,1783],{"class":135},"(top, ",[111,1785,428],{"class":124},[111,1787,1788],{"class":135},"args, ",[111,1790,1791],{"class":124},"**",[111,1793,1794],{"class":135},"kwargs):\n",[111,1796,1798,1800,1803,1805,1808,1810,1812,1814],{"class":113,"line":1797},38,[111,1799,566],{"class":124},[111,1801,1802],{"class":135}," entry ",[111,1804,327],{"class":124},[111,1806,1807],{"class":135}," real_walk(top, ",[111,1809,428],{"class":124},[111,1811,1788],{"class":135},[111,1813,1791],{"class":124},[111,1815,1794],{"class":135},[111,1817,1819,1822,1825],{"class":113,"line":1818},39,[111,1820,1821],{"class":135},"            visited.append(Path(entry[",[111,1823,1824],{"class":128},"0",[111,1826,1827],{"class":135},"]).name)\n",[111,1829,1831,1834],{"class":113,"line":1830},40,[111,1832,1833],{"class":124},"            yield",[111,1835,1836],{"class":135}," entry\n",[111,1838,1840],{"class":113,"line":1839},41,[111,1841,143],{"emptyLinePlaceholder":142},[111,1843,1845,1848,1851],{"class":113,"line":1844},42,[111,1846,1847],{"class":135},"    monkeypatch.setattr(",[111,1849,1850],{"class":211},"\"mytool.walk.os.walk\"",[111,1852,1853],{"class":135},", spy)\n",[111,1855,1857],{"class":113,"line":1856},43,[111,1858,1859],{"class":135},"    listed(tmp_path)\n",[111,1861,1863,1865,1868,1870,1873,1876,1879,1882,1884,1886],{"class":113,"line":1862},44,[111,1864,1652],{"class":124},[111,1866,1867],{"class":211}," \"node_modules\"",[111,1869,531],{"class":124},[111,1871,1872],{"class":124}," in",[111,1874,1875],{"class":135}," visited ",[111,1877,1878],{"class":124},"and",[111,1880,1881],{"class":211}," \"build\"",[111,1883,531],{"class":124},[111,1885,1872],{"class":124},[111,1887,1888],{"class":135}," visited\n",[10,1890,1891],{},"The last test is the performance guarantee in executable form: it fails if someone \"simplifies\" the walker to filter after traversal.",[49,1893,1895],{"id":1894},"conclusion","Conclusion",[10,1897,1898,1899,1901,1902,1904,1905,1907],{},"Walking a tree well means respecting the same rules users already wrote for git, and paying nothing for directories they excluded. Prune ignored directories in place during ",[14,1900,95],{},", match with ",[14,1903,36],{},"'s gitignore semantics using POSIX-style relative paths and a trailing slash for directories, layer built-in skips, ignore files and command-line excludes in that order, and use ",[14,1906,40],{}," when you need git's exact view. Show users what will be processed, and test both the file list and the pruning.",[49,1909,1911],{"id":1910},"frequently-asked-questions","Frequently asked questions",[712,1913,1915,1916,1918,1919,1921],{"id":1914},"does-pathspec-support-nested-gitignore-files","Does ",[14,1917,36],{}," support nested ",[14,1920,28],{}," files?",[10,1923,1924,1925,1927,1928,1931],{},"Not automatically. You can load each directory's ",[14,1926,28],{}," as you walk and match paths relative to that directory, but the semantics get intricate; inside a repository, ",[14,1929,1930],{},"git ls-files --exclude-standard"," handles them exactly.",[712,1933,1935,1936,1939],{"id":1934},"is-pathwalk-an-option","Is ",[14,1937,1938],{},"Path.walk()"," an option?",[10,1941,1942,1943,1945,1946,1948,1949,1952],{},"Yes — Python 3.12 added ",[14,1944,1938],{},", which mirrors ",[14,1947,95],{}," and supports the same in-place pruning of its ",[14,1950,1951],{},"dirnames"," list. The recipe works the same way with it if you only support 3.12+.",[712,1954,1956],{"id":1955},"how-do-i-handle-huge-trees-efficiently","How do I handle huge trees efficiently?",[10,1958,1959,1960,47],{},"Pruning is the big win. Beyond that, process files as the generator yields them instead of building a list, and parallelise the per-file work, as in ",[43,1961,1963],{"href":1962},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools\u002F","parallelising CLI work with thread pools",[712,1965,1967],{"id":1966},"should-ignore-patterns-be-case-insensitive-on-windows-and-macos","Should ignore patterns be case-insensitive on Windows and macOS?",[10,1969,1970,1971,1974],{},"Git itself matches case-sensitively unless ",[14,1972,1973],{},"core.ignorecase"," is set, which it is by default on case-insensitive filesystems. Matching case-sensitively and documenting it is the simplest consistent choice for a CLI.",[49,1976,1978],{"id":1977},"related","Related",[54,1980,1981,1987,1992,1998,2004],{},[57,1982,1983,1984],{},"Up: ",[43,1985,1986],{"href":45},"Filesystem paths and atomic writes",[57,1988,1989],{},[43,1990,1991],{"href":72},"Cross-platform paths with pathlib",[57,1993,1994],{},[43,1995,1997],{"href":1996},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fhandling-file-permissions-and-umask-in-clis\u002F","Handling file permissions and umask in CLIs",[57,1999,2000],{},[43,2001,2003],{"href":2002},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fstoring-cli-state-in-sqlite\u002F","Storing CLI state in SQLite",[57,2005,2006],{},[43,2007,2009],{"href":2008},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fwrapping-git-and-other-tools-from-a-python-cli\u002F","Wrapping git and other tools from a Python CLI",[2011,2012,2013],"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":107,"searchDepth":121,"depth":121,"links":2015},[2016,2017,2018,2021,2024,2025,2026,2027,2035],{"id":51,"depth":121,"text":52},{"id":76,"depth":121,"text":77},{"id":99,"depth":121,"text":100,"children":2019},[2020],{"id":714,"depth":139,"text":715},{"id":1034,"depth":121,"text":1035,"children":2022},[2023],{"id":1258,"depth":139,"text":1259},{"id":1302,"depth":121,"text":1303},{"id":1362,"depth":121,"text":1363},{"id":1894,"depth":121,"text":1895},{"id":1910,"depth":121,"text":1911,"children":2028},[2029,2031,2033,2034],{"id":1914,"depth":139,"text":2030},"Does pathspec support nested .gitignore files?",{"id":1934,"depth":139,"text":2032},"Is Path.walk() an option?",{"id":1955,"depth":139,"text":1956},{"id":1966,"depth":139,"text":1967},{"id":1977,"depth":121,"text":1978},"2026-10-02","Walk a project tree the way users expect: gitignore-style patterns with pathspec, pruning ignored directories, negation, a tool-specific ignore file, git ls-files, and tests.","intermediate",false,"md",{},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwalking-directory-trees-with-ignore-rules",{"title":5,"description":2037},"cli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwalking-directory-trees-with-ignore-rules\u002Findex",[2046,2047,36,2048,2049],"filesystem","gitignore","performance","pathlib","tTUO2bg5gOSzi4BjOagks1uHTTxyYkPIa01cbIXPdB0",[2052,2055,2058,2061,2064,2067,2070,2073,2076,2079,2082,2085,2088,2091,2094,2097,2100,2103,2106,2109,2112,2115,2118,2121,2124,2127,2130,2133,2136,2139,2142,2145,2148,2151,2154,2157,2160,2163,2166,2169,2172,2175,2178,2181,2184,2187,2190,2193,2196,2199,2202,2205,2208,2211,2214,2217,2220,2223,2226,2229,2232,2235,2238,2241,2244,2247,2250,2253,2256,2259,2262,2265,2268,2271,2274,2277,2280,2283,2286,2289,2292,2295,2298,2301,2304,2307,2310,2313,2316,2319,2322,2325,2328,2331,2334,2337,2340,2343,2346,2349,2352,2355,2358,2361,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,2469,2472,2475,2478,2481,2484,2487,2490,2493,2496,2499,2502,2505,2508,2511,2514,2517,2520,2523,2526,2529,2532,2535,2538,2541,2544,2547,2550,2553,2556,2559,2562,2565,2568,2571,2574,2577,2580,2583,2586,2589,2592,2595,2598,2601,2604,2607,2610,2613,2616,2619,2622,2625,2628,2631,2634,2637,2640,2643,2646,2649,2652,2655,2658,2661,2664,2667,2670,2673,2676,2679,2682,2685,2688,2691,2694,2697,2700,2703,2706,2709,2712,2715,2718,2721,2724,2727,2730,2733,2736,2739,2742,2745,2748,2751,2754,2757,2760,2763,2766,2769,2772,2775,2778,2781,2784,2787,2790,2793,2796,2799,2802,2805,2808,2811,2814,2817,2820,2823,2826,2829,2832,2835,2838,2841,2844,2847,2850,2853,2856,2859,2862,2865,2868,2871,2874,2877,2880,2883,2886,2889,2892],{"path":2053,"title":2054},"\u002Fabout","About Python CLI Toolcraft",{"path":2056,"title":2057},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":2059,"title":2060},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":2062,"title":2063},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dates-and-durations-in-cli-arguments","Validating Dates and Durations in Python CLI Arguments",{"path":2065,"title":2066},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":2068,"title":2069},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2071,"title":2072},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":2074,"title":2075},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2077,"title":2078},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":2080,"title":2081},"\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":2083,"title":2084},"\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":2086,"title":2087},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2089,"title":2090},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Frunning-background-work-in-textual-with-workers","Running Background Work in Textual with Workers",{"path":2092,"title":2093},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":2095,"title":2096},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2098,"title":2099},"\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":2101,"title":2102},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":2104,"title":2105},"\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":2107,"title":2108},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2110,"title":2111},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Frich-formatted-help-with-rich-click","Rich-Formatted Help for Click CLIs with rich-click",{"path":2113,"title":2114},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2116,"title":2117},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2119,"title":2120},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2122,"title":2123},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2125,"title":2126},"\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":2128,"title":2129},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":2131,"title":2132},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2134,"title":2135},"\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":2137,"title":2138},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fsupporting-dumb-terminals-and-screen-readers","Supporting Dumb Terminals and Screen Readers in a Python CLI",{"path":2140,"title":2141},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2143,"title":2144},"\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":2146,"title":2147},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdid-you-mean-suggestions-for-mistyped-input","Did You Mean…? Suggestions for Mistyped CLI Input",{"path":2149,"title":2150},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2152,"title":2153},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2155,"title":2156},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2158,"title":2159},"\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":2161,"title":2162},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2164,"title":2165},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2167,"title":2168},"\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":2170,"title":2171},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2173,"title":2174},"\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":2176,"title":2177},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2179,"title":2180},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2182,"title":2183},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fvalidating-config-files-with-json-schema","Validating Config Files with JSON Schema in a Python CLI",{"path":2185,"title":2186},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fwriting-a-config-init-and-edit-command","Writing a Config Init and Edit Command for a Python CLI",{"path":2188,"title":2189},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2191,"title":2192},"\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":2194,"title":2195},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2197,"title":2198},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-tree-views-with-rich","Building Tree Views with Rich in a Python CLI",{"path":2200,"title":2201},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2203,"title":2204},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2206,"title":2207},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-markdown-and-syntax-highlighting-with-rich","Rendering Markdown and Syntax Highlighting with Rich",{"path":2209,"title":2210},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2212,"title":2213},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2215,"title":2216},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fadding-a-format-flag-for-table-json-and-csv","Adding a Format Flag for Table, JSON and CSV Output",{"path":2218,"title":2219},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fcustom-output-templates-with-a-format-string","Custom Output Templates with a Format String in Python CLIs",{"path":2221,"title":2222},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fexporting-cli-results-to-files","Exporting CLI Results to Files from a Python CLI",{"path":2224,"title":2225},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2227,"title":2228},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fselecting-fields-and-columns-from-cli-output","Selecting Fields and Columns from Python CLI Output",{"path":2230,"title":2231},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fwriting-csv-and-tsv-output-correctly","Writing CSV and TSV Output Correctly from a Python CLI",{"path":2233,"title":2234},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2236,"title":2237},"\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":2239,"title":2240},"\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":2242,"title":2243},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2245,"title":2246},"\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":2248,"title":2249},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2251,"title":2252},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2254,"title":2255},"\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":2257,"title":2258},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2260,"title":2261},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2263,"title":2264},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2266,"title":2267},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fseparating-logs-from-program-output","Separating Logs from Program Output in a Python CLI",{"path":2269,"title":2270},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2272,"title":2273},"\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":2275,"title":2276},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2278,"title":2279},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2281,"title":2282},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2284,"title":2285},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2287,"title":2288},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fnull-delimited-input-and-xargs-compatibility","Null-Delimited Input and xargs Compatibility in Python CLIs",{"path":2290,"title":2291},"\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":2293,"title":2294},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2296,"title":2297},"\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":2299,"title":2300},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2302,"title":2303},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2305,"title":2306},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fmocking-http-in-cli-tests-with-respx","Mocking HTTP in Python CLI Tests with respx",{"path":2308,"title":2309},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2311,"title":2312},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2314,"title":2315},"\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":2317,"title":2318},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fuploading-files-with-multipart-and-progress","Uploading Files with Multipart and Progress in a Python CLI",{"path":2320,"title":2321},"\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":2323,"title":2324},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2326,"title":2327},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2329,"title":2330},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2332,"title":2333},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2335,"title":2336},"\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":2338,"title":2339},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fshowing-progress-for-concurrent-tasks","Showing Progress for Concurrent Tasks in a Python CLI",{"path":2341,"title":2342},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2344,"title":2345},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2347,"title":2348},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2350,"title":2351},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fhandling-file-permissions-and-umask-in-clis","Handling File Permissions and umask in Python CLIs",{"path":2353,"title":2354},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2356,"title":2357},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2359,"title":2360},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2042,"title":5},{"path":2363,"title":2364},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2366,"title":2367},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2369,"title":2370},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fcaching-http-responses-on-disk-in-a-cli","Caching HTTP Responses on Disk in a Python CLI",{"path":2372,"title":2373},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2375,"title":2376},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fmigrating-a-cli-sqlite-schema","Migrating a CLI’s SQLite Schema Between Releases",{"path":2378,"title":2379},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Frecording-and-querying-cli-run-history","Recording and Querying CLI Run History in SQLite",{"path":2381,"title":2382},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fstoring-cli-state-in-sqlite","Storing CLI State in SQLite with a Small Repository Class",{"path":2384,"title":2385},"\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":2387,"title":2388},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2390,"title":2391},"\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":2393,"title":2394},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2396,"title":2397},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2399,"title":2400},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Frunning-a-cli-as-a-systemd-service","Running a Python CLI as a systemd Service",{"path":2402,"title":2403},"\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":2405,"title":2406},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fsending-cli-logs-to-journald-and-syslog","Sending Python CLI Logs to journald and syslog",{"path":2408,"title":2409},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2411,"title":2412},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2414,"title":2415},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2417,"title":2418},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2420,"title":2421},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Flaunching-the-users-editor-from-a-cli","Launching the User’s Editor from a Python CLI",{"path":2423,"title":2424},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2426,"title":2427},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2429,"title":2430},"\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":2432,"title":2433},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2435,"title":2436},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2438,"title":2439},"\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":2441,"title":2442},"\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":2444,"title":2445},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2447,"title":2448},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2450,"title":2451},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2453,"title":2454},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fchecking-pypi-for-a-newer-version","Checking PyPI for a Newer Version of Your Python CLI",{"path":2456,"title":2457},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2459,"title":2460},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fopt-in-usage-telemetry-for-python-clis","Opt-In Usage Telemetry for Python CLIs Done Responsibly",{"path":2462,"title":2463},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fself-upgrading-a-cli-installed-with-pipx-or-uv","Self-Upgrading a Python CLI Installed with pipx or uv",{"path":2465,"title":2466},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fshowing-non-blocking-update-notices","Showing Non-Blocking Update Notices in a Python CLI",{"path":344,"title":2468},"Python CLI Toolcraft",{"path":2470,"title":2471},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2473,"title":2474},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2476,"title":2477},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2479,"title":2480},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2482,"title":2483},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fusage-string-driven-clis-with-docopt-ng","Usage-String Driven Python CLIs with docopt-ng",{"path":2485,"title":2486},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Favoiding-import-time-side-effects","Avoiding Import-Time Side Effects in a Python CLI",{"path":2488,"title":2489},"\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":2491,"title":2492},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2494,"title":2495},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2497,"title":2498},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2500,"title":2501},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2503,"title":2504},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2506,"title":2507},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2509,"title":2510},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2512,"title":2513},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargument-groups-and-help-formatting-in-argparse","Argument Groups and Help Formatting in argparse",{"path":2515,"title":2516},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2518,"title":2519},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2521,"title":2522},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2524,"title":2525},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Freading-arguments-from-files-with-fromfile-prefix-chars","Reading Arguments from Files with argparse’s fromfile_prefix_chars",{"path":2527,"title":2528},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2530,"title":2531},"\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":2533,"title":2534},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2536,"title":2537},"\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":2539,"title":2540},"\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":2542,"title":2543},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2545,"title":2546},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2548,"title":2549},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2551,"title":2552},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2554,"title":2555},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2557,"title":2558},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2560,"title":2561},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2563,"title":2564},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2566,"title":2567},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2569,"title":2570},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2572,"title":2573},"\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":2575,"title":2576},"\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":2578,"title":2579},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2581,"title":2582},"\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":2584,"title":2585},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2587,"title":2588},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Foffering-a-python-api-alongside-your-cli","Offering a Python API Alongside Your CLI",{"path":2590,"title":2591},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2593,"title":2594},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2596,"title":2597},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2599,"title":2600},"\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":2602,"title":2603},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2605,"title":2606},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2608,"title":2609},"\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":2611,"title":2612},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2614,"title":2615},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2617,"title":2618},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2620,"title":2621},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2623,"title":2624},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2626,"title":2627},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2629,"title":2630},"\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":2632,"title":2633},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2635,"title":2636},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fchoices-and-enums-in-typer-and-click","Choices and Enums in Typer and Click Options",{"path":2638,"title":2639},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fclick-option-callbacks-and-eager-options","Click Option Callbacks and Eager Options Explained",{"path":2641,"title":2642},"\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":2644,"title":2645},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2647,"title":2648},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Frich-markup-and-help-panels-in-typer","Rich Markup and Help Panels in Typer",{"path":2650,"title":2651},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2653,"title":2654},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2656,"title":2657},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2659,"title":2660},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2662,"title":2663},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2665,"title":2666},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fpublishing-a-cli-docker-image-from-ci","Publishing a Python CLI as a Docker Image from CI",{"path":2668,"title":2669},"\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":2671,"title":2672},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Frunning-cli-tests-on-windows-and-macos-runners","Running Python CLI Tests on Windows and macOS Runners",{"path":2674,"title":2675},"\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":2677,"title":2678},"\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":2680,"title":2681},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2683,"title":2684},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2686,"title":2687},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2689,"title":2690},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2692,"title":2693},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2695,"title":2696},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2698,"title":2699},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2701,"title":2702},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2704,"title":2705},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2707,"title":2708},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2710,"title":2711},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2713,"title":2714},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2716,"title":2717},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2719,"title":2720},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2722,"title":2723},"\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":2725,"title":2726},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2728,"title":2729},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2731,"title":2732},"\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":2734,"title":2735},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Ffinding-unused-code-and-dependencies-with-vulture-and-deptry","Finding Unused Code and Dependencies with vulture and deptry",{"path":2737,"title":2738},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2740,"title":2741},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-pyright-in-strict-mode-on-a-cli","Running Pyright in Strict Mode on a Python CLI",{"path":2743,"title":2744},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-ruff-and-mypy-in-ci-with-annotations","Running Ruff and mypy in CI with Inline Annotations",{"path":2746,"title":2747},"\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":2749,"title":2750},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2752,"title":2753},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2755,"title":2756},"\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":2758,"title":2759},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2761,"title":2762},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2764,"title":2765},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2767,"title":2768},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fshipping-pre-releases-and-release-candidates","Shipping Pre-Releases and Release Candidates of a Python CLI",{"path":2770,"title":2771},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2773,"title":2774},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2776,"title":2777},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fchoosing-a-build-backend-for-a-python-cli","Choosing a Build Backend for a Python CLI",{"path":2779,"title":2780},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2782,"title":2783},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2785,"title":2786},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2788,"title":2789},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2791,"title":2792},"\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":2794,"title":2795},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2797,"title":2798},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2800,"title":2801},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2803,"title":2804},"\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":2806,"title":2807},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2809,"title":2810},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2812,"title":2813},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2815,"title":2816},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2818,"title":2819},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fkeeping-hook-versions-current-with-autoupdate","Keeping pre-commit Hook Versions Current with autoupdate",{"path":2821,"title":2822},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Frunning-pre-commit-in-ci","Running pre-commit in CI for a Python CLI Repository",{"path":2824,"title":2825},"\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":2827,"title":2828},"\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":2830,"title":2831},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fspeeding-up-slow-pre-commit-hooks","Speeding Up Slow pre-commit Hooks in a CLI Repository",{"path":2833,"title":2834},"\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":2836,"title":2837},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fauditing-dependencies-with-pip-audit","Auditing a Python CLI’s Dependencies with pip-audit",{"path":2839,"title":2840},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fgenerating-an-sbom-for-a-python-cli","Generating an SBOM for a Python CLI Release",{"path":2842,"title":2843},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2845,"title":2846},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2848,"title":2849},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2851,"title":2852},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fbuilding-and-publishing-a-cli-with-uv","Building and Publishing a Python CLI with uv",{"path":2854,"title":2855},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2857,"title":2858},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Flocking-and-syncing-cli-dependencies-with-uv","Locking and Syncing a Python CLI’s Dependencies with uv",{"path":2860,"title":2861},"\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":2863,"title":2864},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fusing-private-package-indexes-with-uv","Using Private Package Indexes with uv for Internal CLIs",{"path":2866,"title":2867},"\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":2869,"title":2870},"\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":2872,"title":2873},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2875,"title":2876},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fdebugging-wrong-python-and-wrong-venv-problems","Debugging Wrong-Python and Wrong-Venv Problems in CLIs",{"path":2878,"title":2879},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fexternally-managed-environments-and-pep-668","PEP 668 and Python CLIs: the externally-managed-environment Error",{"path":2881,"title":2882},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2884,"title":2885},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2887,"title":2888},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2890,"title":2891},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2893,"title":2894},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967539840]