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