Edit page in Livemark
(2022-09-19 18:33)

Object Field

Overview

The field contains data which is valid JSON. Read more in Table Schema Standard.

Example

from frictionless import Schema, extract, fields

data = [['name'], ['{"key": "value"}']]
rows = extract(data, schema=Schema(fields=[fields.ObjectField(name='name')]))
print(rows)
[{'name': {'key': 'value'}}]

Reference

fields.ObjectField (class)

fields.ObjectField (class)

Field representation

Signature

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

Parameters

  • name (Optional[str])
  • title (Optional[str])
  • description (Optional[str])
  • format (str)
  • missing_values (List[str])
  • constraints (dict)
  • rdf_type (Optional[str])
  • example (Optional[str])
  • schema (Optional[Schema])

fields.objectField.type (property)

Signature

ClassVar[str]

fields.objectField.builtin (property)

Signature

ClassVar[bool]

fields.objectField.supported_constraints (property)

Signature

ClassVar[List[str]]

fields.objectField.name (property)

Signature

Optional[str]

fields.objectField.title (property)

Signature

Optional[str]

fields.objectField.description (property)

Signature

Optional[str]

fields.objectField.format (property)

Signature

str

fields.objectField.missing_values (property)

Signature

List[str]

fields.objectField.constraints (property)

Signature

dict

fields.objectField.rdf_type (property)

Signature

Optional[str]

fields.objectField.example (property)

Signature

Optional[str]

fields.objectField.schema (property)

Signature

Optional[Schema]

It's a beta version of Frictionless Framework (v5). Read Frictionless Framework (v4) docs for a version that is currently installed by default by pip.