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