Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support setting num_rows #176

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions lib/kino/explorer.ex
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,26 @@ defmodule Kino.Explorer do

* `:name` - The displayed name of the table. Defaults to `"DataFrame"` or `"Series"`,
depending on the given data

* `:num_rows` - the number of rows to show in the table. Defaults to `10`.
"""
@spec new(DataFrame.t() | Series.t(), keyword()) :: t()
def new(data, opts \\ [])

def new(%DataFrame{} = df, opts) do
name = Keyword.get(opts, :name, "DataFrame")
Kino.Table.new(__MODULE__, {df, name}, export: fn state -> {"text", inspect(state.df)} end)

Kino.Table.new(__MODULE__, {df, name, opts},
export: fn state -> {"text", inspect(state.df)} end
)
end

def new(%Series{} = s, opts) do
name = Keyword.get(opts, :name, "Series")
Kino.Table.new(__MODULE__, {s, name}, export: fn state -> {"text", inspect(state.df[0])} end)

Kino.Table.new(__MODULE__, {s, name, opts},
export: fn state -> {"text", inspect(state.df[0])} end
)
end

@doc """
Expand All @@ -56,9 +64,10 @@ defmodule Kino.Explorer do
def update(kino, df), do: Kino.Table.update(kino, df)

@impl true
def init({df, name}) do
def init({df, name, opts}) do
{lazy, groups, df, total_rows, columns} = prepare_data(df, name)
info = info(columns, lazy, name)
num_rows = Keyword.get(opts, :num_rows)
info = info(columns, lazy, name, num_rows)

{:ok, info, %{df: df, total_rows: total_rows, columns: columns, groups: groups, name: name}}
end
Expand Down Expand Up @@ -109,15 +118,16 @@ defmodule Kino.Explorer do
end
end

defp info(columns, lazy, name) do
defp info(columns, lazy, name, num_rows) do
name = if lazy, do: "Lazy - #{name}", else: name
has_composite_type_column? = Enum.any?(columns, &(&1.type == "list" || &1.type == "struct"))
features = [:export, :pagination, :sorting, :relocate]

formats =
if has_composite_type_column?, do: ["NDJSON", "Parquet"], else: ["CSV", "NDJSON", "Parquet"]

%{name: name, features: features, export: %{formats: formats}}
info = %{name: name, features: features, export: %{formats: formats}}
if(num_rows, do: Map.put(info, :num_rows, num_rows), else: info)
end

defp get_records(%{df: df, groups: groups}, rows_spec) do
Expand Down
3 changes: 2 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ defmodule KinoExplorer.MixProject do

defp deps do
[
{:kino, "~> 0.13"},
{:kino, github: "livebook-dev/kino"},
# {:kino, "~> 0.13"}, - restore it when a kino is released
{:explorer, "~> 0.9"},
{:ex_doc, "~> 0.31", only: :dev, runtime: false}
]
Expand Down
2 changes: 1 addition & 1 deletion mix.lock
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"ex_doc": {:hex, :ex_doc, "0.34.2", "13eedf3844ccdce25cfd837b99bea9ad92c4e511233199440488d217c92571e8", [:mix], [{:earmark_parser, "~> 1.4.39", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "5ce5f16b41208a50106afed3de6a2ed34f4acfd65715b82a0b84b49d995f95c1"},
"explorer": {:hex, :explorer, "0.9.2", "a9598eeff8d36d88f643d14818bea1869ca70c4def61bfba22f040ee315b84b6", [:mix], [{:adbc, "~> 0.1", [hex: :adbc, repo: "hexpm", optional: true]}, {:aws_signature, "~> 0.3", [hex: :aws_signature, repo: "hexpm", optional: false]}, {:castore, "~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:flame, "~> 0.3", [hex: :flame, repo: "hexpm", optional: true]}, {:fss, "~> 0.1", [hex: :fss, repo: "hexpm", optional: false]}, {:nx, "~> 0.4", [hex: :nx, repo: "hexpm", optional: true]}, {:rustler, "~> 0.34.0", [hex: :rustler, repo: "hexpm", optional: true]}, {:rustler_precompiled, "~> 0.7", [hex: :rustler_precompiled, repo: "hexpm", optional: false]}, {:table, "~> 0.1.2", [hex: :table, repo: "hexpm", optional: false]}, {:table_rex, "~> 3.1.1 or ~> 4.0.0", [hex: :table_rex, repo: "hexpm", optional: false]}], "hexpm", "63057e318d613c1819bd8bee2d8ed4f7061c3136edc6832ad18243d28e6344eb"},
"fss": {:hex, :fss, "0.1.1", "9db2344dbbb5d555ce442ac7c2f82dd975b605b50d169314a20f08ed21e08642", [:mix], [], "hexpm", "78ad5955c7919c3764065b21144913df7515d52e228c09427a004afe9c1a16b0"},
"kino": {:hex, :kino, "0.14.0", "d0e18f8bcbf81de41dbafdad9c7b9f0607f5e87c2d881cd46e567477abf0fd37", [:mix], [{:fss, "~> 0.1.0", [hex: :fss, repo: "hexpm", optional: false]}, {:nx, "~> 0.1", [hex: :nx, repo: "hexpm", optional: true]}, {:plug, "~> 1.0", [hex: :plug, repo: "hexpm", optional: true]}, {:table, "~> 0.1.2", [hex: :table, repo: "hexpm", optional: false]}], "hexpm", "91bcc77cc58a6ed69697d6e2bdf5f577b03f93476a26270dea66b1a770b1fc76"},
"kino": {:git, "https://github.com/livebook-dev/kino.git", "f538e6320d17519ef17d5ee2a1a135714c4b1288", []},
"makeup": {:hex, :makeup, "1.1.2", "9ba8837913bdf757787e71c1581c21f9d2455f4dd04cfca785c70bbfff1a76a3", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cce1566b81fbcbd21eca8ffe808f33b221f9eee2cbc7a1706fc3da9ff18e6cac"},
"makeup_elixir": {:hex, :makeup_elixir, "0.16.2", "627e84b8e8bf22e60a2579dad15067c755531fea049ae26ef1020cad58fe9578", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "41193978704763f6bbe6cc2758b84909e62984c7752b3784bd3c218bb341706b"},
"makeup_erlang": {:hex, :makeup_erlang, "1.0.1", "c7f58c120b2b5aa5fd80d540a89fdf866ed42f1f3994e4fe189abebeab610839", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "8a89a1eeccc2d798d6ea15496a6e4870b75e014d1af514b1b71fa33134f57814"},
Expand Down
40 changes: 40 additions & 0 deletions test/kino/explorer_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,46 @@ defmodule Kino.ExplorerTest do
})
end

test "name as an option" do
kino = Kino.Explorer.new(people_df(), name: "My People")
data = connect(kino)

assert %{
content: %{
data: [
["3", "1", "2"],
["Amy Santiago", "Jake Peralta", "Terry Jeffords"],
[
"2023-12-12 12:12:12.121212",
"2023-12-01 02:03:04.050607",
"2023-11-11 11:11:11.111111"
]
]
},
name: "My People"
} = data
end

test "num_rows as an option" do
kino = Kino.Explorer.new(people_df(), num_rows: 2)
data = connect(kino)

assert %{
content: %{
data: [
["3", "1"],
["Amy Santiago", "Jake Peralta"],
[
"2023-12-12 12:12:12.121212",
"2023-12-01 02:03:04.050607"
]
],
max_page: 2,
page: 1
}
} = data
end

test "column definitions include type" do
kino = Kino.Explorer.new(people_df())
data = connect(kino)
Expand Down
Loading