Edit page in Livemark
(2026-08-27 10:42)

List Field

Overview

The field contains an ordered collection of primitive values of a fixed item type, written as a string with the items separated by a delimiter. Read more in Table Schema Standard.

Example

from frictionless import Schema, extract, fields

data = [['name'], ['1,2,3']]
rows = extract(data, schema=Schema(fields=[fields.ListField(name='name', item_type='integer')]))
print(rows)
{'memory': [{'name': [1, 2, 3]}]}

Reference

fields.ListField (class)

fields.ListField (class)

Field representation

Signature

(*, name: str, title: Optional[str] = None, description: Optional[str] = None, format: str = default, missing_values: List[str] = NOTHING, constraints: Dict[str, Any] = NOTHING, rdf_type: Optional[str] = None, example: Optional[str] = None, schema: Optional[Schema] = None, delimiter: str = ,, item_type: str = string) -> None

Parameters

  • name (str)
  • title (Optional[str])
  • description (Optional[str])
  • format (str)
  • missing_values (List[str])
  • constraints (Dict[str, Any])
  • rdf_type (Optional[str])
  • example (Optional[str])
  • schema (Optional[Schema])
  • delimiter (str)
  • item_type (str)

fields.listField.item_types (property)

Item types allowed by the standard.

Signature

ClassVar[List[str]]

fields.listField.delimiter (property)

The character sequence that separates the lexically represented items. The default value is ",".

Signature

str

fields.listField.item_type (property)

The type of the list items, given as a Table Schema type. Items are read with the default format of that type, as the standard requires. The default value is "string".

Signature

str