frontend/lib/src/components/widgets/DataFrame/columns/ListColumn.test.ts - develop - vshmidt/streamlit

frontend/lib/src/components/widgets/DataFrame/columns/ListColumn.test.ts
132 строки4 KB
Ken McGrady
Update copyright header to 2026 (#13491)
02 янв 2026, 16:21
02 янв 2026, 16:21374540a
/**
 * Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2026)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { GridCellKind } from "@glideapps/glide-data-grid"
import { MultiSelectCellType } from "@glideapps/glide-data-grid-cells"
import { Field, List, Utf8 } from "apache-arrow"

import { DataFrameCellType } from "~lib/dataframes/arrowTypeUtils"

import ListColumn from "./ListColumn"

const MOCK_LIST_COLUMN_PROPS = {
  id: "1",
  name: "list_column",
  title: "List column",
  indexNumber: 0,
  isEditable: false,
  isHidden: false,
  isIndex: false,
  isPinned: false,
  isStretched: false,
  arrowType: {
    type: DataFrameCellType.DATA,
    arrowField: new Field(
      "list_column",
      new List(new Field("item", new Utf8(), true)),
      true
    ),
    pandasType: {
      field_name: "list_column",
      name: "list_column",
      pandas_type: "object",
      numpy_type: "list[unicode]",
      metadata: null,
    },
  },
}

describe("ListColumn", () => {
  it("creates a valid column instance", () => {
    const mockColumn = ListColumn(MOCK_LIST_COLUMN_PROPS)
    expect(mockColumn.kind).toEqual("list")
    expect(mockColumn.title).toEqual(MOCK_LIST_COLUMN_PROPS.title)
    expect(mockColumn.id).toEqual(MOCK_LIST_COLUMN_PROPS.id)
    expect(mockColumn.sortMode).toEqual("default")

    const mockCell = mockColumn.getCell(["foo", "bar"])
    expect(mockCell.kind).toEqual(GridCellKind.Custom)
    expect((mockCell as MultiSelectCellType).data.values).toEqual([
      "foo",
      "bar",
    ])
  })

  it("Column supports editing", () => {
    const mockColumn = ListColumn({
      ...MOCK_LIST_COLUMN_PROPS,
      isEditable: true,
    })

    expect(mockColumn.isEditable).toEqual(true)
  })

  it.each([
    // Supports almost the same as toSafeArray
    [null, null],
    [undefined, null],
    ["", []],
    [[], []],
    ["[]", []],
    ["foo", ["foo"]],
    // Comma separated syntax
    ["foo,bar", ["foo", "bar"]],
    ["foo,bar,", ["foo", "bar", ""]],
    ["foo,bar,,", ["foo", "bar", "", ""]],
    // JSON Array syntax
    [`["foo","bar"]`, ["foo", "bar"]],
    // non-string values
    [0, [0]],
    [1, [1]],
    [
      [0, 1.2],
      [0, 1.2],
    ],
    [true, [true]],
    [false, [false]],
    [
      [true, false],
      [true, false],
    ],
  ])(
    "supports array-compatible value (%p parsed as %p)",
    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: Replace 'any' with a more specific type.
    (input: any, value: any[] | null) => {
      const mockColumn = ListColumn(MOCK_LIST_COLUMN_PROPS)
      const cell = mockColumn.getCell(input)
      expect(mockColumn.getCellValue(cell)).toEqual(value)
    }
  )

  it.each([
    [null, ""],
    [undefined, ""],
    [[], ""],
    [["foo", "bar"], "foo,bar"],
    [["foo", "bar", ""], "foo,bar,"],
    [["foo", "comma,in value"], "foo,comma in value"],
    [[0, 1.2], "0,1.2"],
    [[true, false], "true,false"],
  ])(
    "correctly prepares data for copy (%p parsed as %p)",
    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: Replace 'any' with a more specific type.
    (input: any, copyData: string | undefined) => {
      const mockColumn = ListColumn(MOCK_LIST_COLUMN_PROPS)
      const cell = mockColumn.getCell(input)
      expect((cell as MultiSelectCellType).copyData).toEqual(copyData)
    }
  )
})