feat(files): allow decoding project files directly to stringfeat/decode-to-string

1 files changed, 20 insertions, 2 deletions

diff --git a/gitlab/v4/objects/files.py b/gitlab/v4/objects/files.py
index d81b711..56c1791 100644
--- a/gitlab/v4/objects/files.py
+++ b/gitlab/v4/objects/files.py
@@ -7,6 +7,7 @@ from typing import (
     Iterator,
     List,
     Optional,
+    overload,
     TYPE_CHECKING,
     Union,
 )
@@ -41,13 +42,30 @@ class ProjectFile(SaveMixin, ObjectDeleteMixin, RESTObject):
     file_path: str
     manager: "ProjectFileManager"
 
+    @overload
     def decode(self) -> bytes:
+        ...
+
+    @overload
+    def decode(self, encoding: None) -> bytes:
+        ...
+
+    @overload
+    def decode(self, encoding: str) -> str:
+        ...
+
+    def decode(self, encoding: Optional[str] = None) -> Union[bytes, str]:
         """Returns the decoded content of the file.
 
         Returns:
-            The decoded content.
+            The decoded content as bytes.
+            The decoded content as string if a valid encoding is provided.
         """
-        return base64.b64decode(self.content)
+        decoded_bytes = base64.b64decode(self.content)
+
+        if encoding is not None:
+            return decoded_bytes.decode(encoding)
+        return decoded_bytes
 
     # NOTE(jlvillal): Signature doesn't match SaveMixin.save() so ignore
     # type error