from_json changes

lib/explorer/backend/lazy_series.ex

@@ -144,7 +144,7 @@ defmodule Explorer.Backend.LazySeries do
     member: 3,
     # Struct functions
     field: 2,
-    json_decode: 3
+    from_json: 3
   ]
 
   @comparison_operations [:equal, :not_equal, :greater, :greater_equal, :less, :less_equal]
@@ -1096,8 +1096,8 @@ defmodule Explorer.Backend.LazySeries do
   end
 
   @impl true
-  def json_decode(series, dtype, infer_schema_length) do
-    data = new(:json_decode, [lazy_series!(series), dtype, infer_schema_length], dtype)
+  def from_json(series, dtype, infer_schema_length) do
+    data = new(:from_json, [lazy_series!(series), dtype, infer_schema_length], dtype)
 
     Backend.Series.new(data, dtype)
   end

lib/explorer/backend/series.ex

@@ -305,7 +305,7 @@ defmodule Explorer.Backend.Series do
 
   # Struct
   @callback field(s, String.t()) :: s
-  @callback json_decode(s, option(dtype()), option(non_neg_integer())) :: s
+  @callback from_json(s, option(dtype()), option(non_neg_integer())) :: s
 
   # Functions
 

lib/explorer/polars_backend/expression.ex

@@ -142,8 +142,7 @@ defmodule Explorer.PolarsBackend.Expression do
     member: 3,
 
     # Structs
-    field: 2,
-    json_decode: 3
+    field: 2
   ]
 
   @custom_expressions [
@@ -162,7 +161,8 @@ defmodule Explorer.PolarsBackend.Expression do
     concat: 1,
     column: 1,
     correlation: 4,
-    covariance: 3
+    covariance: 3,
+    from_json: 3
   ]
 
   missing =
@@ -173,6 +173,11 @@ defmodule Explorer.PolarsBackend.Expression do
     raise ArgumentError, "missing #{inspect(__MODULE__)} nodes: #{inspect(missing)}"
   end
 
+  def to_expr(%LazySeries{op: :from_json, args: _}) do
+    raise ArgumentError,
+          "from_json/2 is not supported as a dataframe operation. Use Series.from_json/2 instead."
+  end
+
   def to_expr(%LazySeries{op: :cast, args: [lazy_series, dtype]}) do
     lazy_series_expr = to_expr(lazy_series)
     Native.expr_cast(lazy_series_expr, dtype)

lib/explorer/polars_backend/native.ex

@@ -449,7 +449,7 @@ defmodule Explorer.PolarsBackend.Native do
   def s_member(_s, _value, _inner_dtype), do: err()
 
   def s_field(_s, _name), do: err()
-  def s_json_decode(_s, _dtype, _infer_schema_length), do: err()
+  def s_from_json(_s, _dtype, _infer_schema_length), do: err()
 
   defp err, do: :erlang.nif_error(:nif_not_loaded)
 end

lib/explorer/polars_backend/series.ex

@@ -739,8 +739,8 @@ defmodule Explorer.PolarsBackend.Series do
     do: Shared.apply_series(series, :s_field, [name])
 
   @impl true
-  def json_decode(series, dtype, infer_schema_length),
-    do: Shared.apply_series(series, :s_json_decode, [dtype, infer_schema_length])
+  def from_json(series, dtype, infer_schema_length),
+    do: Shared.apply_series(series, :s_from_json, [dtype, infer_schema_length])
 
   # Polars specific functions
 

lib/explorer/series.ex

@@ -6044,26 +6044,38 @@ defmodule Explorer.Series do
   end
 
   @doc """
-  Decode json from string.
+  Converts a string series containing valid json to a struct series.
 
   ## Examples
 
       iex> s = Series.from_list(["{\\"a\\":1}"])
-      iex> Series.json_decode(s)
+      iex> Series.from_json(s)
       #Explorer.Series<
         Polars[1]
         struct[1] [%{"a" => 1}]
       >
 
   Will raise `RuntimeError` for invalid json.
+
+  `Series.from_json/2` is a series only operation. It is not supported as a data frame operation.
+  `DataFrame.put/3` can be used to add converted series to `DataFrame`.
+
+      iex> df = Explorer.DataFrame.new([%{a: "{\\"n\\": 1}"}])
+      iex> s = Series.from_json(df["a"])
+      iex> Explorer.DataFrame.put(df, "aj", s)
+      #Explorer.DataFrame<
+        Polars[1 x 2]
+        a string ["{\\"n\\": 1}"]
+        aj struct[1] [%{"n" => 1}]
+      >
   """
   @doc type: :struct_wise
-  @spec json_decode(Series.t(), Keyword.t()) :: Series.t()
-  def json_decode(%Series{dtype: :string} = series, opts \\ []) do
+  @spec from_json(Series.t(), Keyword.t()) :: Series.t()
+  def from_json(%Series{dtype: :string} = series, opts \\ []) do
     opts = Keyword.validate!(opts, [:dtype, :infer_schema_length])
     dtype = if opts[:dtype], do: Shared.normalise_dtype!(opts[:dtype])
 
-    apply_series(series, :json_decode, [dtype, opts[:infer_schema_length]])
+    apply_series(series, :from_json, [dtype, opts[:infer_schema_length]])
   end
 
   # Helpers

native/explorer/src/lib.rs

@@ -280,7 +280,7 @@ rustler::init!(
         expr_member,
         // struct expressions
         expr_field,
-        expr_json_decode,
+        // expr_json_decode,
         // lazyframe
         lf_collect,
         lf_describe_plan,
@@ -481,7 +481,7 @@ rustler::init!(
         s_lengths,
         s_member,
         s_field,
-        s_json_decode,
+        s_from_json,
     ],
     load = on_load
 );

native/explorer/src/series.rs

@@ -1826,7 +1826,7 @@ pub fn s_field(s: ExSeries, name: &str) -> Result<ExSeries, ExplorerError> {
 }
 
 #[rustler::nif]
-pub fn s_json_decode(
+pub fn s_from_json(
     s: ExSeries,
     ex_dtype: Option<ExSeriesDtype>,
     infer_schema_length: Option<usize>,

test/explorer/data_frame_test.exs

@@ -1870,32 +1870,6 @@ defmodule Explorer.DataFrameTest do
                member?: [true, false]
              }
     end
-
-    test "extracts struct from json - json_decode" do
-      df = DF.new([%{a: "{\"n\": 1}"}])
-      dfj = DF.mutate(df, aj: json_decode(a, dtype: {:struct, %{"n" => {:s, 64}}}))
-      assert dfj.dtypes == %{"a" => :string, "aj" => {:struct, %{"n" => {:s, 64}}}}
-      assert DF.to_rows(dfj) == [%{"a" => "{\"n\": 1}", "aj" => %{"n" => 1}}]
-    end
-
-    test "extracts struct from json - json_decode with dtype" do
-      df = DF.new([%{a: "{\"n\": 1}"}])
-      dfj = DF.mutate(df, aj: json_decode(a, dtype: {:struct, %{"n" => {:f, 64}}}))
-      assert dfj.dtypes == %{"a" => :string, "aj" => {:struct, %{"n" => {:f, 64}}}}
-      assert DF.to_rows(dfj) == [%{"a" => "{\"n\": 1}", "aj" => %{"n" => 1.0}}]
-    end
-
-    test "extracts struct from json - json_decode with infer_schema_length" do
-      df = DF.new([%{a: "{\"n\": 1}"}])
-
-      dfj =
-        DF.mutate(df,
-          aj: json_decode(a, infer_schema_length: 100)
-        )
-
-      assert dfj.dtypes == %{"a" => :string, "aj" => {:struct, %{"n" => {:s, 64}}}}
-      assert DF.to_rows(dfj) == [%{"a" => "{\"n\": 1}", "aj" => %{"n" => 1}}]
-    end
   end
 
   describe "sort_by/3" do

test/explorer/series_test.exs

@@ -5866,4 +5866,27 @@ defmodule Explorer.SeriesTest do
       end
     end
   end
+
+  describe "from_json/2" do
+    test "extracts struct from json" do
+      s = Series.from_list(["{\"n\": 1}"])
+      sj = Series.from_json(s)
+      assert sj.dtype == {:struct, %{"n" => {:s, 64}}}
+      assert Series.to_list(sj) == [%{"n" => 1}]
+    end
+
+    test "extracts struct from json with dtype" do
+      s = Series.from_list(["{\"n\": 1}"])
+      sj = Series.from_json(s, dtype: {:struct, %{"n" => {:f, 64}}})
+      assert sj.dtype == {:struct, %{"n" => {:f, 64}}}
+      assert Series.to_list(sj) == [%{"n" => 1.0}]
+    end
+
+    test "extracts struct from json with infer_schema_length" do
+      s = Series.from_list(["{\"n\": 1}"])
+      sj = Series.from_json(s, infer_schema_length: 100)
+      assert sj.dtype == {:struct, %{"n" => {:s, 64}}}
+      assert Series.to_list(sj) == [%{"n" => 1}]
+    end
+  end
 end