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