overload to_json (#2005)

pola-rs · Dec 7, 2021 · 090bb7e · 090bb7e
1 parent c70b5d4
commit 090bb7e
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/py-polars/polars/internals/frame.py b/py-polars/polars/internals/frame.py
@@ -683,10 +683,41 @@ def to_dict(
         else:
             return {s.name: s.to_list() for s in self}
 
+    @tp.overload
+    def to_json(
+        self,
+        file: Optional[Union[BytesIO, str, Path]] = ...,
+        pretty: bool = ...,
+        *,
+        to_string: Literal[True],
+    ) -> str:
+        ...
+
+    @tp.overload
+    def to_json(
+        self,
+        file: Optional[Union[BytesIO, str, Path]] = ...,
+        pretty: bool = ...,
+        *,
+        to_string: Literal[False] = ...,
+    ) -> None:
+        ...
+
+    @tp.overload
+    def to_json(
+        self,
+        file: Optional[Union[BytesIO, str, Path]] = ...,
+        pretty: bool = ...,
+        *,
+        to_string: bool = ...,
+    ) -> Optional[str]:
+        ...
+
     def to_json(
         self,
         file: Optional[Union[BytesIO, str, Path]] = None,
         pretty: bool = False,
+        *,
         to_string: bool = False,
     ) -> Optional[str]:
         """