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