main
1from __future__ import annotations
2
3from typing import TYPE_CHECKING, Any, cast
4from argparse import ArgumentParser
5
6from .._utils import get_client, print_model
7from .._models import BaseModel
8from .._progress import BufferReader
9
10if TYPE_CHECKING:
11 from argparse import _SubParsersAction
12
13
14def register(subparser: _SubParsersAction[ArgumentParser]) -> None:
15 sub = subparser.add_parser("files.create")
16
17 sub.add_argument(
18 "-f",
19 "--file",
20 required=True,
21 help="File to upload",
22 )
23 sub.add_argument(
24 "-p",
25 "--purpose",
26 help="Why are you uploading this file? (see https://platform.openai.com/docs/api-reference/ for purposes)",
27 required=True,
28 )
29 sub.set_defaults(func=CLIFile.create, args_model=CLIFileCreateArgs)
30
31 sub = subparser.add_parser("files.retrieve")
32 sub.add_argument("-i", "--id", required=True, help="The files ID")
33 sub.set_defaults(func=CLIFile.get, args_model=CLIFileCreateArgs)
34
35 sub = subparser.add_parser("files.delete")
36 sub.add_argument("-i", "--id", required=True, help="The files ID")
37 sub.set_defaults(func=CLIFile.delete, args_model=CLIFileCreateArgs)
38
39 sub = subparser.add_parser("files.list")
40 sub.set_defaults(func=CLIFile.list)
41
42
43class CLIFileIDArgs(BaseModel):
44 id: str
45
46
47class CLIFileCreateArgs(BaseModel):
48 file: str
49 purpose: str
50
51
52class CLIFile:
53 @staticmethod
54 def create(args: CLIFileCreateArgs) -> None:
55 with open(args.file, "rb") as file_reader:
56 buffer_reader = BufferReader(file_reader.read(), desc="Upload progress")
57
58 file = get_client().files.create(
59 file=(args.file, buffer_reader),
60 # casts required because the API is typed for enums
61 # but we don't want to validate that here for forwards-compat
62 purpose=cast(Any, args.purpose),
63 )
64 print_model(file)
65
66 @staticmethod
67 def get(args: CLIFileIDArgs) -> None:
68 file = get_client().files.retrieve(file_id=args.id)
69 print_model(file)
70
71 @staticmethod
72 def delete(args: CLIFileIDArgs) -> None:
73 file = get_client().files.delete(file_id=args.id)
74 print_model(file)
75
76 @staticmethod
77 def list() -> None:
78 files = get_client().files.list()
79 for file in files:
80 print_model(file)