feat(api): Narrow down return type of ProjectFileManager.raw using typing.overload

igorp-collabora · nejch · commit 36d9b24ff27d · 2025-01-27T18:48:03.000+01:00
This is equivalent to the changes in 44fd9dc but for `ProjectFileManager.raw` method that I must have missed in the original commit. Signed-off-by: Igor Ponomarev <igor.ponomarev@collabora.com>
diff --git a/gitlab/v4/objects/files.py b/gitlab/v4/objects/files.py
@@ -5,7 +5,9 @@
     Dict,
     Iterator,
     List,
+    Literal,
     Optional,
+    overload,
     Tuple,
     TYPE_CHECKING,
     Union,
@@ -274,6 +276,45 @@ def delete(  # type: ignore[override]
         data = {"branch": branch, "commit_message": commit_message}
         self.gitlab.http_delete(path, query_data=data, **kwargs)
 
+    @overload
+    def raw(
+        self,
+        file_path: str,
+        ref: Optional[str] = None,
+        streamed: Literal[False] = False,
+        action: None = None,
+        chunk_size: int = 1024,
+        *,
+        iterator: Literal[False] = False,
+        **kwargs: Any,
+    ) -> bytes: ...
+
+    @overload
+    def raw(
+        self,
+        file_path: str,
+        ref: Optional[str] = None,
+        streamed: bool = False,
+        action: None = None,
+        chunk_size: int = 1024,
+        *,
+        iterator: Literal[True] = True,
+        **kwargs: Any,
+    ) -> Iterator[Any]: ...
+
+    @overload
+    def raw(
+        self,
+        file_path: str,
+        ref: Optional[str] = None,
+        streamed: Literal[True] = True,
+        action: Optional[Callable[[bytes], None]] = None,
+        chunk_size: int = 1024,
+        *,
+        iterator: Literal[False] = False,
+        **kwargs: Any,
+    ) -> None: ...
+
     @cli.register_custom_action(
         cls_names="ProjectFileManager",
         required=("file_path",),
