refactor(cli): rename internal types for improved auto complete

Author: stainless-bot

src/openai/cli/_api/audio.py

@@ -24,7 +24,7 @@ def register(subparser: _SubParsersAction[ArgumentParser]) -> None:
     sub.add_argument("--language", type=str)
     sub.add_argument("-t", "--temperature", type=float)
     sub.add_argument("--prompt", type=str)
-    sub.set_defaults(func=Audio.transcribe, args_model=TranscribeArgs)
+    sub.set_defaults(func=CLIAudio.transcribe, args_model=CLITranscribeArgs)
 
     # translations
     sub = subparser.add_parser("audio.translations.create")
@@ -38,10 +38,10 @@ def register(subparser: _SubParsersAction[ArgumentParser]) -> None:
     # sub.add_argument("--language", type=str)
     sub.add_argument("-t", "--temperature", type=float)
     sub.add_argument("--prompt", type=str)
-    sub.set_defaults(func=Audio.translate, args_model=TranslationArgs)
+    sub.set_defaults(func=CLIAudio.translate, args_model=CLITranslationArgs)
 
 
-class TranscribeArgs(BaseModel):
+class CLITranscribeArgs(BaseModel):
     model: str
     file: str
     response_format: Optional[str] = None
@@ -50,7 +50,7 @@ class TranscribeArgs(BaseModel):
     prompt: Optional[str] = None
 
 
-class TranslationArgs(BaseModel):
+class CLITranslationArgs(BaseModel):
     model: str
     file: str
     response_format: Optional[str] = None
@@ -59,9 +59,9 @@ class TranslationArgs(BaseModel):
     prompt: Optional[str] = None
 
 
-class Audio:
+class CLIAudio:
     @staticmethod
-    def transcribe(args: TranscribeArgs) -> None:
+    def transcribe(args: CLITranscribeArgs) -> None:
         with open(args.file, "rb") as file_reader:
             buffer_reader = BufferReader(file_reader.read(), desc="Upload progress")
 
@@ -78,7 +78,7 @@ def transcribe(args: TranscribeArgs) -> None:
         print_model(model)
 
     @staticmethod
-    def translate(args: TranslationArgs) -> None:
+    def translate(args: CLITranslationArgs) -> None:
         with open(args.file, "rb") as file_reader:
             buffer_reader = BufferReader(file_reader.read(), desc="Upload progress")
 

src/openai/cli/_api/chat/completions.py

@@ -73,16 +73,16 @@ def register(subparser: _SubParsersAction[ArgumentParser]) -> None:
         help="A stop sequence at which to stop generating tokens for the message.",
     )
     opt.add_argument("--stream", help="Stream messages as they're ready.", action="store_true")
-    sub.set_defaults(func=ChatCompletion.create, args_model=ChatCompletionCreateArgs)
+    sub.set_defaults(func=CLIChatCompletion.create, args_model=CLIChatCompletionCreateArgs)
 
 
-class Message(NamedTuple):
+class CLIMessage(NamedTuple):
     role: ChatCompletionRole
     content: str
 
 
-class ChatCompletionCreateArgs(BaseModel):
-    message: List[Message]
+class CLIChatCompletionCreateArgs(BaseModel):
+    message: List[CLIMessage]
     model: str
     n: Optional[int] = None
     max_tokens: Optional[int] = None
@@ -92,9 +92,9 @@ class ChatCompletionCreateArgs(BaseModel):
     stream: bool = False
 
 
-class ChatCompletion:
+class CLIChatCompletion:
     @staticmethod
-    def create(args: ChatCompletionCreateArgs) -> None:
+    def create(args: CLIChatCompletionCreateArgs) -> None:
         params: CompletionCreateParams = {
             "model": args.model,
             "messages": [{"role": message.role, "content": message.content} for message in args.message],
@@ -111,9 +111,9 @@ def create(args: ChatCompletionCreateArgs) -> None:
             params["max_tokens"] = args.max_tokens
 
         if args.stream:
-            return ChatCompletion._stream_create(cast(CompletionCreateParamsStreaming, params))
+            return CLIChatCompletion._stream_create(cast(CompletionCreateParamsStreaming, params))
 
-        return ChatCompletion._create(cast(CompletionCreateParamsNonStreaming, params))
+        return CLIChatCompletion._create(cast(CompletionCreateParamsNonStreaming, params))
 
     @staticmethod
     def _create(params: CompletionCreateParamsNonStreaming) -> None:

src/openai/cli/_api/completions.py

@@ -87,10 +87,10 @@ def register(subparser: _SubParsersAction[ArgumentParser]) -> None:
         help="A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.",
     )
     # TODO: add support for logit_bias
-    sub.set_defaults(func=Completions.create, args_model=CompletionCreateArgs)
+    sub.set_defaults(func=CLICompletions.create, args_model=CLICompletionCreateArgs)
 
 
-class CompletionCreateArgs(BaseModel):
+class CLICompletionCreateArgs(BaseModel):
     model: str
     stream: bool = False
 
@@ -109,9 +109,9 @@ class CompletionCreateArgs(BaseModel):
     frequency_penalty: NotGivenOr[float] = NOT_GIVEN
 
 
-class Completions:
+class CLICompletions:
     @staticmethod
-    def create(args: CompletionCreateArgs) -> None:
+    def create(args: CLICompletionCreateArgs) -> None:
         if is_given(args.n) and args.n > 1 and args.stream:
             raise CLIError("Can't stream completions with n>1 with the current CLI")
 
@@ -134,12 +134,12 @@ def create(args: CompletionCreateArgs) -> None:
         )
 
         if args.stream:
-            return Completions._stream_create(
+            return CLICompletions._stream_create(
                 # mypy doesn't understand the `partial` function but pyright does
                 cast(Stream[Completion], make_request(stream=True))  # pyright: ignore[reportUnnecessaryCast]
             )
 
-        return Completions._create(make_request())
+        return CLICompletions._create(make_request())
 
     @staticmethod
     def _create(completion: Completion) -> None:

src/openai/cli/_api/files.py

@@ -26,45 +26,45 @@ def register(subparser: _SubParsersAction[ArgumentParser]) -> None:
         help="Why are you uploading this file? (see https://platform.openai.com/docs/api-reference/ for purposes)",
         required=True,
     )
-    sub.set_defaults(func=File.create, args_model=FileCreateArgs)
+    sub.set_defaults(func=CLIFile.create, args_model=CLIFileCreateArgs)
 
     sub = subparser.add_parser("files.retrieve")
     sub.add_argument("-i", "--id", required=True, help="The files ID")
-    sub.set_defaults(func=File.get, args_model=FileCreateArgs)
+    sub.set_defaults(func=CLIFile.get, args_model=CLIFileCreateArgs)
 
     sub = subparser.add_parser("files.delete")
     sub.add_argument("-i", "--id", required=True, help="The files ID")
-    sub.set_defaults(func=File.delete, args_model=FileCreateArgs)
+    sub.set_defaults(func=CLIFile.delete, args_model=CLIFileCreateArgs)
 
     sub = subparser.add_parser("files.list")
-    sub.set_defaults(func=File.list)
+    sub.set_defaults(func=CLIFile.list)
 
 
-class FileIDArgs(BaseModel):
+class CLIFileIDArgs(BaseModel):
     id: str
 
 
-class FileCreateArgs(BaseModel):
+class CLIFileCreateArgs(BaseModel):
     file: str
     purpose: str
 
 
-class File:
+class CLIFile:
     @staticmethod
-    def create(args: FileCreateArgs) -> None:
+    def create(args: CLIFileCreateArgs) -> None:
         with open(args.file, "rb") as file_reader:
             buffer_reader = BufferReader(file_reader.read(), desc="Upload progress")
 
         file = get_client().files.create(file=(args.file, buffer_reader), purpose=args.purpose)
         print_model(file)
 
     @staticmethod
-    def get(args: FileIDArgs) -> None:
+    def get(args: CLIFileIDArgs) -> None:
         file = get_client().files.retrieve(file_id=args.id)
         print_model(file)
 
     @staticmethod
-    def delete(args: FileIDArgs) -> None:
+    def delete(args: CLIFileIDArgs) -> None:
         file = get_client().files.delete(file_id=args.id)
         print_model(file)
 

src/openai/cli/_api/image.py

@@ -18,7 +18,7 @@ def register(subparser: _SubParsersAction[ArgumentParser]) -> None:
     sub.add_argument("-n", "--num-images", type=int, default=1)
     sub.add_argument("-s", "--size", type=str, default="1024x1024", help="Size of the output image")
     sub.add_argument("--response-format", type=str, default="url")
-    sub.set_defaults(func=Image.create, args_model=ImageCreateArgs)
+    sub.set_defaults(func=CLIImage.create, args_model=CLIImageCreateArgs)
 
     sub = subparser.add_parser("images.edit")
     sub.add_argument("-p", "--prompt", type=str, required=True)
@@ -39,7 +39,7 @@ def register(subparser: _SubParsersAction[ArgumentParser]) -> None:
         required=False,
         help="Path to a mask image. It should be the same size as the image you're editing and a RGBA PNG image. The Alpha channel acts as the mask.",
     )
-    sub.set_defaults(func=Image.edit, args_model=ImageEditArgs)
+    sub.set_defaults(func=CLIImage.edit, args_model=CLIImageEditArgs)
 
     sub = subparser.add_parser("images.create_variation")
     sub.add_argument("-n", "--num-images", type=int, default=1)
@@ -52,24 +52,24 @@ def register(subparser: _SubParsersAction[ArgumentParser]) -> None:
     )
     sub.add_argument("-s", "--size", type=str, default="1024x1024", help="Size of the output image")
     sub.add_argument("--response-format", type=str, default="url")
-    sub.set_defaults(func=Image.create_variation, args_model=ImageCreateVariationArgs)
+    sub.set_defaults(func=CLIImage.create_variation, args_model=CLIImageCreateVariationArgs)
 
 
-class ImageCreateArgs(BaseModel):
+class CLIImageCreateArgs(BaseModel):
     prompt: str
     num_images: int
     size: str
     response_format: str
 
 
-class ImageCreateVariationArgs(BaseModel):
+class CLIImageCreateVariationArgs(BaseModel):
     image: str
     num_images: int
     size: str
     response_format: str
 
 
-class ImageEditArgs(BaseModel):
+class CLIImageEditArgs(BaseModel):
     image: str
     num_images: int
     size: str
@@ -78,9 +78,9 @@ class ImageEditArgs(BaseModel):
     mask: NotGivenOr[str] = NOT_GIVEN
 
 
-class Image:
+class CLIImage:
     @staticmethod
-    def create(args: ImageCreateArgs) -> None:
+    def create(args: CLIImageCreateArgs) -> None:
         image = get_client().images.generate(
             prompt=args.prompt,
             n=args.num_images,
@@ -92,7 +92,7 @@ def create(args: ImageCreateArgs) -> None:
         print_model(image)
 
     @staticmethod
-    def create_variation(args: ImageCreateVariationArgs) -> None:
+    def create_variation(args: CLIImageCreateVariationArgs) -> None:
         with open(args.image, "rb") as file_reader:
             buffer_reader = BufferReader(file_reader.read(), desc="Upload progress")
 
@@ -107,7 +107,7 @@ def create_variation(args: ImageCreateVariationArgs) -> None:
         print_model(image)
 
     @staticmethod
-    def edit(args: ImageEditArgs) -> None:
+    def edit(args: CLIImageEditArgs) -> None:
         with open(args.image, "rb") as file_reader:
             buffer_reader = BufferReader(file_reader.read(), desc="Image upload progress")
 

src/openai/cli/_api/models.py

@@ -12,29 +12,29 @@
 
 def register(subparser: _SubParsersAction[ArgumentParser]) -> None:
     sub = subparser.add_parser("models.list")
-    sub.set_defaults(func=Models.list)
+    sub.set_defaults(func=CLIModels.list)
 
     sub = subparser.add_parser("models.retrieve")
     sub.add_argument("-i", "--id", required=True, help="The model ID")
-    sub.set_defaults(func=Models.get, args_model=ModelIDArgs)
+    sub.set_defaults(func=CLIModels.get, args_model=CLIModelIDArgs)
 
     sub = subparser.add_parser("models.delete")
     sub.add_argument("-i", "--id", required=True, help="The model ID")
-    sub.set_defaults(func=Models.delete, args_model=ModelIDArgs)
+    sub.set_defaults(func=CLIModels.delete, args_model=CLIModelIDArgs)
 
 
-class ModelIDArgs(BaseModel):
+class CLIModelIDArgs(BaseModel):
     id: str
 
 
-class Models:
+class CLIModels:
     @staticmethod
-    def get(args: ModelIDArgs) -> None:
+    def get(args: CLIModelIDArgs) -> None:
         model = get_client().models.retrieve(model=args.id)
         print_model(model)
 
     @staticmethod
-    def delete(args: ModelIDArgs) -> None:
+    def delete(args: CLIModelIDArgs) -> None:
         model = get_client().models.delete(model=args.id)
         print_model(model)