[{"data":1,"prerenderedAt":3155},["ShallowReactive",2],{"page-\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fusage-string-driven-clis-with-docopt-ng\u002F":3,"content-directory":2311},{"id":4,"title":5,"body":6,"date":2297,"description":2298,"difficulty":2299,"draft":2300,"extension":2301,"meta":2302,"navigation":158,"path":2303,"seo":2304,"stem":2305,"tags":2306,"updated":2297,"__hash__":2310},"content\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fusage-string-driven-clis-with-docopt-ng\u002Findex.md","Usage-String Driven Python CLIs with docopt-ng",{"type":7,"value":8,"toc":2277},"minimark",[9,34,39,79,83,98,102,124,128,1353,1374,1377,1382,1407,1410,1414,1417,1500,1503,1507,1557,1561,1572,2036,2039,2145,2149,2169,2173,2185,2189,2199,2204,2208,2211,2215,2226,2230,2237,2241,2273],[10,11,12,13,17,18,22,23,27,28,33],"p",{},"docopt starts from a simple observation: every command-line tool already has a precise description of its interface — the usage message — so why write that description a second time as parser code? With docopt you write the help text in a conventional format, and the library turns it into a parser. The help can never drift from the behaviour, because it ",[14,15,16],"em",{},"is"," the behaviour. The original ",[19,20,21],"code",{},"docopt"," package is no longer maintained; ",[24,25,26],"strong",{},"docopt-ng"," is the maintained fork, a drop-in replacement with type hints and fixes. This guide builds a small backup tool with it, adds the validation layer docopt leaves to you, fixes its exit code, and tests the result. It belongs to the ",[29,30,32],"a",{"href":31},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002F","alternative Python CLI frameworks"," topic.",[35,36,38],"h2",{"id":37},"prerequisites","Prerequisites",[40,41,42,57],"ul",{},[43,44,45,46,48,49,52,53,56],"li",{},"Python 3.10+ and ",[19,47,26],{}," (",[19,50,51],{},"uv add docopt-ng","; you still ",[19,54,55],{},"from docopt import docopt",").",[43,58,59,60,63,64,63,67,63,70,73,74,78],{},"Familiarity with POSIX usage syntax — ",[19,61,62],{},"[optional]",", ",[19,65,66],{},"(required | alternatives)",[19,68,69],{},"\u003Cargument>",[19,71,72],{},"..."," for repetition. ",[29,75,77],{"href":76},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Ffollowing-posix-and-gnu-argument-conventions\u002F","Following POSIX and GNU argument conventions"," is a good refresher.",[35,80,82],{"id":81},"how-a-usage-string-becomes-a-parser","How a usage string becomes a parser",[10,84,85,86,89,90,93,94,97],{},"docopt reads two sections of the docstring. Lines under ",[19,87,88],{},"Usage:"," are ",[14,91,92],{},"patterns",": each line is one valid shape of the command line. Lines under ",[19,95,96],{},"Options:"," declare each option's short and long forms, whether it takes a value, and its default. Everything else — the description, examples — is free text that only appears in help.",[99,100],"inline-diagram",{"name":101},"docopt-anatomy",[10,103,104,105,108,109,112,113,116,117,120,121,56],{},"Parsing returns a dictionary with one key per command word, argument and option across ",[14,106,107],{},"all"," patterns. Command words are ",[19,110,111],{},"True","\u002F",[19,114,115],{},"False",", arguments and option values are strings or ",[19,118,119],{},"None",", repeated elements are lists, and flags are booleans (or counts, for repeatable flags such as ",[19,122,123],{},"-v...",[35,125,127],{"id":126},"the-recipe","The recipe",[129,130,135],"pre",{"className":131,"code":132,"language":133,"meta":134,"style":134},"language-python shiki shiki-themes github-light github-dark","# src\u002Fbackup\u002Fcli.py\n\"\"\"Back up directories to a destination.\n\nUsage:\n  backup run \u003Csource>... --to=\u003Cdest> [--compress=\u003Clevel>] [--exclude=\u003Cglob>]... [--dry-run]\n  backup list [--limit=\u003Cn>] [--json]\n  backup -h | --help\n  backup --version\n\nOptions:\n  -h --help            Show this help.\n  --version            Show the version.\n  --to=\u003Cdest>          Destination directory.\n  --compress=\u003Clevel>   Compression level, 0-9 [default: 6].\n  --exclude=\u003Cglob>     Skip paths matching this glob; repeatable.\n  --limit=\u003Cn>          Show at most n backups [default: 10].\n  --json               Print JSON instead of a table.\n  --dry-run            Show what would be copied without copying.\n\nExamples:\n  backup run ~\u002Fdocs ~\u002Fphotos --to=\u002Fmnt\u002Fbackup --exclude='*.tmp'\n  backup list --limit=3\n\"\"\"\nfrom __future__ import annotations\n\nimport sys\nfrom dataclasses import dataclass, field\nfrom pathlib import Path\n\nfrom docopt import DocoptExit, docopt\n\n__version__ = \"1.0.0\"\n\n\nclass UsageError(Exception):\n    pass\n\n\n@dataclass(frozen=True)\nclass RunArgs:\n    sources: list[Path]\n    dest: Path\n    compress: int\n    exclude: list[str] = field(default_factory=list)\n    dry_run: bool = False\n\n\ndef _int_in_range(raw: str, name: str, lo: int, hi: int) -> int:\n    try:\n        value = int(raw)\n    except ValueError:\n        raise UsageError(f\"{name} must be a whole number, got {raw!r}\") from None\n    if not lo \u003C= value \u003C= hi:\n        raise UsageError(f\"{name} must be between {lo} and {hi}, got {value}\")\n    return value\n\n\ndef to_run_args(args: dict) -> RunArgs:\n    return RunArgs(\n        sources=[Path(s) for s in args[\"\u003Csource>\"]],\n        dest=Path(args[\"--to\"]),\n        compress=_int_in_range(args[\"--compress\"], \"--compress\", 0, 9),\n        exclude=list(args[\"--exclude\"]),\n        dry_run=bool(args[\"--dry-run\"]),\n    )\n\n\ndef parse(argv: list[str] | None = None) -> dict:\n    \"\"\"Parse argv; exit 2 on a usage error, like argparse and Click.\"\"\"\n    try:\n        return docopt(__doc__, argv=argv, version=f\"backup {__version__}\")\n    except DocoptExit as exc:\n        print(str(exc), file=sys.stderr)\n        raise SystemExit(2) from None\n\n\ndef main(argv: list[str] | None = None) -> int:\n    args = parse(argv)\n    try:\n        if args[\"run\"]:\n            run = to_run_args(args)\n            verb = \"would copy\" if run.dry_run else \"copying\"\n            for src in run.sources:\n                print(f\"{verb} {src} -> {run.dest} (level {run.compress})\")\n        elif args[\"list\"]:\n            limit = _int_in_range(args[\"--limit\"], \"--limit\", 1, 1000)\n            print(f\"showing up to {limit} backups\")\n    except UsageError as exc:\n        print(f\"error: {exc}\", file=sys.stderr)\n        return 2\n    return 0\n\n\nif __name__ == \"__main__\":\n    raise SystemExit(main())\n","python","",[19,136,137,146,153,160,166,172,178,184,190,195,201,207,213,219,225,231,237,243,249,254,260,266,272,278,296,301,310,323,336,341,354,359,371,376,381,400,406,411,416,436,447,453,459,468,495,509,514,519,556,564,578,589,636,659,710,719,724,729,746,754,783,800,832,850,867,873,878,883,914,920,927,966,980,1001,1020,1025,1030,1058,1069,1076,1090,1101,1124,1138,1190,1203,1233,1258,1270,1299,1307,1315,1320,1325,1342],{"__ignoreMap":134},[138,139,142],"span",{"class":140,"line":141},"line",1,[138,143,145],{"class":144},"sJ8bj","# src\u002Fbackup\u002Fcli.py\n",[138,147,149],{"class":140,"line":148},2,[138,150,152],{"class":151},"sZZnC","\"\"\"Back up directories to a destination.\n",[138,154,156],{"class":140,"line":155},3,[138,157,159],{"emptyLinePlaceholder":158},true,"\n",[138,161,163],{"class":140,"line":162},4,[138,164,165],{"class":151},"Usage:\n",[138,167,169],{"class":140,"line":168},5,[138,170,171],{"class":151},"  backup run \u003Csource>... --to=\u003Cdest> [--compress=\u003Clevel>] [--exclude=\u003Cglob>]... [--dry-run]\n",[138,173,175],{"class":140,"line":174},6,[138,176,177],{"class":151},"  backup list [--limit=\u003Cn>] [--json]\n",[138,179,181],{"class":140,"line":180},7,[138,182,183],{"class":151},"  backup -h | --help\n",[138,185,187],{"class":140,"line":186},8,[138,188,189],{"class":151},"  backup --version\n",[138,191,193],{"class":140,"line":192},9,[138,194,159],{"emptyLinePlaceholder":158},[138,196,198],{"class":140,"line":197},10,[138,199,200],{"class":151},"Options:\n",[138,202,204],{"class":140,"line":203},11,[138,205,206],{"class":151},"  -h --help            Show this help.\n",[138,208,210],{"class":140,"line":209},12,[138,211,212],{"class":151},"  --version            Show the version.\n",[138,214,216],{"class":140,"line":215},13,[138,217,218],{"class":151},"  --to=\u003Cdest>          Destination directory.\n",[138,220,222],{"class":140,"line":221},14,[138,223,224],{"class":151},"  --compress=\u003Clevel>   Compression level, 0-9 [default: 6].\n",[138,226,228],{"class":140,"line":227},15,[138,229,230],{"class":151},"  --exclude=\u003Cglob>     Skip paths matching this glob; repeatable.\n",[138,232,234],{"class":140,"line":233},16,[138,235,236],{"class":151},"  --limit=\u003Cn>          Show at most n backups [default: 10].\n",[138,238,240],{"class":140,"line":239},17,[138,241,242],{"class":151},"  --json               Print JSON instead of a table.\n",[138,244,246],{"class":140,"line":245},18,[138,247,248],{"class":151},"  --dry-run            Show what would be copied without copying.\n",[138,250,252],{"class":140,"line":251},19,[138,253,159],{"emptyLinePlaceholder":158},[138,255,257],{"class":140,"line":256},20,[138,258,259],{"class":151},"Examples:\n",[138,261,263],{"class":140,"line":262},21,[138,264,265],{"class":151},"  backup run ~\u002Fdocs ~\u002Fphotos --to=\u002Fmnt\u002Fbackup --exclude='*.tmp'\n",[138,267,269],{"class":140,"line":268},22,[138,270,271],{"class":151},"  backup list --limit=3\n",[138,273,275],{"class":140,"line":274},23,[138,276,277],{"class":151},"\"\"\"\n",[138,279,281,285,289,292],{"class":140,"line":280},24,[138,282,284],{"class":283},"szBVR","from",[138,286,288],{"class":287},"sj4cs"," __future__",[138,290,291],{"class":283}," import",[138,293,295],{"class":294},"sVt8B"," annotations\n",[138,297,299],{"class":140,"line":298},25,[138,300,159],{"emptyLinePlaceholder":158},[138,302,304,307],{"class":140,"line":303},26,[138,305,306],{"class":283},"import",[138,308,309],{"class":294}," sys\n",[138,311,313,315,318,320],{"class":140,"line":312},27,[138,314,284],{"class":283},[138,316,317],{"class":294}," dataclasses ",[138,319,306],{"class":283},[138,321,322],{"class":294}," dataclass, field\n",[138,324,326,328,331,333],{"class":140,"line":325},28,[138,327,284],{"class":283},[138,329,330],{"class":294}," pathlib ",[138,332,306],{"class":283},[138,334,335],{"class":294}," Path\n",[138,337,339],{"class":140,"line":338},29,[138,340,159],{"emptyLinePlaceholder":158},[138,342,344,346,349,351],{"class":140,"line":343},30,[138,345,284],{"class":283},[138,347,348],{"class":294}," docopt ",[138,350,306],{"class":283},[138,352,353],{"class":294}," DocoptExit, docopt\n",[138,355,357],{"class":140,"line":356},31,[138,358,159],{"emptyLinePlaceholder":158},[138,360,362,365,368],{"class":140,"line":361},32,[138,363,364],{"class":287},"__version__",[138,366,367],{"class":283}," =",[138,369,370],{"class":151}," \"1.0.0\"\n",[138,372,374],{"class":140,"line":373},33,[138,375,159],{"emptyLinePlaceholder":158},[138,377,379],{"class":140,"line":378},34,[138,380,159],{"emptyLinePlaceholder":158},[138,382,384,387,391,394,397],{"class":140,"line":383},35,[138,385,386],{"class":283},"class",[138,388,390],{"class":389},"sScJk"," UsageError",[138,392,393],{"class":294},"(",[138,395,396],{"class":287},"Exception",[138,398,399],{"class":294},"):\n",[138,401,403],{"class":140,"line":402},36,[138,404,405],{"class":283},"    pass\n",[138,407,409],{"class":140,"line":408},37,[138,410,159],{"emptyLinePlaceholder":158},[138,412,414],{"class":140,"line":413},38,[138,415,159],{"emptyLinePlaceholder":158},[138,417,419,422,424,428,431,433],{"class":140,"line":418},39,[138,420,421],{"class":389},"@dataclass",[138,423,393],{"class":294},[138,425,427],{"class":426},"s4XuR","frozen",[138,429,430],{"class":283},"=",[138,432,111],{"class":287},[138,434,435],{"class":294},")\n",[138,437,439,441,444],{"class":140,"line":438},40,[138,440,386],{"class":283},[138,442,443],{"class":389}," RunArgs",[138,445,446],{"class":294},":\n",[138,448,450],{"class":140,"line":449},41,[138,451,452],{"class":294},"    sources: list[Path]\n",[138,454,456],{"class":140,"line":455},42,[138,457,458],{"class":294},"    dest: Path\n",[138,460,462,465],{"class":140,"line":461},43,[138,463,464],{"class":294},"    compress: ",[138,466,467],{"class":287},"int\n",[138,469,471,474,477,480,482,485,488,490,493],{"class":140,"line":470},44,[138,472,473],{"class":294},"    exclude: list[",[138,475,476],{"class":287},"str",[138,478,479],{"class":294},"] ",[138,481,430],{"class":283},[138,483,484],{"class":294}," field(",[138,486,487],{"class":426},"default_factory",[138,489,430],{"class":283},[138,491,492],{"class":287},"list",[138,494,435],{"class":294},[138,496,498,501,504,506],{"class":140,"line":497},45,[138,499,500],{"class":294},"    dry_run: ",[138,502,503],{"class":287},"bool",[138,505,367],{"class":283},[138,507,508],{"class":287}," False\n",[138,510,512],{"class":140,"line":511},46,[138,513,159],{"emptyLinePlaceholder":158},[138,515,517],{"class":140,"line":516},47,[138,518,159],{"emptyLinePlaceholder":158},[138,520,522,525,528,531,533,536,538,541,544,547,549,552,554],{"class":140,"line":521},48,[138,523,524],{"class":283},"def",[138,526,527],{"class":389}," _int_in_range",[138,529,530],{"class":294},"(raw: ",[138,532,476],{"class":287},[138,534,535],{"class":294},", name: ",[138,537,476],{"class":287},[138,539,540],{"class":294},", lo: ",[138,542,543],{"class":287},"int",[138,545,546],{"class":294},", hi: ",[138,548,543],{"class":287},[138,550,551],{"class":294},") -> ",[138,553,543],{"class":287},[138,555,446],{"class":294},[138,557,559,562],{"class":140,"line":558},49,[138,560,561],{"class":283},"    try",[138,563,446],{"class":294},[138,565,567,570,572,575],{"class":140,"line":566},50,[138,568,569],{"class":294},"        value ",[138,571,430],{"class":283},[138,573,574],{"class":287}," int",[138,576,577],{"class":294},"(raw)\n",[138,579,581,584,587],{"class":140,"line":580},51,[138,582,583],{"class":283},"    except",[138,585,586],{"class":287}," ValueError",[138,588,446],{"class":294},[138,590,592,595,598,601,604,607,610,613,616,618,621,624,626,628,631,633],{"class":140,"line":591},52,[138,593,594],{"class":283},"        raise",[138,596,597],{"class":294}," UsageError(",[138,599,600],{"class":283},"f",[138,602,603],{"class":151},"\"",[138,605,606],{"class":287},"{",[138,608,609],{"class":294},"name",[138,611,612],{"class":287},"}",[138,614,615],{"class":151}," must be a whole number, got ",[138,617,606],{"class":287},[138,619,620],{"class":294},"raw",[138,622,623],{"class":283},"!r",[138,625,612],{"class":287},[138,627,603],{"class":151},[138,629,630],{"class":294},") ",[138,632,284],{"class":283},[138,634,635],{"class":287}," None\n",[138,637,639,642,645,648,651,654,656],{"class":140,"line":638},53,[138,640,641],{"class":283},"    if",[138,643,644],{"class":283}," not",[138,646,647],{"class":294}," lo ",[138,649,650],{"class":283},"\u003C=",[138,652,653],{"class":294}," value ",[138,655,650],{"class":283},[138,657,658],{"class":294}," hi:\n",[138,660,662,664,666,668,670,672,674,676,679,681,684,686,689,691,694,696,699,701,704,706,708],{"class":140,"line":661},54,[138,663,594],{"class":283},[138,665,597],{"class":294},[138,667,600],{"class":283},[138,669,603],{"class":151},[138,671,606],{"class":287},[138,673,609],{"class":294},[138,675,612],{"class":287},[138,677,678],{"class":151}," must be between ",[138,680,606],{"class":287},[138,682,683],{"class":294},"lo",[138,685,612],{"class":287},[138,687,688],{"class":151}," and ",[138,690,606],{"class":287},[138,692,693],{"class":294},"hi",[138,695,612],{"class":287},[138,697,698],{"class":151},", got ",[138,700,606],{"class":287},[138,702,703],{"class":294},"value",[138,705,612],{"class":287},[138,707,603],{"class":151},[138,709,435],{"class":294},[138,711,713,716],{"class":140,"line":712},55,[138,714,715],{"class":283},"    return",[138,717,718],{"class":294}," value\n",[138,720,722],{"class":140,"line":721},56,[138,723,159],{"emptyLinePlaceholder":158},[138,725,727],{"class":140,"line":726},57,[138,728,159],{"emptyLinePlaceholder":158},[138,730,732,734,737,740,743],{"class":140,"line":731},58,[138,733,524],{"class":283},[138,735,736],{"class":389}," to_run_args",[138,738,739],{"class":294},"(args: ",[138,741,742],{"class":287},"dict",[138,744,745],{"class":294},") -> RunArgs:\n",[138,747,749,751],{"class":140,"line":748},59,[138,750,715],{"class":283},[138,752,753],{"class":294}," RunArgs(\n",[138,755,757,760,762,765,768,771,774,777,780],{"class":140,"line":756},60,[138,758,759],{"class":426},"        sources",[138,761,430],{"class":283},[138,763,764],{"class":294},"[Path(s) ",[138,766,767],{"class":283},"for",[138,769,770],{"class":294}," s ",[138,772,773],{"class":283},"in",[138,775,776],{"class":294}," args[",[138,778,779],{"class":151},"\"\u003Csource>\"",[138,781,782],{"class":294},"]],\n",[138,784,786,789,791,794,797],{"class":140,"line":785},61,[138,787,788],{"class":426},"        dest",[138,790,430],{"class":283},[138,792,793],{"class":294},"Path(args[",[138,795,796],{"class":151},"\"--to\"",[138,798,799],{"class":294},"]),\n",[138,801,803,806,808,811,814,817,819,821,824,826,829],{"class":140,"line":802},62,[138,804,805],{"class":426},"        compress",[138,807,430],{"class":283},[138,809,810],{"class":294},"_int_in_range(args[",[138,812,813],{"class":151},"\"--compress\"",[138,815,816],{"class":294},"], ",[138,818,813],{"class":151},[138,820,63],{"class":294},[138,822,823],{"class":287},"0",[138,825,63],{"class":294},[138,827,828],{"class":287},"9",[138,830,831],{"class":294},"),\n",[138,833,835,838,840,842,845,848],{"class":140,"line":834},63,[138,836,837],{"class":426},"        exclude",[138,839,430],{"class":283},[138,841,492],{"class":287},[138,843,844],{"class":294},"(args[",[138,846,847],{"class":151},"\"--exclude\"",[138,849,799],{"class":294},[138,851,853,856,858,860,862,865],{"class":140,"line":852},64,[138,854,855],{"class":426},"        dry_run",[138,857,430],{"class":283},[138,859,503],{"class":287},[138,861,844],{"class":294},[138,863,864],{"class":151},"\"--dry-run\"",[138,866,799],{"class":294},[138,868,870],{"class":140,"line":869},65,[138,871,872],{"class":294},"    )\n",[138,874,876],{"class":140,"line":875},66,[138,877,159],{"emptyLinePlaceholder":158},[138,879,881],{"class":140,"line":880},67,[138,882,159],{"emptyLinePlaceholder":158},[138,884,886,888,891,894,896,898,901,904,906,908,910,912],{"class":140,"line":885},68,[138,887,524],{"class":283},[138,889,890],{"class":389}," parse",[138,892,893],{"class":294},"(argv: list[",[138,895,476],{"class":287},[138,897,479],{"class":294},[138,899,900],{"class":283},"|",[138,902,903],{"class":287}," None",[138,905,367],{"class":283},[138,907,903],{"class":287},[138,909,551],{"class":294},[138,911,742],{"class":287},[138,913,446],{"class":294},[138,915,917],{"class":140,"line":916},69,[138,918,919],{"class":151},"    \"\"\"Parse argv; exit 2 on a usage error, like argparse and Click.\"\"\"\n",[138,921,923,925],{"class":140,"line":922},70,[138,924,561],{"class":283},[138,926,446],{"class":294},[138,928,930,933,936,939,941,944,946,949,952,954,956,959,962,964],{"class":140,"line":929},71,[138,931,932],{"class":283},"        return",[138,934,935],{"class":294}," docopt(",[138,937,938],{"class":287},"__doc__",[138,940,63],{"class":294},[138,942,943],{"class":426},"argv",[138,945,430],{"class":283},[138,947,948],{"class":294},"argv, ",[138,950,951],{"class":426},"version",[138,953,430],{"class":283},[138,955,600],{"class":283},[138,957,958],{"class":151},"\"backup ",[138,960,961],{"class":287},"{__version__}",[138,963,603],{"class":151},[138,965,435],{"class":294},[138,967,969,971,974,977],{"class":140,"line":968},72,[138,970,583],{"class":283},[138,972,973],{"class":294}," DocoptExit ",[138,975,976],{"class":283},"as",[138,978,979],{"class":294}," exc:\n",[138,981,983,986,988,990,993,996,998],{"class":140,"line":982},73,[138,984,985],{"class":287},"        print",[138,987,393],{"class":294},[138,989,476],{"class":287},[138,991,992],{"class":294},"(exc), ",[138,994,995],{"class":426},"file",[138,997,430],{"class":283},[138,999,1000],{"class":294},"sys.stderr)\n",[138,1002,1004,1006,1009,1011,1014,1016,1018],{"class":140,"line":1003},74,[138,1005,594],{"class":283},[138,1007,1008],{"class":287}," SystemExit",[138,1010,393],{"class":294},[138,1012,1013],{"class":287},"2",[138,1015,630],{"class":294},[138,1017,284],{"class":283},[138,1019,635],{"class":287},[138,1021,1023],{"class":140,"line":1022},75,[138,1024,159],{"emptyLinePlaceholder":158},[138,1026,1028],{"class":140,"line":1027},76,[138,1029,159],{"emptyLinePlaceholder":158},[138,1031,1033,1035,1038,1040,1042,1044,1046,1048,1050,1052,1054,1056],{"class":140,"line":1032},77,[138,1034,524],{"class":283},[138,1036,1037],{"class":389}," main",[138,1039,893],{"class":294},[138,1041,476],{"class":287},[138,1043,479],{"class":294},[138,1045,900],{"class":283},[138,1047,903],{"class":287},[138,1049,367],{"class":283},[138,1051,903],{"class":287},[138,1053,551],{"class":294},[138,1055,543],{"class":287},[138,1057,446],{"class":294},[138,1059,1061,1064,1066],{"class":140,"line":1060},78,[138,1062,1063],{"class":294},"    args ",[138,1065,430],{"class":283},[138,1067,1068],{"class":294}," parse(argv)\n",[138,1070,1072,1074],{"class":140,"line":1071},79,[138,1073,561],{"class":283},[138,1075,446],{"class":294},[138,1077,1079,1082,1084,1087],{"class":140,"line":1078},80,[138,1080,1081],{"class":283},"        if",[138,1083,776],{"class":294},[138,1085,1086],{"class":151},"\"run\"",[138,1088,1089],{"class":294},"]:\n",[138,1091,1093,1096,1098],{"class":140,"line":1092},81,[138,1094,1095],{"class":294},"            run ",[138,1097,430],{"class":283},[138,1099,1100],{"class":294}," to_run_args(args)\n",[138,1102,1104,1107,1109,1112,1115,1118,1121],{"class":140,"line":1103},82,[138,1105,1106],{"class":294},"            verb ",[138,1108,430],{"class":283},[138,1110,1111],{"class":151}," \"would copy\"",[138,1113,1114],{"class":283}," if",[138,1116,1117],{"class":294}," run.dry_run ",[138,1119,1120],{"class":283},"else",[138,1122,1123],{"class":151}," \"copying\"\n",[138,1125,1127,1130,1133,1135],{"class":140,"line":1126},83,[138,1128,1129],{"class":283},"            for",[138,1131,1132],{"class":294}," src ",[138,1134,773],{"class":283},[138,1136,1137],{"class":294}," run.sources:\n",[138,1139,1141,1144,1146,1148,1150,1152,1155,1157,1160,1163,1165,1168,1170,1173,1175,1178,1180,1183,1185,1188],{"class":140,"line":1140},84,[138,1142,1143],{"class":287},"                print",[138,1145,393],{"class":294},[138,1147,600],{"class":283},[138,1149,603],{"class":151},[138,1151,606],{"class":287},[138,1153,1154],{"class":294},"verb",[138,1156,612],{"class":287},[138,1158,1159],{"class":287}," {",[138,1161,1162],{"class":294},"src",[138,1164,612],{"class":287},[138,1166,1167],{"class":151}," -> ",[138,1169,606],{"class":287},[138,1171,1172],{"class":294},"run.dest",[138,1174,612],{"class":287},[138,1176,1177],{"class":151}," (level ",[138,1179,606],{"class":287},[138,1181,1182],{"class":294},"run.compress",[138,1184,612],{"class":287},[138,1186,1187],{"class":151},")\"",[138,1189,435],{"class":294},[138,1191,1193,1196,1198,1201],{"class":140,"line":1192},85,[138,1194,1195],{"class":283},"        elif",[138,1197,776],{"class":294},[138,1199,1200],{"class":151},"\"list\"",[138,1202,1089],{"class":294},[138,1204,1206,1209,1211,1214,1217,1219,1221,1223,1226,1228,1231],{"class":140,"line":1205},86,[138,1207,1208],{"class":294},"            limit ",[138,1210,430],{"class":283},[138,1212,1213],{"class":294}," _int_in_range(args[",[138,1215,1216],{"class":151},"\"--limit\"",[138,1218,816],{"class":294},[138,1220,1216],{"class":151},[138,1222,63],{"class":294},[138,1224,1225],{"class":287},"1",[138,1227,63],{"class":294},[138,1229,1230],{"class":287},"1000",[138,1232,435],{"class":294},[138,1234,1236,1239,1241,1243,1246,1248,1251,1253,1256],{"class":140,"line":1235},87,[138,1237,1238],{"class":287},"            print",[138,1240,393],{"class":294},[138,1242,600],{"class":283},[138,1244,1245],{"class":151},"\"showing up to ",[138,1247,606],{"class":287},[138,1249,1250],{"class":294},"limit",[138,1252,612],{"class":287},[138,1254,1255],{"class":151}," backups\"",[138,1257,435],{"class":294},[138,1259,1261,1263,1266,1268],{"class":140,"line":1260},88,[138,1262,583],{"class":283},[138,1264,1265],{"class":294}," UsageError ",[138,1267,976],{"class":283},[138,1269,979],{"class":294},[138,1271,1273,1275,1277,1279,1282,1284,1287,1289,1291,1293,1295,1297],{"class":140,"line":1272},89,[138,1274,985],{"class":287},[138,1276,393],{"class":294},[138,1278,600],{"class":283},[138,1280,1281],{"class":151},"\"error: ",[138,1283,606],{"class":287},[138,1285,1286],{"class":294},"exc",[138,1288,612],{"class":287},[138,1290,603],{"class":151},[138,1292,63],{"class":294},[138,1294,995],{"class":426},[138,1296,430],{"class":283},[138,1298,1000],{"class":294},[138,1300,1302,1304],{"class":140,"line":1301},90,[138,1303,932],{"class":283},[138,1305,1306],{"class":287}," 2\n",[138,1308,1310,1312],{"class":140,"line":1309},91,[138,1311,715],{"class":283},[138,1313,1314],{"class":287}," 0\n",[138,1316,1318],{"class":140,"line":1317},92,[138,1319,159],{"emptyLinePlaceholder":158},[138,1321,1323],{"class":140,"line":1322},93,[138,1324,159],{"emptyLinePlaceholder":158},[138,1326,1328,1331,1334,1337,1340],{"class":140,"line":1327},94,[138,1329,1330],{"class":283},"if",[138,1332,1333],{"class":287}," __name__",[138,1335,1336],{"class":283}," ==",[138,1338,1339],{"class":151}," \"__main__\"",[138,1341,446],{"class":294},[138,1343,1345,1348,1350],{"class":140,"line":1344},95,[138,1346,1347],{"class":283},"    raise",[138,1349,1008],{"class":287},[138,1351,1352],{"class":294},"(main())\n",[10,1354,1355,1356,1359,1360,1362,1363,1366,1367,1370,1371,1373],{},"The structure has three layers. ",[19,1357,1358],{},"parse()"," turns ",[19,1361,943],{}," into docopt's dictionary and owns the exit-code fix. ",[19,1364,1365],{},"to_run_args()"," turns that untyped dictionary into a typed, validated dataclass — the layer docopt deliberately does not provide. And ",[19,1368,1369],{},"main()"," dispatches on command words and calls into the real work. Taking ",[19,1372,943],{}," as a parameter is what makes the whole thing testable.",[99,1375],{"name":1376},"docopt-layers",[1378,1379,1381],"h3",{"id":1380},"why-the-exit-code-needs-fixing","Why the exit code needs fixing",[10,1383,1384,1385,1388,1389,1392,1393,1395,1396,1398,1399,1403,1404,1406],{},"When the command line matches no pattern, docopt-ng raises ",[19,1386,1387],{},"DocoptExit",", a ",[19,1390,1391],{},"SystemExit"," subclass whose code is the usage message. Python prints that message and exits with status ",[24,1394,1225],{}," — the same status as \"the backup failed\". Click, Typer, argparse and most Unix tools use ",[24,1397,1013],{}," for usage errors, and scripts rely on the difference; ",[29,1400,1402],{"href":1401},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools\u002F","choosing exit codes for CLI tools"," explains why. Catching ",[19,1405,1387],{}," in one place restores the convention.",[99,1408],{"name":1409},"docopt-terminal",[35,1411,1413],{"id":1412},"pattern-syntax-worth-knowing","Pattern syntax worth knowing",[10,1415,1416],{},"Most docopt surprises come from a handful of syntax rules. Knowing them saves a lot of trial and error:",[40,1418,1419,1427,1447,1465,1471,1488],{},[43,1420,1421,1426],{},[24,1422,1423],{},[19,1424,1425],{},"[options]"," in a pattern is a shortcut for \"any option from the Options section\". It keeps patterns short but loosens validation, because every option becomes legal with every command. Spelling options out per pattern, as above, is stricter.",[43,1428,1429,1434,1435,1438,1439,1442,1443,1446],{},[24,1430,1431,1433],{},[19,1432,72],{}," repeats the element before it."," ",[19,1436,1437],{},"\u003Csource>..."," means one or more sources; ",[19,1440,1441],{},"[\u003Csource>...]"," means zero or more. Repeated options (",[19,1444,1445],{},"[--exclude=\u003Cglob>]...",") arrive as lists.",[43,1448,1449,1434,1452,1455,1456,1459,1460,1464],{},[24,1450,1451],{},"Parentheses group required alternatives.",[19,1453,1454],{},"(--json | --csv)"," requires exactly one; ",[19,1457,1458],{},"[--json | --csv]"," allows at most one. This is docopt's answer to mutually exclusive options, which argparse handles with groups — compare ",[29,1461,1463],{"href":1462},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse\u002F","mutually exclusive options in argparse",".",[43,1466,1467,1470],{},[24,1468,1469],{},"Option descriptions need two spaces."," In the Options section, the option forms and the description must be separated by at least two spaces, or docopt reads the description as part of the option.",[43,1472,1473,1476,1477,1479,1480,1483,1484,1487],{},[24,1474,1475],{},"Counting flags."," A pattern element such as ",[19,1478,123],{}," makes the value an integer count, so ",[19,1481,1482],{},"-vvv"," gives ",[19,1485,1486],{},"3"," — handy for verbosity levels.",[43,1489,1490,1496,1497,1499],{},[24,1491,1492,1495],{},[19,1493,1494],{},"--"," ends options."," Anything after a bare ",[19,1498,1494],{}," is treated as positional, which lets users pass file names that begin with a dash.",[10,1501,1502],{},"When a pattern does not behave as expected, print the parsed dictionary for a few sample command lines. Because the result contains every key from every pattern, it shows exactly which elements matched.",[35,1504,1506],{"id":1505},"ux-considerations","UX considerations",[40,1508,1509,1524,1534,1540,1551],{},[43,1510,1511,1514,1515,688,1517,1519,1520,1464],{},[24,1512,1513],{},"Put examples in the docstring."," They cost nothing — docopt ignores sections other than ",[19,1516,88],{},[19,1518,96],{}," — and users read examples first. See ",[29,1521,1523],{"href":1522},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fadding-examples-and-epilogs-to-help-output\u002F","adding examples and epilogs to help output",[43,1525,1526,1533],{},[24,1527,1528,1529,1532],{},"Write ",[19,1530,1531],{},"[default: …]"," in the options section."," docopt fills in the default and the help shows it, with one source of truth.",[43,1535,1536,1539],{},[24,1537,1538],{},"Be careful with pattern ambiguity."," Two patterns that can match the same tokens produce confusing results. Keep one pattern per command word and let options be optional within it.",[43,1541,1542,1545,1546,1550],{},[24,1543,1544],{},"Validate everything that is not a string."," Numbers, ranges, paths that must exist and mutually exclusive options all belong in the conversion layer. The rule from ",[29,1547,1549],{"href":1548},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002F","advanced argument validation strategies"," applies: validate once, at the boundary, and pass typed values inward.",[43,1552,1553,1556],{},[24,1554,1555],{},"Error messages are terse."," docopt prints the usage section and nothing else for a non-matching command line. Keep the usage section short enough that this is helpful.",[35,1558,1560],{"id":1559},"testing-the-behaviour","Testing the behaviour",[10,1562,1563,1564,688,1566,1568,1569,1571],{},"Because ",[19,1565,1369],{},[19,1567,1358],{}," accept ",[19,1570,943],{},", tests call them directly. Test the parsed dictionary for each pattern, the conversion layer for each rule, and the exit codes:",[129,1573,1575],{"className":131,"code":1574,"language":133,"meta":134,"style":134},"# tests\u002Ftest_cli.py\nimport pytest\n\nfrom backup import cli\n\n\ndef test_run_pattern_collects_repeated_values():\n    args = cli.parse([\"run\", \"a\", \"b\", \"--to=\u002Fmnt\", \"--exclude=*.tmp\", \"--exclude=*.log\"])\n    assert args[\"run\"] and args[\"\u003Csource>\"] == [\"a\", \"b\"]\n    assert args[\"--exclude\"] == [\"*.tmp\", \"*.log\"]\n    assert args[\"--compress\"] == \"6\"                     # default, still a string\n\n\ndef test_conversion_produces_typed_values():\n    run = cli.to_run_args(cli.parse([\"run\", \"a\", \"--to=\u002Fmnt\", \"--compress=9\"]))\n    assert run.compress == 9 and str(run.dest) == \"\u002Fmnt\"\n\n\n@pytest.mark.parametrize(\"level\", [\"10\", \"-1\", \"fast\"])\ndef test_bad_compress_level_is_a_usage_error(level, capsys):\n    assert cli.main([\"run\", \"a\", \"--to=\u002Fmnt\", f\"--compress={level}\"]) == 2\n    assert \"--compress\" in capsys.readouterr().err\n\n\ndef test_unmatched_command_line_exits_2(capsys):\n    with pytest.raises(SystemExit) as exc:\n        cli.main([\"restore\"])\n    assert exc.value.code == 2\n    assert \"Usage:\" in capsys.readouterr().err\n\n\ndef test_dry_run_output(capsys):\n    assert cli.main([\"run\", \"a\", \"--to=\u002Fmnt\", \"--dry-run\"]) == 0\n    assert capsys.readouterr().out == \"would copy a -> \u002Fmnt (level 6)\\n\"\n",[19,1576,1577,1582,1589,1593,1605,1609,1613,1623,1662,1697,1721,1739,1743,1747,1756,1784,1810,1814,1818,1846,1856,1896,1909,1913,1917,1927,1943,1953,1964,1975,1979,1983,1992,2018],{"__ignoreMap":134},[138,1578,1579],{"class":140,"line":141},[138,1580,1581],{"class":144},"# tests\u002Ftest_cli.py\n",[138,1583,1584,1586],{"class":140,"line":148},[138,1585,306],{"class":283},[138,1587,1588],{"class":294}," pytest\n",[138,1590,1591],{"class":140,"line":155},[138,1592,159],{"emptyLinePlaceholder":158},[138,1594,1595,1597,1600,1602],{"class":140,"line":162},[138,1596,284],{"class":283},[138,1598,1599],{"class":294}," backup ",[138,1601,306],{"class":283},[138,1603,1604],{"class":294}," cli\n",[138,1606,1607],{"class":140,"line":168},[138,1608,159],{"emptyLinePlaceholder":158},[138,1610,1611],{"class":140,"line":174},[138,1612,159],{"emptyLinePlaceholder":158},[138,1614,1615,1617,1620],{"class":140,"line":180},[138,1616,524],{"class":283},[138,1618,1619],{"class":389}," test_run_pattern_collects_repeated_values",[138,1621,1622],{"class":294},"():\n",[138,1624,1625,1627,1629,1632,1634,1636,1639,1641,1644,1646,1649,1651,1654,1656,1659],{"class":140,"line":186},[138,1626,1063],{"class":294},[138,1628,430],{"class":283},[138,1630,1631],{"class":294}," cli.parse([",[138,1633,1086],{"class":151},[138,1635,63],{"class":294},[138,1637,1638],{"class":151},"\"a\"",[138,1640,63],{"class":294},[138,1642,1643],{"class":151},"\"b\"",[138,1645,63],{"class":294},[138,1647,1648],{"class":151},"\"--to=\u002Fmnt\"",[138,1650,63],{"class":294},[138,1652,1653],{"class":151},"\"--exclude=*.tmp\"",[138,1655,63],{"class":294},[138,1657,1658],{"class":151},"\"--exclude=*.log\"",[138,1660,1661],{"class":294},"])\n",[138,1663,1664,1667,1669,1671,1673,1676,1678,1680,1682,1685,1688,1690,1692,1694],{"class":140,"line":192},[138,1665,1666],{"class":283},"    assert",[138,1668,776],{"class":294},[138,1670,1086],{"class":151},[138,1672,479],{"class":294},[138,1674,1675],{"class":283},"and",[138,1677,776],{"class":294},[138,1679,779],{"class":151},[138,1681,479],{"class":294},[138,1683,1684],{"class":283},"==",[138,1686,1687],{"class":294}," [",[138,1689,1638],{"class":151},[138,1691,63],{"class":294},[138,1693,1643],{"class":151},[138,1695,1696],{"class":294},"]\n",[138,1698,1699,1701,1703,1705,1707,1709,1711,1714,1716,1719],{"class":140,"line":197},[138,1700,1666],{"class":283},[138,1702,776],{"class":294},[138,1704,847],{"class":151},[138,1706,479],{"class":294},[138,1708,1684],{"class":283},[138,1710,1687],{"class":294},[138,1712,1713],{"class":151},"\"*.tmp\"",[138,1715,63],{"class":294},[138,1717,1718],{"class":151},"\"*.log\"",[138,1720,1696],{"class":294},[138,1722,1723,1725,1727,1729,1731,1733,1736],{"class":140,"line":203},[138,1724,1666],{"class":283},[138,1726,776],{"class":294},[138,1728,813],{"class":151},[138,1730,479],{"class":294},[138,1732,1684],{"class":283},[138,1734,1735],{"class":151}," \"6\"",[138,1737,1738],{"class":144},"                     # default, still a string\n",[138,1740,1741],{"class":140,"line":209},[138,1742,159],{"emptyLinePlaceholder":158},[138,1744,1745],{"class":140,"line":215},[138,1746,159],{"emptyLinePlaceholder":158},[138,1748,1749,1751,1754],{"class":140,"line":221},[138,1750,524],{"class":283},[138,1752,1753],{"class":389}," test_conversion_produces_typed_values",[138,1755,1622],{"class":294},[138,1757,1758,1761,1763,1766,1768,1770,1772,1774,1776,1778,1781],{"class":140,"line":227},[138,1759,1760],{"class":294},"    run ",[138,1762,430],{"class":283},[138,1764,1765],{"class":294}," cli.to_run_args(cli.parse([",[138,1767,1086],{"class":151},[138,1769,63],{"class":294},[138,1771,1638],{"class":151},[138,1773,63],{"class":294},[138,1775,1648],{"class":151},[138,1777,63],{"class":294},[138,1779,1780],{"class":151},"\"--compress=9\"",[138,1782,1783],{"class":294},"]))\n",[138,1785,1786,1788,1791,1793,1796,1799,1802,1805,1807],{"class":140,"line":233},[138,1787,1666],{"class":283},[138,1789,1790],{"class":294}," run.compress ",[138,1792,1684],{"class":283},[138,1794,1795],{"class":287}," 9",[138,1797,1798],{"class":283}," and",[138,1800,1801],{"class":287}," str",[138,1803,1804],{"class":294},"(run.dest) ",[138,1806,1684],{"class":283},[138,1808,1809],{"class":151}," \"\u002Fmnt\"\n",[138,1811,1812],{"class":140,"line":239},[138,1813,159],{"emptyLinePlaceholder":158},[138,1815,1816],{"class":140,"line":245},[138,1817,159],{"emptyLinePlaceholder":158},[138,1819,1820,1823,1825,1828,1831,1834,1836,1839,1841,1844],{"class":140,"line":251},[138,1821,1822],{"class":389},"@pytest.mark.parametrize",[138,1824,393],{"class":294},[138,1826,1827],{"class":151},"\"level\"",[138,1829,1830],{"class":294},", [",[138,1832,1833],{"class":151},"\"10\"",[138,1835,63],{"class":294},[138,1837,1838],{"class":151},"\"-1\"",[138,1840,63],{"class":294},[138,1842,1843],{"class":151},"\"fast\"",[138,1845,1661],{"class":294},[138,1847,1848,1850,1853],{"class":140,"line":256},[138,1849,524],{"class":283},[138,1851,1852],{"class":389}," test_bad_compress_level_is_a_usage_error",[138,1854,1855],{"class":294},"(level, capsys):\n",[138,1857,1858,1860,1863,1865,1867,1869,1871,1873,1875,1877,1880,1882,1885,1887,1889,1892,1894],{"class":140,"line":262},[138,1859,1666],{"class":283},[138,1861,1862],{"class":294}," cli.main([",[138,1864,1086],{"class":151},[138,1866,63],{"class":294},[138,1868,1638],{"class":151},[138,1870,63],{"class":294},[138,1872,1648],{"class":151},[138,1874,63],{"class":294},[138,1876,600],{"class":283},[138,1878,1879],{"class":151},"\"--compress=",[138,1881,606],{"class":287},[138,1883,1884],{"class":294},"level",[138,1886,612],{"class":287},[138,1888,603],{"class":151},[138,1890,1891],{"class":294},"]) ",[138,1893,1684],{"class":283},[138,1895,1306],{"class":287},[138,1897,1898,1900,1903,1906],{"class":140,"line":268},[138,1899,1666],{"class":283},[138,1901,1902],{"class":151}," \"--compress\"",[138,1904,1905],{"class":283}," in",[138,1907,1908],{"class":294}," capsys.readouterr().err\n",[138,1910,1911],{"class":140,"line":274},[138,1912,159],{"emptyLinePlaceholder":158},[138,1914,1915],{"class":140,"line":280},[138,1916,159],{"emptyLinePlaceholder":158},[138,1918,1919,1921,1924],{"class":140,"line":298},[138,1920,524],{"class":283},[138,1922,1923],{"class":389}," test_unmatched_command_line_exits_2",[138,1925,1926],{"class":294},"(capsys):\n",[138,1928,1929,1932,1935,1937,1939,1941],{"class":140,"line":303},[138,1930,1931],{"class":283},"    with",[138,1933,1934],{"class":294}," pytest.raises(",[138,1936,1391],{"class":287},[138,1938,630],{"class":294},[138,1940,976],{"class":283},[138,1942,979],{"class":294},[138,1944,1945,1948,1951],{"class":140,"line":312},[138,1946,1947],{"class":294},"        cli.main([",[138,1949,1950],{"class":151},"\"restore\"",[138,1952,1661],{"class":294},[138,1954,1955,1957,1960,1962],{"class":140,"line":325},[138,1956,1666],{"class":283},[138,1958,1959],{"class":294}," exc.value.code ",[138,1961,1684],{"class":283},[138,1963,1306],{"class":287},[138,1965,1966,1968,1971,1973],{"class":140,"line":338},[138,1967,1666],{"class":283},[138,1969,1970],{"class":151}," \"Usage:\"",[138,1972,1905],{"class":283},[138,1974,1908],{"class":294},[138,1976,1977],{"class":140,"line":343},[138,1978,159],{"emptyLinePlaceholder":158},[138,1980,1981],{"class":140,"line":356},[138,1982,159],{"emptyLinePlaceholder":158},[138,1984,1985,1987,1990],{"class":140,"line":361},[138,1986,524],{"class":283},[138,1988,1989],{"class":389}," test_dry_run_output",[138,1991,1926],{"class":294},[138,1993,1994,1996,1998,2000,2002,2004,2006,2008,2010,2012,2014,2016],{"class":140,"line":373},[138,1995,1666],{"class":283},[138,1997,1862],{"class":294},[138,1999,1086],{"class":151},[138,2001,63],{"class":294},[138,2003,1638],{"class":151},[138,2005,63],{"class":294},[138,2007,1648],{"class":151},[138,2009,63],{"class":294},[138,2011,864],{"class":151},[138,2013,1891],{"class":294},[138,2015,1684],{"class":283},[138,2017,1314],{"class":287},[138,2019,2020,2022,2025,2027,2030,2033],{"class":140,"line":378},[138,2021,1666],{"class":283},[138,2023,2024],{"class":294}," capsys.readouterr().out ",[138,2026,1684],{"class":283},[138,2028,2029],{"class":151}," \"would copy a -> \u002Fmnt (level 6)",[138,2031,2032],{"class":287},"\\n",[138,2034,2035],{"class":151},"\"\n",[10,2037,2038],{},"A useful extra test asserts that every example line in the docstring parses — cheap insurance that documentation and parser stay in step:",[129,2040,2042],{"className":131,"code":2041,"language":133,"meta":134,"style":134},"# tests\u002Ftest_cli.py (continued)\nimport shlex\n\n\ndef test_docstring_examples_parse():\n    examples = [line.strip() for line in cli.__doc__.split(\"Examples:\")[1].splitlines()\n                if line.strip().startswith(\"backup \")]\n    for line in examples:\n        cli.parse(shlex.split(line)[1:])\n",[19,2043,2044,2049,2056,2060,2064,2073,2109,2123,2135],{"__ignoreMap":134},[138,2045,2046],{"class":140,"line":141},[138,2047,2048],{"class":144},"# tests\u002Ftest_cli.py (continued)\n",[138,2050,2051,2053],{"class":140,"line":148},[138,2052,306],{"class":283},[138,2054,2055],{"class":294}," shlex\n",[138,2057,2058],{"class":140,"line":155},[138,2059,159],{"emptyLinePlaceholder":158},[138,2061,2062],{"class":140,"line":162},[138,2063,159],{"emptyLinePlaceholder":158},[138,2065,2066,2068,2071],{"class":140,"line":168},[138,2067,524],{"class":283},[138,2069,2070],{"class":389}," test_docstring_examples_parse",[138,2072,1622],{"class":294},[138,2074,2075,2078,2080,2083,2085,2088,2090,2093,2095,2098,2101,2104,2106],{"class":140,"line":174},[138,2076,2077],{"class":294},"    examples ",[138,2079,430],{"class":283},[138,2081,2082],{"class":294}," [line.strip() ",[138,2084,767],{"class":283},[138,2086,2087],{"class":294}," line ",[138,2089,773],{"class":283},[138,2091,2092],{"class":294}," cli.",[138,2094,938],{"class":287},[138,2096,2097],{"class":294},".split(",[138,2099,2100],{"class":151},"\"Examples:\"",[138,2102,2103],{"class":294},")[",[138,2105,1225],{"class":287},[138,2107,2108],{"class":294},"].splitlines()\n",[138,2110,2111,2114,2117,2120],{"class":140,"line":180},[138,2112,2113],{"class":283},"                if",[138,2115,2116],{"class":294}," line.strip().startswith(",[138,2118,2119],{"class":151},"\"backup \"",[138,2121,2122],{"class":294},")]\n",[138,2124,2125,2128,2130,2132],{"class":140,"line":186},[138,2126,2127],{"class":283},"    for",[138,2129,2087],{"class":294},[138,2131,773],{"class":283},[138,2133,2134],{"class":294}," examples:\n",[138,2136,2137,2140,2142],{"class":140,"line":192},[138,2138,2139],{"class":294},"        cli.parse(shlex.split(line)[",[138,2141,1225],{"class":287},[138,2143,2144],{"class":294},":])\n",[35,2146,2148],{"id":2147},"migrating-an-old-docopt-project","Migrating an old docopt project",[10,2150,2151,2152,2154,2155,2157,2158,2160,2161,2164,2165,2168],{},"Many long-lived internal tools were written with the original ",[19,2153,21],{}," around 2014–2018 and still run today. Moving them to docopt-ng is usually a one-line dependency change — replace ",[19,2156,21],{}," with ",[19,2159,26],{}," in ",[19,2162,2163],{},"pyproject.toml"," and keep the imports — followed by running the test suite on current Python. If there is no test suite, the ",[19,2166,2167],{},"test_docstring_examples_parse"," test above is a fast way to build one: write down the command lines people actually use, assert each one parses, and you have a safety net before touching anything else. From there, adding the typed conversion layer and the exit-code wrapper can be done one command at a time.",[35,2170,2172],{"id":2171},"conclusion","Conclusion",[10,2174,2175,2176,2179,2180,2184],{},"docopt-ng is at its best for small tools whose interface is stable and whose authors want the help text to be the single source of truth. Write clear usage patterns and an options section with defaults, then add what docopt leaves out: a typed conversion layer, exit code 2 for usage errors and a ",[19,2177,2178],{},"main(argv)"," that tests can call. When the tool grows many commands, rich types or completion needs, a declarative framework such as ",[29,2181,2183],{"href":2182},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts\u002F","Cyclopts"," or Typer will carry it further.",[35,2186,2188],{"id":2187},"frequently-asked-questions","Frequently asked questions",[1378,2190,2192,2193,2195,2196,2198],{"id":2191},"should-i-use-docopt-or-docopt-ng","Should I use ",[19,2194,21],{}," or ",[19,2197,26],{},"?",[10,2200,2201,2203],{},[19,2202,26],{},". The original package has had no release in many years and has known bugs; the fork keeps the same API and import name, adds type hints and supports current Python versions.",[1378,2205,2207],{"id":2206},"can-docopt-handle-subcommands-with-their-own-options","Can docopt handle subcommands with their own options?",[10,2209,2210],{},"Yes, as separate usage patterns sharing one options section. For large command trees this gets unwieldy because all options live in one namespace; a common pattern is one docopt string per subcommand, dispatched on the first argument. At that point a framework with real command groups is usually simpler.",[1378,2212,2214],{"id":2213},"how-do-i-get-attribute-access-instead-of-dictionary-keys","How do I get attribute access instead of dictionary keys?",[10,2216,2217,2218,2221,2222,2225],{},"docopt-ng's result supports attribute-style access (",[19,2219,2220],{},"args.compress"," for ",[19,2223,2224],{},"--compress","), but the typed dataclass from the conversion layer is the better interface for the rest of the program — it carries real types, not strings.",[1378,2227,2229],{"id":2228},"does-docopt-support-shell-completion","Does docopt support shell completion?",[10,2231,2232,2233,1464],{},"Not built in. Third-party projects generate completion scripts from usage strings, but coverage is limited. If completion matters, consider a framework that ships it; see ",[29,2234,2236],{"href":2235},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002F","shell completion for Python CLIs",[35,2238,2240],{"id":2239},"related","Related",[40,2242,2243,2249,2255,2261,2267],{},[43,2244,2245,2246],{},"Up: ",[29,2247,2248],{"href":31},"Alternative Python CLI frameworks",[43,2250,2251],{},[29,2252,2254],{"href":2253},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire\u002F","Quick CLIs from functions with Python Fire",[43,2256,2257],{},[29,2258,2260],{"href":2259},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo\u002F","Building a CLI with Cleo",[43,2262,2263],{},[29,2264,2266],{"href":2265},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read\u002F","Writing help text users actually read",[43,2268,2269],{},[29,2270,2272],{"href":2271},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands\u002F","Argparse subparsers for subcommands",[2274,2275,2276],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .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":134,"searchDepth":148,"depth":148,"links":2278},[2279,2280,2281,2284,2285,2286,2287,2288,2289,2296],{"id":37,"depth":148,"text":38},{"id":81,"depth":148,"text":82},{"id":126,"depth":148,"text":127,"children":2282},[2283],{"id":1380,"depth":155,"text":1381},{"id":1412,"depth":148,"text":1413},{"id":1505,"depth":148,"text":1506},{"id":1559,"depth":148,"text":1560},{"id":2147,"depth":148,"text":2148},{"id":2171,"depth":148,"text":2172},{"id":2187,"depth":148,"text":2188,"children":2290},[2291,2293,2294,2295],{"id":2191,"depth":155,"text":2292},"Should I use docopt or docopt-ng?",{"id":2206,"depth":155,"text":2207},{"id":2213,"depth":155,"text":2214},{"id":2228,"depth":155,"text":2229},{"id":2239,"depth":148,"text":2240},"2026-10-02","Write the help text first and let docopt-ng parse it: usage patterns, defaults, typed validation after parsing, exit code 2 for usage errors, and tests.","intermediate",false,"md",{},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fusage-string-driven-clis-with-docopt-ng",{"title":5,"description":2298},"modern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fusage-string-driven-clis-with-docopt-ng\u002Findex",[21,2307,2308,2309],"frameworks","help-text","validation","R7wJx39txvzqHJHWsApt28g9icsLCTsa-edkMuvL5KA",[2312,2315,2318,2321,2324,2327,2330,2333,2336,2339,2342,2345,2348,2351,2354,2357,2360,2363,2366,2369,2372,2375,2378,2381,2384,2387,2390,2393,2396,2399,2402,2405,2408,2411,2414,2417,2420,2423,2426,2429,2432,2435,2438,2441,2444,2447,2450,2453,2456,2459,2462,2465,2468,2471,2474,2477,2480,2483,2486,2489,2492,2495,2498,2501,2504,2507,2510,2513,2516,2519,2522,2525,2528,2531,2534,2537,2540,2543,2546,2549,2552,2555,2558,2561,2564,2567,2570,2573,2576,2579,2582,2585,2588,2591,2594,2597,2600,2603,2606,2609,2612,2615,2618,2621,2624,2627,2630,2633,2636,2639,2642,2645,2648,2651,2654,2657,2660,2663,2666,2669,2672,2675,2678,2681,2684,2687,2690,2693,2696,2699,2702,2705,2708,2711,2714,2717,2720,2723,2726,2729,2731,2734,2737,2740,2743,2744,2747,2750,2753,2756,2759,2762,2765,2768,2771,2774,2777,2780,2783,2786,2789,2792,2795,2798,2801,2804,2807,2810,2813,2816,2819,2822,2825,2828,2831,2834,2837,2840,2843,2846,2849,2852,2855,2858,2861,2864,2867,2870,2873,2876,2879,2882,2885,2888,2891,2894,2897,2900,2903,2906,2909,2912,2915,2918,2921,2924,2927,2930,2933,2936,2939,2942,2945,2948,2951,2954,2957,2960,2963,2966,2969,2972,2975,2978,2981,2984,2987,2990,2993,2996,2999,3002,3005,3008,3011,3014,3017,3020,3023,3026,3029,3032,3035,3038,3041,3044,3047,3050,3053,3056,3059,3062,3065,3068,3071,3074,3077,3080,3083,3086,3089,3092,3095,3098,3101,3104,3107,3110,3113,3116,3119,3122,3125,3128,3131,3134,3137,3140,3143,3146,3149,3152],{"path":2313,"title":2314},"\u002Fabout","About Python CLI Toolcraft",{"path":2316,"title":2317},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":2319,"title":2320},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":2322,"title":2323},"\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":2325,"title":2326},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":2328,"title":2329},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2331,"title":2332},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":2334,"title":2335},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2337,"title":2338},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":2340,"title":2341},"\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":2343,"title":2344},"\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":2346,"title":2347},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2349,"title":2350},"\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":2352,"title":2353},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":2355,"title":2356},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2358,"title":2359},"\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":2361,"title":2362},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":2364,"title":2365},"\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":2367,"title":2368},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2370,"title":2371},"\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":2373,"title":2374},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2376,"title":2377},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2379,"title":2380},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2382,"title":2383},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2385,"title":2386},"\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":2388,"title":2389},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":2391,"title":2392},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2394,"title":2395},"\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":2397,"title":2398},"\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":2400,"title":2401},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2403,"title":2404},"\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":2406,"title":2407},"\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":2409,"title":2410},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2412,"title":2413},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2415,"title":2416},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2418,"title":2419},"\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":2421,"title":2422},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2424,"title":2425},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2427,"title":2428},"\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":2430,"title":2431},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2433,"title":2434},"\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":2436,"title":2437},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2439,"title":2440},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2442,"title":2443},"\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":2445,"title":2446},"\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":2448,"title":2449},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2451,"title":2452},"\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":2454,"title":2455},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2457,"title":2458},"\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":2460,"title":2461},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2463,"title":2464},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2466,"title":2467},"\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":2469,"title":2470},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2472,"title":2473},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2475,"title":2476},"\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":2478,"title":2479},"\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":2481,"title":2482},"\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":2484,"title":2485},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2487,"title":2488},"\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":2490,"title":2491},"\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":2493,"title":2494},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2496,"title":2497},"\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":2499,"title":2500},"\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":2502,"title":2503},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2505,"title":2506},"\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":2508,"title":2509},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2511,"title":2512},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2514,"title":2515},"\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":2517,"title":2518},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2520,"title":2521},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2523,"title":2524},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2526,"title":2527},"\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":2529,"title":2530},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2532,"title":2533},"\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":2535,"title":2536},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2538,"title":2539},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2541,"title":2542},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2544,"title":2545},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2547,"title":2548},"\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":2550,"title":2551},"\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":2553,"title":2554},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2556,"title":2557},"\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":2559,"title":2560},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2562,"title":2563},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2565,"title":2566},"\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":2568,"title":2569},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2571,"title":2572},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2574,"title":2575},"\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":2577,"title":2578},"\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":2580,"title":2581},"\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":2583,"title":2584},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2586,"title":2587},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2589,"title":2590},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2592,"title":2593},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2595,"title":2596},"\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":2598,"title":2599},"\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":2601,"title":2602},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2604,"title":2605},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2607,"title":2608},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2610,"title":2611},"\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":2613,"title":2614},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2616,"title":2617},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2619,"title":2620},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2622,"title":2623},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwalking-directory-trees-with-ignore-rules","Walking Directory Trees with Ignore Rules in a Python CLI",{"path":2625,"title":2626},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2628,"title":2629},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2631,"title":2632},"\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":2634,"title":2635},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2637,"title":2638},"\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":2640,"title":2641},"\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":2643,"title":2644},"\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":2646,"title":2647},"\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":2649,"title":2650},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2652,"title":2653},"\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":2655,"title":2656},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2658,"title":2659},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2661,"title":2662},"\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":2664,"title":2665},"\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":2667,"title":2668},"\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":2670,"title":2671},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2673,"title":2674},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2676,"title":2677},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2679,"title":2680},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2682,"title":2683},"\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":2685,"title":2686},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2688,"title":2689},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2691,"title":2692},"\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":2694,"title":2695},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2697,"title":2698},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2700,"title":2701},"\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":2703,"title":2704},"\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":2706,"title":2707},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2709,"title":2710},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2712,"title":2713},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2715,"title":2716},"\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":2718,"title":2719},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2721,"title":2722},"\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":2724,"title":2725},"\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":2727,"title":2728},"\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":112,"title":2730},"Python CLI Toolcraft",{"path":2732,"title":2733},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2735,"title":2736},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2738,"title":2739},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2741,"title":2742},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2303,"title":5},{"path":2745,"title":2746},"\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":2748,"title":2749},"\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":2751,"title":2752},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2754,"title":2755},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2757,"title":2758},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2760,"title":2761},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2763,"title":2764},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2766,"title":2767},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2769,"title":2770},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2772,"title":2773},"\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":2775,"title":2776},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2778,"title":2779},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2781,"title":2782},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2784,"title":2785},"\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":2787,"title":2788},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2790,"title":2791},"\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":2793,"title":2794},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2796,"title":2797},"\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":2799,"title":2800},"\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":2802,"title":2803},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2805,"title":2806},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2808,"title":2809},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2811,"title":2812},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2814,"title":2815},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2817,"title":2818},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2820,"title":2821},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2823,"title":2824},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2826,"title":2827},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2829,"title":2830},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2832,"title":2833},"\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":2835,"title":2836},"\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":2838,"title":2839},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2841,"title":2842},"\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":2844,"title":2845},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2847,"title":2848},"\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":2850,"title":2851},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2853,"title":2854},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2856,"title":2857},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2859,"title":2860},"\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":2862,"title":2863},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2865,"title":2866},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2868,"title":2869},"\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":2871,"title":2872},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2874,"title":2875},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2877,"title":2878},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2880,"title":2881},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2883,"title":2884},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2886,"title":2887},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2889,"title":2890},"\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":2892,"title":2893},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2895,"title":2896},"\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":2898,"title":2899},"\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":2901,"title":2902},"\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":2904,"title":2905},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2907,"title":2908},"\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":2910,"title":2911},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2913,"title":2914},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2916,"title":2917},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2919,"title":2920},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2922,"title":2923},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2925,"title":2926},"\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":2928,"title":2929},"\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":2931,"title":2932},"\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":2934,"title":2935},"\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":2937,"title":2938},"\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":2940,"title":2941},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2943,"title":2944},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2946,"title":2947},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2949,"title":2950},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2952,"title":2953},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2955,"title":2956},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2958,"title":2959},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2961,"title":2962},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2964,"title":2965},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2967,"title":2968},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2970,"title":2971},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2973,"title":2974},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2976,"title":2977},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2979,"title":2980},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2982,"title":2983},"\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":2985,"title":2986},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2988,"title":2989},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2991,"title":2992},"\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":2994,"title":2995},"\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":2997,"title":2998},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":3000,"title":3001},"\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":3003,"title":3004},"\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":3006,"title":3007},"\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":3009,"title":3010},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":3012,"title":3013},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":3015,"title":3016},"\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":3018,"title":3019},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":3021,"title":3022},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":3024,"title":3025},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":3027,"title":3028},"\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":3030,"title":3031},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":3033,"title":3034},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":3036,"title":3037},"\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":3039,"title":3040},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":3042,"title":3043},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":3045,"title":3046},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":3048,"title":3049},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":3051,"title":3052},"\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":3054,"title":3055},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":3057,"title":3058},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":3060,"title":3061},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":3063,"title":3064},"\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":3066,"title":3067},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":3069,"title":3070},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":3072,"title":3073},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":3075,"title":3076},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":3078,"title":3079},"\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":3081,"title":3082},"\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":3084,"title":3085},"\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":3087,"title":3088},"\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":3090,"title":3091},"\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":3093,"title":3094},"\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":3096,"title":3097},"\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":3099,"title":3100},"\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":3102,"title":3103},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":3105,"title":3106},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":3108,"title":3109},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":3111,"title":3112},"\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":3114,"title":3115},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":3117,"title":3118},"\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":3120,"title":3121},"\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":3123,"title":3124},"\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":3126,"title":3127},"\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":3129,"title":3130},"\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":3132,"title":3133},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":3135,"title":3136},"\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":3138,"title":3139},"\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":3141,"title":3142},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":3144,"title":3145},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":3147,"title":3148},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":3150,"title":3151},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":3153,"title":3154},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967540174]